Skip to content
Kong Logo | Kong Docs Logo
search
  • Docs
    • Explore the API Specs
      View all API Specs View all API Specs View all API Specs arrow image
    • Documentation
      API Specs
      Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Mesh
1.5.x
  • Home icon
  • Kong Mesh
  • Installation
  • Kong Mesh with Docker
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • dev
  • 2.5.x (latest)
  • 2.4.x
  • 2.3.x
  • 2.2.x
  • 2.1.x
  • 2.0.x
  • 1.9.x
  • 1.8.x
  • 1.7.x
  • 1.6.x
  • 1.5.x
  • 1.4.x
  • 1.3.x
  • 1.2.x
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • Prerequisites
  • 1. Download Kong Mesh
  • 2. Run Kong Mesh
  • 3. Verify the Installation
  • 4. Quickstart
You are browsing documentation for an outdated version. See the latest documentation here.

Kong Mesh with Docker

To install and run Kong Mesh on Docker:

  1. Download Kong Mesh
  2. Run Kong Mesh
  3. Verify the Installation

Finally, you can follow the Quickstart to take it from here and continue your Kong Mesh journey.

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

Prerequisites

You have a license for Kong Mesh.

1. Download Kong Mesh

Kong Mesh provides the following Docker images for all of its executables, hosted on Docker Hub:

  • kuma-cp: at kong/kuma-cp:2.5.0
  • kuma-dp: at kong/kuma-dp:2.5.0
  • kumactl: at kong/kumactl:2.5.0
  • kuma-prometheus-sd: at kong/kuma-prometheus-sd:2.5.0

docker pull each image that you need. For example:

$ docker pull kong/kuma-cp:2.5.0

2. Run Kong Mesh

Run the control plane with:

$ docker run \
  -p 5681:5681 \
  -v /path/to/license.json:/license.json \
  -e "KMESH_LICENSE_PATH=/license.json" \
  kong/kuma-cp:2.5.0 run

Where /path/to/license.json is the path to a valid Kong Mesh license file on the host that will be mounted as /license.json into the container.

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

This runs Kong Mesh with a memory backend, but you can use a persistent storage like PostgreSQL by updating the conf/kuma-cp.conf file.

3. Verify the Installation

Now that Kong Mesh (kuma-cp) is running, you can access the control plane using either the GUI, the HTTP API, or the CLI:

GUI (Read-Only)
HTTP API (Read & Write)
kumactl (Read & Write)

Kong Mesh ships with a read-only GUI that you can use to retrieve Kong Mesh resources. By default, the GUI listens on the API port 5681.

To access Kong Mesh, navigate to 127.0.0.1:5681/gui to see the GUI.

Kong Mesh ships with a read and write HTTP API that you can use to perform operations on Kong Mesh resources. By default, the HTTP API listens on port 5681.

To access Kong Mesh, 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 Kong Mesh resources. The kumactl binary is a client to the Kong Mesh HTTP API. For example:

$ docker run \
  --net="host" \
  kong/kumactl:2.5.0 kumactl get meshes

NAME          mTLS      METRICS      LOGGING   TRACING
default       off       off          off       off

Or, you can enable mTLS on the default Mesh with:

$ echo "type: Mesh
  name: default
  mtls:
    enabledBackend: ca-1
    backends:
    - name: ca-1
      type: builtin" | docker run -i --net="host" \
    kong/kumactl:2.5.0 kumactl apply -f -

This runs kumactl from the Docker container on the same network as the host, but most likely you want to download a compatible version of Kong Mesh for the machine where you will be executing the commands.

See the individual installation pages for your OS to download and extract kumactl to your machine:

  • CentOS
  • Red Hat
  • Debian
  • Ubuntu
  • macOS

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

4. Quickstart

The Kuma quickstart documentation is fully compatible with Kong Mesh, except that you are running Kong Mesh containers instead of Kuma containers.

To start using Kong Mesh, see the quickstart guide for Universal deployments. If you are entirely using Docker, you may also be interested in checking out the Kubernetes quickstart as well.

Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    Powering the API world

    Increase developer productivity, security, and performance at scale with the unified platform for API management, service mesh, and ingress controller.

    • Products
      • Kong Konnect
      • Kong Gateway Enterprise
      • Kong Gateway
      • Kong Mesh
      • Kong Ingress Controller
      • Kong Insomnia
      • Product Updates
      • Get Started
    • Documentation
      • Kong Konnect Docs
      • Kong Gateway Docs
      • Kong Gateway Enterprise Docs
      • Kong Mesh Docs
      • Kong Insomnia Docs
      • Kong Konnect Plugin Hub
    • Open Source
      • Kong Gateway
      • Kuma
      • Insomnia
      • Kong Community
    • Company
      • About Kong
      • Customers
      • Careers
      • Press
      • Events
      • Contact
  • Terms• Privacy• Trust and Compliance
© Kong Inc. 2023