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 Kubernetes with Helm charts execute the following steps:
Finally you can follow the Quickstart to take it from here and continue your Kuma journey.
Please note that at least version 3.8.0 of Helm is required to use the Kuma Helm charts. If you are using an older version of Helm, please upgrade to version 3.8.0 first.
Kuma also provides an alternative Kubernetes distribution that we can use instead of Helm charts.
Add the Kuma charts repository
To start using Kuma with Helm charts, we first need to add the Kuma charts repository to our local Helm deployment:
helm repo add kuma https://kumahq.github.io/charts
Once the repo is added, all following updates can be fetched with
helm repo update.
At this point we can install and run Kuma using the following commands. We could use any Kubernetes namespace to install Kuma, by default we suggest using
helm install --create-namespace --namespace kuma-system kuma kuma/kuma
This example will run Kuma in
standalone mode for a “flat” deployment, but there are more advanced deployment modes like “multi-zone”.
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
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
entity with name
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.
Kuma requires a certificate to verify a connection between the control plane and a data plane proxy.
Kuma Helm chart autogenerate self-signed certificate if the certificate isn’t explicitly set.
Argo CD uses
helm template to compare and apply Kubernetes YAMLs.
Helm template doesn’t work with chart logic to verify if the certificate is present.
This results in replacing the certificate on each Argo redeployment.
The solution to this problem is to explicitly set the certificates.
See “Data plane proxy to control plane communication” to learn how to preconfigure Kuma with certificates.