You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a1a1933
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/how-it-works/gateways/configuration.mdx
+2-49Lines changed: 2 additions & 49 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,55 +16,8 @@ The OpenShell gateway reads its configuration from a TOML file when `--config` o
16
16
Gateway CLI flag > gateway OPENSHELL_* env var > TOML file > built-in default
17
17
```
18
18
19
-
## Helm Configuration Boundary
20
-
21
-
The Kubernetes Helm chart exposes `gatewayConfig` as the non-secret gateway
22
-
application-configuration boundary. Each top-level map key names a TOML table,
23
-
and the chart serializes its fields into the mounted `gateway.toml` ConfigMap.
24
-
New non-secret gateway options therefore do not require a chart-template
25
-
change.
26
-
27
-
Secret material never belongs in `gatewayConfig` or the ConfigMap. Database
28
-
URLs, credentials, private keys, and equivalent values use Kubernetes Secrets
29
-
through the chart's supported environment-variable, file, or volume wiring.
30
-
The normal precedence above still applies to the resulting mounted TOML file.
31
-
32
-
During Helm values migration, explicit `gatewayConfig` tables take precedence
33
-
over deprecated aliases. This includes the resource-admission table and the
34
-
Kubernetes Secrets credential namespace, even when a legacy alias still enables
35
-
the credential driver. The global Helm image pull policy applies to runtime
36
-
and supervisor images. Leave the workload's `image_pull_policy` and deprecated
37
-
`sandbox.image.pullPolicy` unset to use Kubernetes defaults for the workload image.
38
-
39
-
The chart rejects the gateway's `database_url` file field and unambiguous
40
-
inline credential or PEM private-key strings before rendering a ConfigMap. It
41
-
validates Secret references as Kubernetes Secret names, but never reads or
42
-
copies referenced Secret data into `gateway.toml`.
43
-
44
-
The serializer has a deterministic YAML-to-TOML contract. YAML `null` fields
45
-
are omitted; `null` array members are rejected because TOML has no equivalent.
46
-
Strings and booleans retain their TOML types, and numeric values remain TOML
47
-
numbers. Helm normalizes YAML numbers before templates run, so it cannot retain
48
-
the lexical distinction between an integral float such as `1.0` and an integer
49
-
such as `1`; both render as the compact TOML value `1`. Scalar arrays become
50
-
TOML arrays, maps become inline tables, and arrays of maps inside a table become
51
-
arrays of inline tables. A top-level `gatewayConfig` list instead renders an
52
-
ordered TOML array of tables: each list item must be a map and emits one
53
-
`[[table]]` block. Keys are ordered alphabetically within each table, while
54
-
array-of-tables item order follows the YAML list, so equivalent input produces
55
-
the same ConfigMap checksum. String values are serialized literally; Helm
56
-
template expressions inside them are not evaluated.
57
-
58
-
The implementation intentionally uses only long-standing Helm 3 template and
59
-
Sprig functions (`kindIs`, `keys`, `sortAlpha`, `splitList`, `quote`, and
60
-
`toJson`); it does not rely on a Helm-specific TOML encoder. This preserves the
61
-
chart's documented Helm 3 compatibility while making the serialization rules
62
-
explicit in the chart itself.
63
-
64
-
Helm retains ownership of Services, workloads, probes, Secrets, certificate
65
-
resources, Routes, RBAC, NetworkPolicies, and mounts. When one of those inputs
66
-
also determines a gateway runtime value, the chart derives it from its resource
67
-
owner instead of exposing two independent settings.
19
+
For Helm deployments, see [Configure Chart Values](/kubernetes/setup#configure-chart-values)
20
+
for setting `gatewayConfig` and chart-owned Kubernetes resources.
68
21
69
22
`database_url` is env-only. The loader rejects it when it appears in the file. When `OPENSHELL_DB_URL` is unset, the gateway stores its SQLite database under `$XDG_STATE_HOME/openshell/gateway/openshell.db`.
0 commit comments