CLI

    • : this is the main Kuma executable that runs the control plane (CP).
    • kuma-dp: this is the Kuma data plane proxy executable that - under the hood - invokes envoy.
    • envoy: this is the Envoy executable that we bundle for convenience into the archive.
    • kumactl: this is the the user CLI to interact with Kuma (kuma-cp) and its data.

    According to the installation instructions, some of these executables are automatically executed as part of the installation workflow, while some other times you will have to execute them directly.

    You can check the usage of the executables by running the -h flag, like:

    and you can check their version by running the version [--detailed] command like:

    • Retrieve the state of Kuma and the configured policies in every environment.
    • On Universal environments, it allows to change the state of Kuma by applying new policies with the kumactl apply [..] command.
    • On Kubernetes it is read-only, because you are supposed to change the state of Kuma by leveraging Kuma’s CRDs.
    • It provides helpers to install Kuma on Kubernetes, and to configure the PostgreSQL schema on Universal (kumactl install [..]).

    The application is a CLI client for the underlying of Kuma. Therefore, you can access the state of Kuma by leveraging with the API directly. On Universal you will be able to also make changes via the HTTP API, while on Kubernetes the HTTP API is read-only.

    Available commands on kumactl are:

    • kumactl install [..]: provides helpers to install Kuma components in Kubernetes.
      • kumactl install control-plane: Installs Kuma in Kubernetes in a kuma-system namespace.
      • kumactl install observability: Install Observability (Metrics, Logging, Tracing) backend in Kubernetes cluster (Prometheus + Grafana + Loki + Jaeger + Zipkin) in mesh-observability namespace.
    • kumactl apply [..]: used to change the state of Kuma. Only available on Universal.
    • kumactl get [..]: used to retrieve the raw state of entities Kuma.
    • : used to retrieve an augmented state of entities in Kuma.
    • kumactl generate dataplane-token: used to generate Dataplane Token .
    • kumactl generate tls-certificate: used to generate a TLS certificate for client or server.
    • kumactl manage ca [..]: used to manage certificate authorities.
    • kumactl help [..]: help dialog that explains the commands available.

    Checkout the for full documentation.

    For example with a yaml like:

    You can then set the caType when applying it:

    This will create this mesh:

    Configuration

    The configuration is stored in $HOME/.kumactl/config, which is created when you run kumactl for the first time. When you add a new control plane with kumactl config control-planes add, the config file is updated. To change the path of the config file, run with --config-file /new-path/config.