Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update compose file and docs #26

Merged
merged 1 commit into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs/compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@

## Prerequisites

Before you start, make sure you have Docker and Docker Compose installed on your system. You will also need to clone the repository containing the Docker Compose file and related configuration files.
Before you start, make sure you have Docker and Docker Compose installed on your
system. You will also need to clone the repository containing the Docker Compose
file and related configuration files.

## Configuration

### Environment Variables

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.

Example:
Expand Down Expand Up @@ -63,8 +66,8 @@ Example for Guardrails:
```yaml
resources:
limits:
cpus: '2.0' # From 4.0 to 2.0 for example
memory: 2048M # From 4096M to 2048M for example
cpus: '6.0' # From 4.0 to 6.0 for example
memory: 8192M # From 6144M to 8192M for example
```

### Updating the Image and Tag
Expand Down
6 changes: 3 additions & 3 deletions docs/compose/compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ services:
source: temp-dir
target: /tmp
deploy:
replicas: 4
replicas: 3
restart_policy:
condition: on-failure
resources:
limits:
cpus: '4.0'
memory: 4096M
memory: 6144M
reservations:
cpus: '4.0'
memory: 4096M
memory: 6144M

nginx:
image: nginx:latest
Expand Down
Loading