public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-26 13:08:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add new network-options page to Install section

Browse Source 
- Initial commit
- Adds this new page describing the flannel backend options and how to set up your own CNI
- Tweaks the existing Networking page
- Adds hyperlinks linking the two pages together.
Note: Intent is that the main Networking page is for CoreDNS, Traefik, ServiceLB, and in the future other general high level networking discussions. Whereas the "network-options" page under the Installation section is for specific things that should be considered at install-time for K3s such as the flannel backend or other CNIs.
This commit is contained in:
David Nuzik
2019-12-06 10:57:15 -07:00
parent 43a85b4de2
commit 189b8f6218
2 changed files with 56 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/k3s/latest/en/installation/network-options/_index.md
+54
View File
@@ -0,0 +1,54 @@
---
title: "Network Options"
weight: 25
---
> **Note:** Please reference the [Networking]({<< baseurl >>}/k3s/latest/en/networking) page for information about CoreDNS, Traefik, and the Service LB.
By default, K3s will run with flannel as the CNI, using VXLAN as the default backend. To change the CNI, refer to the section on configuring a custom CNI. To change the flannel backend, refer to the flannel options section.
### Flannel Options
The default backend for flannel is VXLAN. If you would like to use a different backend with flannel, use one of the options in the table below.
If you wish to use WireGuard as your flannel backend it may require additional kernel modules. Please see the [WireGuard Install Guide](https://www.wireguard.com/install/) for details. The WireGuard install steps will ensure the appropriate kernel modules are installed for your operating system. You need to install WireGuard on every node, both server and agents before attempting to leverage the WireGuard flannel backend option.
CLI Flag and Value | Description
-------------------|------------
<span style="white-space: nowrap">`--flannel-backend=vxlan`</span> | (Default) Uses the VXLAN backend. |
<span style="white-space: nowrap">`--flannel-backend=ipsec`</span> | Uses the IPSEC backend which encrypts network traffic. |
<span style="white-space: nowrap">`--flannel-backend=wireguard`</span> | Uses the WireGuard backend which encrypts network traffic. May require additional kernel modules and configuration. |
### Custom CNI
Run K3s with `--flannel-backend=none` and install your CNI of choice. IP Forwarding should be enabled for Canal and Calico. Please reference the steps below.
{{% tabs %}}
{{% tab "Canal" %}}
Visit the [Project Calico Docs](https://docs.projectcalico.org/) website. Follow the steps to install Canal. Modify the Canal YAML so that IP forwarding is allowed in the container_settings section, for example:
```
"container_settings": {
"allow_ip_forwarding": true
}
```
Applyl the Canal YAML.
{{% /tab %}}
{{% tab "Calico" %}}
Follow the [Calico CNI Plugins Guide](https://docs.projectcalico.org/master/reference/cni-plugin/configuration). Modify the Calico YAML so that IP forwarding is allowed in the container_settings section, for example:
```
"container_settings": {
"allow_ip_forwarding": true
}
```
Apply the Calico YAML.
{{% /tab %}}
{{% /tabs %}}
content/k3s/latest/en/networking/_index.md
+2 -7
View File
@@ -3,17 +3,12 @@ title: "Networking"
weight: 35
---
>**Note:** CNI options are covered in detail on the [Installation Network Options]({{< baseurl >}}/k3s/latest/en/installation/network-options/) page. Please reference that page for details on Flannel and the various flannel backend options or how to set up your own CNI.
Open Ports
----------
Please reference the [Node Requirements]({{< baseurl >}}/k3s/latest/en/installation/node-requirements/#networking) page for port information.
Flannel
-------
Flannel is included by default, if you don't want flannel then run each agent with `--no-flannel` option.
In this setup you will still be required to install your own CNI driver. More info [here](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/#pod-network)
CoreDNS
-------