diff --git a/docs/compose/README.md b/docs/compose/README.md index 5f6957d..f217458 100644 --- a/docs/compose/README.md +++ b/docs/compose/README.md @@ -12,15 +12,19 @@ file and related configuration files. Set the necessary environment variables before starting the application: -- `CONTAINER_PASSWORD`: Password used internally by containers. Set this in your -environment or directly in the Docker Compose file. +- `CONTAINER_PASSWORD`: Password used internally by containers. Set this in your environment or directly in the Docker Compose file. - `WHYLABS_API_KEY`: API key for WhyLabs integration. +- `AUTO_PULL_WHYLABS_POLICY_MODEL_IDS`: A csv value of the model ids that you want automatically sync the WhyLabs platform metric policy + from. Example: ```bash export CONTAINER_PASSWORD=yourpassword export WHYLABS_API_KEY=yourapikey + +# Optional +export AUTO_PULL_WHYLABS_POLICY_MODEL_IDS=model-1 ``` ### Logging into GitLab Container Registry diff --git a/docs/compose/compose.yaml b/docs/compose/compose.yaml index 22ce306..d737efd 100644 --- a/docs/compose/compose.yaml +++ b/docs/compose/compose.yaml @@ -1,13 +1,17 @@ name: guardrails services: - guardrails: cap_drop: - ALL environment: + # A csv value of the model ids that you want automatically sync the WhyLabs platform metric policy from + # example: model-1,model-2 + AUTO_PULL_WHYLABS_POLICY_MODEL_IDS: null + # A static password that has to be sent with each request to the container CONTAINER_PASSWORD: null + # A whylabs api key generated in the WhyLabs platform WHYLABS_API_KEY: null - image: registry.gitlab.com/whylabs/langkit-container:1.0.14 + image: registry.gitlab.com/whylabs/langkit-container:1.0.22 platform: linux/amd64 ports: - target: 8000 @@ -20,16 +24,16 @@ services: source: temp-dir target: /tmp deploy: - replicas: 3 + replicas: 1 restart_policy: condition: on-failure resources: limits: - cpus: '4.0' - memory: 6144M + cpus: "4.0" + memory: 4500M reservations: - cpus: '4.0' - memory: 6144M + cpus: "4.0" + memory: 3700M nginx: image: nginx:latest @@ -38,16 +42,16 @@ services: depends_on: - guardrails volumes: - - ./nginx.conf:/etc/nginx/nginx.conf + - ./nginx.conf:/etc/nginx/nginx.conf - type: tmpfs target: /etc/nginx/conf.d deploy: resources: limits: - cpus: '1.0' + cpus: "1.0" memory: 1024M reservations: - cpus: '1.0' + cpus: "1.0" memory: 1024M volumes: