Consul K8s CLI Reference

    Note: For guidance on how to install the Consul K8s CLI, visit the Installing the Consul K8s CLI documentation.

    This topic describes the subcommands and available options for using Consul K8s CLI.

    Consul K8s CLI uses the following syntax:

    1. $ consul-k8s <SUBCOMMAND> <OPTIONS>

    You can use the following subcommands with consul-k8s.

    The install command installs Consul on Kubernetes.

    1. $ consul-k8s install <OPTIONS>
    1. $ consul-k8s install <OPTIONS>

    The following options are available.

    Example Commands

    The following example command installs Consul according in the myNS namespace according to the secure preset.

    1. $ consul-k8s install -preset=secure -namespace=myNS
    1. $ consul-k8s install -preset=secure -namespace=myNS

    The following example commands install Consul on Kubernetes using custom values, files, or strings that are set via flags. The underlying Consul-on-Kubernetes Helm chart uses the flags to customize the installation. The flags are comparable to the helm install .

    1.  $ consul-k8s install -set key=value
    1.  $ consul-k8s install -set key=value
    1.  $ consul-k8s install -set key1=value1 -set key2=value2
    1.  $ consul-k8s install -set key1=value1 -set key2=value2
    1.  $ consul-k8s install -set-file config1=value1.conf
    1.  $ consul-k8s install -set-file config1=value1.conf -set-file config2=value2.conf
    1.  $ consul-k8s install -set-file config1=value1.conf -set-file config2=value2.conf
    1.  $ consul-k8s install -set-string key=value-bool
    1.  $ consul-k8s install -set-string key=value-bool

    The uninstall command removes Consul from Kubernetes.

    1. $ consul-k8s uninstall <OPTIONS>
    1. $ consul-k8s uninstall <OPTIONS>

    The following options are available.

    See Global Options for additional commands that you can use when uninstalling Consul from Kubernetes.

    Example Command

    The following example command immediately uninstalls Consul from the my-ns namespace with the name my-consul and removes PVCs and secrets associated with the installation without asking for verification:

    1. $ consul-k8s uninstall -namespace=my-ns -name=my-consul -wipe-data=true -auto-approve=true
    1. $ consul-k8s uninstall -namespace=my-ns -name=my-consul -wipe-data=true -auto-approve=true

      Example Command

      1. $ consul-k8s status
      3. ==> Consul-K8s Status Summary
      4.    NAME  | NAMESPACE |  STATUS  | CHARTVERSION | APPVERSION | REVISION |      LAST UPDATED
      5. ---------+-----------+----------+--------------+------------+----------+--------------------------
      6.   consul | consul    | deployed | 0.41.1       | 1.11.4     |        1 | 2022/03/10 07:48:58 MST
      8. ==> Config:
      9.     connectInject:
      10.       enabled: true
      11.       metrics:
      12.         defaultEnableMerging: true
      13.         defaultEnabled: true
      14.         enableGatewayMetrics: true
      15.     controller:
      16.       enabled: true
      17.     global:
      18.       metrics:
      19.         enableAgentMetrics: true
      20.         enabled: true
      21.       name: consul
      22.     prometheus:
      23.       enabled: true
      24.     server:
      25.       replicas: 1
      26.     ui:
      27.       enabled: true
      28.       service:
      29.         enabled: true
      31.  ✓ Consul servers healthy (1/1)
      32.  ✓ Consul clients healthy (3/3)
      1. $ consul-k8s status
      3.    NAME  | NAMESPACE |  STATUS  | CHARTVERSION | APPVERSION | REVISION |      LAST UPDATED
      4. ---------+-----------+----------+--------------+------------+----------+--------------------------
      5.   consul | consul    | deployed | 0.41.1       | 1.11.4     |        1 | 2022/03/10 07:48:58 MST
      7. ==> Config:
      8.     connectInject:
      9.       enabled: true
      10.       metrics:
      11.         defaultEnableMerging: true
      12.         defaultEnabled: true
      14.     controller:
      15.       enabled: true
      16.     global:
      17.       metrics:
      18.         enableAgentMetrics: true
      19.         enabled: true
      20.       name: consul
      21.     prometheus:
      22.       enabled: true
      23.     server:
      24.       replicas: 1
      25.     ui:
      26.       enabled: true
      27.       service:
      28.         enabled: true
      30.  ✓ Consul servers healthy (1/1)
      31.  ✓ Consul clients healthy (3/3)

      The consul-k8s upgrade subcommand is currently in beta: This subcommand is not recommended for production environments.

      The upgrade command upgrades the Consul on Kubernetes components to the current version of the consul-k8s cli. Prior to running consul-k8s upgrade, the consul-k8s CLI should first be upgraded to the latest version as described 

      1. $ consul-k8s upgrade
      1. $ consul-k8s upgrade

      The following options are available.

      See Global Options for additional commands that you can use when installing Consul on Kubernetes.

      The version command prints the Consul on Kubernetes version. This command does not take any options.

      1. $ consul-k8s version
      1. $ consul-k8s version

      You can also print the version with the --version flag.

      1. $ consul-k8s --version