mirror of https://github.com/status-im/consul.git
Remove "Required" column from options (they are all optional)
This commit is contained in:
Thomas Eckert
parent
418bc1ca04
commit
89f3b2979f
|
|
@ -46,20 +46,20 @@ $ consul-k8s install <OPTIONS>
|
|||
|
||||
The following options are available.
|
||||
|
||||
| Flag | Description | Default | Required |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -------- |
|
||||
| `-auto-approve` | Boolean value that enables you to skip the installation confirmation prompt. | `false` | Optional |
|
||||
| `-dry-run` | Boolean value that validates the installation and returns a summary. | `false` | Optional |
|
||||
| `-config-file` | String value that specifies the path to a file containing custom installation configurations, e.g., Consul Helm chart values file. <br/> You can use the `-config-file` flag multiple times to specify multiple files. | none | Optional |
|
||||
| `-namespace` | String value that specifies the namespace of the Consul installation. | `consul` | Optional |
|
||||
| `-preset` | String value that installs Consul based on a preset configuration. You can specify the following values: <br/> `demo`: Installs a single replica server with sidecar injection enabled; useful for testing service mesh functionality. <br/> `secure`: Installs a single replica server with sidecar injection, ACLs, and TLS enabled; useful for testing service mesh functionality. | Configuration of the Consul Helm chart. | Optional |
|
||||
| `-set` | String value that enables you to set a customizable value. This flag is comparable to the `helm install --set` flag. <br/> You can use the `-set` flag multiple times to set multiple values. <br/> Consul Helm chart values are supported. | none | Optional |
|
||||
| `-set-file` | String value that specifies the name of an arbitrary config file. This flag is comparable to the `helm install --set-file` <br/> flag. The contents of the file will be used to set a customizable value. You can use the `-set-file` flag multiple times to specify multiple files. <br/> Consul Helm chart values are supported. | none | Optional |
|
||||
| `-set-string` | String value that enables you to set a customizable string value. This flag is comparable to the `helm install --set-string` <br/> flag. 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` | `10m` | Optional |
|
||||
| `-wait` | Boolean value that determines if Consul should wait for resources in the installation to be ready before exiting the command. | `true` | Optional |
|
||||
| `-verbose`, `-v` | Boolean value that specifies whether to output verbose logs from the install command with the status of resources being installed. | `false` | Optional |
|
||||
| `-help`, `-h` | Prints usage information for this option. | none | Optional |
|
||||
| Flag | Description | Default |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||||
| `-auto-approve` | Boolean value that enables you to skip the installation confirmation prompt. | `false` |
|
||||
| `-dry-run` | Boolean value that validates the installation and returns a summary. | `false` |
|
||||
| `-config-file` | String value that specifies the path to a file containing custom installation configurations, e.g., Consul Helm chart values file. <br/> You can use the `-config-file` flag multiple times to specify multiple files. | none |
|
||||
| `-namespace` | String value that specifies the namespace of the Consul installation. | `consul` |
|
||||
| `-preset` | String value that installs Consul based on a preset configuration. You can specify the following values: <br/> `demo`: Installs a single replica server with sidecar injection enabled; useful for testing service mesh functionality. <br/> `secure`: Installs a single replica server with sidecar injection, ACLs, and TLS enabled; useful for testing service mesh functionality. | Configuration of the Consul Helm chart. |
|
||||
| `-set` | String value that enables you to set a customizable value. This flag is comparable to the `helm install --set` flag. <br/> You can use the `-set` flag multiple times to set multiple values. <br/> Consul Helm chart values are supported. | none |
|
||||
| `-set-file` | String value that specifies the name of an arbitrary config file. This flag is comparable to the `helm install --set-file` <br/> flag. The contents of the file will be used to set a customizable value. You can use the `-set-file` flag multiple times to specify multiple files. <br/> Consul Helm chart values are supported. | none |
|
||||
| `-set-string` | String value that enables you to set a customizable string value. This flag is comparable to the `helm install --set-string` <br/> flag. You can use the `-set-string` flag multiple times to specify multiple strings. <br/> Consul Helm chart values are supported. | none |
|
||||
| `-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` | `10m` |
|
||||
| `-wait` | Boolean value that determines if Consul should wait for resources in the installation to be ready before exiting the command. | `true` |
|
||||
| `-verbose`, `-v` | Boolean value that specifies whether to output verbose logs from the install command with the status of resources being installed. | `false` |
|
||||
| `-help`, `-h` | Prints usage information for this option. | none |
|
||||
|
||||
See [Global Options](#global-options) for additional commands that you can use when installing Consul on Kubernetes.
|
||||
|
||||
|
|
@ -106,10 +106,10 @@ Consul in your Kubernetes Cluster.
|
|||
$ consul-k8s proxy list <OPTIONS>
|
||||
```
|
||||
|
||||
| Flag | Description | Default | Required |
|
||||
| -------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------- |
|
||||
| `-all-namespaces`, `-A` | `Boolean` List pods in all Kubernetes namespaces. | `false` | Optional |
|
||||
| `-namespace`, `-n` | `String` The Kubernetes namespace to list proxies in. | Current [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) namespace. | Optional |
|
||||
| Flag | Description | Default |
|
||||
| -------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| `-all-namespaces`, `-A` | `Boolean` List pods in all Kubernetes namespaces. | `false` |
|
||||
| `-namespace`, `-n` | `String` The Kubernetes namespace to list proxies in. | Current [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) namespace. |
|
||||
|
||||
See [Global Options](#global-options) for additional commands that you can use
|
||||
when installing Consul on Kubernetes.
|
||||
|
|
@ -194,18 +194,18 @@ of a Kubernetes Pod.
|
|||
|
||||
The following options are available.
|
||||
|
||||
| Flag | Description | Default | Required |
|
||||
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | -------- |
|
||||
| `-namespace`, `-n` | `String` The namespace where the target Pod can be found. | Current [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) namespace. | Optional |
|
||||
| `-output`, `-o` | `String` Output the Envoy configuration as 'table', 'json', or 'raw'. | `'table'` | Optional |
|
||||
| `-clusters` | `Boolean` Filter output to only show clusters. | `false` | Optional |
|
||||
| `-endpoints` | `Boolean` Filter output to only show endpoints. | `false` | Optional |
|
||||
| `-listeners` | `Boolean` Filter output to only show listeners. | `false` | Optional |
|
||||
| `-routes` | `Boolean` Filter output to only show routes. | `false` | Optional |
|
||||
| `-secrets` | `Boolean` Filter output to only show secrets. | `false` | Optional |
|
||||
| `-address` | `String` Filter clusters, endpoints, and listeners output to only those with endpoint addresses which contain the given value. | `""` | Optional |
|
||||
| `-fqdn` | `String` Filter cluster output to only clusters with a fully qualified domain name which contains the given value. | `""` | Optional |
|
||||
| `-port` | `Int` Filter endpoints output to only endpoints with the given port number. | `-1` which does not filter by port | Optional |
|
||||
| Flag | Description | Default |
|
||||
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| `-namespace`, `-n` | `String` The namespace where the target Pod can be found. | Current [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) namespace. |
|
||||
| `-output`, `-o` | `String` Output the Envoy configuration as 'table', 'json', or 'raw'. | `'table'` |
|
||||
| `-clusters` | `Boolean` Filter output to only show clusters. | `false` |
|
||||
| `-endpoints` | `Boolean` Filter output to only show endpoints. | `false` |
|
||||
| `-listeners` | `Boolean` Filter output to only show listeners. | `false` |
|
||||
| `-routes` | `Boolean` Filter output to only show routes. | `false` |
|
||||
| `-secrets` | `Boolean` Filter output to only show secrets. | `false` |
|
||||
| `-address` | `String` Filter clusters, endpoints, and listeners output to only those with endpoint addresses which contain the given value. | `""` |
|
||||
| `-fqdn` | `String` Filter cluster output to only clusters with a fully qualified domain name which contains the given value. | `""` |
|
||||
| `-port` | `Int` Filter endpoints output to only endpoints with the given port number. | `-1` which does not filter by port |
|
||||
|
||||
#### Example commands
|
||||
|
||||
|
|
@ -404,14 +404,14 @@ $ consul-k8s uninstall <OPTIONS>
|
|||
|
||||
The following options are available.
|
||||
|
||||
| Flag | Description | Default | Required |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -------- |
|
||||
| `-auto-approve` | Boolean value that enables you to skip the removal confirmation prompt. | `false` | Optional |
|
||||
| `-name` | String value for the name of the installation to remove. | none | Optional |
|
||||
| `-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` | `10m` | Optional |
|
||||
| `-wipe-data` | Boolean 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 |
|
||||
| Flag | Description | Default |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `-auto-approve` | Boolean value that enables you to skip the removal confirmation prompt. | `false` |
|
||||
| `-name` | String value for the name of the installation to remove. | none |
|
||||
| `-namespace` | String value that specifies the namespace of the Consul installation to remove. | `consul` |
|
||||
| `-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` | `10m` |
|
||||
| `-wipe-data` | Boolean 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. |
|
||||
| `--help` | Prints usage information for this option. | none |
|
||||
|
||||
See [Global Options](#global-options) for additional commands that you can use when uninstalling Consul from Kubernetes.
|
||||
|
||||
|
|
@ -435,20 +435,20 @@ $ consul-k8s upgrade
|
|||
|
||||
The following options are available.
|
||||
|
||||
| Flag | Description | Default | Required |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -------- |
|
||||
| `-auto-approve` | Boolean value that enables you to skip the upgrade confirmation prompt. | `false` | Optional |
|
||||
| `-dry-run` | Boolean value that allows you to run pre-upgrade checks and returns a summary of the upgrade. | `false` | Optional |
|
||||
| `-config-file` | String value that specifies the path to a file containing custom upgrade configurations, e.g., Consul Helm chart values file. <br/> You can use the `-config-file` flag multiple times to specify multiple files. | none | Optional |
|
||||
| `-namespace` | String value that specifies the namespace of the Consul installation. | `consul` | Optional |
|
||||
| `-preset` | String value that upgrades Consul based on a preset configuration. | Configuration of the Consul Helm chart. | Optional |
|
||||
| `-set` | String value that enables you to set a customizable value. This flag is comparable to the `helm upgrade --set` flag. <br/> You can use the `-set` flag multiple times to set multiple values. <br/> Consul Helm chart values are supported. | none | Optional |
|
||||
| `-set-file` | String value that specifies the name of an arbitrary config file. This flag is comparable to the `helm upgrade --set-file` <br/> flag. The contents of the file will be used to set a customizable value. You can use the `-set-file` flag multiple times to specify multiple files. <br/> Consul Helm chart values are supported. | none | Optional |
|
||||
| `-set-string` | String value that enables you to set a customizable string value. This flag is comparable to the `helm upgrade --set-string` <br/> flag. 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 upgrade 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, the upgrade will timeout after one minute:<br/> `consul-k8s upgrade -timeout 1m` | `10m` | Optional |
|
||||
| `-wait` | Boolean value that determines if Consul should wait for resources in the upgrade to be ready before exiting the command. | `true` | Optional |
|
||||
| `-verbose`, `-v` | Boolean value that specifies whether to output verbose logs from the upgrade command with the status of resources being upgraded. | `false` | Optional |
|
||||
| `--help` | Prints usage information for this option. | none | Optional |
|
||||
| Flag | Description | Default |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
|
||||
| `-auto-approve` | Boolean value that enables you to skip the upgrade confirmation prompt. | `false` |
|
||||
| `-dry-run` | Boolean value that allows you to run pre-upgrade checks and returns a summary of the upgrade. | `false` |
|
||||
| `-config-file` | String value that specifies the path to a file containing custom upgrade configurations, e.g., Consul Helm chart values file. <br/> You can use the `-config-file` flag multiple times to specify multiple files. | none |
|
||||
| `-namespace` | String value that specifies the namespace of the Consul installation. | `consul` |
|
||||
| `-preset` | String value that upgrades Consul based on a preset configuration. | Configuration of the Consul Helm chart. |
|
||||
| `-set` | String value that enables you to set a customizable value. This flag is comparable to the `helm upgrade --set` flag. <br/> You can use the `-set` flag multiple times to set multiple values. <br/> Consul Helm chart values are supported. | none |
|
||||
| `-set-file` | String value that specifies the name of an arbitrary config file. This flag is comparable to the `helm upgrade --set-file` <br/> flag. The contents of the file will be used to set a customizable value. You can use the `-set-file` flag multiple times to specify multiple files. <br/> Consul Helm chart values are supported. | none |
|
||||
| `-set-string` | String value that enables you to set a customizable string value. This flag is comparable to the `helm upgrade --set-string` <br/> flag. You can use the `-set-string` flag multiple times to specify multiple strings. <br/> Consul Helm chart values are supported. | none |
|
||||
| `-timeout` | Specifies how long to wait for the upgrade 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, the upgrade will timeout after one minute:<br/> `consul-k8s upgrade -timeout 1m` | `10m` |
|
||||
| `-wait` | Boolean value that determines if Consul should wait for resources in the upgrade to be ready before exiting the command. | `true` |
|
||||
| `-verbose`, `-v` | Boolean value that specifies whether to output verbose logs from the upgrade command with the status of resources being upgraded. | `false` |
|
||||
| `--help` | Prints usage information for this option. | none |
|
||||
|
||||
See [Global Options](#global-options) for additional commands that you can use when installing Consul on Kubernetes.
|
||||
|
||||
|
|
@ -470,7 +470,7 @@ $ consul-k8s --version
|
|||
|
||||
The following global options are available.
|
||||
|
||||
| Flag | Description | Default | Required |
|
||||
| ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------- | -------- |
|
||||
| `-context` | String value that sets the Kubernetes context to use for Consul K8s CLI operations. | none | Optional |
|
||||
| `-kubeconfig` <br/> Alias: `-c` | String value that specifies the path to the `kubeconfig` file. <br/> | none | Optional |
|
||||
| Flag | Description | Default |
|
||||
| ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------- |
|
||||
| `-context` | String value that sets the Kubernetes context to use for Consul K8s CLI operations. | none |
|
||||
| `-kubeconfig` <br/> Alias: `-c` | String value that specifies the path to the `kubeconfig` file. <br/> | none |
|
||||
|
|
|
|||
Loading…
Reference in New Issue