updated chronograf 1.8 connection config doc

pull/1970/head
Scott Anderson 2020-12-09 17:04:17 -07:00
parent cb7454be18
commit c04124d85c
4 changed files with 50 additions and 14 deletions

View File

@ -23,20 +23,54 @@ To create an InfluxDB connection in the Chronograf UI:
1. Open Chronograf and click **Configuration** (wrench icon) in the navigation menu.
2. Click **Add Connection**.
![Chronograf connections landing page](/img/chronograf/1-6-connection-landing-page.png)
3. Enter values for the following fields:
<img src="/img/chronograf/1-7-influxdb-connection-config.png" style="width:100%; max-width:600px;">
![Chronograf connections landing page](/img/chronograf/1-6-connection-landing-page.png)
* **Connection URL**: Enter the hostname or IP address of the InfluxDB instance and the port. The field is prefilled with `http://localhost:8086`.
* **Connection Name**: Enter the name for this connection.
* **Username**: Enter the username that will be shared for this connection.
*Required only if [authorization is enabled](/{{< latest "influxdb" "v1" >}}/administration/authentication_and_authorization/) on the InfluxDB instance to which you're connecting.*
* **Password**: Enter the password.
*Required only if [authorization is enabled](/{{< latest "influxdb" "v1" >}}/administration/authentication_and_authorization/) on the InfluxDB instance to which you're connecting.*
* **Telegraf Database Name**: This field specifies the database that Chronograf will use for populating different parts of the application, including the Host List page. If none is provided, we will use `autogen`. You will still be able to query any database you have access to in the InfluxDB instance when building dashboards or exploring data.
* **Default Retention Policy**: Enter the name of the default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp). If none is provided, it assumes `autogen`. If you've changed the default retention policy in your InfluxDB instance, you may want to change it here as well.
* **Make this the default connection**: When this option is selected, this InfluxDB connection will be used when Chronograf is launched.
3. Provide the necessary connection credentials.
{{< tabs-wrapper >}}
{{% tabs %}}
[InfluxDB 1.x](#)
[InfluxDB Cloud or OSS 2.x ](#)
{{% /tabs %}}
{{% tab-content %}}
<img src="/img/chronograf/1-8-influxdb-v1-connection-config.png" style="width:100%; max-width:798px;"/>
- **Connection URL**: hostname or IP address and port of the InfluxDB 1.x instance
- **Connection Name**: Unique name for this connection.
- **Username**: InfluxDB 1.x username
_(Required only if [authorization is enabled](/{{< latest "influxdb" "v1" >}}/administration/authentication_and_authorization/) in InfluxDB)_
- **Password**: InfluxDB password
_(Required only if [authorization is enabled](/{{< latest "influxdb" "v1" >}}/administration/authentication_and_authorization/) in InfluxDB)_
- **Telegraf Database Name**: the database Chronograf uses to populate parts of the application, including the Host List page (default is `autogen`)
- **Default Retention Policy**: default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp) (default is `autogen`)
- **Default connection**: use this connection as the default connection
{{% /tab-content %}}
{{% tab-content %}}
<img src="/img/chronograf/1-8-influxdb-v2-connection-config.png" style="width:100%; max-width:798px;"/>
- **Enable the {{< req "InfluxDB v2 Auth" >}} option**
- **Connection URL**: InfluxDB Cloud or OSS 2.x URL
```
http://localhost:8086
```
- **Connection Name**: Unique name for this connection.
- **Organiziation**: InfluxDB organization
- **Token**: InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
- **Telegraf Database Name**: database Chronograf uses to populate parts of the application, including the Host List page (default is `autogen`)
- **Default Retention Policy**: default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp) (default is `autogen`)
- **Default connection**: use this connection as the default connection
{{% note %}}
For more information about connecting Chronograf to an InfluxDB Cloud or OSS 2.x instance, see:
- [Use Chronograf with InfluxDB Cloud](/influxdb/cloud/tools/chronograf/)
- [Use Chronograf with InfluxDB OSS 2.x](/{{< latest "influxdb" "v2" >}}/tools/chronograf/)
{{% /note %}}
{{% /tab-content %}}
{{< /tabs-wrapper >}}
4. Click **Add Connection**
* If the connection is valid, the Dashboards window appears, allowing you to import dashboard templates you can use to display and analyze your data. For details, see [Creating dashboards](/chronograf/v1.8/guides/create-a-dashboard).

View File

@ -62,8 +62,10 @@ For more information, see [InfluxQL support](/influxdb/v2.0/query-data/influxql/
- **Connection Name:** Name to uniquely identify this connection configuration
- **Organization:** InfluxDB organization name
- **Token:** InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
- **Telegraf Database Name:** Default database name
- **Default Retention Policy:** Default retention policy
- **Telegraf Database Name:** database Chronograf uses to populate parts of
the application, including the Host List page (default is `autogen`)
- **Default Retention Policy:** default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp)
(default is `autogen`)
{{% note %}}
#### DBRPs map to InfluxDB buckets

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB