ContextQMD
Back to Opik

README

deployment/docker-compose/README.md

2.0.43-6803-merge-21316.5 KB
Original Source

Run Opik with docker compose

Installation pre-requirements for local installation

Service Profiles for Development

Opik supports Docker Compose profiles to start different combinations of services for various development scenarios:

Available Profiles

  1. Infrastructure Services (always enabled): MySQL, Redis, ClickHouse, ZooKeeper, MinIO etc.
  2. Backend Services (backend): Infrastructure (automatic) + Backend, Python Backend services etc.
  3. Opik Services (opik): The full Opik suite including all infrastructure and services, except for Guardrails services
  4. Guardrails (guardrails): Guardrails services, meant to be combined with other profiles. Guardrails are always optional by default, even for the full Opik suite, unless explicitly enabled
  5. Opik with OpenTelemetry (opik-otel): The full Opik suite plus Jaeger and OpenTelemetry Collector for observability

Profile Usage Examples

Start only infrastructure services (default behavior when no profile):

bash
docker compose up -d

Start infrastructure + backend services:

bash
docker compose --profile backend up -d

Start full Opik suite (all infrastructure and services, except guardrails):

bash
docker compose --profile opik up -d

Start backend + guardrails:

bash
docker compose --profile backend --profile guardrails up -d

Start full Opik suite + guardrails:

bash
docker compose --profile opik --profile guardrails up -d

Start full Opik suite + OpenTelemetry:

bash
docker compose --profile opik-otel up -d

Note: Infrastructure services (databases, caches, storage etc.) always start by default, as that's the expected behaviour for services with no profile, see Using profiles with Compose. Any profile such as Backend, full Opik suite etc. always automatically include the infrastructure.

Run docker compose using the images

If you want to use a specific version, set Opik version like:

bash
export OPIK_VERSION=0.1.10

Otherwise, it will use the latest images.

Run docker compose from the root of the project:

bash
cd deployment/docker-compose

# Optionally, you can force a pull of the latest images
docker compose --profile opik pull

docker compose -f docker-compose.yaml --profile opik up -d

Run docker compose with building application from latest code

From the root of the project:

bash
cd deployment/docker-compose

# Optionally, you can force a pull of the latest images
docker compose --profile opik pull

# Build the images
docker compose -f docker-compose.yaml --profile opik up -d --build

# Alternatively, you can force a pull of the latest images and build the images
docker compose -f docker-compose.yaml --profile opik up -d --build --pull always

Exposing Database and Backend Ports for Local Development

If you're a developer and need to expose the database and backend ports to your host machine for local testing or debugging, you can use the provided Docker Compose override file.

Steps to Expose Ports

Run the following command to start the services and expose the ports:

bash
# Optionally, you can force a pull of the latest images
docker compose --profile opik pull

docker compose -f docker-compose.yaml -f docker-compose.override.yaml --profile opik up -d

This will expose the following services to the host machine:

  • Redis: Available on port 6379.
  • ClickHouse: Available on ports 8123 (HTTP) and 9000 (Native Protocol).
  • Zookeeper: Available on port 2181.
  • MySQL: Available on port 3306.
  • Backend: Available on ports 8080 (HTTP) and 3003 (OpenAPI specification).
  • Python backend: Available on port 8000 (HTTP).
  • Frontend: Available on port 5173.

Binding Ports in Docker Compose

By default, Docker Compose binds exposed container ports to 0.0.0.0, making them accessible from any network interface on the host. To restrict access, specify a specific IP in the ports section, such as 127.0.0.1:8080:80, to limit exposure to the local machine. This can be done in docker-compose.yaml file

frontend:
    ports:
      - "127.0.0.1:5173:5173" # Frontend server port

Changing the Frontend Port

If port 5173 is already taken on your host (e.g. another Vite dev server or local app you can't move), set NGINX_PORT before bringing the stack up:

bash
# UI will be available at http://localhost:5293
NGINX_PORT=5293 ./opik.sh

NGINX_PORT is honored by the frontend container's port mapping, healthcheck, nginx config, and the backend's internal reverse-proxy URL. Use OPIK_PORT_OFFSET=N instead if you'd like to shift every Opik port (frontend, backend, MySQL, Redis, etc.) by the same delta.

Run Opik backend locally and the rest of the components with docker compose

  1. In nginx_default_local.conf replace:
bash
http://backend:8080

With your localhost.

For Mac/Windows (Docker Desktop):

bash
http://host.docker.internal:8080

For Linux:

bash
http://172.17.0.1:8080
  1. Run docker compose including exposing ports to localhost:
bash
# Optionally, you can force a pull of the latest images
docker compose --profile opik pull

docker compose -f docker-compose.yaml -f docker-compose.override.yaml --profile opik up -d

Stop the backend container, because you don't need it.

Opik with OpenTelemetry observability

You can run Opik with OpenTelemetry Collector and Jaeger to collect and visualize traces and logs.

Run with OpenTelemetry

bash
docker compose --profile opik-otel up -d

This will start:

  • Opik Stack (Frontend, Backend, etc.)
  • OpenTelemetry Collector (ports 4317, 4318, 5140/udp, etc.)
  • Jaeger (UI at http://localhost:16686)

Enable Nginx Tracing and Log Shipping

To enable Nginx OpenTelemetry tracing and ship access/error logs to the collector:

bash
# Enable OpenTelemetry Tracing in Nginx
export OTEL_TRACE=on

# Configure Nginx to ship logs to OpenTelemetry Collector via Syslog
export NGINX_EXTRA_ACCESS_LOG="access_log syslog:server=otel-collector:5140 logger-json;"
export NGINX_EXTRA_ERROR_LOG="error_log syslog:server=otel-collector:5140 error;"

# Run with the profile
docker compose --profile opik-otel up -d

When enabled:

  • Nginx Traces: Will be sent to the OTel Collector and visible in Jaeger.
  • Nginx Logs: Will be sent via syslog to the OTel Collector.

Stop Opik

bash
docker compose --profile opik down
# or if running with otel profile
docker compose --profile opik-otel down