Merge ~xavpaice/charm-grafana:readme into charm-grafana:master

[Xav Paice]

Update README.md for 20.08

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[James Troup (elmo)]

LGTM

review: Approve

[James Troup (elmo)]

Typo

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 26fcde91289997e518537de9422763abb4a574bc

diff --git a/src/README.md b/src/README.md
index c9a1323..cb0ffb1 100644
--- a/src/README.md
+++ b/src/README.md
@@ -2,10 +2,12 @@
 
 This charm provides the latest stable version of Grafana.
 
-# Usage
+## Usage
 
-    juju deploy grafana
-    juju add-relation prometheus:grafana-source grafana:grafana-source
+```
+juju deploy grafana
+juju add-relation prometheus:grafana-source grafana:grafana-source
+```
 
 Above will automatically configure prometheus as grafana datasource
 
@@ -13,113 +15,148 @@ If admin password is not set using configuration option it is autogenerated.
 
 To retrieve autogenerated password run:
 
-    juju run-action --wait grafana/0 get-admin-password
+```
+juju run-action --wait grafana/0 get-admin-password
+```
 
-# Actions
+To have dashboards delivered by charm relations, e.g. from Telegraf, add an
+extra relation as follows.
+
+```
+juju add-relation telegraf:dashboards grafana:dashboards
+```
+
+## Actions
 
 This charm supports importing dashboards, simply run:
 
-    juju run-action --wait grafana/0 import-dashboard dashboard="$(base64 mydashboard.json)"
+```
+juju run-action --wait grafana/0 import-dashboard dashboard="$(base64 mydashboard.json)"
+```
 
 where mydashboard.json is a json file:
 
-    { "dashboard": { exported-json-dashboard }, "overwrite": true }
+```
+{ "dashboard": { exported-json-dashboard }, "overwrite": true }
+```
 
 If you don't want to overwrite the dashboard, set overwrite to false.
 
 There is also an action to create an API key, run:
 
-    juju run-action --wait grafana/0 create-api-key keyname=<name> keyrole=<role>
+```
+juju run-action --wait grafana/0 create-api-key keyname=<name> keyrole=<role>
+```
 
 where the keyrole is one of Viewer, Editor, Read Only Editor or Admin.
 
-## User Management Actions
+### User Management Actions
 
 Currently user management is only implemented to manipulate users in the default
 organisation.
 
 You can retrieve the admin password, via:
 
-    juju run-action --wait grafana/0 get-admin-password
+```
+juju run-action --wait grafana/0 get-admin-password
+```
 
 You can create a user:
 
-    juju run-action -w grafana/0 create-user name="John Citizen" \
-        email="[e-mail]" login="john" password="redacted" \
-        role="Viewer"
+```
+juju run-action -w grafana/0 create-user name="John Citizen" \
+   email="[e-mail]" login="john" password="redacted" \
+   role="Viewer"
+```
 
 where the role is one of Viewer, Editor, Read Only Editor or Admin.
 This will create the user in the default organisation.
 
 To reset a user's password:
 
-    juju run-action --wait grafana/0 set-user-password \
-        login=john new-password=citizen2
+```
+juju run-action --wait grafana/0 set-user-password \
+     login=john new-password=citizen2
+```
 
 This again assumes the user is in the default organisation, if it
 isn't it won't find the user.
 
 If you need to change the user's role, run:
 
-    juju run-action --wait grafana/0 change-user-role login="john" \
+```
+juju run-action --wait grafana/0 change-user-role login="john" \
         new-role="Admin"
+```
 
 To delete a user, you simply run:
 
-    juju run-action --wait grafana/0 delete-user login=john
-
+```
+juju run-action --wait grafana/0 delete-user login=john
+```
 
-## Upgrade action
+### Upgrade action
 
 To perform an upgrade after changing `snap_channel` an upgrade action must be run:
 
-    juju run-action --wait grafana/0 do-upgrade
+```
+juju run-action --wait grafana/0 do-upgrade
+```
 
-
-# Auth proxy
+## Auth proxy
 
 If deployed behind a reverse proxy, you can configure Grafana to let
 it handle authentication by enabled auth-proxy.
 
-    juju config grafana auth-proxy=true
+```
+juju config grafana auth-proxy=true
+```
 
 Check grafana [documentation](https://grafana.com/docs/auth/auth-proxy/#auth-proxy-authentication)
 on how to configure apache as the reverse proxy.
 
 Users will be created/signup automatically with "Viewer" permissions.
 To change the default permissions of a user, use the change-user-role
-action passing the openID identifier or the email if the user updated it 
+action passing the openID identifier or the email if the user updated it
 as the "login":
 
-    juju run-action --wait grafana/0 change-user-role \
-        login="[e-mail]" new-role="Admin"
+```
+juju run-action --wait grafana/0 change-user-role \
+     login="[e-mail]" new-role="Admin"
+```
 
 If not all URL paths are behind the reverse proxy auth,
 and `anonymous=true` is set, those paths will be accessible (view only) to
 non-authenticated users.
 
+## Development
 
-# Development
+After modifying code, you must assemble the charm:
 
-Explicitly set `JUJU_REPOSITORY`:
+```
+charm build
+```
 
-    export JUJU_REPOSITORY=/path/to/charms
-    mkdir -p $JUJU_REPOSITORY/layers
+## Contact Information
 
-Branch code to
+Author: Alvaro Uria <[e-mail]>, Jacek Nykis <[e-mail]>
 
-    $JUJU_REPOSITORY/layers/layer-grafana/
+Report bugs at: https://bugs.launchpad.net/charm-grafana
 
-Modify
+Location:
 
-Assemble the charm:
+* Composed grafana charm: cs:grafana
+* Charm code: https://code.launchpad.net/charm-grafana
 
-    charm build
+## Release information
 
-# Contact Information
+Release 20.08:
 
-Author: Alvaro Uria <[e-mail]>, Jacek Nykis <[e-mail]>
-Report bugs at: https://bugs.launchpad.net/grafana-charm
-Location:
-  Composed grafana charm: cs:~prometheus-charmers/grafana
-  Grafana layer: https://code.launchpad.net/grafana-charm
+* Note that in cs:grafana-36, the Grafana charm shipped a default dashboard for
+  Telegraf.  This is removed as of release 20.08, relying instead on the dashboard
+  delivered by the grafana:dashboard relation endpoint.
+* Dashboard titles are now tagged with "[juju-{provider}]"
+* Folks upgrading to the current release will potentially need to add the
+  relation for dashboard import:
+
+    juju add-relation grafana:dashboards $application:dashboards