Merge ~cjohnston/charm-grafana:ssl-fixes into charm-grafana:master

[Chris Johnston]

If instance_name is provided, use instance_name for checks instead of 127.0.0.1

This is needed when using SSL with certs provided by the user as the certs don't include 127.0.0.1.

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

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

[Celia Wang (ziyiwang)]

lint and unittests passed. running functional tests
code lgtm

[Celia Wang (ziyiwang)]

test passed. +1

fyi:
$ juju config grafana ssl_key="$(base64 -w 0 < ~/test.key)"
$ juju config grafana ssl_cert="$(base64 -w 0 < ~/test.crt)"
$ juju config grafana ssl_ca="$(base64 -w 0 < ~/test.ca)"

review: Approve

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

Change successfully merged at revision 336504ee467922b9a8e157b89201c7dc35a6f2ca

diff --git a/src/config.yaml b/src/config.yaml
index 9cc540b..ed84bc2 100644
--- a/src/config.yaml
+++ b/src/config.yaml
@@ -196,18 +196,19 @@ options:
   external_network:
     default: "ext_net"
     type: string
-    description: \
+    description: |
         Name for the network which hosts the Public IP address space.
   allow_embedding:
     default: False
     type: boolean
-    description: \
+    description: |
         If false the Grafana HTTP responses will instruct browsers to not allow rendering Grafana in a <frame>, <iframe>, <embed> or <object>.
   ssl_cert:
     type: string
     default:
     description: |
-      TLS certificate to install and use for any listening services.
+      Base64 encoded TLS certificate to install and use for any listening services.
+      For example: `juju config grafana ssl_cert=$(base64 -w 0 /path/to/server.crt)`
       .
       __NOTE__: This configuration option will take precedence over any
                 certificates received over the ``certificates`` relation.
@@ -215,15 +216,16 @@ options:
     type: string
     default:
     description: |
-      TLS key to use with certificate specified as ``ssl_cert``.
-      .
+      Base64 encoded TLS key to use with certificate specified as ``ssl_cert``.
+      For example: `juju config grafana ssl_key=$(base64 -w 0 /path/to/server.key)` .
       __NOTE__: This configuration option will take precedence over any
                 certificates received over the ``certificates`` relation.
   ssl_ca:
     type: string
     default:
     description: |
-      TLS CA to use to communicate with other components in a deployment.
+      Base64 encoded TLS CA to use to communicate with other components in a deployment.
+      For example: `juju config grafana ssl_ca=$(base64 -w 0 /path/to/ca.crt)` .
       .
       __NOTE__: This configuration option will take precedence over any
                 certificates received over the ``certificates`` relation.
diff --git a/src/lib/charms/layer/grafana.py b/src/lib/charms/layer/grafana.py
index 0fc3bd0..10135be 100644
--- a/src/lib/charms/layer/grafana.py
+++ b/src/lib/charms/layer/grafana.py
@@ -370,3 +370,12 @@ def config_defined_ssl_cert():
 def config_defined_ssl_ca():
     """Get SSL CA from juju config."""
     return _get_b64decode_for("ssl_ca")
+
+
+@cached
+def get_instance_name():
+    """If defined, return the instance name."""
+    if config("instance_name"):
+        return config("instance_name")
+    else:
+        return "127.0.0.1"
diff --git a/src/reactive/grafana.py b/src/reactive/grafana.py
index cb641e8..0a96d4f 100644
--- a/src/reactive/grafana.py
+++ b/src/reactive/grafana.py
@@ -103,6 +103,7 @@ from charms.layer.grafana import (
     get_ca_cert_path,
     get_deb_package_version,
     get_installed_package_version,
+    get_instance_name,
     get_protocol,
     import_dashboard,
 )
@@ -823,7 +824,9 @@ def get_current_dashboards(port, passwd):
     https://grafana.com/docs/grafana/latest/http_api/folder_dashboard_search/
     """
     dash_req = requests.get(
-        "{}://127.0.0.1:{}/api/search?type=dash-db".format(get_protocol(), port),
+        "{}://{}:{}/api/search?type=dash-db".format(
+            get_protocol(), get_instance_name(), port
+        ),
         auth=("admin", passwd),
         verify=get_ca_cert_path(),
     )
@@ -843,7 +846,9 @@ def get_current_dashboard_json(uid, port, passwd):
         return default_dashboard
 
     dash_req = requests.get(
-        "{}://127.0.0.1:{}/api/dashboards/uid/{}".format(get_protocol(), port, uid),
+        "{}://{}:{}/api/dashboards/uid/{}".format(
+            get_protocol(), get_instance_name(), port, uid
+        ),
         auth=("admin", passwd),
         verify=get_ca_cert_path(),
     )
@@ -934,7 +939,9 @@ def check_and_add_dashboard(
     )
 
     hookenv.log("Using Dashboard Template: {}".format(filename))
-    post_req = "{}://127.0.0.1:{}/api/dashboards/db".format(get_protocol(), port)
+    post_req = "{}://{}:{}/api/dashboards/db".format(
+        get_protocol(), get_instance_name(), port
+    )
     r = requests.post(
         post_req,
         json=dashboard_json,
@@ -1160,7 +1167,7 @@ def get_orgs(port, passwd):
     https://grafana.com/docs/grafana/latest/http_api/org/
     """
     req = requests.get(
-        "{}://127.0.0.1:{}/api/orgs".format(get_protocol(), port),
+        "{}://{}:{}/api/orgs".format(get_protocol(), get_instance_name(), port),
         auth=("admin", passwd),
         verify=get_ca_cert_path(),
     )