Repository navigation
Expand file tree
/
Copy pathdeployment.example.yaml
More file actions
119 lines (110 loc) · 5.93 KB
/
Copy pathdeployment.example.yaml
File metadata and controls
119 lines (110 loc) · 5.93 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
## Project: dfe-docker
## File: deployment.example.yaml
## Purpose: The deployment dial (docker-vm slice) -- copy to deployment.yaml
## Language: YAML
##
## License: BUSL-1.1
## Copyright: (c) 2026 HYPERI PTY LIMITED
## THE DEPLOYMENT DIAL -- one config file the whole deployment reads. `make dial`
## renders the docker-vm keys below into .env, so a redeploy is a dial edit and
## then `make dial && make stack && make ci`. A QA GUI wizard will
## populate this same file later, so every field is a labelled dial with a
## default and its allowed values.
##
## This is the docker-vm SLICE. The canonical superset (docker-vm + k8s + cloud)
## and its schema live in dfe-infra. A lone dfe-docker clone deploys from this
## file alone -- no dfe-infra checkout needed.
##
## Copy to deployment.yaml (gitignored) and populate. Never commit real values:
## secrets are REFERENCES into the deployment's secrets backend, never literals;
## estate endpoints stay blank here and are injected by the operator's own
## tooling at deploy time.
## Which platform this deployment targets. This renderer requires docker-vm.
## (docker-vm | k8s -- a k8s deployment renders via dfe-infra into a DeployContext.)
platform: docker-vm
## Image registry hosting the published dfe-* images, pulled anonymously.
registry: ghcr.io/hyperi-io
## Version dial: pin XOR track. Pinned is the default and the safe production
## choice; track-latest is the opt-in daemon (ops/daemon-update) that advances to
## the newest certified stack tag.
version:
## Pinned release -- written to DFE_STACK_VERSION, which `make stack` pins the
## whole certified set from. An explicit `make stack VERSION=...` still wins.
pin: 2.2.2
## Track-latest instead: comment out `pin` above and use these. The daemon owns
## the roll; leave DFE_STACK_VERSION unset.
# track: latest
# allow_prerelease: "false"
## Secret backend + base path. REFERENCES only, never values. The operator's own
## tooling resolves these from the backend and injects the secrets a deployment
## sets (DFE_OIDC_CLIENT_SECRET below) into .env; without such tooling, set them by
## hand. `make dial` never reads or writes a secret.
secrets:
backend: openbao # openbao | aws-sm | file
## Base path the secrets live under. Which path is estate context.
ref: ""
## Service profile. Left commented, service_profiles.yaml's active_profile is used. One of slim-grpc, slim-kafka, single-grpc or single-kafka, each `<tier>-<transport>`: single adds the per-source apps to slim, plus the archiver on Kafka. There is no `scale`: Compose runs neither an HA broker nor a ClickHouse cluster. Each profile carries its own core/kafbat/hyperdx/otel footprint. The flags below OVERRIDE it.
# profile: single-kafka
## docker-vm knobs. Each maps to one .env key; a blank/absent field leaves the
## .env default in place.
docker:
kafka_backend: redpanda # apache | redpanda
kafbat_enabled: "true"
core_enabled: "true"
hyperdx_enabled: "true"
## Self-monitoring. otel_enabled starts the bundled collector; setting
## otel_exporter_endpoint instead pushes to an OTLP backend of your own.
## Blank endpoint exports nothing.
otel_enabled: "true"
otel_exporter_endpoint: ""
post_enabled: "true"
## Host exposure. bind_host is the OPERATOR surface (127.0.0.1 on a laptop,
## 0.0.0.0 only on a box you mean to expose); ingress_bind_host is the USER
## ingest surface.
bind_host: 127.0.0.1
ingress_bind_host: 0.0.0.0
## Web UI exposure. bind_scope is where every UI publishes: localhost for a
## developer workstation (the host sees them, the LAN does not), all for a
## small/VM deploy. It moves the UI ports only -- ingest and the backing
## services keep the two surfaces above.
## (localhost | all)
bind_scope: localhost
## infra_uis_external is the kill switch over every INFRA-class UI (Kafbat,
## HyperDX): false unpublishes them together and beats their own flags. The
## PRODUCT UIs below are exempt and answer only to themselves.
infra_uis_external: "true"
ui_external: "true"
engine_api_external: "true"
kafbat_ui_external: "true"
hyperdx_ui_external: "true"
## The scheme and host a BROWSER reaches this box on, no port and no trailing
## slash -- every service appends its own. The UI's post-logout redirect, the
## oauth2-proxy callbacks and HyperDX's link-backs all build on it, and empty
## means they all assume localhost. Set it to a real hostname on anything but
## a workstation.
external_origin: ""
## Console TLS: "true" serves the console and HyperDX over https with the certificate in certs/, which OIDC sign-in needs on any hostname but localhost. It needs an https external_origin and auth_enabled "false"; docs/configuration.md has the certificate command.
## (true | false)
proxy_tls: "false"
## Infra UI authentication. auth_enabled puts an oauth2-proxy in front of each
## infra UI, gating on OIDC sign-in AND group membership. It needs an issuer,
## so it stays off until a deployment has one. The client SECRET is not a dial
## field -- the operator's own tooling injects DFE_OIDC_CLIENT_SECRET into .env
## from the secrets backend.
auth_enabled: "false"
oidc_issuer_url: ""
oidc_client_id: ""
oidc_allowed_groups: dfe-infra,dfe-admin
## Per-surface override of external_origin, which it follows when left empty.
oauth2_proxy_external_origin: ""
## External endpoints -- BLANK here. Point a local engine at a remote ClickHouse
## for integration tests by setting clickhouse_host in deployment.yaml (or let the
## operator's tooling inject it). Left empty, the in-stack container is used.
endpoints:
clickhouse_host: ""
## RETENTION -- the deployment-wide TTL for every time-series table DFE deploys,
## the OTel tables included. Whole days; 0 disables the default TTL. A source, or
## a dfe-schemas definition, that declares its own TTL overrides it. Same field as
## the dfe-infra dial. It renders to DFE_ENGINE_CLICKHOUSE_DEFAULT_TTL_DAYS in env/engine.env.
retention:
default_ttl_days: 90