Docker Compose on

Prerequisites

Tue, 20 Feb 2024 00:00:00 +0000

Ensure that the following points are completed before deploying the application.

The development package provided by Protegrity is obtained from the portal and extracted.
The Docker CLI is installed to manage Docker containers.
The Docker Compose is installed for local containerized deployments. This application supports Docker Compose V2. Ensure that your installation supports this version.
The images for Classification service, Presidio service, and Roberta services provided in the images folder are uploaded to the required image repository and available for deployment.

Configuring Environment Variables

Tue, 20 Feb 2024 00:00:00 +0000

Run the following steps to configure the environment variables.

Navigate to the docker_compose directory.
Open the .env file and set the following variables:

Variable	Description	Mandatory
CLASSIFICATION_DOCKER_IMAGE	Repository path where the docker image of Classification service is stored.	Yes
PRESIDIO_DOCKER_IMAGE	Repository path where the docker image of Presidio service is stored.	Yes
ROBERTA_DOCKER_IMAGE	Repository path where the docker image of Roberta service is stored.	Yes
DOCKER_NETWORK_NAME	Name of the Docker network.	No
PRESIDIO_LOGGING_CONFIG	Logging level for Presidio.	No
ROBERTA_LOGGING_CONFIG	Logging level for Roberta.	No
CLASSIFICATION_LOGGING_CONFIG	Logging level for the classification service.	No

Save the changes.

Deploying the Application

Tue, 20 Feb 2024 00:00:00 +0000

Run the following steps to deploy the Data Discovery application on Docker.

Navigate to the docker_compose directory.

cd /docker_compose

Run the compose_up script.

./compose_up.sh

The network is set up based on the values provided in the docker-compose.yaml file. The images are extracted from the repositories provided in the .env file and the respective containers are started.
After the deployment is successful, the following message is displayed.
...[OK]

Verifying the Deployment

After the deployment is complete, verify the deployment on Docker.

Viewing the Logs

Tue, 20 Feb 2024 00:00:00 +0000

Viewing Logs

The application logs can be viewed using the following commands:

docker logs -f classification_service
docker logs -f roberta_provider
docker logs -f presidio_provider

Setting the Log Level

The log level can be updated in the .env file.

To set the log level, run the following steps.

Navigate to the docker_compose directory.
Edit the .env file.
Uncomment the required logging configuration and set the logging level to one of the following:

Removing the Application

Tue, 20 Feb 2024 00:00:00 +0000

To remove the application from Docker, run the following steps.

Navigate to the docker_compose directory.

cd /docker_compose

Run the compose_down script.

./compose_down.sh

Note: To remove the application completely, ensure that the images uploaded to the image repository are also deleted.