From adbd8edb0776efb1a4fe7748d9d81fb48b7a82c8 Mon Sep 17 00:00:00 2001 From: kelseiv <47797004+kelseiv@users.noreply.github.com> Date: Wed, 2 Nov 2022 10:41:10 -0700 Subject: [PATCH] Influx cli 2.5 (#4585) --- .../v2.4/reference/cli/influx/auth/create.md | 2 +- .../reference/cli/influx/config/create.md | 23 +++---- .../v2.4/reference/cli/influx/config/set.md | 23 ++++--- .../reference/release-notes/influx-cli.md | 4 +- .../v2.4/security/tokens/create-token.md | 62 +------------------ 5 files changed, 30 insertions(+), 84 deletions(-) diff --git a/content/influxdb/v2.4/reference/cli/influx/auth/create.md b/content/influxdb/v2.4/reference/cli/influx/auth/create.md index 2fbe11129..cd8958205 100644 --- a/content/influxdb/v2.4/reference/cli/influx/auth/create.md +++ b/content/influxdb/v2.4/reference/cli/influx/auth/create.md @@ -12,7 +12,7 @@ updated_in: CLI 2.5.0 The `influx auth create` command creates an API token in InfluxDB. {{% warn %}} -*Issue resolved**: Using InfluxDB 2.4 and influx CLI 2.4 prevented you from creating an **all-access** or **operator** token using the `influx auth create` command. This issue is resolved in the influx 2.5 CLI release. Please [upgrade to the latest version](/influxdb/latest/tools/influx-cli/) of the influx cli. +**Issue resolved**: Using InfluxDB 2.4 and influx CLI 2.4 prevented you from creating an **all-access** or **operator** token using the `influx auth create` command. This issue is resolved in the influx 2.5 CLI release. Please [upgrade to the latest version](/influxdb/latest/tools/influx-cli/) of the influx cli. {{% /warn %}} ## Usage diff --git a/content/influxdb/v2.4/reference/cli/influx/config/create.md b/content/influxdb/v2.4/reference/cli/influx/config/create.md index 6cdf68e67..eafa9e221 100644 --- a/content/influxdb/v2.4/reference/cli/influx/config/create.md +++ b/content/influxdb/v2.4/reference/cli/influx/config/create.md @@ -34,17 +34,18 @@ influx config create [flags] ``` ## Flags -| Flag | | Description | Input type | {{< cli/mapped >}} | -| :--- | :-------------------- | :------------------------------------------------------------------------------------------ | :--------: | :-------------------- | -| `-a` | `--active` | Set the specified connection to be the active configuration. | | | -| `-n` | `--config-name` | ({{< req >}}) Name of the new configuration. | string | | -| `-h` | `--help` | Help for the `create` command | | | -| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` | -| `-u` | `--host-url` | ({{< req >}}) Connection URL for the new configuration. | string | | -| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` | -| `-o` | `--org` | Organization name | string | | -| `-t` | `--token` | API token | string | `INFLUX_TOKEN` | -| `-p` | `--username-password` | **(OSS only)** Username (and optionally password) to use for authentication. Include `username:password` to ensure a session is automatically authenticated. Include `username` (without password) to prompt for a password before creating the session. | string | | + +| Flag | | Description | Input type | {{< cli/mapped >}} | +| :--- | :-------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------: | :-------------------- | +| `-a` | `--active` | Set the specified connection to be the active configuration. | | | +| `-n` | `--config-name` | ({{< req >}}) Name of the new configuration. | string | | +| `-h` | `--help` | Help for the `create` command | | | +| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` | +| `-u` | `--host-url` | ({{< req >}}) Connection URL for the new configuration. | string | | +| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` | +| `-o` | `--org` | Organization name | string | | +| `-t` | `--token` | API token | string | `INFLUX_TOKEN` | +| `-p` | `--username-password` | **(OSS only)** Username (and optionally password) to use for authentication. Include `username:password` to ensure a session is automatically authenticated. Include `username` (without password) to prompt for a password before creating the session. | string | | ## Examples diff --git a/content/influxdb/v2.4/reference/cli/influx/config/set.md b/content/influxdb/v2.4/reference/cli/influx/config/set.md index a0cee58ad..7352b24f3 100644 --- a/content/influxdb/v2.4/reference/cli/influx/config/set.md +++ b/content/influxdb/v2.4/reference/cli/influx/config/set.md @@ -21,18 +21,17 @@ influx config set [flags] `set` , `update` ## Flags -| Flag | | Description | Input type | {{< cli/mapped >}} | -| :--- | :--------------- | :----------------------------------------------------------------------------------------- | :--------: | :-------------------- | -| `-a` | `--active` | Set the specified connection to active | | | -| `-n` | `--config-name` | Name for the InfluxDB connection configuration to set or update | string | | -| `-h` | `--help` | Help for the `set` command | | | -| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` | -| `-u` | `--host-url` | URL for InfluxDB connection configuration to set or update | string | | -| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` | -| `-o` | `--org` | Organization name for the connection configuration | string | | -| `-t` | `--token` | API token | string | `INFLUX_TOKEN` | -| `-p` | `--username-password` | **(OSS only)** Username (and optionally password) to use for authentication. -Include `username:password` to ensure a session is automatically authenticated. Include `username` (without password) to prompt for a password before creating the session. | string | | + +| Flag | | Description | Input type | {{< cli/mapped >}} | +| :--- | :-------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------: | :-------------------- | +| `-a` | `--active` | Set the specified connection to active | | | +| `-n` | `--config-name` | Name for the InfluxDB connection configuration to set or update | string | | +| `-h` | `--help` | Help for the `set` command | | | +| | `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` | +| `-u` | `--host-url` | URL for InfluxDB connection configuration to set or update | string | | +| | `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` | +| `-o` | `--org` | Organization name for the connection configuration | string | | +| `-p` | `--username-password` | **(OSS only)** Username (and optionally password) to use for authentication. Include `username:password` to ensure a session is automatically authenticated. Include `username` (without password) to prompt for a password before creating the session. | string | | ## Examples diff --git a/content/influxdb/v2.4/reference/release-notes/influx-cli.md b/content/influxdb/v2.4/reference/release-notes/influx-cli.md index 820478279..bd8cb91c1 100644 --- a/content/influxdb/v2.4/reference/release-notes/influx-cli.md +++ b/content/influxdb/v2.4/reference/release-notes/influx-cli.md @@ -8,7 +8,7 @@ menu: name: influx CLI --- -# v2.5.0 [2022-10-21] +## v2.5.0 [2022-10-21] ### Features @@ -24,6 +24,8 @@ menu: - Fix to allow [influx auth create](/influxdb/v2.4/reference/cli/influx/auth/create/) to successfully create an API token without error. - Fix stack error typo. - Fix an error where `stdin` could not be used to create tasks. +- Update `data_type` to `dataType` to ensure CSV files are successfully uploaded. +- Fix to let you create a remote connection for InfluxDB 1.x without requiring a remote org ID (`remoteOrgID`). Add warning that `remoteOrgID` is required for InfluxDB Cloud and InfluxDB OSS, but not required for InfluxDB 1.x (OSS or Enterprise). ## v2.4.0 [2022-08-18] diff --git a/content/influxdb/v2.4/security/tokens/create-token.md b/content/influxdb/v2.4/security/tokens/create-token.md index 9f35d566f..56c296e58 100644 --- a/content/influxdb/v2.4/security/tokens/create-token.md +++ b/content/influxdb/v2.4/security/tokens/create-token.md @@ -9,6 +9,7 @@ menu: name: Create a token parent: Manage tokens weight: 201 +updated_in: CLI 2.5.0 --- Create API tokens using the InfluxDB user interface (UI), the `influx` @@ -76,7 +77,6 @@ click **{{< icon "plus" >}} Generate** and select a token type {{% /oss-only %}} - {{% cloud-only %}} ### Create an all-access token @@ -112,63 +112,9 @@ find the token you want to clone and click the **{{< icon "settings" >}}** icon ## Create a token using the influx CLI {{% warn %}} -InfluxDB 2.4 introduced a bug that prevents you from creating an **all-access** or **operator** token using the `influx auth create` command, and causes the following error: `Error: could not write auth with provided arguments: 403 Forbidden: permission.` - -Until this bug is resolved in the next influx CLI release, please use the [workaround below to create an all-access or operator token](/influxdb/v2.4/security/tokens/create-token/#workaround-to-create-an-all-access-or-operator-token). +**Issue resolved**: Using InfluxDB 2.4 and influx CLI 2.4 prevented you from creating an **all-access** or **operator** token using the `influx auth create` command. This issue is resolved in the influx 2.5 CLI release. Please [upgrade to the latest version](/influxdb/latest/tools/influx-cli/) of the influx cli. {{% /warn %}} -### **Workaround:** To create an all-access or operator token - -- Use the following command to create an [all-access](/influxdb/v2.4/security/tokens/#all-access-token) or [operator](/influxdb/v2.4/security/tokens/#operator-token) token. For an operator token, you must also include the `--read-orgs` and `--write-orgs` flags. - -```sh -influx auth create - --org-id or --org \ - --read-authorizations \ - --write-authorizations \ - --read-buckets \ - --write-buckets \ - --read-dashboards \ - --write-dashboards \ - --read-tasks \ - --write-tasks \ - --read-telegrafs \ - --write-telegrafs \ - --read-users \ - --write-users \ - --read-variables \ - --write-variables \ - --read-secrets \ - --write-secrets \ - --read-labels \ - --write-labels \ - --read-views \ - --write-views \ - --read-documents \ - --write-documents \ - --read-notificationRules \ - --write-notificationRules \ - --read-notificationEndpoints \ - --write-notificationEndpoints \ - --read-checks \ - --write-checks \ - --read-dbrp \ - --write-dbrp \ - --read-annotations \ - --write-annotations \ - --read-sources \ - --write-sources \ - --read-scrapers \ - --write-scrapers \ - --read-notebooks \ - --write-notebooks \ - --read-remotes \ - --write-remotes \ - --read-replications \ - --write-replications -``` - - \ No newline at end of file