Commit 95123d6
authored
docs(install/talos): document Talos / talosctl / Cozystack version pairing (#484)
## What
Adds a new *Version Compatibility* section to
`content/en/docs/v1/install/talos/boot-to-talos.md` spelling out which
Talos image the reader has to feed to `boot-to-talos` for a given
Cozystack release, how `talosctl` has to line up, and why the
`boot-to-talos` interactive 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-talos` v0.7.1 (the latest release) hard-codes its default
installer image to `ghcr.io/cozystack/cozystack/talos:v1.11.6` in
`cmd/boot-to-talos/main.go`.
- Cozystack v1.2.x pins Talos **v1.12.6** in
`packages/core/talos/images/talos/profiles/installer.yaml`, and Talm /
Helm templates target v1.12.
- `talosctl` is downloaded separately and defaults to whatever `latest`
is on siderolabs/talos (`v1.12.6` today).
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:
- Lists the three moving parts (Talos / talosctl / Cozystack) in a short
compatibility table.
- Names the concrete pair for Cozystack v1.2.x (Talos `v1.12.6` +
`talosctl` v1.12.x) and links to the profile file in
`cozystack/cozystack` so a reader on a different release can look up the
same for themselves.
- Adds a warning callout that explains the boot-to-talos default is
unrelated to the Cozystack release and links directly to the `main.go`
line where the default lives.
## Verification
- Pinned Talos version confirmed against
`packages/core/talos/images/talos/profiles/installer.yaml` in
`cozystack/cozystack` at tag `release-1.2.1` (`version: v1.12.6`,
`baseInstaller.imageRef: ghcr.io/siderolabs/installer:v1.12.6`).
- `boot-to-talos` default verified via `gh search code --repo
cozystack/boot-to-talos "v1.11"`, which points at
`cmd/boot-to-talos/main.go` defaulting to
`ghcr.io/cozystack/cozystack/talos:v1.11.6`.
- `ghcr.io/cozystack/cozystack/talos:v1.12.6` existence verified via the
GHCR package API.
- `hugo` builds cleanly; the new section and refreshed example render
correctly.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Updated boot-to-talos documentation with version compatibility
guidance for Cozystack v1.2.x (Talos v1.12.6).
* Added warning about potential version mismatches when using default
Talos installer images.
* Updated example logs and defaults to reflect current versions.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->1 file changed
Lines changed: 30 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
17 | 42 | | |
18 | 43 | | |
19 | 44 | | |
| |||
53 | 78 | | |
54 | 79 | | |
55 | 80 | | |
56 | | - | |
| 81 | + | |
57 | 82 | | |
58 | 83 | | |
59 | 84 | | |
| |||
62 | 87 | | |
63 | 88 | | |
64 | 89 | | |
65 | | - | |
| 90 | + | |
66 | 91 | | |
67 | 92 | | |
68 | 93 | | |
| |||
71 | 96 | | |
72 | 97 | | |
73 | 98 | | |
74 | | - | |
| 99 | + | |
75 | 100 | | |
76 | 101 | | |
77 | 102 | | |
78 | 103 | | |
79 | | - | |
| 104 | + | |
80 | 105 | | |
81 | 106 | | |
82 | 107 | | |
| |||
91 | 116 | | |
92 | 117 | | |
93 | 118 | | |
94 | | - | |
| 119 | + | |
95 | 120 | | |
96 | 121 | | |
97 | 122 | | |
| |||
0 commit comments