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

Merge pull request #1306 from influxdata/dashboards 

Update dashboards
pull/2310/head
kelseiv 2021-03-17 06:43:35 -07:00 committed by GitHub
parent 6a8cb8404f 13046d5e8b
commit 9b85eeb07a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 55 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
content/chronograf/v1.8/administration/config-options.md
View File

@ -64,7 +64,6 @@ Start the Chronograf service, and include any options after `chronograf`, where
> ***Note:*** Command line options take precedence over corresponding environment variables.
## Chronograf service options
#### `--host=`
@ -95,7 +94,7 @@ Environment variable: `$BOLT_PATH`
#### `--canned-path=` | `-c`
The path to the directory of [canned dashboards](/chronograf/v1.8/guides/using-precreated-dashboards) files.
The path to the directory of [canned dashboards](/chronograf/v1.8/guides/using-precreated-dashboards) files. Canned dashboards (also known as pre-created dashboards or application layouts) cannot be edited. They're delivered with Chronograf and available depending on which Telegraf input plugins you have enabled.
Default value: `/usr/share/chronograf/canned`
@ -103,7 +102,11 @@ Environment variable: `$CANNED_PATH`
#### `--resources-path=`
Path to directory of canned dashboards, sources, Kapacitor connections, and organizations.
Path to directory of sources (.src files), Kapacitor connections (.kap files), organizations (.org files), and dashboards (.dashboard files).
{{% note %}}
**Note:** If you have a dashboard with the `.json` extension, rename it with the `.dashboard` extension in this directory to ensure the dashboard is loaded.
{{% /note %}}
Default value: `/usr/share/chronograf/resources`
@ -229,7 +232,6 @@ ETCD_ENDPOINTS=localhost:2379
ETCD_ENDPOINTS=localhost:2379,192.168.1.61:2379,192.192.168.1.100:2379
```
#### `--etcd-username=`
Username to log into etcd.
@ -346,7 +348,6 @@ The secret for signing tokens.
Environment variable: `$TOKEN_SECRET`
### GitHub-specific OAuth 2.0 authentication options
See [Configuring GitHub authentication](/chronograf/v1.8/administration/managing-security/#configure-github-authentication) for more information.

2
content/chronograf/v1.8/administration/configuration.md
View File

@ -31,7 +31,7 @@ Use one of the following commands to start Chronograf:
service chronograf start
```
- **mIf you built Chronograf from source:**
- **If you built Chronograf from source:**
```bash
$GOPATH/bin/chronograf

80
content/chronograf/v1.8/administration/import-export-dashboards.md
View File

@ -1,52 +1,60 @@
---
title: Import and export Chronograf dashboards
description: Share dashboard JSON files between Chronograf instances.
description: Share dashboard JSON files between Chronograf instances, or add dashboards as resources to include in a deployment.
menu:
chronograf_1_8:
weight: 120
parent: Administration
---
Chronograf makes it easy to both export and import dashboards.
Dashboard exports are simple JSON files that can be shared and imported into other Chronograf instances.
This allows you to recreate robust dashboards without having to manually configure them from the ground up.
Chronograf makes it easy to recreate robust dashboards without having to manually configure them from the ground up. Import and export dashboards between instances, or add dashboards as resources to include in a deployment.
[Export a dashboard](#export-a-dashboard)
[Import a dashboard](#import-a-dashboard)
[Required user roles](#required-user-roles)
## Export a dashboard
1. Go to your "Dashboards" landing page.
2. Hover over the dashboard you would like to export and click the "Export"
button that appears to the right.
<img src="/img/chronograf/1-6-dashboard-export.png" alt="Exporting a Chronograf dashboard" style="width:100%;max-width:912px"/>
This downloads a JSON file containing dashboard information including template variables,
cells and cell information such as the query, cell-sizing, color scheme, visualization type, etc.
> No time series data is exported with a dashboard.
> Exports include only dashboard-related information as mentioned above.
## Import a dashboard
1. On your "Dashboards" landing page, click the "Import Dashboard" button.
2. Either drag and drop or select the JSON export file to import.
3. Click the "Upload Dashboard" button.
The newly imported dashboard will be included in your list of dashboards.
![Importing a Chronograf dashboard](/img/chronograf/1-6-dashboard-import.gif)
### Reconcile unmatched sources
If the data sources defined in the imported dashboard JSON file do not match any of your local sources,
you will have to reconcile each of the unmatched sources during the import process.
![Reconcile unmatched sources](/img/chronograf/1-6-dashboard-import-reconcile.png)
- [Export a dashboard](#export-a-dashboard)
- [Load a dashboard as a resource](#load-a-dashboard-as-a-resource)
- [Import a dashboard](#import-a-dashboard)
- [Required user roles](#required-user-roles)
## Required user roles
Depending on the role of your user, there are some restrictions on importing and exporting dashboards:
All users can export a dashboard. To import a dashboard, a user must have an Admin or Editor role.
| Task vs Role | Admin | Editor | Viewer |
|------------------|:-----:|:------:|:------:|
| Export Dashboard | ✅ | ✅ | ✅ |
| Import Dashboard | ✅ | ✅ | ❌ |
## Export a dashboard
1. On the Dashboards page, hover over the dashboard you want to export, and then click the **Export**
button on the right.
<img src="/img/chronograf/1-6-dashboard-export.png" alt="Exporting a Chronograf dashboard" style="width:100%;max-width:912px"/>
This downloads a JSON file containing dashboard information including template variables, cells and cell information such as the query, cell-sizing, color scheme, visualization type, etc.
> No time series data is exported with a dashboard.
> Exports include only dashboard-related information as mentioned above.
## Load a dashboard as a resource
Automatically load the dashboard as a resource (useful for adding a dashboard to a deployment).
1. Rename the dashboard `.json` extension to `.dashboard`.
2. Use the [`resources-path` configuration option](/chronograf/v1.8/administration/config-options/#--resources-path) to save the dashboard in the `/resources` directory (by default, `/usr/share/chronograf/resources`).
## Import a dashboard
1. On your Dashboards page, click the **Import Dashboard** button.
2. Either drag and drop or select the JSON export file to import.
3. Click the **Upload Dashboard** button.
The newly imported dashboard is included in your list of dashboards.
![Importing a Chronograf dashboard](/img/chronograf/1-6-dashboard-import.gif)
### Reconcile unmatched sources
If the data sources defined in the imported dashboard file do not match any of your local sources,
reconcile each of the unmatched sources during the import process, and then click **Done**.
![Reconcile unmatched sources](/img/chronograf/1-6-dashboard-import-reconcile.png)

1
content/chronograf/v1.8/guides/cloning-in-ui.md
View File

@ -14,7 +14,6 @@ This guide explains how to clone, or duplicate, a dashboard or a cell for use as
Dashboards in Chronograf can be cloned (or copied) to be used to create a dashboard based on the original. Rather than building a new dashboard from scratch, you can clone a dashboard and make changes to the dashboard copy.
### To clone a dashboard
1. On the **Dashboards** page, hover your cursor over the listing of the dashboard that you want to clone and click the **Clone** button that appears.

5
content/chronograf/v1.8/guides/create-a-dashboard.md
View File

@ -12,7 +12,10 @@ Chronograf offers a complete dashboard solution for visualizing your data and mo
* View [pre-created dashboards](/chronograf/v1.8/guides/using-precreated-dashboards) from the Host List page. Dashboards are available depending on which Telegraf input plugins you have enabled. These pre-created dashboards cannot be cloned or edited.
* Create custom dashboards from scratch by building queries in the Data Explorer, as described [below](#build-a-dashboard).
* Import dashboard templates when you add or update a connection in Chronograf. See [Dashboard templates](#dashboard-templates) for details.
* [Export a dashboard](/chronograf/latest/administration/import-export-dashboards/#export-a-dashboard) you create
* Import a dashboard:
* When you want to [import an exported dashboard](/chronograf/latest/administration/import-export-dashboards/#import-a-dashboard).
* When you want to add or update a connection in Chronograf. See [Dashboard templates](#dashboard-templates) for details.
By the end of this guide, you'll be aware of the tools available to you for creating dashboards similar to this example: