github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

added version flag to consul-k8s cli docs

pull/11214/head
trujillo-adam 3 years ago
parent
ab587f5221
commit
853512f479
1 changed files with 25 additions and 0 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 25
      website/content/docs/k8s/k8s-cli.mdx

25
website/content/docs/k8s/k8s-cli.mdx
Unescape View File

@ -27,6 +27,13 @@ This topic describes the commands, subcommands, and available options for using
mv bin/consul-k8s /usr/local/bin/consul-k8s
```
1. (Optional) Issue the `consul-k8s version` command to verify the installation:
```shell-session
bin/consul-k8s version
consul-k8s 0.34.1-dev
```
## Usage
Consul K8s CLI uses the following syntax:
@ -61,6 +68,7 @@ The following options are available.
| `-set-string` | String value that enables you to set a customizeable string value. <br/> You can use the `-set-string` flag multiple times to specify multiple strings. <br/> Consul Helm chart values are supported. | none | Optional |
| `-timeout` | Specifies how long to wait for the installation process to complete before timing out. The value is specified with an integer and string value indicating a unit of time. <br/> The following units are supported: <br/> `ms` (milliseconds)<br/>`s` (seconds)<br/>`m` (minutes) <br/>In the following example, installation will timeout after one minute:<br/> `consul-k8s install -timeout 1m` | Optional | `10m` |
| `-wait` | Boolean value that determines if Consul should wait for resources in the installation to be ready before exiting the command. | Optional | `true` |
| `--help` | Prints usage information for this option. | none | Optional |
See [Global Options](#global-options) for additional commands that you can use when installing Consul on Kubernetes.
@ -89,6 +97,7 @@ The following options are available.
| `-namespace` | String value that specifies the namespace of the Consul installation to remove. | `consul` | Optional |
| `-timeout` | Specifies how long to wait for the removal process to complete before timing out. The value is specified with an integer and string value indicating a unit of time. <br/> The following units are supported: <br/> `ms` (milliseconds)<br/>`s` (seconds)<br/>`m` (minutes) <br/>`h` (hours) <br/>In the following example, removal will timeout after one minute:<br/> `consul-k8s uninstall -timeout 1m` | Optional | `10m` |
| `-wipe-data` | Boolan value that deletes PVCs and secrets associated with the Consul installation during installation. <br/> Data will be removed without a verification prompt if the `-auto-approve` flag is set to `true`. | `false` <br/> Instructions for removing data will be printed to the console. | Optional |
| `--help` | Prints usage information for this option. | none | Optional |
See [Global Options](#global-options) for additional commands that you can use when uninstalling Consul from Kubernetes.
@ -100,6 +109,22 @@ The following example command immediately uninstalls Consul from the `my-ns` nam
consul-k8s uninstall -namespace=my-ns -name=my-consul -wipe-data=true -auto-approve=true
```
## `version`
The `version` command prints the Consul version.
```shell-session
consul-k8s version
```
This command does not take any options.
You can also print the version with the `--version` flag.
```shell-session
consul-k8s --version
```
## Global Options
The following global options are available.

Write Preview
Loading…
Cancel
Save