forked from influxdata/docs-v2
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Release influxctl v2.6.0 (influxdata#5370)
* Release influxctl v2.6.0 * Update change log * Apply suggestions from code review * Add 'influxctl management' commands (influxdata#5364) (influxdata#5371) * adds influxctl management commands to cloud-dedicated * updated verbiage for revoking a management token * Apply suggestions from code review * port influxctl management commands to clustered, update format verbiage --------- Co-authored-by: Jason Stirnaman <[email protected]> --------- Co-authored-by: Scott Anderson <[email protected]> Co-authored-by: Jason Stirnaman <[email protected]>
- Loading branch information
3 people
authored
Mar 18, 2024
1 parent
30f9fa0
commit 96515a9
Showing
31 changed files
with
625 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
content/influxdb/cloud-dedicated/reference/cli/influxctl/management/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| title: influxctl management | ||
| description: > | ||
| The `influxctl management` command and its subcommands manage management | ||
| tokens in an InfluxDB Cloud Dedicated cluster. | ||
| menu: | ||
| influxdb_cloud_dedicated: | ||
| parent: influxctl | ||
| weight: 201 | ||
| --- | ||
|
|
||
| The `influxctl management` command and its subcommands manage management tokens | ||
| in an {{< product-name omit=" Clustered" >}} cluster. | ||
|
|
||
| Management tokens allow the user to perform administrative tasks on the | ||
| InfluxDB instance. This includes creating and deleting databases, managing | ||
| users, and other administrative tasks. | ||
|
|
||
| Management tokens do not provide access to databases or data in databases. | ||
| Only _database tokens_ with "read" or "write" permissions can access data in | ||
| databases. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```sh | ||
| influxctl management [subcommand] [flags] | ||
| ``` | ||
|
|
||
| ## Subcommands | ||
|
|
||
| | Subcommand | Description | | ||
| | :----------------------------------------------------------------------------- | :------------------------------ | | ||
| | [create](/influxdb/cloud-dedicated/reference/cli/influxctl/management/create/) | Create a management token | | ||
| | [list](/influxdb/cloud-dedicated/reference/cli/influxctl/management/list/) | List all management tokens | | ||
| | [revoke](/influxdb/cloud-dedicated/reference/cli/influxctl/management/revoke/) | Revoke a management token by ID | | ||
| | help, h | Output command help | | ||
|
|
||
| ## Flags | ||
|
|
||
| | Flag | | Description | | ||
| | :--- | :------- | :------------------ | | ||
| | `-h` | `--help` | Output command help | |
85 changes: 85 additions & 0 deletions
85
content/influxdb/cloud-dedicated/reference/cli/influxctl/management/create.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| --- | ||
| title: influxctl management create | ||
| description: > | ||
| The `influxctl management create` command creates a management token used to | ||
| perform administrative tasks in an InfluxDB Cloud Dedicated cluster. | ||
| menu: | ||
| influxdb_cloud_dedicated: | ||
| parent: influxctl management | ||
| weight: 301 | ||
| --- | ||
|
|
||
| The `influxctl management create` command creates a management token to be used | ||
| with an {{< product-name omit=" Clustered" >}} cluster. | ||
| Management tokens authorize a user to perform administrative tasks on the | ||
| InfluxDB instance such as creating and deleting databases, managing users, and | ||
| other administrative tasks. | ||
|
|
||
| {{% note %}} | ||
| Management tokens do not provide access to databases or data in databases. | ||
| Only _database tokens_ with "read" or "write" permissions can access data in | ||
| databases. | ||
| {{% /note %}} | ||
|
|
||
| The optional `--expires-at` flag defines the token expiration date and time. | ||
| Provide an RFC3999 date string--for example: `{{< datetime/current-date offset=1 >}}`. | ||
| If not set, the token does not expire until revoked. | ||
|
|
||
| The `--format` flag lets you print the output in other formats. | ||
| The `json` format is available for programmatic parsing by other tooling. | ||
| Default: `table`. | ||
|
|
||
| {{% note %}} | ||
| #### Store secure tokens in a secret store | ||
|
|
||
| Management token strings are returned _only_ on token creation. | ||
| We recommend storing management tokens in a **secure secret store**. | ||
| {{% /note %}} | ||
|
|
||
| ## Usage | ||
|
|
||
| ```sh | ||
| influxctl management create [flags] | ||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
||
| | Flag | | Description | | ||
| | :--- | :-------------- | :-------------------------------------------- | | ||
| | | `--description` | Management token description | | ||
| | | `--expires-at` | Token expiration date | | ||
| | | `--format` | Output format (`table` _(default)_ or `json`) | | ||
| | `-h` | `--help` | Output command help | | ||
|
|
||
| {{% caption %}} | ||
| _Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._ | ||
| {{% /caption %}} | ||
|
|
||
| ## Examples | ||
|
|
||
| - [Create a management token with no expiration](#create-a-management-token-with-no-expiration) | ||
| - [Create a management token with an expiration and description](#create-a-management-token-with-an-expiration-and-description) | ||
|
|
||
| ### Create a management token with no expiration | ||
|
|
||
| ```sh | ||
| influxctl management create | ||
| ``` | ||
|
|
||
| ### Create a management token with an expiration and description | ||
|
|
||
| {{% code-placeholders "RFC3339_EXPIRATION|TOKEN_DESCRIPTION" %}} | ||
| ```sh | ||
| influxctl management create \ | ||
| --expire-at RFC3339_EXPIRATION \ | ||
| --description TOKEN_DESCRIPTION | ||
| ``` | ||
| {{% /code-placeholders %}} | ||
|
|
||
| Replace the following: | ||
|
|
||
| - {{% code-placeholder-key %}}`RFC3339_EXPIRATION`{{% /code-placeholder-key %}}: | ||
| An RFC3339 date string to expire the token at--for example: | ||
| `{{< datetime/current-date offset=1 >}}`. | ||
| - {{% code-placeholder-key %}}`TOKEN_DESCRIPTION`{{% /code-placeholder-key %}}: | ||
| Management token description. |
47 changes: 47 additions & 0 deletions
47
content/influxdb/cloud-dedicated/reference/cli/influxctl/management/list.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: influxctl management list | ||
| description: > | ||
| The `influxctl management list` command lists all management tokens used to | ||
| perform administrative tasks in an InfluxDB Cloud Dedicated cluster. | ||
| menu: | ||
| influxdb_cloud_dedicated: | ||
| parent: influxctl management | ||
| weight: 301 | ||
| --- | ||
|
|
||
| The `influxctl management list` command lists all management tokens used to | ||
| perform administrative tasks in an {{< product-name omit=" Clustered" >}} cluster. | ||
| It returns the token description and other relevant information. | ||
|
|
||
| {{% note %}} | ||
| #### Management token strings are not retrievable | ||
|
|
||
| The actual management token string is not printed and is only returned when | ||
| creating the token. | ||
|
|
||
| #### Revoked tokens are included in output | ||
|
|
||
| Revoked tokens still appear when listing management tokens, but they are no | ||
| longer valid for any operations. | ||
| {{% /note %}} | ||
|
|
||
| The `--format` flag lets you print the output in other formats. | ||
| The `json` format is available for programmatic parsing by other tooling. | ||
| Default: `table`. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```sh | ||
| influxctl management list [--format=table|json] | ||
| ``` | ||
|
|
||
| ## Flags | ||
|
|
||
| | Flag | | Description | | ||
| | :--- | :--------- | :-------------------------------------------- | | ||
| | | `--format` | Output format (`table` _(default)_ or `json`) | | ||
| | `-h` | `--help` | Output command help | | ||
|
|
||
| {{% caption %}} | ||
| _Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._ | ||
| {{% /caption %}} |
78 changes: 78 additions & 0 deletions
78
content/influxdb/cloud-dedicated/reference/cli/influxctl/management/revoke.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| --- | ||
| title: influxctl management revoke | ||
| description: > | ||
| The `influxctl management revoke` command revokes management token access | ||
| to your InfluxDB Cloud Dedicated cluster. | ||
| menu: | ||
| influxdb_cloud_dedicated: | ||
| parent: influxctl management | ||
| weight: 301 | ||
| --- | ||
|
|
||
| The `influxctl management revoke` command revokes management token access | ||
| to your {{< product-name omit=" Clustered" >}} cluster. | ||
| **This operation cannot be undone**. | ||
|
|
||
| {{% note %}} | ||
| #### Revoked tokens are included when listing tokens | ||
|
|
||
| Revoked tokens still appear when | ||
| [listing management tokens](/influxdb/cloud-dedicated/reference/cli/influxctl/management/list/), | ||
| but they are no longer valid for any operations. | ||
| {{% /note %}} | ||
|
|
||
| ## Usage | ||
|
|
||
| ```sh | ||
| influxctl management revoke [flags] <TOKEN_ID>[ ... TOKEN_ID_N] | ||
| ``` | ||
|
|
||
| ## Arguments | ||
|
|
||
| | Argument | Description | | ||
| | :----------- | :--------------------------------------------------------- | | ||
| | **TOKEN_ID** | Token ID(s) to revoke access from (space-delimit multiple IDs) | | ||
|
|
||
| ## Flags | ||
|
|
||
| | Flag | | Description | | ||
| | :--- | :-------- | :--------------------------------------- | | ||
| | | `--force` | Do not prompt for confirmation to revoke | | ||
| | `-h` | `--help` | Output command help | | ||
|
|
||
| {{% caption %}} | ||
| _Also see [`influxctl` global flags](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags)._ | ||
| {{% /caption %}} | ||
|
|
||
| ## Examples | ||
|
|
||
| - [Revoke access from a management token](#revoke-access-from-a-management-token) | ||
| - [Revoke access from multiple management tokens](#revoke-access-from-multiple-management-tokens) | ||
| - [Revoke access from a token and skip confirmation](#revoke-access-from-a-token-and-skip-confirmation) | ||
|
|
||
| In the examples below, replace the following: | ||
|
|
||
| - {{% code-placeholder-key %}}`TOKEN_ID*`{{% /code-placeholder-key %}}: | ||
| Token ID to revoke access from. | ||
|
|
||
| {{% code-placeholders "TOKEN_ID(_[1-2])?" %}} | ||
|
|
||
| ### Revoke access from a management token | ||
|
|
||
| ```sh | ||
| influxctl management revoke TOKEN_ID | ||
| ``` | ||
|
|
||
| ### Revoke access from multiple management tokens | ||
|
|
||
| ```sh | ||
| influxctl management revoke TOKEN_ID_1 TOKEN_ID_2 | ||
| ``` | ||
|
|
||
| ### Revoke access from a token and skip confirmation | ||
|
|
||
| ```sh | ||
| influxctl management revoke --force TOKEN_ID | ||
| ``` | ||
|
|
||
| {{% /code-placeholder-key %}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.