Estimated reading time:
You are browsing documentation for an outdated version of Kong Mesh. Go here
to see the documentation for the latest version.
To install and run Kong Mesh on macOS, execute the following
Finally, you can follow the Quickstart to take it from here
and continue your Kong Mesh journey.
You have a license for Kong Mesh.
1. Download Kong Mesh
To run Kong Mesh on macOS, you can choose from the following
2. Run Kong Mesh
Once downloaded, you will find the contents of Kong Mesh in the
kong-mesh-1.0.4 folder. In this folder, you will find — among other files — the bin directory that stores all the executables for Kong Mesh.
Navigate to the
Note: Before running the Kong Mesh
control plane process in the next step — which is served by the
executable — you need to have a valid Kong Mesh license
Then, run the control plane with:
$ KUMA_LICENSE_PATH=/path/to/file/license.json kuma-cp run
/path/to/file/license.json is the path to a valid
Kong Mesh license file on the file system.
This example will run Kong Mesh in standalone mode for a flat
deployment, but there are more advanced deployment modes
We suggest adding the
kumactl executable to your
PATH so that it’s always
available in every working directory. Alternatively, you can also create a link
/usr/local/bin/ by executing:
$ ln -s ./kumactl /usr/local/bin/kumactl
By default, this will run Kong Mesh with a memory
, but you can use a persistent storage like PostgreSQL by updating the
3. Verify the Installation
Now that Kong Mesh has been installed, you can access the
control plane using either the GUI, the HTTP API, or the CLI:
You will notice that Kong Mesh automatically creates a
entity with the name
Congratulations! You have successfully installed Kong Mesh.
After installation, the Kuma quickstart documentation is fully compatible with
Kong Mesh, except that you are running Kong Mesh
binaries instead of the vanilla Kuma ones.
To start using Kong Mesh, see the quickstart guide for Universal deployments.