updated chronograf docs to address PR feedback
Scott Anderson
parent
c04124d85c
commit
e6bc3636e8
|
|
@ -8,7 +8,7 @@
|
|||
color: $article-note-text;
|
||||
}
|
||||
strong {
|
||||
color: inherit;
|
||||
color: $article-note-strong;
|
||||
}
|
||||
a {
|
||||
color: $article-note-link;
|
||||
|
|
|
|||
|
|
@ -81,6 +81,7 @@ $article-table-scrollbar: $g0-obsidian;
|
|||
$article-note-base: $gr-viridian;
|
||||
$article-note-heading: $g20-white;
|
||||
$article-note-text: $gr-honeydew;
|
||||
$article-note-strong: $gr-krypton;
|
||||
$article-note-link: $gr-wasabi;
|
||||
$article-note-link-hover: $g20-white;
|
||||
$article-note-table-header: $grad-green-dark;
|
||||
|
|
|
|||
|
|
@ -82,6 +82,7 @@ $article-table-scrollbar: $g14-chromium !default;
|
|||
$article-note-base: $gr-rainforest !default;
|
||||
$article-note-heading: $gr-emerald !default;
|
||||
$article-note-text: $gr-emerald !default;
|
||||
$article-note-strong: $gr-emerald !default;
|
||||
$article-note-link: $b-ocean !default;
|
||||
$article-note-link-hover: $br-magenta !default;
|
||||
$article-note-table-header: $grad-green-dark !default;
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
@font-face {
|
||||
font-family: 'icomoon';
|
||||
src: url('fonts/icomoon.eot?lj8dxa');
|
||||
src: url('fonts/icomoon.eot?lj8dxa#iefix') format('embedded-opentype'),
|
||||
url('fonts/icomoon.ttf?lj8dxa') format('truetype'),
|
||||
url('fonts/icomoon.woff?lj8dxa') format('woff'),
|
||||
url('fonts/icomoon.svg?lj8dxa#icomoon') format('svg');
|
||||
src: url('fonts/icomoon.eot?a22byr');
|
||||
src: url('fonts/icomoon.eot?a22byr#iefix') format('embedded-opentype'),
|
||||
url('fonts/icomoon.ttf?a22byr') format('truetype'),
|
||||
url('fonts/icomoon.woff?a22byr') format('woff'),
|
||||
url('fonts/icomoon.svg?a22byr#icomoon') format('svg');
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
font-display: block;
|
||||
|
|
@ -25,6 +25,9 @@
|
|||
-moz-osx-font-smoothing: grayscale;
|
||||
}
|
||||
|
||||
.icon-crown:before {
|
||||
content: "\e934";
|
||||
}
|
||||
.icon-book-pencil:before {
|
||||
content: "\e965";
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ menu:
|
|||
name: Create InfluxDB and Kapacitor connections
|
||||
weight: 50
|
||||
parent: Administration
|
||||
related:
|
||||
- /influxdb/v2.0/tools/chronograf/
|
||||
---
|
||||
|
||||
Connections to InfluxDB and Kapacitor can be configured through the Chronograf user interface (UI) or with JSON configuration files:
|
||||
|
|
@ -42,26 +44,29 @@ To create an InfluxDB connection in the Chronograf UI:
|
|||
_(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
|
||||
- **Telegraf Database Name**: the database Chronograf uses to populate parts of the application, including the Host List page (default is `telegraf`)
|
||||
- **Default Retention Policy**: default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp)
|
||||
(if left blank, defaults to `autogen`)
|
||||
- **Default connection**: use this connection as the default connection for data exploration, dashboards, and administrative actions
|
||||
{{% /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
|
||||
- **Connection URL**: [InfluxDB Cloud region URL](/influxdb/cloud/reference/regions/)
|
||||
or [InfluxDB OSS 2.x URL](/influxdb/v2.0/reference/urls/)
|
||||
|
||||
```
|
||||
http://localhost:8086
|
||||
```
|
||||
|
||||
- **Connection Name**: Unique name for this connection.
|
||||
- **Organiziation**: InfluxDB organization
|
||||
- **Organiziation**: InfluxDB [organization](/influxdb/v2.0/organizations/)
|
||||
- **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
|
||||
- **Telegraf Database Name**: database Chronograf uses to populate parts of the application, including the Host List page (default is `telegraf`)
|
||||
- **Default Retention Policy**: default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp)
|
||||
(if left blank, default is `autogen`)
|
||||
- **Default connection**: use this connection as the default connection for data exploration and dashboards
|
||||
|
||||
{{% note %}}
|
||||
For more information about connecting Chronograf to an InfluxDB Cloud or OSS 2.x instance, see:
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Example post
|
||||
description: This is just an example post to show the format of new 2.0 posts
|
||||
weight: 1
|
||||
draft: true
|
||||
#draft: true
|
||||
related:
|
||||
- /influxdb/v2.0/write-data/
|
||||
- /influxdb/v2.0/write-data/quick-start
|
||||
|
|
@ -35,6 +35,7 @@ This is **bold** text. This is _italic_ text. This is _**bold and italic**_.
|
|||
{{< icon "cog" >}} cog
|
||||
{{< icon "config" >}} config
|
||||
{{< icon "copy" >}} copy
|
||||
{{< icon "crown" >}} crown
|
||||
{{< icon "dashboard" >}} dashboard
|
||||
{{< icon "dashboards" >}} dashboards
|
||||
{{< icon "data-explorer" >}} data-explorer
|
||||
|
|
|
|||
|
|
@ -21,29 +21,6 @@ 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 %}}
|
||||
### 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:
|
||||
|
||||
- Define databases
|
||||
- Modify retention policies
|
||||
- Add users
|
||||
|
||||
When connected to an InfluxDB Cloud or InfluxDB 2.0 database, the **InfluxDB Admin**
|
||||
section of Chronograf is disabled.
|
||||
|
||||
To complete administrative tasks, use the following:
|
||||
|
||||
- **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).
|
||||
{{% /warn %}}
|
||||
|
||||
## Create an InfluxDB connection
|
||||
1. In Choronograf, click **Configuration** in the left navigation bar,
|
||||
and then click **{{< icon "plus" >}} Add Connection**.
|
||||
|
|
@ -60,17 +37,19 @@ 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
|
||||
- **Organization:** InfluxDB [organization](/influxdb/v2.0/organizations/)
|
||||
- **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`)
|
||||
the application, including the Host List page (default is `telegraf`)
|
||||
- **Default Retention Policy:** default [retention policy](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp)
|
||||
(default is `autogen`)
|
||||
(if left blank, defaults to `autogen`)
|
||||
|
||||
{{% 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.
|
||||
**DBRP mappings are required to query InfluxDB OSS 2.x or InfluxDB Cloud using InfluxQL.**
|
||||
|
||||
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 %}}
|
||||
|
|
@ -83,9 +62,36 @@ and [Map unmapped buckets](/influxdb/v2.0/query-data/influxql/#map-unmapped-buck
|
|||
see [Use Kapacitor with InfluxDB](/influxdb/v2.0/tools/kapacitor/)._
|
||||
6. Click **Finish**.
|
||||
|
||||
## Important notes
|
||||
|
||||
- [Update upgraded InfluxDB connections](#Update-upgraded-InfluxDB-connections)
|
||||
- [No administrative functionality](#No-administrative-functionality)
|
||||
- [Limited InfluxQL support](#Limited-InfluxQL-support)
|
||||
|
||||
### Update upgraded InfluxDB connections
|
||||
If using Chronograf with an InfluxDB instance that was upgraded from 1.x
|
||||
to 2.x, update your connection configuration to use the **InfluxDB v2 Auth** option
|
||||
and provide an organization and a token.
|
||||
to 2.x, update your InfluxDB connection configuration in Chronograf to use the
|
||||
**InfluxDB v2 Auth** option and provide an organization and a token.
|
||||
**Without an organization, Chronograf cannot use Flux to query InfluxDB.**
|
||||
|
||||
### 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:
|
||||
|
||||
- Define databases
|
||||
- Modify retention policies
|
||||
- Add users
|
||||
|
||||
When connected to an InfluxDB Cloud or InfluxDB 2.0 database, functionality in the
|
||||
**{{< icon "crown" >}} InfluxDB Admin** section of Chronograf is disabled.
|
||||
|
||||
To complete administrative tasks, use the following:
|
||||
|
||||
- **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).
|
||||
|
||||
|
|
|
|||
|
|
@ -60,6 +60,8 @@
|
|||
<span class="inline icon-eye-closed large"></span>
|
||||
{{ else if or (eq $icon "notebook") (eq $icon "notebooks") }}
|
||||
<span class="inline icon-book-pencil"></span>
|
||||
{{ else if eq $icon "crown" }}
|
||||
<span class="inline icon-crown large"></span>
|
||||
{{ else if eq $icon "add-label" }}
|
||||
<span class="inline add-btn-round"></span>
|
||||
{{ else if or (eq $icon "toggle") (eq $icon "toggle-blue") }}
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -59,6 +59,7 @@
|
|||
<glyph unicode="" glyph-name="refresh" d="M875.95 653.953c-76.95 76.95-176.344 127.609-285.357 144.282-135.304 20.52-270.608-12.826-381.545-93.622-110.296-81.439-182.756-200.712-203.277-336.016-5.13-35.268 18.596-67.972 53.866-73.102 3.206-0.642 6.412-0.642 9.618-0.642 31.422 0 58.354 22.444 63.484 54.506 15.39 101.318 69.896 191.093 152.618 252.012s184.68 85.928 285.998 70.538c82.080-12.184 156.466-50.658 214.178-108.372l-144.282-144.282h384.751v384.751l-150.053-150.053zM966.367 286.516c-35.268 5.13-67.972-18.596-73.102-53.866-32.062-209.69-228.927-354.612-438.616-322.55-81.439 12.184-156.466 50.658-214.178 108.372l144.282 144.282h-384.751v-384.751l150.053 150.053c76.95-76.95 176.986-127.609 285.357-144.282 26.292-3.848 51.942-5.772 77.592-5.772 248.806 0 468.114 182.116 506.589 435.41 5.772 35.268-17.956 67.972-53.224 73.102z" />
|
||||
<glyph unicode="" glyph-name="remove" d="M641.252 291.004l236.622 236.622c25.008 25.008 25.008 66.049 0 90.416l-37.834 37.834c-25.008 25.008-66.049 25.008-90.416 0l-236.622-236.622-236.622 236.622c-25.008 25.008-66.049 25.008-90.416 0l-37.834-37.834c-25.008-25.008-25.008-66.049 0-90.416l236.622-236.622-236.622-236.622c-25.008-25.008-25.008-66.049 0-90.416l37.834-37.834c25.008-25.008 66.049-25.008 90.416 0l236.622 236.622 236.622-236.622c25.008-25.008 66.049-25.008 90.416 0l37.834 37.834c25.008 25.008 25.008 66.049 0 90.416l-236.622 236.622z" />
|
||||
<glyph unicode="" glyph-name="alert-circle" d="M982.292 300.179c0 129.706-52.616 247.238-137.606 332.185s-202.481 137.606-332.185 137.606-247.238-52.616-332.185-137.606-137.606-202.481-137.606-332.185 52.616-247.238 137.606-332.185 202.481-137.606 332.185-137.606 247.238 52.616 332.185 137.606 137.606 202.481 137.606 332.185zM896.876 300.179c0-106.173-42.965-202.181-112.579-271.796s-165.623-112.579-271.796-112.579-202.181 42.965-271.796 112.579-112.579 165.623-112.579 271.796 42.965 202.181 112.579 271.796 165.623 112.579 271.796 112.579 202.181-42.965 271.796-112.579 112.579-165.623 112.579-271.796zM469.792 471.013v-170.834c0-23.575 19.134-42.709 42.709-42.709s42.709 19.134 42.709 42.709v170.834c0 23.575-19.134 42.709-42.709 42.709s-42.709-19.134-42.709-42.709zM512.5 86.637c23.575 0 42.709 19.134 42.709 42.709s-19.134 42.709-42.709 42.709-42.709-19.134-42.709-42.709 19.134-42.709 42.709-42.709z" />
|
||||
<glyph unicode="" glyph-name="crown" d="M187.063-96.155c-28.188 0-51.25 20.5-58.938 46.125l-125.563 492c-5.125 17.938 2.563 38.438 17.938 48.688 15.375 12.813 35.875 12.813 53.813 2.563l233.188-148.625 166.563 246c7.688 12.813 23.063 20.5 38.438 20.5s30.75-7.688 38.438-20.5l169.125-246 233.188 148.625c15.375 10.25 38.438 10.25 53.813-2.563s23.063-30.75 17.938-51.25l-128.125-489.438c-7.688-28.188-30.75-46.125-58.938-46.125h-650.876zM202.438-29.53v0c0 0 0 0 0 0zM199.875-19.28h625.251l105.063 407.438-181.938-117.875c-28.188-17.938-64.063-10.25-82 15.375l-153.75 222.938-153.75-222.938c-17.938-25.625-53.813-33.313-82-17.938l-181.938 117.875 105.063-404.875zM994.251 429.158v0c0 0 0 0 0 0zM76.875 459.908v0c0 0 0 0 0 0zM948.126 459.908c0 0 0 0 0 0v0zM486.875 547.033c2.563 0 2.563 0 0 0v0zM535.563 547.033v0c0 0 0 0 0 0z" />
|
||||
<glyph unicode="" glyph-name="trash" d="M936.227 675.756h-194.94l-66.69 110.296c-5.13 10.26-17.956 17.956-30.78 17.956h-261.63c-12.826 0-25.65-7.696-33.346-17.956l-64.126-110.296h-194.94c-20.52 0-38.476-17.956-38.476-38.476v-102.6c0-20.52 17.956-38.476 38.476-38.476h846.453c20.52 0 38.476 17.956 38.476 38.476v102.6c0 20.52-17.956 38.476-38.476 38.476zM405.271 727.056h215.46l30.78-51.3h-277.021l30.78 51.3zM859.277 444.905h-692.552c-10.26 0-20.52-5.13-28.216-12.826s-10.26-17.956-10.26-28.216l51.3-589.952c2.566-20.52 17.956-35.91 38.476-35.91h589.952c20.52 0 35.91 15.39 38.476 35.91l51.3 589.952c0 10.26-2.566 20.52-10.26 28.216s-17.956 12.826-28.216 12.826z" />
|
||||
<glyph unicode="" glyph-name="triangle" d="M983.252 66.567l-359.101 607.052c-17.101 29.925-47.025 51.3-81.225 59.849s-68.401 4.275-98.325-12.826c-17.101-8.549-34.199-25.65-42.751-42.751 0 0 0 0 0 0l-359.101-611.326c-34.199-59.849-12.826-141.076 47.025-175.275 17.101-12.826 38.476-17.101 59.849-17.101h726.752c34.199 0 68.401 12.826 89.776 38.476 25.65 25.65 38.476 55.575 38.476 89.776-4.275 21.375-8.549 47.025-21.375 64.126zM906.302-27.483c-8.549-8.549-21.375-12.826-29.925-12.826h-726.752c-8.549 0-12.826 0-21.375 4.275-21.375 12.826-25.65 38.476-17.101 59.849l363.377 602.777c4.275 4.275 8.549 12.826 12.826 12.826 21.375 12.826 47.025 4.275 59.849-12.826l363.377-602.777c4.275-4.275 4.275-12.826 4.275-21.375 4.275-12.826-4.275-21.375-8.549-29.925z" />
|
||||
<glyph unicode="" glyph-name="x" d="M572.851 301.692l226.575 226.575c17.101 17.101 17.101 42.751 0 59.849s-42.751 17.101-59.849 0l-226.575-226.575-226.575 226.575c-17.101 17.101-42.751 17.101-59.849 0s-17.101-42.751 0-59.849l226.575-226.575-226.575-226.575c-17.101-17.101-17.101-42.751 0-59.849 8.549-8.549 17.101-12.826 29.925-12.826s21.375 4.275 29.925 12.826l226.575 226.575 226.575-226.575c8.549-8.549 21.375-12.826 29.925-12.826s21.375 4.275 29.925 12.826c17.101 17.101 17.101 42.751 0 59.849l-226.575 226.575z" />
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 63 KiB After Width: | Height: | Size: 64 KiB |
Binary file not shown.
Binary file not shown.
Loading…
Reference in New Issue