updated secret update documentation, resolves #785

pull/786/head
Scott Anderson 2020-02-27 16:04:48 -07:00
parent 16d60bcad1
commit d3cb7a6483
3 changed files with 31 additions and 9 deletions

View File

@ -11,7 +11,14 @@ v2.0/tags: [secrets]
The `influx secret update` command adds and updates secrets.
Provide the secret key with the `-k` or `--key` flag.
When prompted, enter and confirm the secret value.
You may also provide the secret value with the `-v` or `--value` flag.
If you do not provide the secret value with the `-v` or `--value` flag,
enter the value when prompted.
{{% warn %}}
Providing a secret value with the `-v` or `--value` flag may expose the secret
in your command history.
{{% /warn %}}
## Usage
```
@ -19,11 +26,12 @@ influx secret update [flags]
```
## Flags
| Flag | Description | Input type |
|:---- |:----------- |:----------:|
| `-h`, `--help` | Help for `secret update` | |
| `-k`, `--key` | Secret key _**(required)**_ | string |
| `-o`, `--org` | Organization name | string |
| `--org-id` | Organization ID | string |
| Flag | Description | Input type |
|:---- |:----------- |:----------:|
| `-h`, `--help` | Help for `secret update` | |
| `-k`, `--key` | Secret key _**(required)**_ | string |
| `-o`, `--org` | Organization name | string |
| `--org-id` | Organization ID | string |
| `-v`, `--value` | Secret value | string |
{{% influx-cli-global-flags %}}

View File

@ -14,7 +14,14 @@ Add secrets using the `influx` command line interface (CLI) or the InfluxDB API.
Use the [`influx secret update` command](/v2.0/reference/cli/influx/secret/update/)
to add a new secret to your organization.
Provide the secret key with the `-k` or `--key` flag.
When prompted, enter and confirm the secret value.
You may also provide the secret value with the `-v` or `--value` flag.
If you do not provide the secret value with the `-v` or `--value` flag,
enter the value when prompted.
{{% warn %}}
Providing a secret value with the `-v` or `--value` flag may expose the secret
in your command history.
{{% /warn %}}
```sh
# Syntax

View File

@ -14,7 +14,14 @@ Update secrets using the `influx` command line interface (CLI) or the InfluxDB A
Use the [`influx secret update` command](/v2.0/reference/cli/influx/secret/update/)
to update a secret in your organization.
Provide the secret key to update with the `-k` or `--key` flag.
When prompted, enter and confirm the secret value.
You may also provide the secret value with the `-v` or `--value` flag.
If you do not provide the secret value with the `-v` or `--value` flag,
enter the value when prompted.
{{% warn %}}
Providing a secret value with the `-v` or `--value` flag may expose the secret
in your command history.
{{% /warn %}}
```sh
# Syntax