Merge pull request #326 from influxdata/chronograf-update-011

Update Chronograf docs for 0.11

content/chronograf/v0.10/index.md

@@ -5,7 +5,7 @@ menu:
   chronograf:
     name: v0.10
     identifier: chronograf_010
-    weight: 0
+    weight: 10
 ---
 
 ## [Getting Started](/chronograf/v0.10/introduction/getting_started/)

content/chronograf/v0.11/administration/index.md

@@ -0,0 +1,13 @@
+---
+title: Administration
+
+menu:
+  chronograf_011:
+    name: Administration
+    weight: 10
+---
+
+## [New features in Chronograf 0.11](/chronograf/v0.11/administration/new_features_in_chronograf_0.11/)
+
+
+## [Upgrading to Chronograf 0.11 from versions <= 0.4](/chronograf/v0.11/administration/upgrading_to_chronograf_0.11_from_previous_versions/)

content/chronograf/v0.11/administration/new_features_in_chronograf_0.11.md

@@ -0,0 +1,23 @@
+---
+title: New features in Chronograf 0.11
+
+menu:
+  chronograf_011:
+    name: New features in Chronograf 0.11
+    weight: 0
+    parent: Administration
+---
+
+### Customizing the y-axis range
+
+Chronograf 0.11 allows users to customize the y-axis range:
+
+![Y-axis customizer GIF](/img/chronograf/v0.11/y-axis-customization.gif)
+
+### No more scientific notation!
+
+In Chronograf 0.11 we've replaced the scientific notation for large y-axis values with the following abbreviations:
+
+`K`: thousands  
+`M`: millions  
+`B`: billions

content/chronograf/v0.11/administration/upgrading_to_chronograf_0.11_from_previous_versions.md

