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

Add Flannel CNI docs #170

Merged
merged 1 commit into from
Mar 5, 2024
Merged

Add Flannel CNI docs #170

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
18 changes: 18 additions & 0 deletions docs/install/network_options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ This page focuses on the network options available when setting up RKE2:

## Install a CNI plugin

RKE2 integrates with four different CNI plugins: Canal, Cilium, Calico and Flannel. Note that only Calico and Flannel are options for RKE2 deployments with Windows nodes.

The next tabs inform how to deploy each CNI plugin and override the default options:

<Tabs groupId = "CNIplugin">
Expand Down Expand Up @@ -133,6 +135,17 @@ For more information about values available for the Calico chart, please refer t
Calico requires the iptables or xtables-nft package to be installed on the node.
:::

</TabItem>
<TabItem value="Flannel CNI plugin" default>
Starting with RKE2 2024 Feb release (v1.29.2, v1.28.7, v1.27.11, v1.26.14), Flannel can be deployed as the CNI plugin. To do so, pass `flannel` as the value of the `--cni` flag.

:::note
Only vxlan backend is supported at this point
:::

:::warning
Flannel does not support network policies. Therefore, it is not recommended for hardened installations
:::
</TabItem>
</Tabs>

Expand Down Expand Up @@ -162,6 +175,11 @@ Cilium automatically detects the RKE2 configuration for dual-stack and does not
<TabItem value="Calico CNI plugin" default>

Calico automatically detects the RKE2 configuration for dual-stack and does not need any extra configuration. When deployed in dual-stack mode, it creates two different ippool resources. Note that when using dual-stack, calico leverages BGP instead of VXLAN encapsulation. Dual-stack and BGP are currently not supported in the windows installations of RKE2.
</TabItem>
<TabItem value="Flannel CNI plugin" default>

Flannel automatically detects the RKE2 configuration for dual-stack and does not need any extra configuration.

</TabItem>
</Tabs>

Expand Down
1 change: 1 addition & 0 deletions docs/install/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ If you wish to utilize the metrics server, you will need to open port 10250 on e
| TCP | 9099 | All RKE2 nodes | All RKE2 nodes | Canal CNI health checks
| UDP | 51820 | All RKE2 nodes | All RKE2 nodes | Canal CNI with WireGuard IPv4
| UDP | 51821 | All RKE2 nodes | All RKE2 nodes | Canal CNI with WireGuard IPv6/dual-stack
| UDP | 4789 | All RKE2 nodes | All RKE2 nodes | Flannel CNI with VXLAN

### Windows Specific Inbound Network Rules

Expand Down
Loading