From 7bf799c3d033c2d802dee1dfe4e9ecd1e8f8e68b Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 28 May 2025 23:09:04 -0500 Subject: [PATCH] fix(mono): Update descriptions to be more operator-specific --- content/influxdb3/core/admin/tokens/admin/regenerate.md | 3 +-- .../core/reference/cli/influxdb3/create/token/_index.md | 2 +- .../core/reference/cli/influxdb3/create/token/admin.md | 5 ++--- .../influxdb3/enterprise/admin/tokens/admin/regenerate.md | 3 +-- .../reference/cli/influxdb3/create/token/admin.md | 3 +-- .../enterprise/reference/internals/authentication.md | 4 ++-- content/shared/influxdb3-cli/create/token/admin.md | 8 ++++++-- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/content/influxdb3/core/admin/tokens/admin/regenerate.md b/content/influxdb3/core/admin/tokens/admin/regenerate.md index c125ceda1..f8e8d7ab9 100644 --- a/content/influxdb3/core/admin/tokens/admin/regenerate.md +++ b/content/influxdb3/core/admin/tokens/admin/regenerate.md @@ -4,8 +4,7 @@ description: > Use the [`influxdb3 create token --admin` command](/influxdb3/core/reference/cli/influxdb3/create/token/) or the HTTP API [`/api/v3/configure/token/admin/regenerate`](/influxdb3/core/api/v3/#operation/PostRegenerateAdminToken) endpoint to regenerate an [operator token](/influxdb3/core/admin/tokens/admin/) for your {{< product-name omit="Clustered" >}} instance. - An admin token grants access to all actions on the server. - Regenerating an admin token deactivates the previous token. + Regenerating an operator token deactivates the previous token. menu: influxdb3_core: parent: Admin tokens diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/token/_index.md b/content/influxdb3/core/reference/cli/influxdb3/create/token/_index.md index e73d9850c..c85988446 100644 --- a/content/influxdb3/core/reference/cli/influxdb3/create/token/_index.md +++ b/content/influxdb3/core/reference/cli/influxdb3/create/token/_index.md @@ -5,7 +5,7 @@ description: > menu: influxdb3_core: parent: influxdb3 create - name: influxdb3 create token + name: influxdb3 create token weight: 400 source: /shared/influxdb3-cli/create/token/_index.md --- diff --git a/content/influxdb3/core/reference/cli/influxdb3/create/token/admin.md b/content/influxdb3/core/reference/cli/influxdb3/create/token/admin.md index 6e72540a0..a2646e4ec 100644 --- a/content/influxdb3/core/reference/cli/influxdb3/create/token/admin.md +++ b/content/influxdb3/core/reference/cli/influxdb3/create/token/admin.md @@ -1,12 +1,11 @@ --- title: influxdb3 create token admin description: > - The `influxdb3 create token --admin` command creates a new operator or named - admin authentication token. + The `influxdb3 create token admin` command creates an operator token or named admin token with full administrative privileges for server actions. menu: influxdb3_core: parent: influxdb3 create token - name: influxdb3 create token admin + name: influxdb3 create token admin weight: 400 source: /shared/influxdb3-cli/create/token/admin.md --- diff --git a/content/influxdb3/enterprise/admin/tokens/admin/regenerate.md b/content/influxdb3/enterprise/admin/tokens/admin/regenerate.md index ccf73ca14..7da106f73 100644 --- a/content/influxdb3/enterprise/admin/tokens/admin/regenerate.md +++ b/content/influxdb3/enterprise/admin/tokens/admin/regenerate.md @@ -3,8 +3,7 @@ title: Regenerate an operator admin token description: > Use the [`influxdb3 create token --admin` command](/influxdb3/enterprise/reference/cli/influxdb3/create/token/) or the [HTTP API](/influxdb3/enterprise/api/v3/) - to regenerate an [admin token](/influxdb3/enterprise/admin/tokens/admin/) for your {{< product-name omit="Clustered" >}} instance. - An operator token grants access to all actions on the server. + to regenerate an [operator token](/influxdb3/enterprise/admin/tokens/admin/) for your {{< product-name omit="Clustered" >}} instance. Regenerating an admin token deactivates the previous token. menu: influxdb3_enterprise: diff --git a/content/influxdb3/enterprise/reference/cli/influxdb3/create/token/admin.md b/content/influxdb3/enterprise/reference/cli/influxdb3/create/token/admin.md index cf0f63ce6..7c4bab6bc 100644 --- a/content/influxdb3/enterprise/reference/cli/influxdb3/create/token/admin.md +++ b/content/influxdb3/enterprise/reference/cli/influxdb3/create/token/admin.md @@ -1,8 +1,7 @@ --- title: influxdb3 create token admin description: > - The `influxdb3 create token --admin` command creates a new operator or named - admin authentication token. + The `influxdb3 create token admin` command creates an operator token or named admin token with full administrative privileges for server actions. menu: influxdb3_enterprise: parent: influxdb3 create token diff --git a/content/influxdb3/enterprise/reference/internals/authentication.md b/content/influxdb3/enterprise/reference/internals/authentication.md index 95ebeac5a..1df9cc97f 100644 --- a/content/influxdb3/enterprise/reference/internals/authentication.md +++ b/content/influxdb3/enterprise/reference/internals/authentication.md @@ -14,5 +14,5 @@ source: /shared/influxdb3-internals-reference/authentication.md --- \ No newline at end of file +// SOURCE content/shared/influxdb3-internals-reference/authentication.md +--> \ No newline at end of file diff --git a/content/shared/influxdb3-cli/create/token/admin.md b/content/shared/influxdb3-cli/create/token/admin.md index 2525e6e37..84d79b033 100644 --- a/content/shared/influxdb3-cli/create/token/admin.md +++ b/content/shared/influxdb3-cli/create/token/admin.md @@ -1,5 +1,5 @@ -Create a new operator or named admin token. +Create an operator token or named admin token. ## Usage @@ -17,7 +17,7 @@ influxdb3 create token --admin [OPTIONS] | `--host ` | The host URL of the running InfluxDB 3 server [env: `INFLUXDB3_HOST_URL=`] [default: `http://127.0.0.1:8181`] | | `--token ` | An existing admin token for the InfluxDB 3 server | | `--tls-ca ` | An optional arg to use a custom ca for useful for testing with self signed certs | -| `--format ` | Output format for token, supports just json or text [possible values: json, text] | +| `--format ` | Output format for token [possible values: `json`, `text`] | | `-h`, `--help` | Print help information | | `--help-all` | Print more detailed help information | @@ -25,6 +25,10 @@ influxdb3 create token --admin [OPTIONS] ### Create an operator token +The operator token is a special token that has full administrative privileges on the InfluxDB server and doesn't expire. +The first admin token you create becomes the operator token for the instance. +You can create an operator token using the `--admin` flag without any additional options. + ```bash