You are browsing documentation for the next version of Kuma. Use this version at your own risk.
Go here to browse the documentation for the latest version.
The operation of the Kuma data plane proxy, precludes that all the relevant inbound and outbound traffic on the host (or container) that runs the service is diverted to pass through the proxy itself. This is done through transparent proxying, which is set up automatically on Kubernetes. Installing it requires certain privileges, which are delegated to pre-sidecar initialisation steps. There are two options to do this with Kuma:
- use the standard
kuma-init, which is the default
- use the Kuma CNI
Kuma CNI can be leveraged in the two installation methods for Kubernetes: using
kumactl and with Helm.
The default settings are tuned for OpenShift with Multus,
therefore to use it in other environments we need to set the relevant configuration parameters.
Kuma CNI applies NetworkAttachmentDefinition(NAD) to applications in a namespace with
To apply NAD to the applications not in a Mesh, add the label
kuma.io/sidecar-injection with the value
disabled to the namespace.
Below are the details of how to set up Kuma CNI in different environments using both
Kuma CNI Logs
Logs of the CNI plugin are available in
/tmp/kuma-cni.log on the node and the logs of the installer are available via
Kuma CNI v2
The v2 version of the CNI is using kuma-net engine to do transparent proxying.
To install v2 CNI append the following options to the command from installation:
--set ... \ --set "cni.enabled=true" \ --set "experimental.cni=true"
Currently, the v2 CNI is behind an
experimental flag, but it’s intended to be the default CNI in future releases.
Kuma v2 CNI Taint controller
To prevent a race condition described in this issue a new controller was implemented.
The controller will taint a node with
NoSchedule taint to prevent scheduling before the CNI DaemonSet is running and ready.
Once the CNI DaemonSet is running and ready it will remove the taint and allow other pods to be scheduled into the node.
To disable the taint controller use the following env variable:
Kuma CNI v2 Logs
Logs of the new CNI plugin and the installer logs are available via
Merbridge CNI with eBPF
To install merbridge CNI with eBPF append the following options to the command from installation:
To use Merbridge CNI with eBPF your environment has to use
Kernel >= 5.7
--set ... \ --set "cni.enabled=true" \ --set "experimental.ebpf.enabled=true"
Merbridge CNI with eBPF Logs
Logs of the installer of Merbridge CNI with eBPF are available via