add doc updates for influctl 2.9.7 and 2.9.8 (#5649)

influxdata · Oct 16, 2024 · aa289d9 · aa289d9
1 parent 66b78f6
commit aa289d9
Show file tree

Hide file tree

Showing 4 changed files with 135 additions and 31 deletions.
diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/_index.md b/content/influxdb/cloud-dedicated/reference/cli/influxctl/_index.md
@@ -17,22 +17,22 @@ administrative tasks in an {{< product-name omit=" Clustered" >}} cluster.
 
 - [Usage](#usage)
 - [Commands](#commands)
-- [Flags](#command-flags)
+- [Global flags](#global-flags)
 - [Download and install influxctl](#download-and-install-influxctl)
 - [Configure connection profiles](#configure-connection-profiles)
 - [Authentication](#authentication)
 
 ## Usage
 
 ```sh
-influxctl [flags] [command]
+influxctl [global-flags] [command]
 ```
 
 ## Commands
 
 | Command                                                                     | Description                            |
 | :-------------------------------------------------------------------------- | :------------------------------------- |
-| [auth](/influxdb/cloud-dedicated/reference/cli/influxctl/auth/)             | Log in to or log out of InfluxDB v3         |
+| [auth](/influxdb/cloud-dedicated/reference/cli/influxctl/auth/)             | Log in to or log out of InfluxDB v3    |
 | [cluster](/influxdb/cloud-dedicated/reference/cli/influxctl/cluster/)       | List InfluxDB v3 cluster information   |
 | [database](/influxdb/cloud-dedicated/reference/cli/influxctl/database/)     | Manage InfluxDB v3 databases           |
 | [help](/influxdb/cloud-dedicated/reference/cli/influxctl/help/)             | Output `influxctl` help information    |
@@ -45,15 +45,16 @@ influxctl [flags] [command]
 
 ## Global flags
 
-| Flag |             | Description                                                |
-| :--- | :---------- | :--------------------------------------------------------- |
-|      | `--debug`   | Enable debug logging                                       |
-|      | `--account` | Override account ID value in configuration file            |
-|      | `--cluster` | Override cluster ID value in configuration file            |
-|      | `--config`  | Path to configuration file to use                          |
-|      | `--profile` | Specify a connection profile to use (default is `default`) |
-|      | `--trace`   | Enable more verbose debug logging                          |
-| `-h` | `--help`    | Show help                                                  |
+| Flag |             | Description                                                  |
+| :--- | :---------- | :----------------------------------------------------------- |
+|      | `--debug`   | Enable debug logging                                         |
+|      | `--account` | Override account ID value in configuration file              |
+|      | `--cluster` | Override cluster ID value in configuration file              |
+|      | `--config`  | Path to configuration file to use                            |
+|      | `--profile` | Specify a connection profile to use (default is `default`)   |
+|      | `--timeout` | Specify a timeout duration for API calls (default is `1m0s`) |
+|      | `--trace`   | Enable more verbose debug logging                            |
+| `-h` | `--help`    | Show help                                                    |
 
 ---
 
@@ -344,7 +345,6 @@ If stored at a non-default location, include the `--config` flag with each
     ## OAuth2 client authorization settings
     # [profile.auth.oauth2]
         # client_id = ""
-        # client_secret = ""
         # scopes = [""]
         # parameters = { audience = "" }
         # token_url = "https://indentityprovider/oauth2/v2/token"

diff --git a/content/influxdb/cloud-dedicated/reference/release-notes/influxctl.md b/content/influxdb/cloud-dedicated/reference/release-notes/influxctl.md
@@ -11,12 +11,54 @@ menu:
 weight: 202
 ---
 
+## v2.9.8 {date="2024-10-15"}
+
+### Bug Fixes
+
+- Continue revoking tokens on error.
+- Reject unsupported input to `--template-timeformat`.
+- Remove unused `client_secret` option from
+  [connection configuration profiles](/influxdb/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles).
+
+### Dependency Updates
+
+- Update Go to v1.23.2.
+- Update `github.com/jedib0t/go-pretty/v6` from 6.5.9 to 6.6.0.
+- Update `github.com/urfave/cli/v2` from 2.27.4 to 2.27.5.
+- Update `google.golang.org/grpc` from 1.66.0 to 1.67.1.
+- Update `google.golang.org/protobuf` from 1.34.2 to 1.35.1.
+
+---
+
+## v2.9.7 {date="2024-09-11"}
+
+### Features
+
+- Add [global `--timeout` flag](/influxdb/cloud-dedicated/reference/cli/influxctl/#global-flags).
+- Improve timezone support.
+
+### Bug Fixes
+
+- Use passthrough resolver for gRPC.
+
+### Dependency Updates
+
+- Update Go to 1.23.1.
+- Update `github.com/pelletier/go-toml/v2` from 2.2.2 to 2.2.3.
+- Update `golang.org/x/mod` from 0.20.0 to 0.21.0.
+- Update `golang.org/x/oauth2` from 0.22.0 to 0.23.0.
+- Update `google.golang.org/grpc` from 1.65.0 to 1.66.0.
+
+---
+
 ## v2.9.6 {date="2024-08-15"}
 
 ### Bug Fixes
 
 - Update query to wait for EOF on stdin instead of the first newline.
 
+---
+
 ## v2.9.5 {date="2024-08-13"}
 
 ### Bug Fixes
@@ -29,6 +71,8 @@ weight: 202
 - Update `golang.org/x/mod` from 0.19.0 to 0.20.0
 - Update `golang.org/x/oauth2` from 0.21.0 to 0.22.0
 
+---
+
 ## v2.9.4 {date="2024-07-25"}
 
 ### Bug Fixes
@@ -40,12 +84,16 @@ weight: 202
 - Update `golang.org/x/mod` from 0.18.0 to 0.19.0
 - Update `google.golang.org/grpc` from 1.64.0 to 1.65.0
 
+---
+
 ## v2.9.3 {date="2024-06-26"}
 
 ### Bug Fixes
 
 - Update query subcommand to safely handle null timestamp in response.
 
+---
+
 ## v2.9.2 {date="2024-06-17"}
 
 ### Bug Fixes
@@ -56,6 +104,8 @@ weight: 202
 
 - Update `google.golang.org/protobuf` from 1.34.1 to 1.34.2.
 
+---
+
 ## v2.9.1 {date="2024-06-06"}
 
 ### Dependency Updates
@@ -69,6 +119,8 @@ weight: 202
 - Update `google.golang.org/protobuf` from 1.34.0 to 1.34.1
 - Update build dependencies.
 
+---
+
 ## v2.9.0 {date="2024-05-06"}
 
 ### Features
@@ -80,7 +132,7 @@ weight: 202
 
 - Update unimplemented error message with additional information.
 
-### Dependecy Updates
+### Dependency Updates
 
 - Update `github.com/apache/arrow/go/v16` from 16.0.0-20240401180149-68241d8a86e9 to 16.0.0.
 - Update `github.com/jedib0t/go-pretty/v6` from 6.5.8 to 6.5.9.
@@ -188,7 +240,7 @@ associated with another InfluxDB cluster.
 
 ### Bug Fixes
 
-- Update arrow to allow non-TLS connections.
+- Update Arrow to allow non-TLS connections.
 - Do not attempt to load cached tokens when an admin token file is provided.
 - Print retention period up to days rather than very large hours.
 - Fix indentation of help output.

diff --git a/content/influxdb/clustered/reference/cli/influxctl/_index.md b/content/influxdb/clustered/reference/cli/influxctl/_index.md
@@ -17,22 +17,22 @@ administrative tasks in an {{< product-name omit=" Clustered" >}} cluster.
 
 - [Usage](#usage)
 - [Commands](#commands)
-- [Flags](#command-flags)
+- [Global flags](#global-flags)
 - [Download and install influxctl](#download-and-install-influxctl)
 - [Configure connection profiles](#configure-connection-profiles)
 - [Authentication](#authentication)
 
 ## Usage
 
 ```sh
-influxctl [flags] [command]
+influxctl [global-flags] [command]
 ```
 
 ## Commands
 
 | Command                                                               | Description                            |
 | :-------------------------------------------------------------------- | :------------------------------------- |
-| [auth](/influxdb/clustered/reference/cli/influxctl/auth/)             | Log in to or log out of InfluxDB v3     |
+| [auth](/influxdb/clustered/reference/cli/influxctl/auth/)             | Log in to or log out of InfluxDB v3    |
 | [cluster](/influxdb/clustered/reference/cli/influxctl/cluster/)       | List InfluxDB v3 cluster information   |
 | [database](/influxdb/clustered/reference/cli/influxctl/database/)     | Manage InfluxDB v3 databases           |
 | [help](/influxdb/clustered/reference/cli/influxctl/help/)             | Output `influxctl` help information    |
@@ -45,15 +45,16 @@ influxctl [flags] [command]
 
 ## Global flags
 
-| Flag |             | Description                                                |
-| :--- | :---------- | :--------------------------------------------------------- |
-|      | `--debug`   | Enable debug logging                                       |
-|      | `--account` | Override account ID value in configuration file            |
-|      | `--cluster` | Override cluster ID value in configuration file            |
-|      | `--config`  | Path to configuration file to use                          |
-|      | `--profile` | Specify a connection profile to use (default is `default`) |
-|      | `--trace`   | Enable more verbose debug logging                          |
-| `-h` | `--help`    | Show help                                                  |
+| Flag |             | Description                                                  |
+| :--- | :---------- | :----------------------------------------------------------- |
+|      | `--debug`   | Enable debug logging                                         |
+|      | `--account` | Override account ID value in configuration file              |
+|      | `--cluster` | Override cluster ID value in configuration file              |
+|      | `--config`  | Path to configuration file to use                            |
+|      | `--profile` | Specify a connection profile to use (default is `default`)   |
+|      | `--timeout` | Specify a timeout duration for API calls (default is `1m0s`) |
+|      | `--trace`   | Enable more verbose debug logging                            |
+| `-h` | `--help`    | Show help                                                    |
 
 ---
 
@@ -354,7 +355,6 @@ If stored at a non-default location, include the `--config` flag with each
     ## OAuth2 client authorization settings
     [profile.auth.oauth2]
         client_id = "OAUTH_CLIENT_ID"
-        client_secret = ""
         scopes = [""]
         parameters = { audience = "" }
         token_url = "OAUTH_TOKEN_URL"

diff --git a/content/influxdb/clustered/reference/release-notes/influxctl.md b/content/influxdb/clustered/reference/release-notes/influxctl.md
@@ -12,11 +12,53 @@ weight: 202
 canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/
 ---
 
+## v2.9.8 {date="2024-10-15"}
+
+### Bug Fixes
+
+- Continue revoking tokens on error.
+- Reject unsupported input to `--template-timeformat`.
+- Remove unused `client_secret` option from
+  [connection configuration profiles](/influxdb/clustered/reference/cli/influxctl/#configure-connection-profiles).
+
+### Dependency Updates
+
+- Update Go to v1.23.2.
+- Update `github.com/jedib0t/go-pretty/v6` from 6.5.9 to 6.6.0.
+- Update `github.com/urfave/cli/v2` from 2.27.4 to 2.27.5.
+- Update `google.golang.org/grpc` from 1.66.0 to 1.67.1.
+- Update `google.golang.org/protobuf` from 1.34.2 to 1.35.1.
+
+---
+
+## v2.9.7 {date="2024-09-11"}
+
+### Features
+
+- Add [global `--timeout` flag](/influxdb/clustered/reference/cli/influxctl/#global-flags).
+- Improve timezone support.
+
+### Bug Fixes
+
+- Use passthrough resolver for gRPC.
+
+### Dependency Updates
+
+- Update Go to 1.23.1.
+- Update `github.com/pelletier/go-toml/v2` from 2.2.2 to 2.2.3.
+- Update `golang.org/x/mod` from 0.20.0 to 0.21.0.
+- Update `golang.org/x/oauth2` from 0.22.0 to 0.23.0.
+- Update `google.golang.org/grpc` from 1.65.0 to 1.66.0.
+
+---
+
 ## v2.9.6 {date="2024-08-15"}
 
 ### Bug Fixes
 
-- Update query subcommand to wait for EOF on stdin instead of the first newline.
+- Update query to wait for EOF on stdin instead of the first newline.
+
+---
 
 ## v2.9.5 {date="2024-08-13"}
 
@@ -31,6 +73,8 @@ canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/
 - Update `golang.org/x/mod` from 0.19.0 to 0.20.0
 - Update `golang.org/x/oauth2` from 0.21.0 to 0.22.0
 
+---
+
 ## v2.9.4 {date="2024-07-25"}
 
 ### Bug Fixes
@@ -42,12 +86,16 @@ canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/
 - Update `golang.org/x/mod` from 0.18.0 to 0.19.0
 - Update `google.golang.org/grpc` from 1.64.0 to 1.65.0
 
+---
+
 ## v2.9.3 {date="2024-06-26"}
 
 ### Bug Fixes
 
 - Update query subcommand to safely handle null timestamp in response.
 
+---
+
 ## v2.9.2 {date="2024-06-17"}
 
 ### Bug Fixes
@@ -58,6 +106,8 @@ canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/
 
 - Update `google.golang.org/protobuf` from 1.34.1 to 1.34.2.
 
+---
+
 ## v2.9.1 {date="2024-06-06"}
 
 ### Dependency Updates
@@ -71,6 +121,8 @@ canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/
 - Update `google.golang.org/protobuf` from 1.34.0 to 1.34.1
 - Update build dependencies.
 
+---
+
 ## v2.9.0 {date="2024-05-06"}
 
 ### Features
@@ -82,7 +134,7 @@ canonical: /influxdb/cloud-dedicated/reference/release-notes/influxctl/
 
 - Update unimplemented error message with additional information.
 
-### Dependecy Updates
+### Dependency Updates
 
 - Update `github.com/apache/arrow/go/v16` from 16.0.0-20240401180149-68241d8a86e9 to 16.0.0.
 - Update `github.com/jedib0t/go-pretty/v6` from 6.5.8 to 6.5.9.
@@ -197,7 +249,7 @@ associated with another InfluxDB cluster.
 
 ### Bug Fixes
 
-- Update arrow to allow non-TLS connections.
+- Update Arrow to allow non-TLS connections.
 - Do not attempt to load cached tokens when an admin token file is provided.
 - Print retention period up to days rather than very large hours.
 - Fix indentation of help output.