Skip to content
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

Jump to bottom

Networking content update #188

Merged
merged 1 commit into from
Oct 19, 2023
Merged

Networking content update #188

merged 1 commit into from
Oct 19, 2023

Conversation

manuelbuil
Copy link
Contributor

@manuelbuil manuelbuil commented Oct 16, 2023 •
edited
Loading

This PR does the following:

  • Removes the option --flannel-backend=wireguard (deprecated since 1.24 and removed in 1.26)
  • Hides the section "Migrating from wireguard or ipsec to wireguard-native" from the side summary
  • Updates warning about dualStack node-ip
  • Adds known issue when doing dualStack with IPv6 first
  • Removes Multicluster CIDR
  • Fixed this error thrown by CI:
./docs/release-notes/v1.27.X.md:134: porfile ==> profile
Error: Process completed with exit code 6[5](https://github.com/k3s-io/docs/actions/runs/6532077574/job/17734575997?pr=188#step:5:6).

@rbrtbnfgl
Copy link
Contributor

does the update of yarn.lock file needed?

@manuelbuil
Copy link
Contributor Author

does the update of yarn.lock file needed?

good catch! And the json is also not needed

@brandond
Copy link
Member

brandond commented Oct 16, 2023 •
edited
Loading

Do we need a Table Of Contents at the top, in addition to the auto-generated one on the side? Could we perhaps just clean up the section titles so that the auto-generated TOC is more usable?

image

A lot of the stuff on this page isn't really related to networking - coredns and traefik for example should probably be covered elsewhere, leaving this page for just actual netpol/flannel/servicelb/dual-stack/vpn content, which could be reorganized to be easier to navigate.

@manuelbuil manuelbuil changed the title Add an initial quick menu and update a couple of things for networking Networking content update Oct 19, 2023
@manuelbuil
Copy link
Contributor Author

Do we need a Table Of Contents at the top, in addition to the auto-generated one on the side? Could we perhaps just clean up the section titles so that the auto-generated TOC is more usable?

image

A lot of the stuff on this page isn't really related to networking - coredns and traefik for example should probably be covered elsewhere, leaving this page for just actual netpol/flannel/servicelb/dual-stack/vpn content, which could be reorganized to be easier to navigate.

My eyes were ignoring the sidebar Table of Contents, that's why I added it :). But now that I see it, I think it is repetitive. Instead I am doing just a regular update of the content.

I will create an issue to reorg our networking content which is confusing. It is covered in two different places and I think that is confusing but it is also not obvious how to divide it

brandond
brandond requested changes Oct 19, 2023
View reviewed changes
docs/installation/network-options.md Outdated Show resolved Hide resolved
docs/networking/networking.md Outdated Show resolved Hide resolved
@manuelbuil manuelbuil merged commit 22f518e into k3s-io:main Oct 19, 2023
3 checks passed
@manuelbuil manuelbuil deleted the organizeNetwork branch October 19, 2023 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thomasferrandiz thomasferrandiz thomasferrandiz approved these changes

@rbrtbnfgl rbrtbnfgl rbrtbnfgl approved these changes

@brandond brandond brandond approved these changes

@dereknola dereknola Awaiting requested review from dereknola

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@manuelbuil @rbrtbnfgl @brandond @thomasferrandiz