Helm
Finally you can follow the to take it from here and continue your Kuma journey.
Kuma also provides an alternative Kubernetes distribution that we can use instead of Helm charts.
To start using Kuma with Helm charts, we first need to add the to our local Helm deployment:
Once the repo is added, all following updates can be fetched with .
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 kuma-system
:
$ helm install --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 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 can use Kuma with kubectl
to perform read and write operations on Kuma resources. For example:
or you can enable mTLS on the Mesh with:
echo "apiVersion: kuma.io/v1alpha1
kind: Mesh
metadata:
name: default
spec:
enabledBackend: ca-1
backends:
- name: ca-1
type: builtin" | kubectl apply -f -
Kuma ships with a read-only HTTP API that you can use to retrieve Kuma resources.
And then you can navigate to 127.0.0.1:5681
(opens new window) to see the HTTP API.
You can use the kumactl
CLI to perform read-only operations on Kuma resources. The kumactl
binary is a client to the Kuma HTTP API, you will need to first port-forward the API service with:
and then run kumactl
, for example:
$ kumactl get meshes
NAME mTLS METRICS LOGGING TRACING
You can configure kumactl
to point to any remote kuma-cp
instance by running:
$ kumactl config control-planes add --name=XYZ --address=http://{address-to-kuma}:5681
You will notice that Kuma automatically creates a entity with name .
Congratulations! You have successfully installed Kuma on Kubernetes 🚀.