Docker Compose on

Docker Compose Deployment

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

Prerequisites

The Deployment Package provided by Protegrity is obtained from the portal and extracted.
Docker CLI version greater than or equal to 28.3.0 is installed. This is required for managing Docker containers.
Docker Compose version greater than or equal to 2.37.3 is installed. This is required for local containerized deployments.

Docker Compose v2 that uses the docker compose command syntax. Ensure that the the installation supports this version.

For Apple Macbook users, refer Additional Notes.

Configuring Environment Variables

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

Run the following steps to edit the environment variables:

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

Variable	Description	Required
DOCKER_CLASSIFICATION_IMAGE	Repository path where the docker image of Classification Service is stored.	Yes
DOCKER_PATTERN_PROVIDER_IMAGE	Repository path where the docker image of Pattern classification Service is stored.	Yes
DOCKER_CONTEXT_PROVIDER_IMAGE	Repository path where the docker image of Context clarification Service is stored.	Yes
DOCKER_NETWORK_NAME	Name of the Docker network.	No
PATTERN_PROVIDER_LOGGING_CONFIG	a valid JSON python logging configuration for the Pattern Classification Provider.	No
CONTEXT_PROVIDER_LOGGING_CONFIG	a valid JSON python logging configuration for the Context Classification Provider.	No
CLASSIFICATION_LOGGING_CONFIG	a valid JSON python logging configuration for the Classification Service.	No
ENABLE_ALL_SECURITY_CONTROLS	Controls whether security mitigations are enabled. Accepted values: true (default) or false	No

Save the changes.

Viewing Application Logs

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

The application logs can be viewed using the following commands:

docker logs -f classification_service
docker logs -f context_provider
docker logs -f pattern_provider

Setting the Log Level and other logging configuration

The log level and other valid Python Logging configuration can be set in the .env file using JSON.

Run the following steps to set the overall logging level.

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:

Mon, 01 Jan 0001 00:00:00 +0000

When running commands from inside the Docker network (for example, from another container), use the service name directly. This leverages Docker’s internal DNS. e.g.,

curl -XPOST http://localhost:8050/pty/data-discovery/v1.1/classify --data 'You can reach Dave Elliot by phone 203-555-1286' -H "Content-Type: text/plain"

Mon, 01 Jan 0001 00:00:00 +0000

When running command from outside the docker network, e.g., from your host machine, use the published port mapping. e.g.,

curl -XPOST classification_service/pty/data-discovery/v1.1/classify --data 'You can reach Dave Elliot by phone 203-555-1286' -H "Content-Type: text/plain"