Docker
The official Docker images are used by default in the Kubernetes and distributions.
Kuma provides the following Docker images for all of its executables:
- kuma-cp: at
- kuma-dp: at
kong-docker-kuma-docker.bintray.io/kuma-dp:0.5.1
- kuma-prometheus-sd: at
kong-docker-kuma-docker.bintray.io/kuma-prometheus-sd:0.5.1
You can freely docker pull
these images to start using Kuma, as we will demonstrate in the following steps.
We can proceed to run Kuma with:
Note: By default this will run Kuma with a memory
backend, but you can use a persistent storage like PostgreSQL by updating the conf/kuma-cp.conf
file.
Kuma () is now running! Now that Kuma has been installed you can access the control-plane via either the GUI, the HTTP API, or the CLI:
To access Kuma you can navigate to to see the GUI.
Kuma ships with a read and write HTTP API that you can use to perform operations on Kuma resources. By default the HTTP API listens on port 5681
.
To access Kuma you can navigate to 127.0.0.1:5681
to see the HTTP API.
You can use the kumactl
CLI to perform read and write operations on Kuma resources. The kumactl
binary is a client to the Kuma HTTP API. For example:
or you can enable mTLS on the Mesh with:
Note: we are running kumactl
from the Docker container on the same network as the host
, but most likely you want to download a compatible version of Kuma for the machine where you will be executing the commands.
or you can download the distribution manually:
and extract the archive with:
You will then find the kumactl
executable in the kuma-0.5.1/bin
folder.
You will notice that Kuma automatically creates a entity with name default
.
Congratulations! You have successfully installed Kuma on Docker 🚀.
In order to start using Kuma, it’s time to check out the quickstart guide for Universal deployments. If you are using Docker you may also be interested in checking out the as well.