# Conflicts: # api/v1alpha1/casting.go # api/v1alpha1/installation/signoz.go # docs/casting.md # docs/examples/docker/compose/pours/deployment/configs/ingester/opamp.yaml # docs/examples/systemd/binary/pours/deployment/signoz-ingester.service # docs/examples/systemd/binary/pours/deployment/signoz-signoz.service # docs/examples/systemd/binary/pours/deployment/signoz-telemetrystore-migrator.service # docs/schemas/v1alpha1.yaml # internal/foundry/registry.go # internal/instrumentation/handler.go # internal/molding/signozmolding/signoz.go
Docker Compose
| Field | Value |
|---|---|
| Mode | docker |
| Flavor | compose |
| Platform | - |
Overview
Deploys SigNoz using Docker Compose with all Foundry defaults. This is the simplest way to run SigNoz locally or on a single node.
Prerequisites
- Docker Engine 20.10+
- Docker Compose v2
Configuration
apiVersion: v1alpha1
metadata:
name: signoz
spec:
deployment:
flavor: compose
mode: docker
Deploy
foundryctl cast -f casting.yaml
Or step by step:
# Validate prerequisites
foundryctl gauge -f casting.yaml
# Generate compose files
foundryctl forge -f casting.yaml
# Start the stack
cd pours/deployment && docker compose up -d
Generated output
pours/deployment/
compose.yaml
configs/
ingester/
ingester.yaml
opamp.yaml
telemetrykeeper/
clickhousekeeper/
keeper-0.yaml
telemetrystore/
clickhouse/
config.yaml
functions.yaml
After deployment
# Check running containers
docker ps
# View logs for a specific service
docker compose -f pours/deployment/compose.yaml logs -f signoz
# Stop the stack
cd pours/deployment && docker compose down
Note
foundryctl castdetects whetherdocker compose(v2 plugin) ordocker-compose(legacy standalone) is available and uses whichever it finds, preferring the v2 plugin.
Customization
Override component images, replicas, or environment variables in the casting spec. For platform-level changes to the generated compose.yaml (memory limits, networks, volumes), use patches.