# Docker

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

The official Docker images are used by default in the Kubernetes and OpenShift distributions.

# 1. Download Kuma

Kuma provides the following Docker images for all of its executables:

  • kuma-cp: at kong-docker-kuma-docker.bintray.io/kuma-cp:1.0.0
  • kuma-dp: at kong-docker-kuma-docker.bintray.io/kuma-dp:1.0.0
  • kumactl: at kong-docker-kuma-docker.bintray.io/kumactl:1.0.0
  • kuma-prometheus-sd: at kong-docker-kuma-docker.bintray.io/kuma-prometheus-sd:1.0.0

You can freely docker pull these images to start using Kuma, as we will demonstrate in the following steps.

# 2. Run Kuma

We can proceed to run Kuma with:

$ docker run \
    -p 5681:5681 \
    kong-docker-kuma-docker.bintray.io/kuma-cp:1.0.0 run
1
2
3

This example will run Kuma in standalone mode for a "flat" deployment, but there are more advanced deployment modes like "multi-zone".

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.

# 3. Use Kuma

Kuma (kuma-cp) 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:

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

    # 4. Quickstart

    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 Kubernetes quickstart as well.

    Last Updated: 11/17/2020, 4:59:15 PM