Careful!
You are browsing documentation for a version of Kuma that is not the latest release.
Looking for even older versions? Learn more.
Kubernetes
To install and run Kuma on Kubernetes execute the following steps:
Finally you can follow the Quickstart to take it from here and continue your Kuma journey.
Kuma also provides Helm charts that we can use instead of this distribution.
1. Download Kuma
To run Kuma on Kubernetes, 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 https://kuma.io/installer.sh | VERSION=1.1.6 sh -2. Run Kuma
Once downloaded, you will find the contents of Kuma in the kuma- 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 Kubernetes - of all the Kuma binaries in the bin folder - we only need kumactl.
So we enter the bin folder by executing:
cd kuma-1.1.6/bin
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 | kubectl apply -f -
To learn more, read about the deployment modes available.
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
It may take a while for Kubernetes to start the Kuma resources, you can check the status by executing:
kubectl 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, kubectl, 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 127.0.0.1:5681/gui to see the GUI.
You will notice that Kuma automatically creates a Mesh entity with name default.
4. Quickstart
Congratulations! You have successfully installed Kuma on Kubernetes 🚀.
In order to start using Kuma, it’s time to check out the quickstart guide for Kubernetes deployments.