observability.svc.plus/roles/deepflow_server/README.md
2026-03-17 08:16:32 +08:00

38 lines
1.2 KiB
Markdown

# Role: deepflow_server
Deploy DeepFlow control plane (`deepflow-server` + `deepflow-app`) with Docker Compose managed by systemd.
This role is intentionally container-only. It does not provide a host binary install path for
`deepflow-server`.
This role expects backend dependencies from separate roles:
- `deepflow_mysql`
- `deepflow_clickhouse_s3`
Optional downstream integration:
- `deepflow_connector`
## Usage
1. Ensure Docker is installed (`./docker.yml`) and `docker_enabled: true`.
2. Run backend roles first, then this role (see `deepflow.yml`).
## Key Variables
- `deepflow_server_grpc_port` (default `20035`)
- `deepflow_server_http_port` (default `20417`)
- `deepflow_app_port` (default `20880`)
- `deepflow_clickhouse_addr` (default `host.docker.internal:19000`)
- `deepflow_s3_endpoint` (default `http://host.docker.internal:19090`)
- `deepflow_clickhouse_retention_hours` (default `24`)
- `deepflow_storage_mode` (default `short_ttl`)
## Lightweight Defaults
- `deepflow_deploy_profile: lite`
- `deepflow_storage_mode: short_ttl`
- retention is written to DeepFlow `server.yaml` in hours
- S3/MinIO is optional and can be disabled with `deepflow_s3_enabled: false`