siderolabs / siderolabs/docs

TEL migration guide: recommend a throwaway kernel argument for clusters already on the newest version

Open Beginner friendly
#769 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation omni
Dominant language
MDX
Stars
11
Forks
76
Avg merge
3d 5h
Merged PRs (30d)
26

Description

Fast follow to docs#757, which is being merged as part of the Talos Enterprise Linux launch section. Part of #649.

The migration how-to already says that any schematic change moves a cluster to enterprise images on the next upgrade, and it lists the options: bumping the Talos version, adding or removing a system extension, or changing kernel arguments. That is correct and does not need fixing.

What it does not do is tell the reader which of those to pick. Someone already running the newest Talos version has no version to bump to, and the obvious remaining move (add an extension, upgrade, remove the extension, upgrade again) is two upgrades and leaves them wondering whether the extension was supposed to stay.

What to add

A sentence recommending a throwaway kernel argument as the cleanest trigger for a cluster already on the current version, and saying it can be left in place afterwards rather than needing a second upgrade to remove.

Where this came from

Raised in #proj-omni on September 15. The first answer given was to add and then remove the hello-world extension; the better answer, from Utku, was to add a dummy kernel argument instead, precisely because it does not have to be taken back out.

This is the question the first internal person hit on launch day within minutes of the cutover, which is a reasonable signal that customers will hit it too.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the migration how-to described in the issue and find the section listing schematic-change options. Add the recommendation for a throwaway kernel argument for clusters already on the newest version, including that it can remain afterward. Confirm the rendered guide clearly explains this single-upgrade path.

Written by the indexing model from the issue text.

Assessment

Tech stack
linux
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.