add docs for consul-k8s config read command

This PR adds documentation for the functionality introduced in hashicorp/consul-k8s#2078.
hashicorp · May 25, 2023 · 6e53750 · 6e53750
1 parent a90c9ce
commit 6e53750
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/website/content/docs/k8s/k8s-cli.mdx b/website/content/docs/k8s/k8s-cli.mdx
@@ -28,6 +28,8 @@ $ consul-k8s <COMMAND> <OPTIONS>
 
 You can use the following commands with `consul-k8s`.
 
+  - [`config`](#config): Interact with helm configuration.
+      - [`config read`](#config-read): Read helm configuration of a Consul installation.
   - [`install`](#install): Install Consul on Kubernetes.
   - [`proxy`](#proxy): Inspect Envoy proxies managed by Consul.
       - [`proxy list`](#proxy-list): List all Pods running proxies managed by Consul.
@@ -39,6 +41,34 @@ You can use the following commands with `consul-k8s`.
   - [`upgrade`](#upgrade): Upgrade Consul on Kubernetes from an existing installation.
   - [`version`](#version): Print the version of the Consul on Kubernetes CLI.
 
+### `config`
+
+The `config` command exposes the `read` subcommand that allows to read the helm configuration of a Consul installation.
+
+- [`config read`](#config-read): Read helm configuration of a Consul installation.
+
+### `config read`
+
+```shell-session
+$ consul-k8s config read <OPTIONS>
+```
+
+| Flag                                 | Description                                           | Default                                                                                                                |
+| ------------------------------------ | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| <nobr>`-all-namespaces`, `-A`</nobr> | `Boolean` List pods in all Kubernetes namespaces.     | `false`                                                                                                                |
+| <nobr>`-namespace`, `-n`</nobr>      | `String` The Kubernetes namespace to list proxies in. | Current [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) namespace. |
+
+Refer to the [Global Options](#global-options) for additional options that you can use
+when installing Consul on Kubernetes.
+
+#### Example Commands
+
+The following example command reads the Helm configuration in the `myNS` namespace.
+
+```shell-session
+$ consul-k8s config read -namespace=myNS
+```
+
 ### `install`
 
 The `install` command installs Consul on your Kubernetes cluster.