Skip to content

docs: document the minimum Talos version that can connect to Omni #927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oguzkilcan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document the minimum Talos version that can connect to Omni #927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion public/omni/getting-started/support-matrix.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,18 @@

Note that each version of Talos Linux generally supports up to five prior versions of Kubernetes at the time it was released. See the <a href={`../../talos/${version}/getting-started/support-matrix`}>Talos Support Matrix</a> for details.

## Minimum Talos Linux version to connect to Omni

Check notice on line 22 in public/omni/getting-started/support-matrix.mdx

View workflow job for this annotation

GitHub Actions / doc-accuracy

Doc accuracy — NOTICE 

Two adjacent minimum-Talos-version headings give conflicting numbers (1.10 and 1.6)
Why: The new connectivity floor of 1.6 sits directly under the support floor of 1.10, so a skimming reader may conclude 1.6 is a supported version. The distinction is correct but not signalled on this page.
Fix: Rename to "Minimum Talos Linux version that can connect to Omni" and note that this is the compatibility floor, not the support floor.

Talos Linux 1.6, starting with the first Omni minor release of 2027 (estimated January 2027)

Talos Linux versions below it will be incompatible with Omni, and machines running them will not be able to connect. See the [Talos Version Support Policy](./talos-version-support-policy#incompatible-talos-versions).

## Effect of non-supported Talos Linux versions

If you neglect to update Talos Linux to a version where the initial minor version was released within the prior 18 months, your cluster will be out of support, and you must upgrade in order to receive support.

Clusters running unsupported versions of Talos Linux or Kubernetes may have limited ability to manage their clusters within Omni - clusters may not be able to have new nodes provisioned to scale up the cluster, for example.

Omni provides status notifications for machines running Talos versions approaching end-of-support. To ensure platform stability, Omni will transition to a minimum supported version model in a future release. Please refer to the [Talos Version Support Policy](./talos-version-support-policy) for details on support timelines and notification windows.
Omni provides status notifications for machines running Talos versions approaching end-of-support. Please refer to the [Talos Version Support Policy](./talos-version-support-policy) for details on support timelines and notification windows.

We encourage all users to take advantage of how easy Omni makes Talos Linux and Kubernetes upgrades, to ensure they are always running the latest security and bug fixes.
33 changes: 29 additions & 4 deletions public/omni/getting-started/talos-version-support-policy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,40 @@
---

Omni requires machines to run a supported version of Talos Linux.
Versions that fall below the minimum supported version are considered **unsupported** and must be upgraded.
Versions below the minimum supported version are considered **unsupported** and must be upgraded.

For the current minimum supported Talos Linux version and the general support window, see the [Support Matrix](./support-matrix).

## Talos Version Compatibility
## Unsupported Talos versions

Starting with **Omni v1.11.0** (estimated **October 2026**), Omni requires all registered machines to meet the minimum supported Talos Linux version. To ensure system stability and feature compatibility, Omni will not start if any registered machines are running versions below this baseline.
Machines running unsupported versions stay connected to Omni, but Omni does not guarantee that it can manage them.
Omni shows warning notifications for machines running unsupported or soon-to-be-unsupported versions.

Until then, Omni will display warning notifications for machines running unsupported or soon-to-be-unsupported versions.
## Incompatible Talos versions

Starting with the first Omni minor release of 2027 (estimated January 2027), Talos Linux versions below 1.6 will be **incompatible** with Omni:

- Omni will reject their SideroLink connection requests.
- Omni will disconnect them if they are already connected.

Until then, Omni shows a notification for these machines that cannot be dismissed.

### Disconnecting incompatible machines earlier

Omni does not disconnect any machines by default yet.

Check warning on line 27 in public/omni/getting-started/talos-version-support-policy.mdx

View workflow job for this annotation

GitHub Actions / doc-accuracy

Doc accuracy — WARNING 

Does not warn that disconnected machines can no longer be upgraded through Omni
Why: Once SideroLink is refused, a machine is unmanageable from Omni, including the Talos upgrade the next section tells readers to run through Omni; recovery needs direct talosctl access to each machine.
Fix: Add before the snippet: upgrade any machines running Talos below 1.6 before setting this flag, since a disconnected machine can only be upgraded with direct talosctl access.
To disconnect the machines below 1.6 now, set the `--siderolink-disconnect-talos-below` flag:

Check warning on line 28 in public/omni/getting-started/talos-version-support-policy.mdx

View workflow job for this annotation

GitHub Actions / doc-accuracy

Doc accuracy — WARNING 

Missing warning that setting --siderolink-disconnect-talos-below can make a future Omni release refuse to start
Why: Omni's schema.json documents that when a future release raises the Talos version floor, Omni refuses to start if any machine runs a version between the configured value and the new floor. The page omits this, and it also deletes the previous revision's warning that Omni will not start below the baseline.
Fix: Add: this setting is a standing confirmation - when a future Omni release raises the Talos version floor, Omni will refuse to start if any machine runs a version between this value and the new floor.

```bash
--siderolink-disconnect-talos-below=1.6.0

Check notice on line 31 in public/omni/getting-started/talos-version-support-policy.mdx

View workflow job for this annotation

GitHub Actions / doc-accuracy

Doc accuracy — NOTICE 

bash code block contains a bare flag fragment that is not runnable
Why: The fence is tagged bash but holds only --siderolink-disconnect-talos-below=1.6.0, which fails if pasted into a shell, and the page does not say where the flag belongs (Omni server arguments).
Fix: omni --siderolink-disconnect-talos-below=1.6.0
```

or in the configuration file:

```yaml
services:
siderolink:
disconnectTalosBelow: 1.6.0
```

## How to upgrade

Expand Down
Loading