@@ -0,0 +1,25 @@
+---
+title: Upgrading to Chronograf 0.11 from versions <= 0.4
+
+menu:
+  chronograf_011:
+    name: Upgrading to Chronograf 0.11 from versions <= 0.4
+    weight: 10
+    parent: Administration
+---
+
+Changes in Chronograf 0.11 require users looking to upgrade from versions prior to 0.10 to take a few additional steps.
+
+### For users who wish to maintain their dashboards and visualizations
+
+1. [Install](https://influxdata.com/downloads/) Chronograf 0.10 to upgrade the `chronograf.db` directory
+2. [Install](https://influxdata.com/downloads/) Chronograf 0.11
+
+### For users with no attachment to their dashboards and visualizations
+
+1. Remove the `chronograf.db` directory
+2. [Install](https://influxdata.com/downloads/) Chronograf 0.11
+
+> **Note:** Chronograf 0.11 made several changes to take into account the [breaking API changes](https://github.com/influxdata/influxdb/blob/master/CHANGELOG.md) released with InfluxDB 0.11.
+As a result, we do not recommend using Chronograf 0.11 with InfluxDB versions prior to 0.11.
+In general, we recommend maintaining version parity across the TICK stack.

content/chronograf/v0.11/index.md

@@ -0,0 +1,15 @@
+---
+title: Chronograf Version 0.11 Documentation
+
+menu:
+  chronograf:
+    name: v0.11
+    identifier: chronograf_011
+    weight: 0
+---
+
+## [Getting Started](/chronograf/v0.11/introduction/getting_started/)
+Download, install, and start building beautiful visualizations and dashboards with Chronograf.
+
+## [Templating](/chronograf/v0.11/introduction/templating/)
+Easily modify the time range and tag values displayed by a visualization and/or dashboard.

content/chronograf/v0.11/introduction/getting_started.md

@@ -0,0 +1,169 @@
+---
+title: Getting Started with Chronograf
+
+menu:
+  chronograf_011:
+    name: Getting Started
+    weight: 0
+    parent: Introduction
+---
+
+This guide shows how to download, install, and start visualizing data with Chronograf.
+
+> **Note:** Chronograf 0.11 made several changes to take into account the [breaking API changes](https://github.com/influxdata/influxdb/blob/master/CHANGELOG.md) released with InfluxDB 0.11.
+As a result, we do not recommend using Chronograf 0.11 with InfluxDB versions prior to 0.11.
+In general, we recommend maintaining version parity across the TICK stack.
+
+## Download and Install Chronograf
+Follow the instructions in the Chronograf Downloads section on the [Downloads page](https://influxdata.com/downloads/#chronograf).
+
+## Start the Chronograf Server
+How you start Chronograf depends on how you installed it:
+
+#### Debian or RPM package
+```
+sudo service chronograf start
+```
+Note that the Chronograf startup script needs root permission to ensure that it can write to `/var/log`, but the executable runs as a normal user.
+
+#### OS X via [Homebrew](http://brew.sh/)
+* Run Chronograf manually on the command line:
+
+    ```
+chronograf
+    ```
+
+* To have launchd start homebrew/binary/chronograf at login:
+
+    ```
+ln -sfv /usr/local/opt/chronograf/*.plist ~/Library/LaunchAgents
+    ```
+
+    Then to load homebrew/binary/chronograf now:
+
+    ```
+launchctl load ~/Library/LaunchAgents/homebrew.mxcl.chronograf.plist
+    ```
+
+#### Standalone OS X binary
+Assuming you're working with Chronograf version 0.11, from the `chronograf-0.11/` directory:
+```
+./chronograf-0.11-darwin_amd64
+```
+
+Check to see that Chronograf is running at http://127.0.0.1:10000.
+If this is the first time you've started Chronograf, you'll see this:
+
+![Add new server](/img/chronograf/v0.11/add-new-server.png)
+
+> **NOTE:** By default, Chronograf runs on localhost port `10000`.
+Those settings are configurable; see the configuration file to change them and to see the other configuration options.
+We list the location of the configuration file by installation process below.
+
+> * Debian or RPM package: `/opt/chronograf/config.toml`
+> * OS X via Homebrew: `/usr/local/etc/chronograf.toml`
+> * Standalone OS X binary: `chronograf-0.x.x/chronograf.toml`
+
+Now that you've got everything installed and running it's time to start visualizing your data in Chronograf!
+
+## Add your first Server
+Direct Chronograf to your InfluxDB data by adding a server:
+
+1.
+Click the `Add new server` button.
+
+2.
+Fill out the form with the relevant information.
+In this step the only required fields are `NICKNAME`, `HOST`, and `PORT`.
+
+In the example below, we've called our server `InfluxDB-1` and it's running on `localhost` on port `8086` (the default `HOST` and `PORT` for InfluxDB).
+<br>
+<br>
+![Add server](/img/chronograf/v0.11/add-server.png)
+
+3.
+Click the `Add` button.
+
+In the image below, notice that Chronograf is now aware of our InfluxDB server `InfluxDB-1`.
+<br>
+<br>
+![Servers](/img/chronograf/v0.11/servers.png)
+
+Click `Done` in the top left corner and move on to the next section to create your first graph.
+You can always return to the `Servers` page by clicking on the gear in the top right corner.
+
+## Create your first Visualization
+It's time to graph your data.
+In the next steps, we'll create an example graph that shows the average idle CPU percentage grouped by CPU tag and by one minute time intervals.
+If you'd like to follow along, see [Getting Started with Telegraf](https://docs.influxdata.com/telegraf/v0.11/introduction/getting-started-telegraf/) to get the data we use in this section.
+
+1.
+Click `+` and name your graph in the `New Graph` window.
+We'll call our graph `Average idle CPU usage`.
+
+2.
+Click the `Save` button.
+
+3.
+Choose the server, [database](../concepts/glossary.html#database), and [retention policy](../concepts/glossary.html#retention-policy-rp) that you want to work with:
+<br>
+<br>
+![Server Tray](/img/chronograf/v0.11/server-tray.png)
+
+In this example, we're working with the the server `InfluxDB-1`, the database `telegraf`, and the retention policy `default`.
+
+4.
+Create your query.
+
+To create a [query](/influxdb/v0.10/concepts/glossary/#query), you can either use the Query Builder or, if you're already familiar with InfluxQL, you can manually enter the query in the text input.
+In this step, we manually enter the following query:
+
+```
+SELECT mean(usage_idle) FROM cpu WHERE time > now() - 10m GROUP BY time(1m), cpu
+```
+
+Our query calculates the average of the field key `usage_idle` in the measurement `cpu`, and it `GROUPs BY` the tag `cpu` and by one minute intervals. The query asks for data that fall within the past 10 minutes.
+<br>
+<br>
+    ![Query Builder](/img/chronograf/v0.11/query-builder.png)
+
+Click `Done` in the top right corner to complete your graph, and move on to the next section to create your first dashboard.
+
+## Create your first Dashboard
+Now that we have a graph we want to add it to a dashboard.
+
+1.
+Move to the `DASHBOARDS` tab at the top of your screen.
+
+2.
+Click `+` and name your dashboard in the `New Dashboard` window.
+We'll call our dashboard `Idle CPU usage`.
+
+Because our dashboard has no visualizations, it looks like this:
+<br>
+<br>
+![Add Graph to Dashboard](/img/chronograf/v0.11/add-graph-to-dash.png)
+
+3.
+Click the `Add Visualization` button.
+
+4.
+We want to add the graph we made in the section above so we click `Add From Existing Visualizations`.
+<br>
+<br>
+![Add From Existing Graphs](/img/chronograf/v0.11/add-from-existing-graphs.png)
+
+5.
+Select `Average idle CPU usage` and click the `Add Visualizations to Dash` button in the top right corner.
+<br>
+<br>
+![Select Graph For Dash](/img/chronograf/v0.11/select-graph-for-dash.png)
+
+That takes us back to our new dashboard!
+One visualization on a dashboard isn't spectacularly interesting, so we've added a couple more graphs to show you some of the possibilities:
+<br>
+<br>
+![Sample Dashboard](/img/chronograf/v0.11/sample-dashboard.png)
+
+And that's it!
+You now have the foundation for building beautiful data visualizations and dashboards with Chronograf.

content/chronograf/v0.11/introduction/index.md

@@ -0,0 +1,14 @@
+---
+title: Introduction to Chronograf
+
+menu:
+  chronograf_011:
+    name: Introduction
+    weight: 0
+---
+
+## [Getting Started](/chronograf/v0.11/introduction/getting_started/)
+Download, install, and start building beautiful visualizations and dashboards with Chronograf.
+
+## [Templating](/chronograf/v0.11/introduction/templating/)
+Easily modify the time range and tag values displayed by a visualization and/or dashboard.

content/chronograf/v0.11/introduction/templating.md

@@ -0,0 +1,71 @@
+---
+title: Templating
+
+menu:
+  chronograf_011:
+    name: Templating
+    weight: 0
+    parent: Introduction
+---
+
+Easily modify the time range and [tag values](/influxdb/v0.10/concepts/glossary/#tag-value) displayed by a visualization and/or dashboard.
+
+## Templating a visualization
+
+The following sections will show you how to create template variables on a graph.
+If you'd like to follow along, see [Getting Started with Telegraf](https://docs.influxdata.com/telegraf/v0.11/introduction/getting-started-telegraf/) to get the data we use in this section.
+
+### Template time range with `tmplTime()`
+
+Use the `tmplTime()` function to create a template variable that controls the query's time range.
+This works for queries that use the query builder as well as manually entered queries.
+
+**Example:**
+
+Once you enter the query below, you can select alternative time ranges by clicking on the dropdown in the top right corner.
+
+*Query:*
+```
+SELECT usage_idle FROM "telegraf"."default"."cpu" WHERE tmplTime()
+```
+
+*Chronograf visualization with a time template variable:*
+
+![Time template](/img/chronograf/v0.11/time-template.gif)
+
+### Template tag values with `tmplTagValue()`
+
+Use the `tmplTagValue()` function to create a template variable that allows you to change the value of the query's [tag key(s)](/influxdb/v0.10/concepts/glossary/#tag-key).
+
+**Example:**
+
+In the `FILTER BY` section of the Query Builder:
+
+1.
+Select the tag key that you want to template (here, we choose `cpu`).
+
+2.
+Select `Make Variable` as the Tag Value.
+
+3.
+Save the title of your template variable in the `Make Tag Value Variable` window (here, we name it `cpu`).
+
+Now you can select alternative tag values of the tag key `cpu` in the `cpu` dropdown in the top right corner.
+
+> **Note:** If you'd like to enter the `tmplTagValue()` function manually, place in the `WHERE` clause:
+> ```
+> <tag_key> = tmplTagValue('<tag_key>','<variable_name>')
+> ```
+> Where `variable_name` is the title of the dropdown that appears in the top right corner.
+
+*Chronograf visualization with a tag template variable:*
+
+![Tag template](/img/chronograf/v0.11/tag-template.gif)
+
+## Templating a dashboard
+
+Chronograf's template variables also work on dashboards. Note that only visualizations that specify `tmplTime()` and/or `tmplTagValue()` will work with the template variables.
+
+*Chronograf dashboard with template variables:*
+
+![Tag template](/img/chronograf/v0.11/template-dashboard.gif)

content/chronograf/v0.4/index.md

@@ -5,7 +5,7 @@ menu:
   chronograf:
     name: v0.4
     identifier: chronograf_04
-    weight: 0
+    weight: 20
 ---
 
 The Chronograf documentation is currently under construction.

data/default_versions.toml

@@ -2,7 +2,7 @@ telegraf = "telegraf_011"
 telegraf_semver = "v0.11"
 influxdb = "influxdb_010"
 influxdb_semver = "v0.10"
-chronograf = "chronograf_010"
-chronograf_semver = "v0.10"
+chronograf = "chronograf_011"
+chronograf_semver = "v0.11"
 kapacitor = "kapacitor_011"
 kapacitor_semver = "v0.11"