omni/deploy/compose/README.md
Utku Ozdemir 1e24fd222d
feat: implement helm chart v2
**Helm Chart v2:**
- Add new Helm chart with comprehensive configuration via values.yaml
- Support for both Kubernetes Ingress and Gateway API
- Built-in validation for required fields and URL consistency
- Prometheus metrics and ServiceMonitor support
- Detailed documentation with examples for Traefik
- Workload proxy setup guide

**Deploy directory reorganization:**
- Move Docker Compose files to `deploy/compose/`
- Move existing Helm chart to `deploy/helm/omni/`
- Add top-level `deploy/README.md` pointing to deployment options
- Add deprecation warning to v1 Helm chart

**Documentation:**
- Add link to Helm chart in root README

Co-authored-by: Kevin Tijssen <kevin.tijssen@siderolabs.com>
Signed-off-by: Utku Ozdemir <utku.ozdemir@siderolabs.com>
2026-01-30 14:09:27 +01:00

722 B

Omni On-Prem Compose File

Follow the full documentation in the Omni docs.

The template requires the following environment variables to be set (change these for your environment):

OMNI_VERSION=v1.4.7
OMNI_ACCOUNT_UUID=$(uuidgen)
OMNI_DOMAIN_NAME=omni.siderolabs.com
OMNI_WG_IP=10.10.1.100
OMNI_ADMIN_EMAIL=omni@siderolabs.com
AUTH0_CLIENT_ID=xxxyyyzzz
AUTH0_DOMAIN=dev-aaabbbccc.us.auth0.com

You may also want to update certificate paths, etcd storage, and other settings.

  • Copy env.template and edit all fields necessary
  • Run docker compose, supplying the environment file edited above: docker compose --env-file <path-to-env> up -d