Talos 1.14.0 upgrade docs are missing explicit cni: none migration instructions
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- documentation
Research direction
Start with the Talos 1.14.0 migration document, the flannel configuration document, the current Cilium and other CNI documentation, and the document map. Document how to configure cni: none, clarify that flannel remains the default and its document is generated by default, and add the appropriate alternative to the document map.
Written by the indexing model from the issue text.
Description
Current migration docs mention that network configuration is replaced by the node config and flannel configuration documents and neither lists a way to configure cni: none. This can suggest to the reader that cni: none has become the default. The upgrade document further describes that the flannel document can be used to configure flannel, which reinforces the idea that you deploy that document when you want to use flannel and not when you don't. This is incorrect, as flannel is still the default cni and the flannel configuration document is generated by default. The flannel document also does not contain an enabled/disabled field. Instead current cilium and other cni documentation instructs the users to use a patch delete operation in the flannel document to delete the default configuration of flannel. This is - at least for talos configuration so far - an unintuitive method of configuration and I suspect many users will fall for it and accidentally end up with flannel installed.
The document map also does not list the appropriate alternative for cni: none.
- Dominant language
- MDX
- Stars
- 11
- Forks
- 76
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 26
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from siderolabs/docs
-
documentation omni
Difficulty 1/5 Under an hour Newbie friendliness 85/100
siderolabs/docs#769 ·
-
documentation omni
Difficulty 1/5 Under an hour Newbie friendliness 90/100
siderolabs/docs#768 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
siderolabs/docs#764 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
siderolabs/docs#758 · 1 comment · 1 reaction ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
siderolabs/docs#752 ·
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100