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.

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

Fix installation network-options table #209

Merged
merged 2 commits into from
Dec 5, 2023
Merged

Fix installation network-options table #209

merged 2 commits into from
Dec 5, 2023

Conversation

Luigi600
Copy link
Contributor

A small fix that corrects the presentation of the Markdown table, as well as formatting the table.

Comment on lines 22 to 30
| CLI Flag and Value | Description |
|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--flannel-ipv6-masq` | Apply masquerading rules to IPv6 traffic (default for IPv4). Only applies on dual-stack or IPv6-only clusters. Compatible with any Flannel backend other than `none`. |
| `--flannel-external-ip` | Use node external IP addresses as the destination for Flannel traffic, instead of internal IPs. Only applies when --node-external-ip is set on a node. |
| `--flannel-backend=vxlan` | Use VXLAN to encapsulate the packets. May require additional kernel modules on Raspberry Pi. |
| `--flannel-backend=host-gw` | Use IP routes to pod subnets via node IPs. Requires direct layer 2 connectivity between all nodes in the cluster. |
| `--flannel-backend=wireguard-native` | Use WireGuard to encapsulate and encrypt network traffic. May require additional kernel modules. |
| `--flannel-backend=ipsec` | Use strongSwan IPSec via the `swanctl` binary to encrypt network traffic. (Deprecated; will be removed in v1.27.0) |
| `--flannel-backend=none` | Disable Flannel entirely. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing the table formatting - but I don't think that it's necessary to pad these lines out with extra whitespace or hyphens to make the table line up in the raw view. Can you amend this to just fix the markdown?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually, such a formatting is generated when using code formatters such as Prettier. Basically, however, I have oriented myself to the following tables, which are part of the main branch:

If a change is nevertheless desirable, I will make it.

@brandond brandond merged commit 5f89942 into k3s-io:main Dec 5, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants