mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-11-21 11:36:05 +00:00
a156f5be32
The trimming if swallowed the blank line, so the HTTPRoute note ran straight on from the Persistence section. Move the blank line inside the conditional so it only appears with the section.
43 lines
2.8 KiB
Plaintext
43 lines
2.8 KiB
Plaintext
1. ENCRYPTION_KEY handling:
|
|
- ENCRYPTION_KEY encrypts stored secrets (API keys, MFA, SMTP, OIDC) at rest.
|
|
- By default, the chart creates a Kubernetes Secret from `secretEnv.ENCRYPTION_KEY` in values.yaml.
|
|
- To generate a random key at install (preserved across upgrades), set `generateEncryptionKey: true`.
|
|
- To use an existing Kubernetes secret, set `existingSecret` to the secret name. The chart then
|
|
renders no Secret of its own and reads every secret env var from that secret: `ENCRYPTION_KEY`
|
|
(renamable via `existingSecretKey`), plus `ADMIN_EMAIL`, `ADMIN_PASSWORD`, `OIDC_CLIENT_SECRET`,
|
|
`UNSPLASH_ACCESS_KEY`, `PLACES_API_KEY`, `AMAP_API_KEY`, `AMAP_API_SECRET`,
|
|
`VAPID_PRIVATE_KEY`, `SMTP_PASS`, `MAPBOX_ACCESS_TOKEN`, `CARTO_API_KEY` and
|
|
`DEMO_ADMIN_PASS`. Missing keys are simply left unset, so only provide the ones you use.
|
|
- If left empty, the server resolves the key automatically: existing installs fall back to
|
|
data/.jwt_secret (encrypted data stays readable with no manual action); fresh installs
|
|
auto-generate a key persisted to the data PVC.
|
|
|
|
2. JWT_SECRET is managed entirely by the server:
|
|
- Auto-generated on first start and persisted to the data PVC (data/.jwt_secret).
|
|
- Rotate it via the admin panel (Settings → Danger Zone → Rotate JWT Secret).
|
|
- No Helm configuration needed or supported.
|
|
|
|
3. Example usage:
|
|
- Set an explicit encryption key: `--set secretEnv.ENCRYPTION_KEY=your_enc_key`
|
|
- Generate a random key at install: `--set generateEncryptionKey=true`
|
|
- Use an existing secret: `--set existingSecret=my-k8s-secret`
|
|
- Use a custom key name in the existing secret: `--set existingSecret=my-k8s-secret --set existingSecretKey=MY_ENC_KEY`
|
|
|
|
4. Only one method should be used at a time. If both `generateEncryptionKey` and `existingSecret` are
|
|
set, `existingSecret` takes precedence. Ensure the referenced secret and key exist in the namespace.
|
|
|
|
5. Persistence:
|
|
- To bind your own PVCs, set `persistence.data.existingClaim` and/or `persistence.uploads.existingClaim`.
|
|
The other values for that volume (size, storageClassName, annotations) are then ignored.
|
|
- With `persistence.enabled=false` the volumes use an emptyDir — storage is ephemeral and is lost
|
|
when the pod restarts. Use only for testing.
|
|
{{- if .Values.httpRoute.enabled }}
|
|
|
|
6. HTTPRoute:
|
|
- The chart creates an HTTPRoute v1 to the existing TREK Service. The Gateway, GatewayClass,
|
|
listeners, TLS certificates and allowedRoutes are managed by your cluster operator.
|
|
- Ingress and HTTPRoute may be enabled together.
|
|
- Timeout fields are Standard Channel in Gateway API v1.2, but controller support varies. Omit
|
|
them to use controller defaults; `0s` disables the corresponding timeout where supported.
|
|
{{- end }}
|