Skip to content

Commit edff884

Browse files
committed
[docs] talm: address review feedback on encrypted-values section
- block-style YAML for the templateOptions.valueFiles example - American English spelling (Behavior, honors) - comma after "By default" for readability Signed-off-by: Aleksei Sviridkin <f@lex.la>
1 parent 97ad134 commit edff884

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

  • content/en/docs/next/install/kubernetes

content/en/docs/next/install/kubernetes/talm.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,9 @@ registryPassword: "s3cr3t-high-entropy-value"
273273
**Step 3 — reference the encrypted file** from `Chart.yaml` by adding it to `templateOptions.valueFiles`, so both `talm template` and `talm apply` read it:
274274

275275
```yaml
276-
templateOptions: { valueFiles: ["values-secret.encrypted.yaml"] }
276+
templateOptions:
277+
valueFiles:
278+
- values-secret.encrypted.yaml
277279
```
278280

279281
Referencing it only via the CLI `--values` flag is a foot-gun: the modeline in a node file does not persist value files, so a later `talm apply` would re-render WITHOUT the secret and silently drop the field. Talm surfaces a warning when an encrypted file is passed via `--values` but is not in `templateOptions.valueFiles`.
@@ -282,15 +284,15 @@ Referencing it only via the CLI `--values` flag is a foot-gun: the modeline in a
282284

283285
How secrets are handled across commands:
284286

285-
| Command | Behaviour |
287+
| Command | Behavior |
286288
| --- | --- |
287289
| `talm template` (stdout) | secret values render as `***`; `--show-secrets` prints them verbatim. |
288290
| `talm template -i` (node file) | secret values are omitted entirely from the committed node file — the real value is re-rendered in memory only at apply, so no plaintext (or ciphertext) ever lands in `nodes/*.yaml`. |
289291
| `talm apply --dry-run` | both diffs redact secrets: talm's structured drift preview AND the server-returned `Config diff:` block. `--show-secrets-in-drift` reveals them. |
290292
291-
The `--show-secrets-in-drift` flag governs every secret-bearing surface of the apply dry-run, covering both these user values and the Talos bootstrap material (`cluster.ca.key`, `machine.token`, encryption secrets, Wireguard keys, etc.). By default a dry-run never prints a CA private key or a user secret in cleartext.
293+
The `--show-secrets-in-drift` flag governs every secret-bearing surface of the apply dry-run, covering both these user values and the Talos bootstrap material (`cluster.ca.key`, `machine.token`, encryption secrets, Wireguard keys, etc.). By default, a dry-run never prints a CA private key or a user secret in cleartext.
292294
293-
`talm apply` honours the full set of value sources, matching `talm template`: `--values`, `--set`, `--set-string`, `--set-file`, `--set-json`, `--set-literal`, merged on top of the `templateOptions.*` defaults from `Chart.yaml`. This keeps `template` and `apply` rendering identically.
295+
`talm apply` honors the full set of value sources, matching `talm template`: `--values`, `--set`, `--set-string`, `--set-file`, `--set-json`, `--set-literal`, merged on top of the `templateOptions.*` defaults from `Chart.yaml`. This keeps `template` and `apply` rendering identically.
294296
295297
**Sharp edge — value-based matching.** Redaction matches by exact value across the whole rendered config, so a secret whose plaintext coincides with an ordinary structural string (a password literally set to `controlplane`, or a bare port like `6443`) will also redact that unrelated field. Prefer high-entropy values; do not encrypt low-entropy strings that collide with non-secret config.
296298

0 commit comments

Comments
 (0)