From 637a38a8bb44bb49c3ce1d6b3f722dcf83648c16 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 10 Jul 2020 16:12:17 -0600 Subject: [PATCH 1/5] updated download links for beta-15 --- content/v2.0/get-started.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/content/v2.0/get-started.md b/content/v2.0/get-started.md index 4053aa254..6a22cc539 100644 --- a/content/v2.0/get-started.md +++ b/content/v2.0/get-started.md @@ -105,7 +105,7 @@ To use the `influx` CLI to manage and interact with your InfluxDB Cloud instance Click the following button to download and install `influx` CLI for macOS. -influx CLI (macOS) +influx CLI (macOS) #### Unpackage the influx binary @@ -117,7 +117,7 @@ or run the following command in a macOS command prompt application such ```sh # Unpackage contents to the current working directory -tar zxvf ~/Downloads/influxdb_client_2.0.0-beta.14_darwin_amd64.tar.gz +tar zxvf ~/Downloads/influxdb_client_2.0.0-beta.15_darwin_amd64.tar.gz ``` #### (Optional) Place the binary in your $PATH @@ -129,7 +129,7 @@ prefix the executable with `./` to run in place. If the binary is on your $PATH, ```sh # Copy the influx binary to your $PATH -sudo cp influxdb_client_2.0.0-beta.14_darwin_amd64/influx /usr/local/bin/ +sudo cp influxdb_client_2.0.0-beta.15_darwin_amd64/influx /usr/local/bin/ ``` {{% note %}} @@ -152,8 +152,8 @@ Now, you're ready to [Use the influx CLI](#use-the-influx-cli). Click one of the following buttons to download and install the `influx` CLI appropriate for your chipset. -influx CLI (amd64) -influx CLI (arm) +influx CLI (amd64) +influx CLI (arm) #### Unpackage the influx binary @@ -161,7 +161,7 @@ Click one of the following buttons to download and install the `influx` CLI appr ```sh # Unpackage contents to the current working directory -tar xvfz influxdb_client_2.0.0-beta.14_linux_amd64.tar.gz +tar xvfz influxdb_client_2.0.0-beta.15_linux_amd64.tar.gz ``` #### (Optional) Place the binary in your $PATH @@ -173,7 +173,7 @@ prefix the executable with `./` to run in place. If the binary is on your $PATH, ```sh # Copy the influx and influxd binary to your $PATH -sudo cp influxdb_client_2.0.0-beta.14_linux_amd64/influx /usr/local/bin/ +sudo cp influxdb_client_2.0.0-beta.15_linux_amd64/influx /usr/local/bin/ ``` {{% note %}} @@ -218,7 +218,7 @@ executables, and running the initial setup process. Download InfluxDB v2.0 beta for macOS. -InfluxDB v2.0 beta (macOS) +InfluxDB v2.0 beta (macOS) ### Unpackage the InfluxDB binaries @@ -228,7 +228,7 @@ or run the following command in a macOS command prompt application such ```sh # Unpackage contents to the current working directory -tar zxvf ~/Downloads/influxdb_2.0.0-beta.14_darwin_amd64.tar.gz +tar zxvf ~/Downloads/influxdb_2.0.0-beta.15_darwin_amd64.tar.gz ``` #### (Optional) Place the binaries in your $PATH @@ -238,7 +238,7 @@ prefix the executables with `./` to run then in place. ```sh # (Optional) Copy the influx and influxd binary to your $PATH -sudo cp influxdb_2.0.0-beta.14_darwin_amd64/{influx,influxd} /usr/local/bin/ +sudo cp influxdb_2.0.0-beta.15_darwin_amd64/{influx,influxd} /usr/local/bin/ ``` {{% note %}} @@ -307,8 +307,8 @@ influxd --reporting-disabled Download the InfluxDB v2.0 beta package appropriate for your chipset. -InfluxDB v2.0 beta (amd64) -InfluxDB v2.0 beta (arm) +InfluxDB v2.0 beta (amd64) +InfluxDB v2.0 beta (arm) ### Place the executables in your $PATH @@ -318,10 +318,10 @@ _**Note:** The following commands are examples. Adjust the file names, paths, an ```sh # Unpackage contents to the current working directory -tar xvzf path/to/influxdb_2.0.0-beta.14_linux_amd64.tar.gz +tar xvzf path/to/influxdb_2.0.0-beta.15_linux_amd64.tar.gz # Copy the influx and influxd binary to your $PATH -sudo cp influxdb_2.0.0-beta.14_linux_amd64/{influx,influxd} /usr/local/bin/ +sudo cp influxdb_2.0.0-beta.15_linux_amd64/{influx,influxd} /usr/local/bin/ ``` {{% note %}} From 418439e3774accfc223bbd23fab7998aa2fb4152 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 10 Jul 2020 16:13:20 -0600 Subject: [PATCH 2/5] remove pkg alias --- content/v2.0/reference/cli/influx/apply/_index.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/content/v2.0/reference/cli/influx/apply/_index.md b/content/v2.0/reference/cli/influx/apply/_index.md index 36c8e7aeb..f50ac1d08 100644 --- a/content/v2.0/reference/cli/influx/apply/_index.md +++ b/content/v2.0/reference/cli/influx/apply/_index.md @@ -20,9 +20,6 @@ _For information about finding and using InfluxDB templates, see influx apply [flags] ``` -#### Aliases -`apply`, `pkg` _(deprecated)_ - ## Flags | Flag | | Description | Input Type | {{< cli/mapped >}} | |:---- |:--- |:----------------------------- |:---------- |:------------------ | From 2669f8d23872d9de84b8ede36aecd8441f086dd7 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Tue, 21 Jul 2020 14:39:28 -0600 Subject: [PATCH 3/5] added influx telegrafs commands, resolves #1226 --- .../reference/cli/influx/telegrafs/_index.md | 46 ++++++++++++++++++ .../reference/cli/influx/telegrafs/create.md | 45 ++++++++++++++++++ .../v2.0/reference/cli/influx/telegrafs/rm.md | 37 +++++++++++++++ .../reference/cli/influx/telegrafs/update.md | 47 +++++++++++++++++++ 4 files changed, 175 insertions(+) create mode 100644 content/v2.0/reference/cli/influx/telegrafs/_index.md create mode 100644 content/v2.0/reference/cli/influx/telegrafs/create.md create mode 100644 content/v2.0/reference/cli/influx/telegrafs/rm.md create mode 100644 content/v2.0/reference/cli/influx/telegrafs/update.md diff --git a/content/v2.0/reference/cli/influx/telegrafs/_index.md b/content/v2.0/reference/cli/influx/telegrafs/_index.md new file mode 100644 index 000000000..a5800cd47 --- /dev/null +++ b/content/v2.0/reference/cli/influx/telegrafs/_index.md @@ -0,0 +1,46 @@ +--- +title: influx telegrafs +description: > + placeholder +menu: + v2_0_ref: + name: influx telegrafs + parent: influx +weight: 101 +v2.0/tags: [telegraf] +--- + +The `influx telegrafs` command lists Telegraf configurations. +Subcommands manage Telegraf configurations. + +## Usage +```sh +influx telegrafs [flags] +influx telegrafs [command] +``` + +## Subcommands +| Subcommand | Description | +|:---------- |:----------- | +| [create](/v2.0/reference/cli/influx/telegrafs/create) | Create a Telegraf configuration | +| [rm](/v2.0/reference/cli/influx/telegrafs/rm) | Remove a Telegraf configuration | +| [update](/v2.0/reference/cli/influx/telegrafs/update) | List Telegraf configurations | + +## Flags +| Flag | | Description | Input type | {{< cli/mapped >}} | +|:---- |:--- |:----------- |:----------: |:------------------ | +| `-h` | `--help` | Help for the `telegrafs` command | | | +| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` | +| `-i` | `--id` | Telegraf configuration ID to retrieve | string | | +| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` | +| `-o` | `--org` | Organization name | string | `INFLUX_ORG` | +| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` | + +## Examples +```sh +# List all known Telegraf configurations +influx telegrafs + +# List only a Telegraf configuration with the specified ID +influx telegrafs -i $ID +``` diff --git a/content/v2.0/reference/cli/influx/telegrafs/create.md b/content/v2.0/reference/cli/influx/telegrafs/create.md new file mode 100644 index 000000000..d76f4a54c --- /dev/null +++ b/content/v2.0/reference/cli/influx/telegrafs/create.md @@ -0,0 +1,45 @@ +--- +title: influx telegrafs create +description: > + placeholder +menu: + v2_0_ref: + name: influx telegrafs create + parent: influx telegrafs +weight: 201 +--- + +The `influx telegrafs create` command creates a new Telegraf configuration in InfluxDB +using a provided Telegraf configuration file. + +## Usage +```sh +influx telegrafs create [flags] +``` + +## Flags +| Flag | | Description | Input type | {{< cli/mapped >}} | +|:---- |:--- |:----------- |:----------: |:------------------ | +| `-d` | `--description` | Telegraf configuration description | string | | +| `-f` | `--file` | Path to Telegraf configuration | string | | +| `-h` | `--help` | Help for the `create` command | | | +| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` | +| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` | +| `-n` | `--name` | Telegraf configuration name | string | | +| `-o` | `--org` | Organization name | string | `INFLUX_ORG` | +| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` | + +## Examples +```sh +# Create a new Telegraf configuration +influx telegrafs create \ + -n "Example configuration name" \ + -d "Example Telegraf configuration description" \ + -f /path/to/telegraf.conf + +# Create a new Telegraf configuration with configuration settings +# provided via STDIN +cat /path/to/telegraf.conf | influx telegrafs create \ + -n "Example configuration name" \ + -d "Example Telegraf configuration description" \ +``` diff --git a/content/v2.0/reference/cli/influx/telegrafs/rm.md b/content/v2.0/reference/cli/influx/telegrafs/rm.md new file mode 100644 index 000000000..147100ea2 --- /dev/null +++ b/content/v2.0/reference/cli/influx/telegrafs/rm.md @@ -0,0 +1,37 @@ +--- +title: influx telegrafs rm +description: > + placeholder +menu: + v2_0_ref: + name: influx telegrafs rm + parent: influx telegrafs +weight: 201 +--- + +The `influx telegrafs rm` command removes Telegraf configurations from InfluxDB. + +## Usage +```sh +influx telegrafs rm [flags] +``` + +#### Aliases +`rm`, `remove` + +## Flags +| Flag | | Description | Input type | {{< cli/mapped >}} | +|:---- |:--- |:----------- |:----------: |:------------------ | +| `-h` | `--help` | Help for the `rm` command | | | +| | `--hide-headers` | Hide the table headers | | `$INFLUX_HIDE_HEADERS` | +| `-i` | `--id` | Telegraf configuration ID to remove | strings | | +| | `--json` | Output data as json | | `$INFLUX_OUTPUT_JSON` | + +## Examples +```sh +# Remove a single Telegraf configuration +influx telegrafs rm -i $ID + +# Remove multiple Telegraf configurations +influx telegrafs rm -i $ID1 -i $ID2 +``` diff --git a/content/v2.0/reference/cli/influx/telegrafs/update.md b/content/v2.0/reference/cli/influx/telegrafs/update.md new file mode 100644 index 000000000..0a12bd248 --- /dev/null +++ b/content/v2.0/reference/cli/influx/telegrafs/update.md @@ -0,0 +1,47 @@ +--- +title: influx telegrafs update +description: > + placeholder +menu: + v2_0_ref: + name: influx telegrafs update + parent: influx telegrafs +weight: 201 +--- + +The `influx telegrafs update` command updates a Telegraf configuration to match the specified parameters. +If a name or description are not provided, they are set to an empty string. + +## Usage +```sh +influx telegrafs update [flags] +``` + +## Flags +| Flag | | Description | Input type | {{< cli/mapped >}} | +|:---- |:--- |:----------- |:----------: |:------------------ | +| `-d` | `--description` | Telegraf configuration description | string | | +| `-f` | `--file` | Path to Telegraf configuration | string | | +| `-h` | `--help` | Help for the `update` command | | | +| | `--hide-headers` | Hide table headers | | `INFLUX_HIDE_HEADERS` | +| | `--json` | Output data as JSON | | `INFLUX_OUTPUT_JSON` | +| `-n` | `--name` | Telegraf configuration name | string | | +| `-o` | `--org` | Organization name | string | `INFLUX_ORG` | +| | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` | + +## Examples +```sh +# Update a Telegraf configuration +influx telegrafs update \ + -i $ID \ + -n "Example configuration name" \ + -d "Example Telegraf configuration description" \ + -f /path/to/telegraf.conf + +# Update a Telegraf configuration with configuration settings +# provided via STDIN +cat /path/to/telegraf.conf | influx telegrafs update \ + -i $ID \ + -n "Example configuration name" \ + -d "Example Telegraf configuration description" \ +``` From 5f97c15d8b1118568b87ac802a9063dda57e4f4f Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 22 Jul 2020 15:07:48 -0600 Subject: [PATCH 4/5] added descriptions to influx telegrafs commands --- content/v2.0/reference/cli/influx/telegrafs/_index.md | 3 ++- content/v2.0/reference/cli/influx/telegrafs/create.md | 3 ++- content/v2.0/reference/cli/influx/telegrafs/rm.md | 2 +- content/v2.0/reference/cli/influx/telegrafs/update.md | 3 ++- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/content/v2.0/reference/cli/influx/telegrafs/_index.md b/content/v2.0/reference/cli/influx/telegrafs/_index.md index a5800cd47..96cc0a2dc 100644 --- a/content/v2.0/reference/cli/influx/telegrafs/_index.md +++ b/content/v2.0/reference/cli/influx/telegrafs/_index.md @@ -1,7 +1,8 @@ --- title: influx telegrafs description: > - placeholder + The `influx telegrafs` command lists Telegraf configurations. + Subcommands manage Telegraf configurations. menu: v2_0_ref: name: influx telegrafs diff --git a/content/v2.0/reference/cli/influx/telegrafs/create.md b/content/v2.0/reference/cli/influx/telegrafs/create.md index d76f4a54c..ab3faefd4 100644 --- a/content/v2.0/reference/cli/influx/telegrafs/create.md +++ b/content/v2.0/reference/cli/influx/telegrafs/create.md @@ -1,7 +1,8 @@ --- title: influx telegrafs create description: > - placeholder + The `influx telegrafs create` command creates a new Telegraf configuration in InfluxDB + using a provided Telegraf configuration file. menu: v2_0_ref: name: influx telegrafs create diff --git a/content/v2.0/reference/cli/influx/telegrafs/rm.md b/content/v2.0/reference/cli/influx/telegrafs/rm.md index 147100ea2..61bf25705 100644 --- a/content/v2.0/reference/cli/influx/telegrafs/rm.md +++ b/content/v2.0/reference/cli/influx/telegrafs/rm.md @@ -1,7 +1,7 @@ --- title: influx telegrafs rm description: > - placeholder + The `influx telegrafs rm` command removes Telegraf configurations from InfluxDB. menu: v2_0_ref: name: influx telegrafs rm diff --git a/content/v2.0/reference/cli/influx/telegrafs/update.md b/content/v2.0/reference/cli/influx/telegrafs/update.md index 0a12bd248..b562f6aca 100644 --- a/content/v2.0/reference/cli/influx/telegrafs/update.md +++ b/content/v2.0/reference/cli/influx/telegrafs/update.md @@ -1,7 +1,8 @@ --- title: influx telegrafs update description: > - placeholder + The `influx telegrafs update` command updates a Telegraf configuration to match the specified parameters. + If a name or description are not provided, they are set to an empty string. menu: v2_0_ref: name: influx telegrafs update From 4a2162cd24c78169b06af3bcebd648464ea6b0ea Mon Sep 17 00:00:00 2001 From: noramullen1 <42354779+noramullen1@users.noreply.github.com> Date: Thu, 23 Jul 2020 10:45:50 -0700 Subject: [PATCH 5/5] Add beta 15 changelog --- .../v2.0/reference/release-notes/influxdb.md | 21 ++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/content/v2.0/reference/release-notes/influxdb.md b/content/v2.0/reference/release-notes/influxdb.md index c91cb1050..365618cd6 100644 --- a/content/v2.0/reference/release-notes/influxdb.md +++ b/content/v2.0/reference/release-notes/influxdb.md @@ -8,9 +8,24 @@ menu: weight: 101 --- +## v2.0.0-beta.15 [2020-07-23] + +### Features + +- Add event source to stacks. +- Add ability to uninstall stacks. +- Drop deprecated `influx pkg` commands. +- Add Telegraf management commands to `influx` CLI. +- Enable dynamic destination for the `influx` CLI configuration file. + +### Bug Fixes +- Allow 0 to be the custom set minimum value for y domain. +- Single Stat cells render properly in Safari. +- Limit variable querying when submitting queries to used variables. + ## v2.0.0-beta.14 [2020-07-08] -## Features +### Features - Extend `influx stacks update` command with ability to add resources without apply template. - Consolidate all InfluxDB template and stack functionality into two new public APIs: `/api/v2/templates` and `/api/v2/stacks`. @@ -18,14 +33,14 @@ weight: 101 - Add static builds for Linux. - Update Flux to v.0.71.1. -## Bug Fixes +### Bug Fixes - Don't overwrite build date set via `ldflags`. - Fix issue where define query was unusable after importing a Check. - Update documentation links ## v2.0.0-beta.13 [2020-06-25] -## Features +### Features - Cancel submitted queries in the Data Explorer. - Extend templates with the source `file|url|reader`.