Merge ~mthaddon/charm-grafana/+git/grafana-charm:indent-code-readme into ~prometheus-charmers/charm-grafana:master

Proposed by Tom Haddon
Status: Merged
Approved by: Benjamin Allot
Approved revision: b7677854ce3df15794a95163720db0c58b14d128
Merged at revision: 4992811f9cfc11c801e7e450e51d13be91954188
Proposed branch: ~mthaddon/charm-grafana/+git/grafana-charm:indent-code-readme
Merge into: ~prometheus-charmers/charm-grafana:master
Diff against target: 90 lines (+12/-12)
1 file modified
README.md (+12/-12)
Reviewer Review Type Date Requested Status
Benjamin Allot Approve
Canonical IS Reviewers Pending
Review via email: mp+369509@code.launchpad.net

Commit message

Correct indentation of README.md for display on jaas.ai

Description of the change

Correct indentation of README.md for display on jaas.ai.

Compare https://jaas.ai/u/mthaddon/grafana with https://jaas.ai/grafana to see the difference.

To post a comment you must log in.
Revision history for this message
🤖 Canonical IS Merge Bot (canonical-is-mergebot) wrote :

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

Revision history for this message
Benjamin Allot (ballot) wrote :

+1

review: Approve
Revision history for this message
🤖 Canonical IS Merge Bot (canonical-is-mergebot) wrote :

Change successfully merged at revision 4992811f9cfc11c801e7e450e51d13be91954188

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/README.md b/README.md
2index 8591ce1..bd6e7b8 100644
3--- a/README.md
4+++ b/README.md
5@@ -12,24 +12,24 @@ Above will automatically configure prometheus as grafana datasource
6 If admin password is not set using configuration option it is autogenerated.
7
8 To retrieve autogenerated password run:
9- $ juju run-action --wait grafana/0 get-admin-password
10+
11+ juju run-action --wait grafana/0 get-admin-password
12
13 #Actions
14
15 This charm supports importing dashboards, simply run:
16
17- $ juju run-action --wait grafana/0 import-dashboard dashboard="$(base64 mydashboard.json)"
18+ juju run-action --wait grafana/0 import-dashboard dashboard="$(base64 mydashboard.json)"
19
20 where mydashboard.json is a json file:
21
22- { "dashboard": { exported-json-dashboard },
23- "overwrite": true }
24+ { "dashboard": { exported-json-dashboard }, "overwrite": true }
25
26 If you don't want to overwrite the dashboard, set overwrite to false.
27
28 There is also an action to create an API key, run:
29
30- $ juju run-action --wait grafana/0 create-api-key keyname=<name> keyrole=<role>
31+ juju run-action --wait grafana/0 create-api-key keyname=<name> keyrole=<role>
32
33 where the keyrole is one of Viewer, Editor, Read Only Editor or Admin.
34
35@@ -40,11 +40,11 @@ organisation.
36
37 You can retrieve the admin password, via:
38
39- $ juju run-action --wait grafana/0 get-admin-password
40+ juju run-action --wait grafana/0 get-admin-password
41
42 You can create a user:
43
44- $ juju run-action -w grafana/0 create-user name="John Citizen" \
45+ juju run-action -w grafana/0 create-user name="John Citizen" \
46 email="john@example.com" login="john" password="redacted" \
47 role="Viewer"
48
49@@ -53,7 +53,7 @@ This will create the user in the default organisation.
50
51 To reset a user's password:
52
53- $ juju run-action --wait grafana/0 set-user-password \
54+ juju run-action --wait grafana/0 set-user-password \
55 login=john new-password=citizen2
56
57 This again assumes the user is in the default organisation, if it
58@@ -61,12 +61,12 @@ isn't it won't find the user.
59
60 If you need to change the user's role, run:
61
62- $ juju run-action --wait grafana/0 change-user-role login="john" \
63+ juju run-action --wait grafana/0 change-user-role login="john" \
64 new-role="Admin"
65
66 To delete a user, you simply run:
67
68- $ juju run-action --wait grafana/0 delete-user login=john
69+ juju run-action --wait grafana/0 delete-user login=john
70
71
72 #Auth proxy
73@@ -74,7 +74,7 @@ To delete a user, you simply run:
74 If deployed behind a reverse proxy, you can configure Grafana to let
75 it handle authentication by enabled auth-proxy.
76
77- $ juju config grafana auth-proxy=true
78+ juju config grafana auth-proxy=true
79
80 Check grafana [documentation](https://grafana.com/docs/auth/auth-proxy/#auth-proxy-authentication)
81 on how to configure apache as the reverse proxy.
82@@ -84,7 +84,7 @@ To change the default permissions of a user, use the change-user-role
83 action passing the openID identifier or the email if the user updated it
84 as the "login":
85
86- $ juju run-action --wait grafana/0 change-user-role \
87+ juju run-action --wait grafana/0 change-user-role \
88 login="user@company.com" new-role="Admin"
89
90 If not all URL paths are behind the reverse proxy auth,

Subscribers

People subscribed via source and target branches