add docs for consul-k8s config read command (#17461)
* add docs for consul-k8s config read command This PR adds documentation for the functionality introduced in https://github.com/hashicorp/consul-k8s/pull/2078. * add output --------- Co-authored-by: David Yu <dyu@hashicorp.com>
This commit is contained in:
parent
90d12cd62c
commit
57b34cf420
|
@ -28,6 +28,8 @@ $ consul-k8s <COMMAND> <OPTIONS>
|
||||||
|
|
||||||
You can use the following commands with `consul-k8s`.
|
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.
|
- [`install`](#install): Install Consul on Kubernetes.
|
||||||
- [`proxy`](#proxy): Inspect Envoy proxies managed by Consul.
|
- [`proxy`](#proxy): Inspect Envoy proxies managed by Consul.
|
||||||
- [`proxy list`](#proxy-list): List all Pods running proxies managed by Consul.
|
- [`proxy list`](#proxy-list): List all Pods running proxies managed by Consul.
|
||||||
|
@ -39,6 +41,51 @@ You can use the following commands with `consul-k8s`.
|
||||||
- [`upgrade`](#upgrade): Upgrade Consul on Kubernetes from an existing installation.
|
- [`upgrade`](#upgrade): Upgrade Consul on Kubernetes from an existing installation.
|
||||||
- [`version`](#version): Print the version of the Consul on Kubernetes CLI.
|
- [`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
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
global:
|
||||||
|
cloud:
|
||||||
|
clientId:
|
||||||
|
secretKey: client-id
|
||||||
|
secretName: consul-hcp-client-id
|
||||||
|
clientSecret:
|
||||||
|
secretKey: client-secret
|
||||||
|
secretName: consul-hcp-client-secret
|
||||||
|
enabled: true
|
||||||
|
resourceId:
|
||||||
|
secretKey: resource-id
|
||||||
|
secretName: consul-hcp-resource-id
|
||||||
|
image: hashicorp/consul:1.14.7
|
||||||
|
name: consul
|
||||||
|
```
|
||||||
|
|
||||||
### `install`
|
### `install`
|
||||||
|
|
||||||
The `install` command installs Consul on your Kubernetes cluster.
|
The `install` command installs Consul on your Kubernetes cluster.
|
||||||
|
|
Loading…
Reference in New Issue