From 2b680550e9263cf67d4471488ffd6cb701c3f751 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 13 Nov 2020 10:11:22 -0700 Subject: [PATCH 1/6] WIP kapacitor with 2.0 and cloud guide --- content/influxdb/cloud/tools/chronograf.md | 14 ++ content/influxdb/cloud/tools/kapacitor.md | 16 +++ .../account-management/change-password.md | 15 --- .../v2.0/reference/api/influxdb-1x/query.md | 4 +- .../v2.0/reference/api/influxdb-1x/write.md | 4 +- content/influxdb/v2.0/tools/chronograf.md | 28 ++++ content/influxdb/v2.0/tools/kapacitor.md | 120 ++++++++++++++++++ 7 files changed, 182 insertions(+), 19 deletions(-) create mode 100644 content/influxdb/cloud/tools/chronograf.md create mode 100644 content/influxdb/cloud/tools/kapacitor.md delete mode 100644 content/influxdb/v2.0/account-management/change-password.md create mode 100644 content/influxdb/v2.0/tools/chronograf.md create mode 100644 content/influxdb/v2.0/tools/kapacitor.md diff --git a/content/influxdb/cloud/tools/chronograf.md b/content/influxdb/cloud/tools/chronograf.md new file mode 100644 index 000000000..8571fab20 --- /dev/null +++ b/content/influxdb/cloud/tools/chronograf.md @@ -0,0 +1,14 @@ +--- +title: Use Chronograf with InfluxDB Cloud +description: > + Use [Chronograf](/chronograf/) to visualize data from **InfluxDB Cloud**. +menu: + influxdb_cloud: + name: Use Chronograf + parent: Tools & integrations +weight: 104 +related: + - /{{< latest "chronograf" >}}/ +--- + +{{< duplicate-oss >}} diff --git a/content/influxdb/cloud/tools/kapacitor.md b/content/influxdb/cloud/tools/kapacitor.md new file mode 100644 index 000000000..f8e0028d4 --- /dev/null +++ b/content/influxdb/cloud/tools/kapacitor.md @@ -0,0 +1,16 @@ +--- +title: Use Kapacitor with InfluxDB Cloud +description: > + [Kapacitor](/kapacitor/) is a data processing framework that makes it easy to + create alerts, run ETL (Extract, Transform and Load) jobs and detect anomalies. + Use Kapacitor with **InfluxDB Cloud**. +menu: + influxdb_cloud: + name: Use Kapacitor + parent: Tools & integrations +weight: 104 +related: + - /{{< latest "kapacitor" >}}/ +--- + +{{< duplicate-oss >}} \ No newline at end of file diff --git a/content/influxdb/v2.0/account-management/change-password.md b/content/influxdb/v2.0/account-management/change-password.md deleted file mode 100644 index d68620266..000000000 --- a/content/influxdb/v2.0/account-management/change-password.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Change your password -seotitle: Change your password in InfluxDB Cloud -description: Change your password in InfluxDB Cloud. -menu: - influxdb_2_0: - name: Change your password - parent: Account management - identifier: change_password_cloud -weight: 105 ---- - -To change or reset your InfluxDB Cloud password, use the **Forgot Password** button on the [login page](https://cloud2.influxdata.com/login). -If you are logged in, log out and then click the **Forgot Password** button. -In the **InfluxCloud: Password Change Requested** email, click the link to choose a new password. diff --git a/content/influxdb/v2.0/reference/api/influxdb-1x/query.md b/content/influxdb/v2.0/reference/api/influxdb-1x/query.md index de5066ab0..f307a3d07 100644 --- a/content/influxdb/v2.0/reference/api/influxdb-1x/query.md +++ b/content/influxdb/v2.0/reference/api/influxdb-1x/query.md @@ -11,7 +11,7 @@ weight: 301 influxdb/v2.0/tags: [influxql, query] list_code_example: |
-  GET https://cloud2.influxdata.com/query
+  GET http://localhost:8086/query
   
related: - /influxdb/v2.0/query-data/influxql @@ -21,7 +21,7 @@ The `/query` 1.x compatibility endpoint queries InfluxDB Cloud and InfluxDB OSS Use the `GET` request method to query data from the `/query` endpoint.
-GET https://cloud2.influxdata.com/query
+GET http://localhost:8086/query
 
The `/query` compatibility endpoint use the **database** and **retention policy** diff --git a/content/influxdb/v2.0/reference/api/influxdb-1x/write.md b/content/influxdb/v2.0/reference/api/influxdb-1x/write.md index 1bdf4feeb..0121c8f76 100644 --- a/content/influxdb/v2.0/reference/api/influxdb-1x/write.md +++ b/content/influxdb/v2.0/reference/api/influxdb-1x/write.md @@ -12,7 +12,7 @@ weight: 301 influxdb/v2.0/tags: [write] list_code_example: |
-  POST https://cloud2.influxdata.com/write
+  POST http://localhost:8086/write
   
related: - /influxdb/v2.0/reference/syntax/line-protocol @@ -24,7 +24,7 @@ Use the `POST` request method to write [line protocol](/influxdb/v2.0/reference/ to the `/write` endpoint.
-POST https://cloud2.influxdata.com/write
+POST http://localhost:8086/write
 
## Authentication diff --git a/content/influxdb/v2.0/tools/chronograf.md b/content/influxdb/v2.0/tools/chronograf.md new file mode 100644 index 000000000..f1ec8c619 --- /dev/null +++ b/content/influxdb/v2.0/tools/chronograf.md @@ -0,0 +1,28 @@ +--- +title: Use Chronograf with InfluxDB OSS +description: > + Use [Chronograf](/chronograf/) to visualize data from your **InfluxDB OSS 2.0** instance. +menu: + influxdb_2_0: + name: Use Chronograf + parent: Tools & integrations +weight: 104 +related: + - /{{< latest "chronograf" >}}/ +--- + +Use [Chronograf](/{{< latest "chronograf" >}}/) to visualize data from **InfluxDB Cloud** and **InfluxDB OSS 2.0**. + +- Chronogaf will use the v1 compatibility APIs +- Limited write functionality +- Continue to use InfluxQL +- If using an admin user for visualization or Chronograf's administrative functions, create a new read-only user before upgrading. + Admin rights are granted to the primary user created in the InfluxDB 2.0 setup process which runs at the end of the upgrade process. + This provides you with the opportunity to re-assess who should be granted admin-level access in your InfluxDB 2.0 setup. + +1. Create a new connection +2. Enter your InfluxDB URL: + ``` + http://localhost:8086 + ``` +3. Test the connection diff --git a/content/influxdb/v2.0/tools/kapacitor.md b/content/influxdb/v2.0/tools/kapacitor.md new file mode 100644 index 000000000..1e2f5f7d5 --- /dev/null +++ b/content/influxdb/v2.0/tools/kapacitor.md @@ -0,0 +1,120 @@ +--- +title: Use Kapacitor with InfluxDB OSS +description: > + [Kapacitor](/kapacitor/) is a data processing framework that makes it easy to + create alerts, run ETL (Extract, Transform and Load) jobs and detect anomalies. + Use Kapacitor with **InfluxDB OSS 2.0**. +menu: + influxdb_2_0: + name: Use Kapacitor + parent: Tools & integrations +weight: 104 +related: + - /{{< latest "kapacitor" >}}/ +--- + +[Kapacitor](/{{< latest "kapacitor" >}}/) is a data processing framework that makes +it easy to create alerts, run ETL jobs and detect anomalies. +Use Kapacitor with **InfluxDB Cloud** and **InfluxDB OSS 2.0** to offload much of +data processing burden to Kapacitor. + +Because Kapacitor interacts with InfluxDB Cloud and InfluxDB OSS 2.0 using the +[InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/), +you can continue using Kapacitor without having to migrate libraries of +TICKscripts to InfluxDB tasks. + +#### Important notes to consider +- InfluxDB Cloud and InfluxDB OSS 2.0 do not have subscription APIs and + **do not support Kapacitor stream tasks**, but you can continue to use stream + tasks by writing data directly to Kapacitor. + For more information, see [below](#). + +## Configure Kapacitor to connect to InfluxDB +To connect Kapacitor to InfluxDB Cloud or InfluxDB OSS 2.0, update the `[[influxdb]]` +section(s) of your Kapacitor configuration file: + +- [Specify your InfluxDB URL](#specify-your-influxdb-url) +- [Provide InfluxDB authentication credentials](#provide-influxdb-authentication-credentials) +- [Disable InfluxDB subcriptions](#disable-influxdb-subscriptions) + +### Specify your InfluxDB URL +Provide your InfluxDB URL in the `[[influxdb]].urls` configuration option. +For more information, see [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/) +or [InfluxDB OSS URLs](/influxdb/v2.0/reference/urls/). + +```toml +[[influxdb]] + # ... + urls = ["http://localhost:8086"] +``` + +### Provide InfluxDB authentication credentials +InfluxDB Cloud and InfluxDB OSS 2.0 require authentication. +Provide the following credentials in your `[[influxdb]].username` and `[[influxdb]].password` +configuration options: + +- **username:** InfluxDB username +- **password:** InfluxDB [authentication token](/influxdb/v2.0/security/tokens/) + +```toml +[[influxdb]] + # ... + username = "influxdb-username" + password = "influxdb-token" +``` + +{{% warn %}} +Kapacitor is subject to InfluxDB token permission restrictions. +Ensure the provided InfluxDB authentication token has the necessary read and write permissions. +{{% /warn %}} + +### Disable InfluxDB subscriptions +InfluxDB Cloud and InfluxDB OSS 2.0 to not have subscriptions APIs. +Set the `[[influxdb]].disable-subscriptions`to `false` to disable InfluxDB subscriptions. + +```toml +[[influxdb]] + # ... + disable-subscriptions = true +``` + +## Kapacitor batch tasks +Kapacitor Batch-style TICKscripts work with the 1.x read compatible API. + +## Use Kapacitor stream tasks +InfluxDB Cloud and OSS 2.0 do not have subsription APIs and do not support Kapacitor stream tasks directly. +To use Kapacitor stream tasks, write data directly to Kapacitor using the [Kapcitior `/write` API](/{{< latest "kapacitor" >}}/working/api/#writing-data). + +We recommend using [Telegraf InfluxDB output plugin](/{{< latest "telegraf" >}}/plugins/#influxdb) +to write data to both InfluxDB Cloud or OSS and Kapacitor. + +##### Example Telegraf configuration +```toml +# Write to Kapacitor +[[outputs.influxdb]] + urls = ["http://localhost:9092"] + database = "example-db" + retention_policy = "example-rp" + +# Write to InfluxDB Cloud or OSS +[[outputs.influxdb]] + urls = ["http://localhost:8086"] + database = "example-db" + retention_policy = "example-rp" + username = "influxdb-username" + password = "influxdb-token" +``` + +## Write back to InfluxDB +The `InfluxDBOut` Node. The following writes to the `my-db/my-rp` bucket in InfluxDB Cloud or InfluxDB 2.0. + ```js + batch + |query('SELECT errors / total AS error_percent from requests') + // Write the transformed data to InfluxDB + |influxDBOut() + .database('my-db') + .retentionPolicy('my-rp') + .measurement('errors') + .tag('kapacitor', 'true') + .tag('version', '0.2') + ``` From 865b74480a8d0e2a073e59fc8cf9c8fb208a4a9c Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 13 Nov 2020 10:15:46 -0700 Subject: [PATCH 2/6] added missing telegraf config description --- content/influxdb/cloud/telegraf-configs/_index.md | 3 ++- content/influxdb/v2.0/telegraf-configs/_index.md | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/content/influxdb/cloud/telegraf-configs/_index.md b/content/influxdb/cloud/telegraf-configs/_index.md index 0aa2ae0d6..c3106cd8c 100644 --- a/content/influxdb/cloud/telegraf-configs/_index.md +++ b/content/influxdb/cloud/telegraf-configs/_index.md @@ -1,7 +1,8 @@ --- title: Telegraf configurations description: > - placeholder + InfluxDB Cloud lets you automatically generate Telegraf configurations or upload customized + Telegraf configurations that collect metrics and write them to InfluxDB Cloud. weight: 12 menu: influxdb_cloud influxdb/cloud/tags: [telegraf] diff --git a/content/influxdb/v2.0/telegraf-configs/_index.md b/content/influxdb/v2.0/telegraf-configs/_index.md index df85860f9..b5c55ccd8 100644 --- a/content/influxdb/v2.0/telegraf-configs/_index.md +++ b/content/influxdb/v2.0/telegraf-configs/_index.md @@ -1,8 +1,8 @@ --- title: Telegraf configurations description: > - InfluxDB lets you automatically generate Telegraf configurations or upload customized - Telegraf configurations that collect metrics and write them to InfluxDB. + InfluxDB OSS lets you automatically generate Telegraf configurations or upload customized + Telegraf configurations that collect metrics and write them to InfluxDB OSS. weight: 12 menu: influxdb_2_0 influxdb/v2.0/tags: [telegraf] From 6181460b2fd7c97ad6e679381a9ecf9f6e6f8481 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 13 Nov 2020 11:56:44 -0700 Subject: [PATCH 3/6] finished draft of kapacitor with influxdb cloud and 2.0 --- content/influxdb/cloud/tools/chronograf.md | 2 +- .../cloud/tools/google-data-studio.md | 2 +- content/influxdb/cloud/tools/kapacitor.md | 2 +- content/influxdb/v2.0/tools/chronograf.md | 2 +- .../influxdb/v2.0/tools/google-data-studio.md | 2 +- content/influxdb/v2.0/tools/kapacitor.md | 55 ++++++++++++------- 6 files changed, 39 insertions(+), 26 deletions(-) diff --git a/content/influxdb/cloud/tools/chronograf.md b/content/influxdb/cloud/tools/chronograf.md index 8571fab20..b57978f0e 100644 --- a/content/influxdb/cloud/tools/chronograf.md +++ b/content/influxdb/cloud/tools/chronograf.md @@ -6,7 +6,7 @@ menu: influxdb_cloud: name: Use Chronograf parent: Tools & integrations -weight: 104 +weight: 103 related: - /{{< latest "chronograf" >}}/ --- diff --git a/content/influxdb/cloud/tools/google-data-studio.md b/content/influxdb/cloud/tools/google-data-studio.md index 63bbc51ac..c61e4e666 100644 --- a/content/influxdb/cloud/tools/google-data-studio.md +++ b/content/influxdb/cloud/tools/google-data-studio.md @@ -7,7 +7,7 @@ description: > menu: influxdb_cloud: parent: Tools & integrations -weight: 102 +weight: 104 influxdb/cloud/tags: [google] --- diff --git a/content/influxdb/cloud/tools/kapacitor.md b/content/influxdb/cloud/tools/kapacitor.md index f8e0028d4..e24f3c76c 100644 --- a/content/influxdb/cloud/tools/kapacitor.md +++ b/content/influxdb/cloud/tools/kapacitor.md @@ -8,7 +8,7 @@ menu: influxdb_cloud: name: Use Kapacitor parent: Tools & integrations -weight: 104 +weight: 102 related: - /{{< latest "kapacitor" >}}/ --- diff --git a/content/influxdb/v2.0/tools/chronograf.md b/content/influxdb/v2.0/tools/chronograf.md index f1ec8c619..62519aa26 100644 --- a/content/influxdb/v2.0/tools/chronograf.md +++ b/content/influxdb/v2.0/tools/chronograf.md @@ -6,7 +6,7 @@ menu: influxdb_2_0: name: Use Chronograf parent: Tools & integrations -weight: 104 +weight: 103 related: - /{{< latest "chronograf" >}}/ --- diff --git a/content/influxdb/v2.0/tools/google-data-studio.md b/content/influxdb/v2.0/tools/google-data-studio.md index 99c39c234..b2183ed0f 100644 --- a/content/influxdb/v2.0/tools/google-data-studio.md +++ b/content/influxdb/v2.0/tools/google-data-studio.md @@ -7,7 +7,7 @@ description: > menu: influxdb_2_0: parent: Tools & integrations -weight: 102 +weight: 104 influxdb/v2.0/tags: [google] --- diff --git a/content/influxdb/v2.0/tools/kapacitor.md b/content/influxdb/v2.0/tools/kapacitor.md index 1e2f5f7d5..e3d8d151f 100644 --- a/content/influxdb/v2.0/tools/kapacitor.md +++ b/content/influxdb/v2.0/tools/kapacitor.md @@ -8,7 +8,7 @@ menu: influxdb_2_0: name: Use Kapacitor parent: Tools & integrations -weight: 104 +weight: 102 related: - /{{< latest "kapacitor" >}}/ --- @@ -23,11 +23,18 @@ Because Kapacitor interacts with InfluxDB Cloud and InfluxDB OSS 2.0 using the you can continue using Kapacitor without having to migrate libraries of TICKscripts to InfluxDB tasks. -#### Important notes to consider -- InfluxDB Cloud and InfluxDB OSS 2.0 do not have subscription APIs and - **do not support Kapacitor stream tasks**, but you can continue to use stream - tasks by writing data directly to Kapacitor. - For more information, see [below](#). +{{% note %}} +#### Support for stream tasks +InfluxDB Cloud and InfluxDB OSS 2.0 do not have subscription APIs and +**do not support Kapacitor stream tasks**, but you can continue to use stream +tasks by writing data directly to Kapacitor. +For more information, see [below](#use-kapacitor-stream-tasks). +{{% /note %}} + +#### On this page +- [Configure Kapacitor to connect to InfluxDB](#configure-kapacitor-to-connect-to-influxdb) +- [Use Kapacitor stream tasks](#use-kapacitor-stream-tasks) +- [Write back to InfluxDB](#write-back-to-influxdb) ## Configure Kapacitor to connect to InfluxDB To connect Kapacitor to InfluxDB Cloud or InfluxDB OSS 2.0, update the `[[influxdb]]` @@ -78,15 +85,13 @@ Set the `[[influxdb]].disable-subscriptions`to `false` to disable InfluxDB subsc disable-subscriptions = true ``` -## Kapacitor batch tasks -Kapacitor Batch-style TICKscripts work with the 1.x read compatible API. - ## Use Kapacitor stream tasks InfluxDB Cloud and OSS 2.0 do not have subsription APIs and do not support Kapacitor stream tasks directly. To use Kapacitor stream tasks, write data directly to Kapacitor using the [Kapcitior `/write` API](/{{< latest "kapacitor" >}}/working/api/#writing-data). We recommend using [Telegraf InfluxDB output plugin](/{{< latest "telegraf" >}}/plugins/#influxdb) to write data to both InfluxDB Cloud or OSS and Kapacitor. +The following example Telegraf configuration writes data to both InfluxDB and Kapacitor: ##### Example Telegraf configuration ```toml @@ -106,15 +111,23 @@ to write data to both InfluxDB Cloud or OSS and Kapacitor. ``` ## Write back to InfluxDB -The `InfluxDBOut` Node. The following writes to the `my-db/my-rp` bucket in InfluxDB Cloud or InfluxDB 2.0. - ```js - batch - |query('SELECT errors / total AS error_percent from requests') - // Write the transformed data to InfluxDB - |influxDBOut() - .database('my-db') - .retentionPolicy('my-rp') - .measurement('errors') - .tag('kapacitor', 'true') - .tag('version', '0.2') - ``` +If using the Kapacitor `InfluxDBOut` node to write data to InfluxDB Cloud or OSS 2.0, +InfluxDB maps the specified database and retention policy to a corresponding bucket. +You can also manually map database/retention policy combinations (DBRPs) to buckets. +For more information, see [DBRP mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/) +and [Map unmapped buckets](/influxdb/v2.0/query-data/influxql/#map-unmapped-buckets). + +The following example TICKscript writes to the `my-db/my-rp` bucket in +InfluxDB Cloud or InfluxDB OSS 2.0. + +```js +batch + |query('SELECT errors / total AS error_percent from requests') + // Write the transformed data to InfluxDB + |influxDBOut() + .database('my-db') + .retentionPolicy('my-rp') + .measurement('errors') + .tag('kapacitor', 'true') + .tag('version', '0.2') +``` From f6141b3357ff51b26cd14bad7375d0f0c930e65c Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Fri, 13 Nov 2020 15:12:19 -0700 Subject: [PATCH 4/6] added chronograf guide to v2 --- content/influxdb/v2.0/tools/chronograf.md | 50 +++++++++++++++++------ content/influxdb/v2.0/tools/kapacitor.md | 11 ++--- layouts/shortcodes/icon.html | 2 +- 3 files changed, 43 insertions(+), 20 deletions(-) diff --git a/content/influxdb/v2.0/tools/chronograf.md b/content/influxdb/v2.0/tools/chronograf.md index 62519aa26..56e97ae78 100644 --- a/content/influxdb/v2.0/tools/chronograf.md +++ b/content/influxdb/v2.0/tools/chronograf.md @@ -12,17 +12,43 @@ related: --- Use [Chronograf](/{{< latest "chronograf" >}}/) to visualize data from **InfluxDB Cloud** and **InfluxDB OSS 2.0**. +Chronogaf uses the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/) +so you can continue to use InfluxQL in your dashboards and when exploring data. -- Chronogaf will use the v1 compatibility APIs -- Limited write functionality -- Continue to use InfluxQL -- If using an admin user for visualization or Chronograf's administrative functions, create a new read-only user before upgrading. - Admin rights are granted to the primary user created in the InfluxDB 2.0 setup process which runs at the end of the upgrade process. - This provides you with the opportunity to re-assess who should be granted admin-level access in your InfluxDB 2.0 setup. +{{% note %}} +#### Limited InfluxQL support +InfluxDB Cloud and InfluxDB OSS 2.0 support InfluxQL **read-only** queries. +For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/#influxql-support), +{{% /note %}} -1. Create a new connection -2. Enter your InfluxDB URL: - ``` - http://localhost:8086 - ``` -3. Test the connection +## Create an InfluxDB connection +1. Click **Configuration** in the left navigation bar, and then click **{{< icon "plus" >}} Add Connection**. +2. Enter your InfluxDB connection credentials: + - **Connection URL:** InfluxDB URL _(see [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/) + or [InfluxDB OSS URLs](/influxdb/v2.0/reference/urls/))_ + + ``` + http://localhost:8086 + ``` + + - **Connection Name:** Name to uniquely identify this connection configuration. + - **Username:** InfluxDB username + - **Password:** InfluxDB [authentication token](/influxdb/v2.0/security/tokens/) + - **Telegraf Database Name:** Default database name + - **Default Retention Policy:** Default retention policy + + {{% note %}} +#### DBRPs map to InfluxDB buckets +In InfluxDB Cloud and InfluxDB OSS 2.0, database/retention-policy (DBRP) combinations +are mapped to buckets using the `database-name/retention-policy` naming convention. +For more information, see [DBRP mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/) +and [Map unmapped buckets](/influxdb/v2.0/query-data/influxql/#map-unmapped-buckets). + {{% /note %}} + +3. Click **Add Connection** +4. Select any dashboards you would like to create and then click **Next**. +5. Configure a Kapacitor connection and then click **Continue**. + If you do not wish to create a Kapacitor connection, click **Skip**. + _For more information about using Kapacitor with InfluxDB Cloud or InfluxDB OSS 2.0, + see [Use Kapacitor with InfluxDB](/influxdb/v2.0/tools/kapacitor/)._ +6. Click **Finish**. diff --git a/content/influxdb/v2.0/tools/kapacitor.md b/content/influxdb/v2.0/tools/kapacitor.md index e3d8d151f..7aad778c4 100644 --- a/content/influxdb/v2.0/tools/kapacitor.md +++ b/content/influxdb/v2.0/tools/kapacitor.md @@ -15,13 +15,10 @@ related: [Kapacitor](/{{< latest "kapacitor" >}}/) is a data processing framework that makes it easy to create alerts, run ETL jobs and detect anomalies. -Use Kapacitor with **InfluxDB Cloud** and **InfluxDB OSS 2.0** to offload much of -data processing burden to Kapacitor. - -Because Kapacitor interacts with InfluxDB Cloud and InfluxDB OSS 2.0 using the -[InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/), -you can continue using Kapacitor without having to migrate libraries of -TICKscripts to InfluxDB tasks. +Kapacitor interacts with **InfluxDB Cloud** and **InfluxDB OSS 2.0** using the +[InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/), so +you can continue using Kapacitor without having to migrate libraries of TICKscripts +to InfluxDB tasks. {{% note %}} #### Support for stream tasks diff --git a/layouts/shortcodes/icon.html b/layouts/shortcodes/icon.html index 4c7ac93c9..68571e537 100644 --- a/layouts/shortcodes/icon.html +++ b/layouts/shortcodes/icon.html @@ -37,7 +37,7 @@ {{ else if eq $icon "play" }} {{ else if eq $icon "plus" }} - + {{ else if or (eq $icon "refresh") (eq $icon "replay") }} {{ else if or (eq $icon "remove") (eq $icon "x") }} From 0bc3606bd7807c1b0b57111b4f752e2dc6a56d77 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 16 Nov 2020 10:01:58 -0700 Subject: [PATCH 5/6] updated kapa and chrono guides to address PR feedback --- content/influxdb/cloud/tools/chronograf.md | 6 +++- content/influxdb/v2.0/tools/chronograf.md | 32 ++++++++++++++++++---- content/influxdb/v2.0/tools/kapacitor.md | 11 ++++++-- 3 files changed, 40 insertions(+), 9 deletions(-) diff --git a/content/influxdb/cloud/tools/chronograf.md b/content/influxdb/cloud/tools/chronograf.md index b57978f0e..1960a0513 100644 --- a/content/influxdb/cloud/tools/chronograf.md +++ b/content/influxdb/cloud/tools/chronograf.md @@ -1,7 +1,11 @@ --- title: Use Chronograf with InfluxDB Cloud description: > - Use [Chronograf](/chronograf/) to visualize data from **InfluxDB Cloud**. + [Chronograf](/{{< latest "chronograf" >}}/) is a data visualization and dashboarding + tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstatck](/platform/) + that provides an InfluxQL data explorer, Kapacitor integrations, and more. + Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS 2.0** and the + [1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). menu: influxdb_cloud: name: Use Chronograf diff --git a/content/influxdb/v2.0/tools/chronograf.md b/content/influxdb/v2.0/tools/chronograf.md index 56e97ae78..1bacc1583 100644 --- a/content/influxdb/v2.0/tools/chronograf.md +++ b/content/influxdb/v2.0/tools/chronograf.md @@ -1,7 +1,11 @@ --- title: Use Chronograf with InfluxDB OSS description: > - Use [Chronograf](/chronograf/) to visualize data from your **InfluxDB OSS 2.0** instance. + [Chronograf](/{{< latest "chronograf" >}}/) is a data visualization and dashboarding + tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstatck](/platform/) + that provides an InfluxQL data explorer, Kapacitor integrations, and more. + Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS 2.0** and the + [1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). menu: influxdb_2_0: name: Use Chronograf @@ -11,15 +15,31 @@ related: - /{{< latest "chronograf" >}}/ --- -Use [Chronograf](/{{< latest "chronograf" >}}/) to visualize data from **InfluxDB Cloud** and **InfluxDB OSS 2.0**. -Chronogaf uses the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/) -so you can continue to use InfluxQL in your dashboards and when exploring data. +[Chronograf](/{{< latest "chronograf" >}}/) is a data visualization and dashboarding +tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstatck](/platform/) +that provides an InfluxQL data explorer, Kapacitor integrations, and more. +Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS 2.0** and the +[1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). + +{{% warn %}} +### Important notes + +#### No administrative functionality +Chronograf cannot be used for administrative tasks in InfluxDB Cloud and InfluxDB OSS 2.0. +For example, you cannot do the following: + +- definine databases +- modify retention policies +- add users +- etc. + +You must migrate administrative tasks to the native InfluxDB Cloud or InfluxDB OSS 2.0 +user interface (UI). -{{% note %}} #### Limited InfluxQL support InfluxDB Cloud and InfluxDB OSS 2.0 support InfluxQL **read-only** queries. For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/#influxql-support), -{{% /note %}} +{{% /warn %}} ## Create an InfluxDB connection 1. Click **Configuration** in the left navigation bar, and then click **{{< icon "plus" >}} Add Connection**. diff --git a/content/influxdb/v2.0/tools/kapacitor.md b/content/influxdb/v2.0/tools/kapacitor.md index 7aad778c4..5accf91a0 100644 --- a/content/influxdb/v2.0/tools/kapacitor.md +++ b/content/influxdb/v2.0/tools/kapacitor.md @@ -30,6 +30,7 @@ For more information, see [below](#use-kapacitor-stream-tasks). #### On this page - [Configure Kapacitor to connect to InfluxDB](#configure-kapacitor-to-connect-to-influxdb) +- [Use Kapacitor batch tasks](#use-kapacitor-batch-tasks) - [Use Kapacitor stream tasks](#use-kapacitor-stream-tasks) - [Write back to InfluxDB](#write-back-to-influxdb) @@ -73,7 +74,7 @@ Ensure the provided InfluxDB authentication token has the necessary read and wri {{% /warn %}} ### Disable InfluxDB subscriptions -InfluxDB Cloud and InfluxDB OSS 2.0 to not have subscriptions APIs. +InfluxDB Cloud and InfluxDB OSS 2.0 do not have subscriptions APIs. Set the `[[influxdb]].disable-subscriptions`to `false` to disable InfluxDB subscriptions. ```toml @@ -82,8 +83,14 @@ Set the `[[influxdb]].disable-subscriptions`to `false` to disable InfluxDB subsc disable-subscriptions = true ``` +## Use Kapacitor batch tasks +Kapacitor batch tasks use the `/query` endpoint of the 1.x compatibility API +and require no change to use with InfluxDB Cloud and InfluxDB OSS. +For information about writing back to InfluxDB in Kapacitor tasks, +see [Write back to InfluxDB](#write-back-to-influxdb) below. + ## Use Kapacitor stream tasks -InfluxDB Cloud and OSS 2.0 do not have subsription APIs and do not support Kapacitor stream tasks directly. +InfluxDB Cloud and OSS 2.0 do not have subscription APIs and do not support Kapacitor stream tasks directly. To use Kapacitor stream tasks, write data directly to Kapacitor using the [Kapcitior `/write` API](/{{< latest "kapacitor" >}}/working/api/#writing-data). We recommend using [Telegraf InfluxDB output plugin](/{{< latest "telegraf" >}}/plugins/#influxdb) From 1b65ddca9a4f5cdb8a2c9743d63baa4583ecd1db Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Mon, 23 Nov 2020 10:27:39 -0700 Subject: [PATCH 6/6] addressed PR feedback in kapa and chrono guides --- content/influxdb/cloud/tools/chronograf.md | 2 +- .../influxdb/v2.0/telegraf-configs/_index.md | 4 +- content/influxdb/v2.0/tools/chronograf.md | 45 ++++++++++--------- content/influxdb/v2.0/tools/kapacitor.md | 12 ++--- 4 files changed, 33 insertions(+), 30 deletions(-) diff --git a/content/influxdb/cloud/tools/chronograf.md b/content/influxdb/cloud/tools/chronograf.md index 1960a0513..97a320d19 100644 --- a/content/influxdb/cloud/tools/chronograf.md +++ b/content/influxdb/cloud/tools/chronograf.md @@ -2,7 +2,7 @@ title: Use Chronograf with InfluxDB Cloud description: > [Chronograf](/{{< latest "chronograf" >}}/) is a data visualization and dashboarding - tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstatck](/platform/) + tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstack](/platform/) that provides an InfluxQL data explorer, Kapacitor integrations, and more. Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS 2.0** and the [1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). diff --git a/content/influxdb/v2.0/telegraf-configs/_index.md b/content/influxdb/v2.0/telegraf-configs/_index.md index b5c55ccd8..84d7e7a8e 100644 --- a/content/influxdb/v2.0/telegraf-configs/_index.md +++ b/content/influxdb/v2.0/telegraf-configs/_index.md @@ -1,7 +1,7 @@ --- title: Telegraf configurations description: > - InfluxDB OSS lets you automatically generate Telegraf configurations or upload customized + InfluxDB OSS lets you automatically generate Telegraf configurations or upload custom Telegraf configurations that collect metrics and write them to InfluxDB OSS. weight: 12 menu: influxdb_2_0 @@ -11,7 +11,7 @@ related: - /influxdb/v2.0/write-data/no-code/use-telegraf/auto-config/ --- -InfluxDB lets you automatically generate Telegraf configurations or upload customized +InfluxDB lets you automatically generate Telegraf configurations or upload custom Telegraf configurations that collect metrics and write them to InfluxDB. Telegraf retrieves configurations from InfluxDB on startup. diff --git a/content/influxdb/v2.0/tools/chronograf.md b/content/influxdb/v2.0/tools/chronograf.md index 1bacc1583..115c58b15 100644 --- a/content/influxdb/v2.0/tools/chronograf.md +++ b/content/influxdb/v2.0/tools/chronograf.md @@ -2,7 +2,7 @@ title: Use Chronograf with InfluxDB OSS description: > [Chronograf](/{{< latest "chronograf" >}}/) is a data visualization and dashboarding - tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstatck](/platform/) + tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstack](/platform/) that provides an InfluxQL data explorer, Kapacitor integrations, and more. Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS 2.0** and the [1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). @@ -16,33 +16,34 @@ related: --- [Chronograf](/{{< latest "chronograf" >}}/) is a data visualization and dashboarding -tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstatck](/platform/) +tool designed to visualize data in InfluxDB 1.x. It is part of the [TICKstack](/platform/) that provides an InfluxQL data explorer, Kapacitor integrations, and more. Continue to use Chronograf with **InfluxDB Cloud** and **InfluxDB OSS 2.0** and the [1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/). {{% warn %}} -### Important notes - -#### No administrative functionality +### No administrative functionality Chronograf cannot be used for administrative tasks in InfluxDB Cloud and InfluxDB OSS 2.0. -For example, you cannot do the following: +For example, you **cannot** do the following: -- definine databases -- modify retention policies -- add users -- etc. +- Define databases +- Modify retention policies +- Add users -You must migrate administrative tasks to the native InfluxDB Cloud or InfluxDB OSS 2.0 -user interface (UI). +To complete administrative tasks, use the following: -#### Limited InfluxQL support +- **InfluxDB user interface (UI)** +- [InfluxDB CLI](/influxdb/v2.0/reference/cli/influx/) +- [InfluxDB v2 API](/influxdb/v2.0/reference/api/) + +### Limited InfluxQL support InfluxDB Cloud and InfluxDB OSS 2.0 support InfluxQL **read-only** queries. -For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/#influxql-support), +For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/#influxql-support). {{% /warn %}} ## Create an InfluxDB connection -1. Click **Configuration** in the left navigation bar, and then click **{{< icon "plus" >}} Add Connection**. +1. In Choronograf, click **Configuration** in the left navigation bar, + and then click **{{< icon "plus" >}} Add Connection**. 2. Enter your InfluxDB connection credentials: - **Connection URL:** InfluxDB URL _(see [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/) or [InfluxDB OSS URLs](/influxdb/v2.0/reference/urls/))_ @@ -51,7 +52,7 @@ For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/ http://localhost:8086 ``` - - **Connection Name:** Name to uniquely identify this connection configuration. + - **Connection Name:** Name to uniquely identify this connection configuration - **Username:** InfluxDB username - **Password:** InfluxDB [authentication token](/influxdb/v2.0/security/tokens/) - **Telegraf Database Name:** Default database name @@ -61,14 +62,14 @@ For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/ #### DBRPs map to InfluxDB buckets In InfluxDB Cloud and InfluxDB OSS 2.0, database/retention-policy (DBRP) combinations are mapped to buckets using the `database-name/retention-policy` naming convention. -For more information, see [DBRP mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/) +For information, see [DBRP mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/) and [Map unmapped buckets](/influxdb/v2.0/query-data/influxql/#map-unmapped-buckets). {{% /note %}} -3. Click **Add Connection** -4. Select any dashboards you would like to create and then click **Next**. -5. Configure a Kapacitor connection and then click **Continue**. - If you do not wish to create a Kapacitor connection, click **Skip**. - _For more information about using Kapacitor with InfluxDB Cloud or InfluxDB OSS 2.0, +3. Click **Add Connection**. +4. Select the dashboards you would like to create, and then click **Next**. +5. To configure a Kapacitor connection, provide the necessary credentials, + and then click **Continue**. Otherwise, click **Skip**. + _For information about using Kapacitor with InfluxDB Cloud or InfluxDB OSS 2.0, see [Use Kapacitor with InfluxDB](/influxdb/v2.0/tools/kapacitor/)._ 6. Click **Finish**. diff --git a/content/influxdb/v2.0/tools/kapacitor.md b/content/influxdb/v2.0/tools/kapacitor.md index 5accf91a0..b78fa4bb7 100644 --- a/content/influxdb/v2.0/tools/kapacitor.md +++ b/content/influxdb/v2.0/tools/kapacitor.md @@ -36,7 +36,7 @@ For more information, see [below](#use-kapacitor-stream-tasks). ## Configure Kapacitor to connect to InfluxDB To connect Kapacitor to InfluxDB Cloud or InfluxDB OSS 2.0, update the `[[influxdb]]` -section(s) of your Kapacitor configuration file: +section(s) of your [Kapacitor configuration file](/{{< latest "kapacitor" >}}/administration/configuration/#kapacitor-configuration-file): - [Specify your InfluxDB URL](#specify-your-influxdb-url) - [Provide InfluxDB authentication credentials](#provide-influxdb-authentication-credentials) @@ -70,12 +70,14 @@ configuration options: {{% warn %}} Kapacitor is subject to InfluxDB token permission restrictions. -Ensure the provided InfluxDB authentication token has the necessary read and write permissions. +To query or write to an InfluxDB bucket, the InfluxDB token must have read and/or +write permissions for the target bucket. +For information about token permissions, see [Create a token](/influxdb/v2.0/security/tokens/create-token/). {{% /warn %}} ### Disable InfluxDB subscriptions InfluxDB Cloud and InfluxDB OSS 2.0 do not have subscriptions APIs. -Set the `[[influxdb]].disable-subscriptions`to `false` to disable InfluxDB subscriptions. +Set the `[[influxdb]].disable-subscriptions`to `true` to disable InfluxDB subscriptions. ```toml [[influxdb]] @@ -84,14 +86,14 @@ Set the `[[influxdb]].disable-subscriptions`to `false` to disable InfluxDB subsc ``` ## Use Kapacitor batch tasks -Kapacitor batch tasks use the `/query` endpoint of the 1.x compatibility API +Kapacitor batch tasks use the `query` endpoint of the 1.x compatibility API and require no change to use with InfluxDB Cloud and InfluxDB OSS. For information about writing back to InfluxDB in Kapacitor tasks, see [Write back to InfluxDB](#write-back-to-influxdb) below. ## Use Kapacitor stream tasks InfluxDB Cloud and OSS 2.0 do not have subscription APIs and do not support Kapacitor stream tasks directly. -To use Kapacitor stream tasks, write data directly to Kapacitor using the [Kapcitior `/write` API](/{{< latest "kapacitor" >}}/working/api/#writing-data). +To use Kapacitor stream tasks, write data directly to Kapacitor using the [Kapcitior `write` API](/{{< latest "kapacitor" >}}/working/api/#writing-data). We recommend using [Telegraf InfluxDB output plugin](/{{< latest "telegraf" >}}/plugins/#influxdb) to write data to both InfluxDB Cloud or OSS and Kapacitor.