You are browsing documentation for a version of Kuma that is not the latest release.

Looking for even older versions? Learn more.


To install and run Kuma on OpenShift execute the following steps:

Finally you can follow the Quickstart to take it from here and continue your Kuma journey.

1. Download Kuma

To run Kuma on OpenShift, you need to download a compatible version of Kuma for the machine from which you will be executing the commands.

You can run the following script to automatically detect the operating system and download Kuma:

curl -L | VERSION=1.3.1 sh -

2. Run Kuma

Once downloaded, you will find the contents of Kuma in the kuma-1.3.1 folder. In this folder, you will find - among other files - the bin directory that stores the executables for Kuma, including the CLI client kumactl.

Note: On OpenShift - of all the Kuma binaries in the bin folder - we only need kumactl.

So we enter the bin folder by executing:

cd kuma-1.3.1/bin

We suggest adding the kumactl executable to your PATH so that it’s always available in every working directory. Or - alternatively - you can also create link in /usr/local/bin/ by executing:

ln -s $PWD/kumactl /usr/local/bin/kumactl

Finally we can install and run Kuma in either standalone or multi-zone mode:

Standalone mode is perfect when running Kuma in a single cluster across one environment:

./kumactl install control-plane --cni-enabled | oc apply -f -

Starting from version 4.1 OpenShift utilizes nftables instead of iptables. So using init container for redirecting traffic to the proxy is no longer works. Instead, we use kuma-cni which could be installed with --cni-enabled flag.

It may take a while for OpenShift to start the Kuma resources, you can check the status by executing:

oc get pod -n kuma-system

3. Use Kuma

Kuma (kuma-cp) will be installed in the newly created kuma-system namespace! Now that Kuma has been installed, you can access the control-plane via either the GUI, oc, the HTTP API, or the CLI:

Kuma ships with a read-only GUI that you can use to retrieve Kuma resources. By default the GUI listens on the API port and defaults to :5681/gui.

To access Kuma we need to first port-forward the API service with:

kubectl port-forward svc/kuma-control-plane -n kuma-system 5681:5681

And then navigate to to see the GUI.

You will notice that Kuma automatically creates a Mesh entity with name default.

Kuma explicitly specifies UID for kuma-dp sidecar to avoid capturing traffic from kuma-dp itself. For that reason, nonroot Security Context Constraint has to be granted to the application namespace:

oc adm policy add-scc-to-group nonroot system:serviceaccounts:<app-namespace>

If namespace is not configured properly, we will see following error on the Deployment or DeploymentConfig

'pods "kuma-demo-backend-v0-cd6b68b54-" is forbidden: unable to validate against any security context constraint: [spec.containers[1].securityContext.securityContext.runAsUser: Invalid value: 5678: must be in the ranges: [1000540000, 1000549999]]'

4. Quickstart

Congratulations! You have successfully installed Kuma on OpenShift 🚀.

In order to start using Kuma, it’s time to check out the quickstart guide for Kubernetes deployments.

Before running Kuma Demo in the Quickstart, remember to run the following command

oc adm policy add-scc-to-group anyuid system:serviceaccounts:kuma-demo

In case of Kuma Demo, one of the component requires root access therefore we use anyuid instead of nonroot permission.

Last Updated: 2/8/2024, 18:54:18 PM