Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

addressed PR feedback in kapa and chrono guides

pull/1827/head
Scott Anderson 2020-11-23 10:27:39 -07:00
parent 0bc3606bd7
commit 1b65ddca9a
4 changed files with 33 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
content/influxdb/cloud/tools/chronograf.md
View File

@ -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/).

4
content/influxdb/v2.0/telegraf-configs/_index.md
View File

@ -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.

45
content/influxdb/v2.0/tools/chronograf.md
View File

@ -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**.

12
content/influxdb/v2.0/tools/kapacitor.md
View File

@ -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.