Merge branch 'master' into docs_v5.0

2018-02-05 15:23:32 +01:00
parent 65bb6cc728 2d1bd270fb
commit 49c02aa8d2
234 changed files with 6207 additions and 1947 deletions
@@ -28,7 +28,7 @@ in that organization.

 Can do everything scoped to the organization. For example:

- Add & Edit data data sources.
+- Add & Edit data sources.
 - Add & Edit organization users & teams.
 - Configure App plugins & set org settings.

@@ -52,10 +52,12 @@ This admin flag makes a user a `Super Admin`. This means they can access the `Se

 ### Dashboard & Folder Permissions

+> Introduced in Grafana v5.0
+
 {{< docs-imagebox img="/img/docs/v50/folder_permissions.png" max-width="500px" class="docs-image--right" >}}

 For dashboards and dashboard folders there is a **Permissions** page that make it possible to
-remove the default role based permissions for Editors and Viewers. It is here you can add and assign permissions to specific **Users** and **Teams**.
+remove the default role based permssions for Editors and Viewers. It's here you can add and assign permissions to specific **Users** and **Teams**.

 You can assign & remove permissions for **Organization Roles**, **Users** and **Teams**.

@@ -102,3 +104,4 @@ Permissions for a dashboard:


 Result: You cannot override to a lower permission. `user1` has Admin permission as the highest permission always wins.
+- **View**: Can only view existing dashboars/folders.
@@ -3,6 +3,7 @@ title = "Provisioning"
 description = ""
 keywords = ["grafana", "provisioning"]
 type = "docs"
+aliases = ["/installation/provisioning"]
 [menu.docs]
 parent = "admin"
 weight = 8
@@ -66,7 +67,6 @@ Tool | Project
 -----|------------
 Puppet | [https://forge.puppet.com/puppet/grafana](https://forge.puppet.com/puppet/grafana)
 Ansible | [https://github.com/cloudalchemy/ansible-grafana](https://github.com/cloudalchemy/ansible-grafana)
-Ansible | [https://github.com/picotrading/ansible-grafana](https://github.com/picotrading/ansible-grafana)
 Chef | [https://github.com/JonathanTron/chef-grafana](https://github.com/JonathanTron/chef-grafana)
 Saltstack | [https://github.com/salt-formulas/salt-formula-grafana](https://github.com/salt-formulas/salt-formula-grafana)

@@ -36,7 +36,7 @@ The new dashboard layout engine allows for much easier movement and sizing of pa
 a very intuitive way. Panels are sized independently, so rows are no longer necessary to create layouts. This opens
 up many new types of layouts where panels of different heights can be aligned easily. Checkout the new grid in the video
 above or on the [play site](http://play.grafana.org). All your existing dashboards will automatically migrate to the
-new position system and look close to identical. The new panel position makes dashboards saved in v5.0 not compatible
+new position system and look close to identical. The new panel position makes dashboards saved in v5.0 incompatible
 with older versions of Grafana.

 <div class="clearfix"></div>
@@ -61,7 +61,7 @@ settings views have been combined with a side nav which allows you to easily mov

 {{< docs-imagebox img="/img/docs/v50/new_white_theme.png" max-width="1000px" class="docs-image--right" >}}

-This theme has not seen a lot of love in recent years and we felt it was time to rework it and give it a major overhaul. We are very happy with the result.
+This theme has not seen a lot of love in recent years and we felt it was time to give it a major overhaul. We are very happy with the result.

 <div class="clearfix"></div>

@@ -78,7 +78,7 @@ which is very useful if you have a lot of dashboards or multiple teams.

 ## Teams

-A team is a new concept in Grafana v5. They are simply a group of users that can be then be used in the new permission system for dashboards and folders. Only an admin can create teams.
+A team is a new concept in Grafana v5. They are simply a group of users that can be used in the new permission system for dashboards and folders. Only an admin can create teams.
 We hope to do more with teams in future releases like integration with LDAP and a team landing page.

 ## Permissions
@@ -93,7 +93,7 @@ You can assign permissions to folders and dashboards. The default user role-base

 In previous versions of Grafana, you could only use the API for provisioning data sources and dashboards.
 But that required the service to be running before you started creating dashboards and you also needed to
-set up credentials for the HTTP API. In 5.0 we decided to improve this experience by adding a new active
+set up credentials for the HTTP API. In v5.0 we decided to improve this experience by adding a new active
 provisioning system that uses config files. This will make GitOps more natural as data sources and dashboards can
 be defined via files that can be version controlled. We hope to extend this system to later add support for users, orgs
 and alerts as well.
@@ -105,9 +105,9 @@ It's also possible to update and delete data sources from the config file. More

 ### Dashboards

-We also deprecated the [dashboard.json] in favor of our new dashboard provisioner that keeps dashboards on disk
+We also deprecated the `[dashboard.json]` in favor of our new dashboard provisioner that keeps dashboards on disk
 in sync with dashboards in Grafana's database. The dashboard provisioner has multiple advantages over the old
-[dashboard.json] feature. Instead of storing the dashboard in memory we now insert the dashboard into the database,
+`[dashboard.json]` feature. Instead of storing the dashboard in memory we now insert the dashboard into the database,
 which makes it possible to star them, use one as the home dashboard, set permissions and other features in Grafana that
 expects the dashboards to exist in the database. More info in the [dashboard provisioning docs](/administration/provisioning/#dashboards)

@@ -62,7 +62,7 @@ Content-Type: application/json
      }
    "newStateDate": "2016-12-25",
    "executionError": "",
-    "dashboardUri": "http://grafana.com/dashboard/db/sensors"
+    "url": "http://grafana.com/dashboard/db/sensors"
  }
 ]
 ```
