docs(install/talos): document Talos / talosctl / Cozystack version pairing#484
docs(install/talos): document Talos / talosctl / Cozystack version pairing#484
Conversation
…iring New users repeatedly hit a version mismatch when installing Cozystack via boot-to-talos in the Russian community chat: boot-to-talos v0.7.1 ships with a hardcoded default image of ghcr.io/cozystack/cozystack/talos:v1.11.6, while Cozystack v1.2.x actually pins Talos v1.12.6 in packages/core/talos/images/talos/ profiles/installer.yaml. If the user accepts the interactive default they get a Talos v1.11 node underneath a Cozystack installer that expects Talos v1.12, and the bootstrap fails in obscure ways. Add a Version Compatibility section to the boot-to-talos install guide that spells out: - the three things that need to line up (Talos image, talosctl, Cozystack release), - the specific pinned Talos version for Cozystack v1.2.x (v1.12.6), with a link to the profile file upstream, - a warning callout that boot-to-talos keeps its own default image separate from whatever Cozystack release the reader is installing, with a link to the exact line in cmd/boot-to-talos/main.go. Also refresh the interactive session example further down the page so it shows v1.12.6 instead of the stale v1.10.5, matching the rest of the v1 docs. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 7 minutes and 35 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation update to the boot-to-talos installation guide for Cozystack, adding a "Version Compatibility" section that clarifies required alignment between Talos versions, updating examples from v1.10.5 to v1.12.6, and adding a warning about Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for boot-to-talos to reflect compatibility with Cozystack v1.2.x and Talos v1.12.6, adding a version compatibility guide and a warning about default image mismatches. A review comment identifies an inconsistency in the example output where the displayed default version contradicts the warning text, suggesting a correction to show the explicit version override.
| Mode [1]: 2 | ||
| Target disk [/dev/sda]: | ||
| Talos installer image [ghcr.io/cozystack/cozystack/talos:v1.10.5]: | ||
| Talos installer image [ghcr.io/cozystack/cozystack/talos:v1.12.6]: |
There was a problem hiding this comment.
The example shows v1.12.6 as the default value in brackets, which implies the user can simply press Enter to accept it. However, the warning added in lines 31-40 explicitly states that boot-to-talos (v0.7.x) defaults to v1.11.6. To be consistent with the warning and accurately reflect the tool's behavior, the example should show the actual default and the user explicitly typing the desired version.
| Talos installer image [ghcr.io/cozystack/cozystack/talos:v1.12.6]: | |
| Talos installer image [ghcr.io/cozystack/cozystack/talos:v1.11.6]: ghcr.io/cozystack/cozystack/talos:v1.12.6 |
There was a problem hiding this comment.
Applied — updated the example so it reads Talos installer image [ghcr.io/cozystack/cozystack/talos:v1.11.6]: ghcr.io/cozystack/cozystack/talos:v1.12.6. Now the bracketed default shows the real boot-to-talos v0.7.x hardcoded image and the line after the colon shows the explicit override the reader has to type for a Cozystack v1.2.x cluster, matching the Version Compatibility warning immediately above the block.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@content/en/docs/v1/install/talos/boot-to-talos.md`:
- Line 81: The doc shows Talos installer image string
"ghcr.io/cozystack/cozystack/talos:v1.12.6" while the warning block references
"boot-to-talos v0.7.1 default is v1.11.6", causing a mismatch; update the page
so the interactive/default Talos version and the boot-to-talos warning are
consistent by either changing the installer image tag to v1.11.6 to match the
warning or updating the warning to reference v1.12.6, and add a short note
showing how to explicitly override the default (e.g., provide the exact flag or
variable name users must set) so readers see the real default and how to specify
their own version.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 375ce004-edc7-4f4c-8be7-e59b16b9bd68
📒 Files selected for processing (1)
content/en/docs/v1/install/talos/boot-to-talos.md
…ult and explicit v1.12.6 override Review comments on #484 from gemini-code-assist and coderabbitai flagged the same mismatch: the interactive session example showed v1.12.6 inside the prompt brackets (implying that is what pressing Enter would give you), but the warning block above it says the real boot-to-talos v0.7.x default is v1.11.6. Those two statements contradicted each other. Fix: show the actual default the tool prints in brackets (v1.11.6) followed by the explicit user override (v1.12.6) on the same line. This is what a reader would actually see and type, and it reinforces the version-compatibility warning instead of contradicting it. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
2 participants
What
Adds a new Version Compatibility section to
content/en/docs/v1/install/talos/boot-to-talos.mdspelling out which Talos image the reader has to feed toboot-to-talosfor a given Cozystack release, howtalosctlhas to line up, and why theboot-to-talosinteractive default is not the right answer on its own. Also refreshes the console-session example on the same page (v1.10.5→v1.12.6) so it matches the pinned Talos version the rest of the v1 docs and the Cozystack v1.2.x release profile use.Why
Fresh-install users in the community chat keep hitting the same version mismatch:
boot-to-talosv0.7.1 (the latest release) hard-codes its default installer image toghcr.io/cozystack/cozystack/talos:v1.11.6incmd/boot-to-talos/main.go.packages/core/talos/images/talos/profiles/installer.yaml, and Talm / Helm templates target v1.12.talosctlis downloaded separately and defaults to whateverlatestis on siderolabs/talos (v1.12.6today).If the reader follows the boot-to-talos prompts and accepts the suggested default, they get a Talos v1.11 node under a Cozystack installer that expects v1.12, and the bootstrap fails in obscure ways (schedule errors, Talm template failures, nested-CRD mismatches). The fix is trivial — type in the right image — but it is not documented anywhere the reader would find it before running the command.
The new section:
v1.12.6+talosctlv1.12.x) and links to the profile file incozystack/cozystackso a reader on a different release can look up the same for themselves.main.goline where the default lives.Verification
packages/core/talos/images/talos/profiles/installer.yamlincozystack/cozystackat tagrelease-1.2.1(version: v1.12.6,baseInstaller.imageRef: ghcr.io/siderolabs/installer:v1.12.6).boot-to-talosdefault verified viagh search code --repo cozystack/boot-to-talos "v1.11", which points atcmd/boot-to-talos/main.godefaulting toghcr.io/cozystack/cozystack/talos:v1.11.6.ghcr.io/cozystack/cozystack/talos:v1.12.6existence verified via the GHCR package API.hugobuilds cleanly; the new section and refreshed example render correctly.Summary by CodeRabbit