Merge ~johnsca/charm-grafana:johnsca/feature/dashboard-import into ~prometheus-charmers/charm-grafana:master

[Cory Johns]

Add relation for getting dashboards imported

Kubernetes has dashboards it needs loaded when monitoring is in use.
This adds a relation that it can use to provide those dashboards.

Also adds a new action to get all info for connecting.

The URL or port can be changed via config, so it's useful (and more
convenient) to get all info needed to connect to Grafana from a single
action. I added a new action for clarity and to maintain compatibility,
but this could potentially be folded into get-admin-password.

Depends on https://github.com/juju-solutions/interface-grafana-dashboard/pull/1

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

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

[Stuart Bishop (stub)]

Code changes are all great. I think there is a bug on line 170 of the diff, but trivially fixed.

This is using proposed changes to charms.reactive I believe, for the request/response interface ? Has this landed, do we need to wait before landing this MP, or do we need to update requirements.txt to temporarily build with a charms.reactive fork?

review: Approve

[Jeremy Lounder (jldev)]

Comments inline.

Need to check on the build status of this branch, regarding Stuart's reactive question. I will circle back on this after the import_dashboard signature issue has been fixed.

review: Needs Fixing

[Cory Johns (johnsca)]

Review comments addressed.

The PR for charms.reactive is at: https://github.com/juju-solutions/charms.reactive/pull/215

I'd like to get that reviewed and merged prior to releasing this or the Prometheus2 charm. For reference, this is all in support of https://github.com/charmed-kubernetes/charm-kubernetes-master/pull/45

[Cory Johns (johnsca)]

review: Needs Resubmitting

[Cory Johns (johnsca)]

1.3.0 of charms.reactive is released with the relevant change, as well as the interface layer PRs.

[Jeremy Lounder (jldev)]

review: Approve

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

Change successfully merged at revision 4cd46e4a696b27b3b4b4c77f6be95d96ce6bb1f8

[Kevin W Monroe (kwmonroe)]

I released this to edge/beta in https://jaas.ai/u/prometheus-charmers/grafana/34 to ease our K8s LMA testing, but I didn't push to stable in case there was a more formal stable release process.

diff --git a/actions.yaml b/actions.yaml
index 5476855..b90282b 100644
--- a/actions.yaml
+++ b/actions.yaml
@@ -14,6 +14,8 @@ import-dashboard:
   additionalProperties: false
 get-admin-password:
   description: Retrieves the admin password, either auto generated or set in config
+get-login-info:
+  description: Retrieves all of the info needed to log into Grafana.
 create-api-key:
   description: Create an api key given a keyname and a keyrole out of Viewer, Editor, Read Only Editor or Admin
   params:
diff --git a/actions/change-user-role b/actions/change-user-role
index f635c59..3e455f4 100755
--- a/actions/change-user-role
+++ b/actions/change-user-role
@@ -12,7 +12,7 @@ from charmhelpers.core.hookenv import (
     log,
 )
 
-from grafana_utils import get_admin_password
+from charms.layer.grafana import get_admin_password
 
 action = "change-user-role"
 
diff --git a/actions/create-api-key b/actions/create-api-key
index bdd054d..9deafd5 100755
--- a/actions/create-api-key
+++ b/actions/create-api-key
@@ -11,7 +11,7 @@ from charmhelpers.core.hookenv import (
 )
 import sys
 
-from grafana_utils import get_admin_password
+from charms.layer.grafana import get_admin_password
 
 passwd = get_admin_password()
 
diff --git a/actions/create-user b/actions/create-user
index 95d5167..7abd043 100755
--- a/actions/create-user
+++ b/actions/create-user
@@ -12,7 +12,7 @@ from charmhelpers.core.hookenv import (
     log,
 )
 
-from grafana_utils import get_admin_password
+from charms.layer.grafana import get_admin_password
 
 action = "create-user"
 
diff --git a/actions/delete-user b/actions/delete-user
index 7e57172..5b41d9f 100755
--- a/actions/delete-user
+++ b/actions/delete-user
@@ -12,7 +12,7 @@ from charmhelpers.core.hookenv import (
     log,
 )
 
-from grafana_utils import get_admin_password
+from charms.layer.grafana import get_admin_password
 
 action = "delete-user"
 
diff --git a/actions/get-admin-password b/actions/get-admin-password
index c345762..7b66f92 100755
--- a/actions/get-admin-password
+++ b/actions/get-admin-password
@@ -1,7 +1,7 @@
 #!/usr/local/sbin/charm-env python3
 # Get admin password
 