@@ -94,7 +94,7 @@ Content-Type: application/json
  "state": "alerting",
  "newStateDate": "2016-12-25",
  "executionError": "",
-  "dashboardUri": "http://grafana.com/dashboard/db/sensors"
+  "url": "http://grafana.com/dashboard/db/sensors"
 }
 ```

@@ -196,7 +196,7 @@ Content-Type: application/json

 ## Create alert notification

-You can find the full list of [supported notifers](/alerting/notifications/#all-supported-notifier) at the alert notifiers page. 
+You can find the full list of [supported notifers](/alerting/notifications/#all-supported-notifier) at the alert notifiers page.

 `POST /api/alert-notifications`

@@ -294,4 +294,4 @@ Content-Type: application/json
 {
  "message": "Notification deleted"
 }
-```
+```
@@ -90,7 +90,7 @@ Content-Type: application/json

 ## Get a single data source by Name

-`GET /api/datasources/name/:name`
+`GET /api/datasources/:name`

 **Example Request**:

@@ -18,12 +18,15 @@ dashboards, creating users and updating data sources.
 ## Supported HTTP APIs:


-* [Authentication API]({{< relref "auth.md" >}})
-* [Dashboard API]({{< relref "dashboard.md" >}})
-* [Data Source API]({{< relref "data_source.md" >}})
-* [Organisation API]({{< relref "org.md" >}})
-* [User API]({{< relref "user.md" >}})
-* [Admin API]({{< relref "admin.md" >}})
-* [Snapshot API]({{< relref "snapshot.md" >}})
-* [Preferences API]({{< relref "preferences.md" >}})
-* [Other API]({{< relref "other.md" >}})
+* [Authentication API]({{< relref "/http_api/auth.md" >}})
+* [Dashboard API]({{< relref "/http_api/dashboard.md" >}})
+* [Dashboard Versions API]({{< relref "http_api/dashboard_versions.md" >}})
+* [Data Source API]({{< relref "http_api/data_source.md" >}})
+* [Organisation API]({{< relref "http_api/org.md" >}})
+* [Snapshot API]({{< relref "http_api/snapshot.md" >}})
+* [Annotations API]({{< relref "http_api/annotations.md" >}})
+* [Alerting API]({{< relref "http_api/alerting.md" >}})
+* [User API]({{< relref "http_api/user.md" >}})
+* [Admin API]({{< relref "http_api/admin.md" >}})
+* [Preferences API]({{< relref "http_api/preferences.md" >}})
+* [Other API]({{< relref "http_api/other.md" >}})
@@ -18,7 +18,7 @@ other domains including industrial sensors, home automation, weather, and proces
 - [Installing on Mac OS X](installation/mac)
 - [Installing on Windows](installation/windows)
 - [Installing on Docker](installation/docker)
- [Installing using Provisioning (Chef, Puppet, Salt, Ansible, etc)](installation/provisioning)
+- [Installing using Provisioning (Chef, Puppet, Salt, Ansible, etc)](administration/provisioning#configuration-management-tools)
 - [Nightly Builds](https://grafana.com/grafana/download)

 For other platforms Read the [build from source]({{< relref "project/building_from_source.md" >}})
@@ -671,31 +671,6 @@ session provider you have configured.
 - **memcache:** ex:  127.0.0.1:11211
 - **redis:** ex: `addr=127.0.0.1:6379,pool_size=100,prefix=grafana`

-If you use MySQL or Postgres as the session store you need to create the
-session table manually.
-
-Mysql Example:
-
-```bash
-CREATE TABLE `session` (
-    `key`       CHAR(16) NOT NULL,
-    `data`      BLOB,
-    `expiry`    INT(11) UNSIGNED NOT NULL,
-    PRIMARY KEY (`key`)
-) ENGINE=MyISAM DEFAULT CHARSET=utf8;
-```
-
-Postgres Example:
-
-```bash
-CREATE TABLE session (
-    key       CHAR(16) NOT NULL,
-    data      BYTEA,
-    expiry    INTEGER NOT NULL,
-    PRIMARY KEY (key)
-);
-```
-
 Postgres valid `sslmode` are `disable`, `require`, `verify-ca`, and `verify-full` (default).

 ### cookie_name
@@ -84,15 +84,15 @@ An array of:
  {
    "target":"upper_75",
    "datapoints":[
-      [622,1450754160000],
-      [365,1450754220000]
+      [622, 1450754160000],
+      [365, 1450754220000]
    ]
  },
  {
    "target":"upper_90",
    "datapoints":[
-      [861,1450754160000],
-      [767,1450754220000]
+      [861, 1450754160000],
+      [767, 1450754220000]
    ]
  }
 ]