Skip to content

docs(talm): document chart drift detection and strict mode#577

Open
Aleksei Sviridkin (lexfrei) wants to merge 2 commits into
mainfrom
docs/talm-chart-drift-detection
Open

docs(talm): document chart drift detection and strict mode#577
Aleksei Sviridkin (lexfrei) wants to merge 2 commits into
mainfrom
docs/talm-chart-drift-detection

Conversation

@lexfrei

@lexfrei Aleksei Sviridkin (lexfrei) commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Documents the chart drift detection that lands in talm with cozystack/talm#216: the library-content and preset-baseline drift warnings, the .talm-preset.lock file (including the advice to commit it), the exact re-sync semantics of talm init --update, and the strictCharts: true / --strict-charts escalation with its unverifiable-baseline behavior.

Targets docs/next/ only — the feature ships in the next talm release. Companion to cozystack/talm#216.

Summary by CodeRabbit

  • Documentation
    • Updated Kubernetes-on-Talos installation guide with details on preset-drift detection using the machine-managed .talm-preset.lock baseline (and advised committing it to git)
    • Extended talm init --update guidance to clarify how it re-syncs vendored charts/talm/ contents and advances the preset baseline
    • Added a “Chart Drift Detection (Talm v0.32+)” section covering preset/library drift WARN conditions and how to enforce hard failures via strictCharts: true or --strict-charts

@netlify

netlify Bot commented Jun 12, 2026

Copy link
Copy Markdown

Deploy Preview for cozystack failed.

Name Link
🔨 Latest commit ef36335
🔍 Latest deploy log https://app.netlify.com/projects/cozystack/deploys/6a3928bb82145500089a3509

@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 86416297-f3b2-435b-ac4e-56cdc0134d3e

📥 Commits

Reviewing files that changed from the base of the PR and between e92f97c and ef36335.

📒 Files selected for processing (1)
  • content/en/docs/next/install/kubernetes/talm.md
✅ Files skipped from review due to trivial changes (1)
  • content/en/docs/next/install/kubernetes/talm.md

📝 Walkthrough

Walkthrough

This PR updates the Kubernetes-on-Talos installation guide to document two talm features: the .talm-preset.lock baseline file generated after talm init, and Chart Drift Detection warnings introduced in Talm v0.32+ during chart updates and --update operations.

Changes

Talm Installation and Update Documentation

Layer / File(s) Summary
Preset baseline file documentation
content/en/docs/next/install/kubernetes/talm.md
Documents .talm-preset.lock as a newly generated file that records preset baseline hash and content for drift detection after talm upgrades, with instruction to commit it to git.
Update behavior and Chart Drift Detection documentation
content/en/docs/next/install/kubernetes/talm.md
Describes talm init --update behavior for re-syncing and pruning vendored charts/talm/ contents and advancing the preset baseline. Introduces "Chart Drift Detection (Talm v0.32+)" subsection documenting non-fatal WARN: conditions (library drift and preset drift), strict failure escalation via strictCharts: true or --strict-charts, and baseline verification failure handling.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • cozystack/website#537: Both PRs update talm documentation in the same talm.md file, overlapping in the talm init preset and chart update behavior area.

Suggested reviewers

  • kvaps
  • lllamnyp
  • myasnikovdaniil

🐰 A preset locked in place,
Drift detected with grace,
Charts stay in their space!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and concisely summarizes the main change: documenting chart drift detection and strict mode in talm, which matches the PR's primary objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/talm-chart-drift-detection

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the Talm documentation to include details about the .talm-preset.lock file and a new section on Chart Drift Detection (Talm v0.32+), which covers library drift, preset drift, and strict mode. The review comments suggest minor grammatical and readability enhancements to the new text, specifically adding the relative pronoun 'that' and inserting commas after introductory adverbial phrases.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

talm init --update --preset cozystack --force # non-interactive: auto-accept all diffs
```

`--update` re-syncs the vendored `charts/talm/` exactly — files the new library no longer ships (or strays like `.DS_Store`) are pruned — and advances the preset baseline in `.talm-preset.lock`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Adding the relative pronoun 'that' improves the grammatical flow and readability of this sentence.

Suggested change
`--update` re-syncs the vendored `charts/talm/` exactly — files the new library no longer ships (or strays like `.DS_Store`) are pruned — and advances the preset baseline in `.talm-preset.lock`.
`--update` re-syncs the vendored `charts/talm/` exactly — files that the new library no longer ships (or strays like `.DS_Store`) are pruned — and advances the preset baseline in `.talm-preset.lock`.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the relative pronoun — the sentence now reads "files that the new library no longer ships". Fixed in ef36335.

- **Library drift**: the vendored `charts/talm/` differs by content from the copy built into the binary. A pure version stamp difference stays silent; a real difference is reported with a sample of the differing paths (`modified:` / `extra:` / `missing:`).
- **Preset drift**: the binary ships a newer preset than the baseline pinned in `.talm-preset.lock` at init time. Your `templates/` edits are never reported as drift — the comparison is binary-vs-baseline, not binary-vs-project.

Both warnings point at the remediation above. To escalate the warning into a hard error (exit 1) — for example, in CI — set `strictCharts: true` in `Chart.yaml` so the whole team inherits it, or pass `--strict-charts` for a single run. Under strict mode a baseline that cannot be verified (a corrupted or deleted `.talm-preset.lock`, an unreadable `charts/talm/`) also blocks, so deleting the baseline is not a bypass; without strict mode such failures degrade to a warning, and projects created before baseline pinning stay silent.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Adding commas after introductory adverbial phrases ('Under strict mode' and 'without strict mode') improves readability and sentence structure.

Suggested change
Both warnings point at the remediation above. To escalate the warning into a hard error (exit 1) — for example, in CI — set `strictCharts: true` in `Chart.yaml` so the whole team inherits it, or pass `--strict-charts` for a single run. Under strict mode a baseline that cannot be verified (a corrupted or deleted `.talm-preset.lock`, an unreadable `charts/talm/`) also blocks, so deleting the baseline is not a bypass; without strict mode such failures degrade to a warning, and projects created before baseline pinning stay silent.
Both warnings point at the remediation above. To escalate the warning into a hard error (exit 1) — for example, in CI — set `strictCharts: true` in `Chart.yaml` so the whole team inherits it, or pass `--strict-charts` for a single run. Under strict mode, a baseline that cannot be verified (a corrupted or deleted `.talm-preset.lock`, an unreadable `charts/talm/`) also blocks, so deleting the baseline is not a bypass; without strict mode, such failures degrade to a warning, and projects created before baseline pinning stay silent.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the commas after the introductory phrases — now "Under strict mode, a baseline …" and "without strict mode, such failures …". Fixed in ef36335.

Cover the two drift signals a talm binary upgrade can surface (vendored
library content drift, preset baseline drift via .talm-preset.lock),
the exact re-sync semantics of init --update, and the strictCharts /
--strict-charts escalation including the unverifiable-baseline
behavior.

Assisted-By: Claude <noreply@anthropic.com>
Signed-off-by: Aleksei Sviridkin <f@lex.la>
Add the relative pronoun 'that' to the --update description and insert
commas after the 'Under strict mode' / 'without strict mode' introductory
phrases for clearer reading.

Signed-off-by: Aleksei Sviridkin <f@lex.la>
@lexfrei Aleksei Sviridkin (lexfrei) force-pushed the docs/talm-chart-drift-detection branch from e92f97c to ef36335 Compare June 22, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant