You are browsing documentation for an older version.
See the latest documentation here.
Kong Mesh CNI
The operation of the Kong Mesh 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 Kong Mesh:
- use the standard
kuma-init
, which is the default
- use the Kong Mesh CNI
Kong Mesh 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.
Kong Mesh CNI applies NetworkAttachmentDefinition(NAD) to applications in a namespace with kuma.io/sidecar-injection
label.
To apply NAD to the applications not in a Mesh, add the label kuma.io/sidecar-injection
with the value disabled
to the namespace.
Installation
Below are the details of how to set up Kong Mesh CNI in different environments using both kumactl
and helm
.
Calico
K3D with Flannel
Kind
Azure
AWS - EKS
Google - GKE
OpenShift 4
kumactl install control-plane \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/etc/cni/net.d" \
--set "cni.binDir=/opt/cni/bin" \
--set "cni.confName=10-calico.conflist"
helm install --create-namespace --namespace kong-mesh-system \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/etc/cni/net.d" \
--set "cni.binDir=/opt/cni/bin" \
--set "cni.confName=10-calico.conflist" \
kong-mesh kong-mesh/kong-mesh
kumactl install control-plane \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/var/lib/rancher/k3s/agent/etc/cni/net.d" \
--set "cni.binDir=/bin" \
--set "cni.confName=10-flannel.conflist"
helm install --create-namespace --namespace kong-mesh-system \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/var/lib/rancher/k3s/agent/etc/cni/net.d" \
--set "cni.binDir=/bin" \
--set "cni.confName=10-flannel.conflist" \
kong-mesh kong-mesh/kong-mesh
kumactl install control-plane \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/etc/cni/net.d" \
--set "cni.binDir=/opt/cni/bin" \
--set "cni.confName=10-kindnet.conflist"
helm install --create-namespace --namespace kong-mesh-system \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/etc/cni/net.d" \
--set "cni.binDir=/opt/cni/bin" \
--set "cni.confName=10-kindnet.conflist" \
kong-mesh kong-mesh/kong-mesh
kumactl install control-plane \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/etc/cni/net.d" \
--set "cni.binDir=/opt/cni/bin" \
--set "cni.confName=10-azure.conflist"
helm install --create-namespace --namespace kong-mesh-system \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/etc/cni/net.d" \
--set "cni.binDir=/opt/cni/bin" \
--set "cni.confName=10-azure.conflist" \
kong-mesh kong-mesh/kong-mesh
kumactl install control-plane \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/etc/cni/net.d" \
--set "cni.binDir=/opt/cni/bin" \
--set "cni.confName=10-aws.conflist"
helm install --create-namespace --namespace kong-mesh-system \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/etc/cni/net.d" \
--set "cni.binDir=/opt/cni/bin" \
--set "cni.confName=10-aws.conflist" \
kong-mesh kong-mesh/kong-mesh
You need to enable network-policy in your cluster (for existing clusters this redeploys the nodes).
kumactl install control-plane \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/etc/cni/net.d" \
--set "cni.binDir=/home/kubernetes/bin" \
--set "cni.confName=10-calico.conflist"
helm install --create-namespace --namespace kong-mesh-system \
--set "cni.enabled=true" \
--set "cni.chained=true" \
--set "cni.netDir=/etc/cni/net.d" \
--set "cni.binDir=/home/kubernetes/bin" \
--set "cni.confName=10-calico.conflist" \
kong-mesh kong-mesh/kong-mesh
kumactl install control-plane \
--set "cni.enabled=true"
helm install --create-namespace --namespace kong-mesh-system \
--set "cni.enabled=true" \
kong-mesh kong-mesh/kong-mesh
Kong Mesh 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 kubectl logs
.
Kong Mesh 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.
Kong Mesh 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_RUNTIME_KUBERNETES_NODE_TAINT_CONTROLLER_ENABLED=false
Kong Mesh CNI v2 Logs
Logs of the new CNI plugin and the installer logs are available via kubectl logs
.
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
and have cgroup2
available
--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 kubectl logs
.