»Consul K8s CLI Reference

Consul K8s CLI is a tool for quickly installing and interacting with Consul on Kubernetes. This topic describes the subcommands and available options for using Consul K8s CLI.

»Usage

Consul K8s CLI uses the following syntax:

consul-k8s <SUBCOMMAND> <OPTIONS>

consul-k8s <SUBCOMMAND> <OPTIONS>

»Subcommands

You can use the following subcommands with consul-k8s.

• install
• uninstall
• status
• upgrade ^BETA
• version

»install

The install command installs Consul on Kubernetes.

consul-k8s install <OPTIONS>

consul-k8s install <OPTIONS>

The following options are available.

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

»Example Commands

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

consul-k8s install -preset=secure -namespace=myNS

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 flags.

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

consul-k8s install -set key=valueconsul-k8s install -set key1=value1 -set key2=value2consul-k8s install -set-file config1=value1.confconsul-k8s install -set-file config1=value1.conf -set-file config2=value2.confconsul-k8s install -set-string key=value-boolconsul-k8s install -set key1=value1 -set key2=value2

»uninstall

The uninstall command removes Consul from Kubernetes.

consul-k8s uninstall <OPTIONS>

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:

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

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

»status

The status command provides an overall status summary of the Consul on Kubernetes installation. It also provides the config that was used to deploy Consul K8s and provides a quick glance at the health of both Consul servers and clients. This command does not take in any flags.

consul-k8s status

consul-k8s status

»Example Command

$ consul-k8s status

==> Consul-K8s Status Summary
   NAME  | NAMESPACE |  STATUS  | CHARTVERSION | APPVERSION | REVISION |      LAST UPDATED
---------+-----------+----------+--------------+------------+----------+--------------------------
  consul | consul    | deployed | 0.39.0       | 1.11.1     |        1 | 2021/12/16 15:42:39 PST

==> Config:
    connectInject:
      enabled: true
      metrics:
        defaultEnableMerging: true
        defaultEnabled: true
        enableGatewayMetrics: true
    controller:
      enabled: true
    global:
      metrics:
        enableAgentMetrics: true
        enabled: true
      name: consul
    prometheus:
      enabled: true
    server:
      replicas: 1
    ui:
      enabled: true
      service:
        enabled: true

 ✓ Consul servers healthy (1/1)
 ✓ Consul clients healthy (3/3)

$ consul-k8s status
==> Consul-K8s Status Summary   NAME  | NAMESPACE |  STATUS  | CHARTVERSION | APPVERSION | REVISION |      LAST UPDATED---------+-----------+----------+--------------+------------+----------+--------------------------  consul | consul    | deployed | 0.39.0       | 1.11.1     |        1 | 2021/12/16 15:42:39 PST
==> Config:    connectInject:      enabled: true      metrics:        defaultEnableMerging: true        defaultEnabled: true        enableGatewayMetrics: true    controller:      enabled: true    global:      metrics:        enableAgentMetrics: true        enabled: true      name: consul    prometheus:      enabled: true    server:      replicas: 1    ui:      enabled: true      service:        enabled: true
 ✓ Consul servers healthy (1/1) ✓ Consul clients healthy (3/3)

»upgrade

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 Upgrade the Consul K8s CLI

consul-k8s upgrade

consul-k8s upgrade

The following options are available.

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

»version

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

consul-k8s version

consul-k8s version

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

consul-k8s --version

consul-k8s --version

»Global Options

The following global options are available.