macOS

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

    To run Kuma on macOS you can choose among different installation methods:

    Run the following script to automatically detect the operating system and download Kuma:

    You can also download the distribution manually:

    Then extract the archive with:

    If you only need the Kuma CLI kumactl, then you can also execute:

    1. $ brew install kumactl

    Once downloaded, you will find the contents of Kuma in the kuma-1.1.0 folder. In this folder, you will find - among other files - the bin directory that stores all the executables for Kuma.

    So we enter the bin folder by executing:

    Standalone mode is perfect when running Kuma in a single cluster across one environment:

    1. $ ./kuma-cp run

    To learn more, read about the deployment modes available.

    Multi-zone mode is perfect when running one deployment of Kuma that spans across multiple Kubernetes clusters, clouds and VM environments under the same Kuma deployment.

    This mode also supports hybrid Kubernetes + VMs deployments.

    To learn more, read the .

    We suggest adding the kumactl executable to your PATH so that it’s always available in every working directory. Or - alternatively - you can also create link in /usr/local/bin/ by executing:

    1. ln -s ./kumactl /usr/local/bin/kumactl

    Note: By default this will run Kuma with a backend, but you can use a persistent storage like PostgreSQL by updating the conf/kuma-cp.conf file.

    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:

    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 (opens new window) 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 default Mesh with:

    1. echo "type: Mesh
    2. mtls:
    3.   enabledBackend: ca-1
    4.   backends:
    5.   - name: ca-1
    6.     type: builtin" | kumactl apply -f -

    You can configure kumactl to point to any remote kuma-cp instance by running:

    1. $ kumactl config control-planes add --name=XYZ --address=http://{address-to-kuma}:5681

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

    Congratulations! You have successfully installed Kuma on macOS 🚀.