For information on deploying flannel manually, using the Kubernetes installer toolkit kubeadm, see Installing Kubernetes on Linux with kubeadm.
NOTE: If kubeadm
is used, then pass --pod-network-cidr=10.244.0.0/16
to kubeadm init
to ensure that the podCIDR
is set.
The flannel
manifest defines five things:
- A
kube-flannel
with PodSecurity level set to privileged. - A ClusterRole and ClusterRoleBinding for Role Based Access Control (RBAC).
- A service account for
flannel
to use. - A ConfigMap containing both a CNI configuration and a
flannel
configuration. Thenetwork
in theflannel
configuration should match the pod network CIDR. The choice ofbackend
is also made here and defaults to VXLAN. - A DaemonSet for every architecture to deploy the
flannel
pod on each Node. The pod has two containers 1) theflannel
daemon itself, and 2) an initContainer for deploying the CNI configuration to a location that thekubelet
can read.
When you run pods, they will be allocated IP addresses from the pod network CIDR. No matter which node those pods end up on, they will be able to communicate with each other.
As of Kubernetes v1.21, the PodSecurityPolicy API was deprecated and it will be removed in v1.25. Thus, the flannel
manifest does not use PodSecurityPolicy anymore.
If you wish to use the Pod Security Admission Controller which was introduced to replace PodSecurityPolicy, you will need to deploy flannel
in a namespace which allows the deployment of pods with privileged
level. The baseline
level is insufficient to deploy flannel
and you will see the following error message:
Error creating: non-default capabilities (container "kube-flannel" must not include "NET_ADMIN", "NET_RAW" in securityContext.capabilities.add), host namespaces (hostNetwork=true), hostPath volumes (volumes "run", "cni-plugin", "cni", "xtables-lock")
The kube-flannel.yaml
manifest deploys flannel
in the kube-flannel
namespace and enables the privileged
level for this namespace.
Thus, you will need to restrict access to this namespace if you wish to secure your cluster.
If you want to deploy flannel
securely in a shared namespace or want more fine-grained control over the pods deployed in your cluster, you can use a 3rd-party admission controller like Kubewarden. Kubewarden provides policies that can replace features of PodSecurityPolicy like capabilities-psp-policy and hostpaths-psp-policy.
Other options include Kyverno and OPA Gatekeeper.
Additional annotations can be configured on a specific node as parameters used when Flannel starts on that specific node
flannel.alpha.coreos.com/node-public-ip
,flannel.alpha.coreos.com/node-public-ipv6
: Define the used IP of the node in case the node has multiple interface it selects the interface with the configured IP for the backend tunnel. If configured when Flannel starts it'll be used as thepublic-ip
andpublic-ipv6
flag.flannel.alpha.coreos.com/public-ip-overwrite
,flannel.alpha.coreos.com/public-ipv6-overwrite
: Allows to overwrite the public IP of a node that IP can be not configured on the node. Useful if the public IP can not determined from the node, e.G. because it is behind a NAT and the other nodes need to use it to create the tunnel. It can be automatically set to a nodesExternalIP
using the flannel-node-annotator. See also the "NAT" section in troubleshooting if UDP checksums seem corrupted.
kube-flannel.yaml
has some features that aren't compatible with older versions of Kubernetes, though flanneld itself should work with any version of Kubernetes.
If you see errors saying found invalid field...
when you try to apply kube-flannel.yaml
then you can try the "legacy" manifest file
kubectl apply -f https://raw.githubusercontent.com/coreos/flannel/master/Documentation/k8s-old-manifests/kube-flannel-legacy.yml
This file does not bundle RBAC permissions. If you need those, run
kubectl apply -f https://raw.githubusercontent.com/coreos/flannel/master/Documentation/k8s-old-manifests/kube-flannel-rbac.yml
If you didn't apply the kube-flannel-rbac.yml
manifest and you need to, you'll see errors in your flanneld logs about failing to connect.
Failed to create SubnetManager: error retrieving pod spec...
kube-flannel.yaml
uses ClusterRole
& ClusterRoleBinding
of rbac.authorization.k8s.io/v1
. When you use Kubernetes v1.16, you should replace rbac.authorization.k8s.io/v1
to rbac.authorization.k8s.io/v1beta1
because rbac.authorization.k8s.io/v1
had become GA from Kubernetes v1.17.
As of Kubernetes v1.21, the PodSecurityPolicy API was deprecated and it will be removed in v1.25. Thus, the flannel
manifest does not use PodSecurityPolicy anymore.
If you still wish to use it, you can use kube-flannel-psp.yaml
instead of kube-flannel.yaml
. Please note that if you use a Kubernetes version >= 1.21, you will see a deprecation warning for the PodSecurityPolicy API.
See troubleshooting