Disclaimer: Network plugins are in alpha. Its contents will change rapidly.
Network plugins in Kubernetes come in a few flavors:
The kubelet has a single default network plugin, and a default network common to the entire cluster. It probes for plugins when it starts up, remembers what it found, and executes the selected plugin at appropriate times in the pod lifecycle (this is only true for docker, as rkt manages its own CNI plugins). There are two Kubelet command line parameters to keep in mind when using plugins:
network-plugin-dir: Kubelet probes this directory for plugins on startup
network-plugin: The network plugin to use from
network-plugin-dir. It must match the name reported by a plugin probed from the plugin directory. For CNI plugins, this is simply “cni”.
Besides providing the
NetworkPlugin interface to configure and clean up pod networking, the plugin may also need specific support for kube-proxy. The iptables proxy obviously depends on iptables, and the plugin may need to ensure that container traffic is made available to iptables. For example, if the plugin connects containers to a Linux bridge, the plugin must set the
net/bridge/bridge-nf-call-iptables sysctl to
1 to ensure that the iptables proxy functions correctly. If the plugin does not use a Linux bridge (but instead something like Open vSwitch or some other mechanism) it should ensure container traffic is appropriately routed for the proxy.
By default if no kubelet network plugin is specified, the
noop plugin is used, which sets
net/bridge/bridge-nf-call-iptables=1 to ensure simple configurations (like docker with a bridge) work correctly with the iptables proxy.
Place plugins in
network-plugin-dir/plugin-name/plugin-name, i.e if you have a bridge plugin and
/usr/lib/kubernetes, you’d place the bridge plugin executable at
/usr/lib/kubernetes/bridge/bridge. See this comment for more details.
The CNI plugin is selected by passing Kubelet the
--network-plugin=cni command-line option. Kubelet reads a file from
/etc/cni/net.d) and uses the CNI configuration from that file to set up each pod’s network. The CNI configuration file must match the CNI specification, and any required CNI plugins referenced by the configuration must be present in
If there are multiple CNI configuration files in the directory, the first one in lexicographic order of file name is used.
In addition to the CNI plugin specified by the configuration file, Kubernetes requires the standard CNI
lo plugin, at minimum version 0.2.0
The Linux-only kubenet plugin provides functionality similar to the
--configure-cbr0 kubelet command-line option. It creates a Linux bridge named
cbr0 and creates a veth pair for each pod with the host end of each pair connected to
cbr0. The pod end of the pair is assigned an IP address allocated from a range assigned to the node either through configuration or by the controller-manager.
cbr0 is assigned an MTU matching the smallest MTU of an enabled normal interface on the host. The kubenet plugin is currently mutually exclusive with, and will eventually replace, the –configure-cbr0 option. It is also currently incompatible with the flannel experimental overlay.
The plugin requires a few things:
host-localplugins are required, at minimum version 0.2.0. Kubenet will first search for them in
network-plugin-dirto supply additional search path. The first found match will take effect.
--network-plugin=kubenetargument to enable the plugin
--reconcile-cidrargument to ensure the IP subnet assigned to the node by configuration or the controller-manager is propagated to the plugin
--pod-cidrkubelet command-line option or the
--allocate-node-cidrs=true --cluster-cidr=<cidr>controller-manager command-line options.
The MTU should always be configured correctly to get the best networking performance. Network plugins will usually try to infer a sensible MTU, but sometimes the logic will not result in an optimal MTU. For example, if the Docker bridge or another interface has a small MTU, kubenet will currently select that MTU. Or if you are using IPSEC encapsulation, the MTU must be reduced, and this calculation is out-of-scope for most network plugins.
Where needed, you can specify the MTU explicitly with the
network-plugin-mtu kubelet option. For example,
on AWS the
eth0 MTU is typically 9001, so you might specify
--network-plugin-mtu=9001. If you’re using IPSEC you
might reduce it to allow for encapsulation overhead e.g.
This option is provided to the network-plugin; currently only kubenet supports
--network-plugin=execspecifies that we use the
execplugin, with executables located in
--network-plugin=cnispecifies that we use the
cninetwork plugin with actual CNI plugin binaries located in
/opt/cni/bin) and CNI plugin configuration located in
--network-plugin=kubenetspecifies that we use the
kubenetnetwork plugin with CNI
host-localplugins placed in
--network-plugin-mtu=9001specifies the MTU to use, currently only used by the