Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Backport of add docs for consul-k8s config read command into release/1.15.x #17473

Merged
merged 4 commits into from
Jun 5, 2023
Merged

Backport of add docs for consul-k8s config read command into release/1.15.x #17473

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b116618
backport of commit 6e537507efda59ac982febb9cf0b921140317922
hanshasselberg May 25, 2023
1ed6319
backport of commit fbdab01e8548635ff86ebc0ae1241ea35ce0d20f
hanshasselberg May 25, 2023
056e092
trigger ci
hanshasselberg May 25, 2023
e81c3f8
Merge branch 'release/1.15.x' into backport/hans/add_k8s_config_read_…
hanshasselberg May 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions website/content/docs/k8s/k8s-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -39,6 +41,51 @@ 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
```

```
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`

The `install` command installs Consul on your Kubernetes cluster.
Expand Down