From dd5c6a26d020430265a78fe5165c57b1887477ad Mon Sep 17 00:00:00 2001 From: Kelly Date: Thu, 13 Aug 2020 15:32:41 -0700 Subject: [PATCH 1/6] move Update dashboards doc PR from v1 to v2 --- .../v1.8/administration/config-options.md | 4 +- .../v1.8/administration/configuration.md | 2 +- .../import-export-dashboards.md | 60 ++++++++++--------- .../chronograf/v1.8/guides/cloning-in-ui.md | 15 +++-- .../v1.8/guides/create-a-dashboard.md | 5 +- 5 files changed, 45 insertions(+), 41 deletions(-) diff --git a/content/chronograf/v1.8/administration/config-options.md b/content/chronograf/v1.8/administration/config-options.md index 48e8bc25c..19876e834 100644 --- a/content/chronograf/v1.8/administration/config-options.md +++ b/content/chronograf/v1.8/administration/config-options.md @@ -94,7 +94,7 @@ Environment variable: `$BOLT_PATH` #### `--canned-path=` | `-c` -The path to the directory of [canned dashboards](/chronograf/latest/guides/using-precreated-dashboards) files. +The path to the directory of [canned dashboards](/chronograf/latest/guides/using-precreated-dashboards) and [exported dashboard](/chronograf/latest/administration/import-export-dashboards/#export-a-dashboard) (.dashboard) files. Default value: `/usr/share/chronograf/canned` @@ -102,7 +102,7 @@ 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), and organizations (.org files). Default value: `/usr/share/chronograf/resources` diff --git a/content/chronograf/v1.8/administration/configuration.md b/content/chronograf/v1.8/administration/configuration.md index 899136489..65f99835d 100644 --- a/content/chronograf/v1.8/administration/configuration.md +++ b/content/chronograf/v1.8/administration/configuration.md @@ -30,7 +30,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 diff --git a/content/chronograf/v1.8/administration/import-export-dashboards.md b/content/chronograf/v1.8/administration/import-export-dashboards.md index ed59bf415..efd2550fc 100644 --- a/content/chronograf/v1.8/administration/import-export-dashboards.md +++ b/content/chronograf/v1.8/administration/import-export-dashboards.md @@ -7,46 +7,48 @@ menu: 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 both export and import dashboards. Recreate robust dashboards without having to manually configure them from the ground up. -[Exporting a dashboard](#exporting-a-dashboard) -[Importing a dashboard](#importing-a-dashboard) +[Export a dashboard](#export-a-dashboard) +[Import a dashboard](#import-a-dashboard) [Required user roles](#required-user-roles) -## Exporting 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. +## Required user roles -Exporting a Chronograf dashboard +All users can export a dashboard. To import a dashboard, a user must have an Admin or Editor role. -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. +| Task vs Role | Admin | Editor | Viewer | +|------------------|:-----:|:------:|:------:| +| Export Dashboard | ✅ | ✅ | ✅ | +| Import Dashboard | ✅ | ✅ | ❌ | -> No time series data is exported with a dashboard. -> Exports include only dashboard-related information as mentioned above. +## Export a dashboard -## Importing 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. +1. On the Dashboards page, hover over the dashboard you want to export, and then click the **Export** + button on the right. -The newly imported dashboard will be included in your list of dashboards. + Exporting a Chronograf dashboard + + 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. + +2. Rename the `.json` extention to `.dashboard`, and save the dashboard file in the `/usr/share/chronograf/canned` directory. + +## Import a dashboard + +1. On your Dashboards page, click the **Import Dashboard** button. +2. Either drag and drop or select the `.dashboard` 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) ### Reconciling 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. + +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) - -## Required user roles -Depending on the role of your user, there are some restrictions on importing and exporting dashboards: - -| Task vs Role | Admin | Editor | Viewer | -|------------------|:-----:|:------:|:------:| -| Export Dashboard | ✅ | ✅ | ✅ | -| Import Dashboard | ✅ | ✅ | ❌ | diff --git a/content/chronograf/v1.8/guides/cloning-in-ui.md b/content/chronograf/v1.8/guides/cloning-in-ui.md index ea94831f5..fd7bbb1bb 100644 --- a/content/chronograf/v1.8/guides/cloning-in-ui.md +++ b/content/chronograf/v1.8/guides/cloning-in-ui.md @@ -13,18 +13,17 @@ 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. -![Click the Clone button](/img/chronograf/1-6-clone-dashboard.png) + ![Click the Clone button](/img/chronograf/1-6-clone-dashboard.png) -The cloned dashboard opens and displays the name of the original dashboard with `(clone)` after it. + The cloned dashboard opens and displays the name of the original dashboard with `(clone)` after it. -![Cloned dashboard](/img/chronograf/1-6-clone-dashboard-clone.png) + ![Cloned dashboard](/img/chronograf/1-6-clone-dashboard-clone.png) -You can now change the dashboard name and customize the dashboard. + You can now change the dashboard name and customize the dashboard. ## Cloning cells @@ -34,10 +33,10 @@ Cells in Chronograf dashboards can be cloned, or copied, to quickly create a cel 1. On the dashboard cell that you want to make a copy of, click the **Clone** icon and then confirm by clicking **Clone Cell**. -![Click the Clone icon](/img/chronograf/1-6-clone-cell-click-button.png) + ![Click the Clone icon](/img/chronograf/1-6-clone-cell-click-button.png) 2. The cloned cell appears in the dashboard displaying the nameof the original cell with `(clone)` after it. -![Cloned cell](/img/chronograf/1-6-clone-cell-cell-copy.png) + ![Cloned cell](/img/chronograf/1-6-clone-cell-cell-copy.png) -You can now change the cell name and customize the cell. + You can now change the cell name and customize the cell. diff --git a/content/chronograf/v1.8/guides/create-a-dashboard.md b/content/chronograf/v1.8/guides/create-a-dashboard.md index 98570ee80..40ecf9260 100644 --- a/content/chronograf/v1.8/guides/create-a-dashboard.md +++ b/content/chronograf/v1.8/guides/create-a-dashboard.md @@ -12,7 +12,10 @@ Chronograf offers a complete dashboard solution for visualizing your data and mo * View [pre-created dashboards](/chronograf/latest/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: From 84a8c86f346898921404b5e914adfb045d8fd530 Mon Sep 17 00:00:00 2001 From: kelseiv <47797004+kelseiv@users.noreply.github.com> Date: Thu, 11 Mar 2021 08:53:24 -0800 Subject: [PATCH 2/6] fix typo --- .../chronograf/v1.8/administration/import-export-dashboards.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/chronograf/v1.8/administration/import-export-dashboards.md b/content/chronograf/v1.8/administration/import-export-dashboards.md index efd2550fc..4012558d8 100644 --- a/content/chronograf/v1.8/administration/import-export-dashboards.md +++ b/content/chronograf/v1.8/administration/import-export-dashboards.md @@ -34,7 +34,7 @@ All users can export a dashboard. To import a dashboard, a user must have an Adm > No time series data is exported with a dashboard. > Exports include only dashboard-related information as mentioned above. -2. Rename the `.json` extention to `.dashboard`, and save the dashboard file in the `/usr/share/chronograf/canned` directory. +2. Rename the `.json` extension to `.dashboard`, and save the dashboard file in the `/usr/share/chronograf/canned` directory. ## Import a dashboard From 283dfc4c7d03a0a8e71af9f8cf942b2f7b9383e5 Mon Sep 17 00:00:00 2001 From: Kelly Date: Fri, 12 Mar 2021 16:55:07 -0800 Subject: [PATCH 3/6] fix format --- content/chronograf/v1.8/administration/config-options.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/chronograf/v1.8/administration/config-options.md b/content/chronograf/v1.8/administration/config-options.md index 796b1db68..7833b8f1e 100644 --- a/content/chronograf/v1.8/administration/config-options.md +++ b/content/chronograf/v1.8/administration/config-options.md @@ -104,8 +104,9 @@ Environment variable: `$CANNED_PATH` Path to directory of sources (.src files), Kapacitor connections (.kap files), organizations (.org files), and dashboards (.dashboard files). -{{%note%}} +{{% note %}} **Note:** If you have a dashboard with the `.json` extension, rename it with the `.dashboard` extension to ensure the dashboard is loaded. +{{% /note %}} Default value: `/usr/share/chronograf/resources` From e2ca3ef801a095bbbfc7889f7681391546a6fde7 Mon Sep 17 00:00:00 2001 From: kelseiv <47797004+kelseiv@users.noreply.github.com> Date: Fri, 12 Mar 2021 16:58:40 -0800 Subject: [PATCH 4/6] Update config-options.md --- content/chronograf/v1.8/administration/config-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/chronograf/v1.8/administration/config-options.md b/content/chronograf/v1.8/administration/config-options.md index 7833b8f1e..c7e9f5d3c 100644 --- a/content/chronograf/v1.8/administration/config-options.md +++ b/content/chronograf/v1.8/administration/config-options.md @@ -105,7 +105,7 @@ Environment variable: `$CANNED_PATH` 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 to ensure the dashboard is loaded. +**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` From c75a0c090290a6b0f9324301029a005c3a1c25c5 Mon Sep 17 00:00:00 2001 From: Kelly Date: Fri, 12 Mar 2021 18:07:11 -0800 Subject: [PATCH 5/6] load a dashboard as a resource --- .../import-export-dashboards.md | 26 ++++++++++++------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/content/chronograf/v1.8/administration/import-export-dashboards.md b/content/chronograf/v1.8/administration/import-export-dashboards.md index 5b488e402..86d69db0c 100644 --- a/content/chronograf/v1.8/administration/import-export-dashboards.md +++ b/content/chronograf/v1.8/administration/import-export-dashboards.md @@ -1,17 +1,18 @@ --- 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. 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](#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 @@ -27,14 +28,19 @@ All users can export a dashboard. To import a dashboard, a user must have an Adm 1. On the Dashboards page, hover over the dashboard you want to export, and then click the **Export** button on the right. - Exporting a Chronograf dashboard + Exporting a Chronograf dashboard - 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. + 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. + > No time series data is exported with a dashboard. + > Exports include only dashboard-related information as mentioned above. -2. Rename the `.json` extension to `.dashboard`, and save the dashboard in the `/usr/share/chronograf/resources` directory. +## Load a dashboard as a resource + +Automatically load the dashboard as a resource (useful for adding a dashboard to a deployment). + +1. Rename the `.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 From 13046d5e8b5f5e9f262bcc78dc69d323a69622e5 Mon Sep 17 00:00:00 2001 From: Kelly Date: Fri, 12 Mar 2021 18:07:49 -0800 Subject: [PATCH 6/6] edit --- .../chronograf/v1.8/administration/import-export-dashboards.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/chronograf/v1.8/administration/import-export-dashboards.md b/content/chronograf/v1.8/administration/import-export-dashboards.md index 86d69db0c..b01efa7a1 100644 --- a/content/chronograf/v1.8/administration/import-export-dashboards.md +++ b/content/chronograf/v1.8/administration/import-export-dashboards.md @@ -39,7 +39,7 @@ All users can export a dashboard. To import a dashboard, a user must have an Adm Automatically load the dashboard as a resource (useful for adding a dashboard to a deployment). -1. Rename the `.json` extension to `.dashboard`. +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