-from grafana_utils import get_admin_password
+from charms.layer.grafana import get_admin_password
 import sys
 
 from charmhelpers.core.hookenv import (
diff --git a/actions/get-login-info b/actions/get-login-info
new file mode 100755
index 0000000..d1c50bb
--- /dev/null
+++ b/actions/get-login-info
@@ -0,0 +1,30 @@
+#!/usr/local/sbin/charm-env python3
+# Get admin password
+
+import sys
+
+from charmhelpers.core.hookenv import (
+    action_fail,
+    action_set,
+    unit_get,
+    config,
+)
+
+from charms.layer.grafana import get_admin_password
+
+passwd = get_admin_password()
+
+if passwd is not None:
+    cfg = config()
+    action_set({
+        "url": cfg['root_url'] % {
+            'protocol': 'http',
+            'domain': unit_get('public-address'),
+            'http_port': cfg['port'],
+        },
+        "username": "admin",
+        "password": passwd,
+    })
+else:
+    action_fail('Unable to retrieve password.')
+    sys.exit(0)
diff --git a/actions/import-dashboard b/actions/import-dashboard
index e7c6c53..62c28c5 100755
--- a/actions/import-dashboard
+++ b/actions/import-dashboard
@@ -1,7 +1,6 @@
 #!/usr/local/sbin/charm-env python3
 # Imports a json based dashboard into grafana
 
-import requests
 import json
 import base64
 import traceback
@@ -14,26 +13,7 @@ from charmhelpers.core.hookenv import (
     log,
 )
 
-from grafana_utils import get_admin_password
-
-
-def import_dashboard(dashboard):
-    headers = {'Content-Type': 'application/json'}
-    import_url = 'http://localhost:{}/api/dashboards/db'.format(
-                  config('port'))
-    passwd = get_admin_password()
-    if passwd is None:
-        action_fail('Unable to retrieve grafana password.')
-        return False
-    api_auth = ('admin', passwd)
-    r = requests.post(import_url, auth=api_auth, headers=headers,
-                      data=json.dumps(dashboard))
-    if r.status_code == 200:
-        return True
-    else:
-        title = dashboard['dashboard']['title']
-        action_fail('Error importing dashboard: "{}"'.format(title))
-        return False
+from charms.layer.grafana import import_dashboard
 
 
 def import_file(path):
diff --git a/actions/set-user-password b/actions/set-user-password
index 7a8403d..1bc2c56 100755
--- a/actions/set-user-password
+++ b/actions/set-user-password
@@ -12,7 +12,7 @@ from charmhelpers.core.hookenv import (
     log,
 )
 
-from grafana_utils import get_admin_password
+from charms.layer.grafana import get_admin_password
 
 action = "set-user-password"
 
diff --git a/layer.yaml b/layer.yaml
index 0eb7b9b..df345e6 100644
--- a/layer.yaml
+++ b/layer.yaml
@@ -1,3 +1,3 @@
-includes: ['layer:basic', 'layer:snap', 'interface:nrpe-external-master', 'interface:grafana-source', 'interface:http']
+includes: ['layer:basic', 'layer:snap', 'interface:nrpe-external-master', 'interface:grafana-source', 'interface:http', 'interface:grafana-dashboard']
 ignore: ['.*.swp' ]
 repo: https://git.launchpad.net/grafana-charm
diff --git a/actions/grafana_utils.py b/lib/charms/layer/grafana.py
similarity index 65%
rename from actions/grafana_utils.py
rename to lib/charms/layer/grafana.py
index 54af925..b482203 100644
--- a/actions/grafana_utils.py
+++ b/lib/charms/layer/grafana.py
@@ -1,5 +1,7 @@
 #!/usr/bin/python3
 
+import json
+import requests
 from charmhelpers.core.hookenv import (
     config,
     log,
@@ -22,3 +24,21 @@ def get_admin_password():
 
     return passwd
 
+
+def import_dashboard(dashboard, name=None):
+    if name is None:
+        name = dashboard['dashboard'].get('title') or 'Untitled'
+    headers = {'Content-Type': 'application/json'}
+    import_url = 'http://localhost:{}/api/dashboards/db'.format(
+                  config('port'))
+    passwd = get_admin_password()
+    if passwd is None:
+        return (False, 'Unable to retrieve grafana password.')
+    api_auth = ('admin', passwd)
+    r = requests.post(import_url, auth=api_auth, headers=headers,
+                      data=json.dumps(dashboard))
+    if r.status_code == 200:
+        return (True, None)
+    else:
+        return (False, 'Error importing dashboard "{}": {}'.format(name,
+                                                                   r.text))
diff --git a/metadata.yaml b/metadata.yaml
index 64dcbff..9476ae1 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -21,3 +21,5 @@ provides:
 requires:
   grafana-source:
     interface: grafana-source
+  dashboards:
+    interface: grafana-dashboard
diff --git a/reactive/grafana.py b/reactive/grafana.py
index 7d1c422..ba40c2f 100644
--- a/reactive/grafana.py
+++ b/reactive/grafana.py
@@ -31,6 +31,7 @@ from charms.reactive import (
 )
 
 from charms.layer import snap
+from charms.layer.grafana import import_dashboard
 
 SVCNAME = {'snap': 'snap.grafana.grafana',
            'apt': 'grafana-server'}
@@ -712,3 +713,11 @@ def check_adminuser():
 def hpwgen(passwd, salt):
     hpasswd = pbkdf2.PBKDF2(passwd, salt, 10000, SHA256).hexread(50)
     return hpasswd
+
+
+@when('grafana.started',
+      'endpoint.dashboards.requests')
+def import_dashboards(dashboards):
+    for request in dashboards.new_requests:
+        success, reason = import_dashboard(request.dashboard, request.name)
+        request.respond(success, reason)