build(ansible): add options to install grafana and dashboards

ansible/README.md

@@ -127,6 +127,7 @@ will only install Kafka when setting up the ecosystem.
 | full_install            | bool   | yes                           | enables full ecosystem installation                      |
 | install_kafka           | bool   | `{{ full_install }}`          | installs Strimzi Kafka Operator                          |
 | install_prometheus      | bool   | `{{ full_install }}`          | installs Prometheus Operator                             |
+| install_grafana         | bool   | `{{ full_install }}`          | installs Grafana Operator                                |
 | install_certmanager     | bool   | `{{ full_install }}`          | installs Cert Manager                                    |
 | install_jaeger          | bool   | `{{ full_install }}`          | installs Jaeger                                          |
 | install_opentelemetry   | bool   | `{{ full_install }}`          | installs OpenTelemetry                                   |

ansible/playbooks/setup-ecosystem.yaml

@@ -7,12 +7,14 @@
     full_install: yes
 
     install_prometheus: "{{ full_install }}"
+    install_grafana: "{{ full_install }}"
     install_kafka: "{{ full_install }}"
     install_certmanager: "{{ full_install }}"
     install_jaeger: "{{ full_install }}"
     install_opentelemetry: "{{ full_install }}"
 
     configure_prometheus: "{{ install_prometheus }}"
+    configure_grafana: "{{ install_grafana }}"
     configure_kafka: "{{ install_kafka }}"
     configure_jaeger: "{{ install_jaeger }}"
     configure_opentelemetry: "{{ install_opentelemetry }}"

ansible/playbooks/vars/default.yaml

@@ -1,4 +1,19 @@
 ---
+# Default credentials.
+# These credentials are used as defaults for:
+#   - the grafana install, when configured
+#
+# For grafana, once the cluster is up and running, you may fetch the randomly generated password
+# by running (change `seldon-monitoring` to the value of the seldon_monitoring_namespace
+# variable):
+#
+# kubectl get secret --namespace seldon-monitoring grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo
+#
+
+# Overwrite by passing sd_user and/or sd_password variables when running the playbook
+seldon_admin_user: "admin"
+seldon_random_gen_password: "{{ lookup('password', '/dev/null chars=digits length=6') }}"
+
 # Seldon Configuration
 seldon_mesh_namespace: seldon-mesh
 
@@ -9,7 +24,11 @@ seldon_core_v2_type_svc_type: LoadBalancer
 seldon_core_v2_scheduler_svc_type: LoadBalancer
 
 # Prometheus Operator Configuration
+seldon_monitoring_prometheus_name_generated: seldon-monitoring-prometheus
+seldon_monitoring_prometheus_url: "http://{{ seldon_monitoring_prometheus_name_generated }}.{{ seldon_monitoring_namespace }}:9090"
 seldon_monitoring_namespace: seldon-monitoring
+# Grafana
+seldon_monitoring_grafana_web_ui_port: 3000
 
 # Strimzi Kafka Configuration
 strimzi_kafka_operator_namespace: "{{ seldon_mesh_namespace }}"

ansible/roles/ecosystem/defaults/main.yaml

@@ -4,13 +4,15 @@ seldon_mesh_namespace: seldon-mesh
 
 # Installation on/off flags
 install_prometheus: true
+install_grafana: false
 install_kafka: true
 install_certmanager: true
 install_jaeger: true
 install_opentelemetry: true
 
 # Configuration on/off flags
 configure_prometheus: "{{ install_prometheus }}"
+configure_grafana: "{{ install_grafana }}"
 enable_kraft: "{{ install_kafka }}"
 configure_kafka: "{{ install_kafka }}"
 configure_jaeger: "{{ install_jaeger }}"

ansible/roles/ecosystem/tasks/grafana.yaml

@@ -0,0 +1,15 @@
+---
+- name: Set default user
+  ansible.builtin.set_fact:
+    sd_user: "{{ seldon_admin_user }}"
+  when: sd_user is not defined
+
+- name: Set default password
+  ansible.builtin.set_fact:
+    sd_password: "{{ seldon_random_gen_password }}"
+  when: sd_password is not defined
+
+- name: "Install Grafana instance"
+  include_role:
+    name: grafana
+  when: install_grafana | bool

ansible/roles/ecosystem/tasks/main.yaml

@@ -4,6 +4,9 @@
 - name: Install and configure Prometheus Operator
   import_tasks: prometheus.yaml
 
+- name: Install and configure Grafana
+  import_tasks: grafana.yaml
+
 - name: Install and configure Strimzi Kafka
   import_tasks: kafka.yaml
 

ansible/roles/grafana/defaults/main.yaml

@@ -0,0 +1,7 @@
+---
+grafana_chart_version: 7.3.9
+grafana_app_version: 10.4.2
+
+grafana_preloaded_dashboards:
+  - name: mms
+    json: "{{ lookup('file', playbook_dir + '/../../prometheus/dashboards/provisioning/seldon.json') }}"

ansible/roles/grafana/tasks/main.yaml

@@ -0,0 +1,26 @@
+---
+- name: Create a k8s namespace
+  kubernetes.core.k8s:
+    name: "{{ seldon_monitoring_namespace }}"
+    api_version: v1
+    kind: Namespace
+    state: present
+
+- name: Install Grafana
+  kubernetes.core.helm:
+    name: grafana
+    namespace: "{{ seldon_monitoring_namespace }}"
+    chart_ref: "grafana"
+    chart_version: "{{ grafana_chart_version }}"
+    chart_repo_url: "https://grafana.github.io/helm-charts"
+    wait: true
+    values: "{{ lookup('ansible.builtin.template', '../templates/values.yaml.j2') | from_yaml }}"
+
+- name: Grafana config and login details
+  ansible.builtin.debug:
+    msg:
+      - Grafana installed in the cluster.
+      - To view the webapp, access it via the generated ingress URL, or run
+      - "kubectl port-forward -n {{ seldon_monitoring_namespace }} svc/grafana {{ seldon_monitoring_grafana_web_ui_port }}:80"
+      - in a terminal, and visit http://localhost:{{ seldon_monitoring_grafana_web_ui_port }} in your browser.
+      - Login with {{ sd_user }}/{{ sd_password }}.

ansible/roles/grafana/templates/values.yaml.j2

@@ -0,0 +1,68 @@
+---
+apiVersion: 1
+
+adminUser: "{{ sd_user }}"
+adminPassword: "{{ sd_password }}"
+
+grafana.ini:
+  paths:
+    data: /var/lib/grafana/
+    logs: /var/log/grafana
+    plugins: /var/lib/grafana/plugins
+    provisioning: /etc/grafana/provisioning
+  analytics:
+    check_for_updates: false
+  log:
+    mode: console
+  grafana_net:
+    url: https://grafana.net
+  server:
+    protocol: http
+    http_port: "{{ seldon_monitoring_grafana_web_ui_port }}"
+    domain: "''"
+    serve_from_sub_path: false
+
+persistence:
+  type: pvc
+  enabled: true
+  accessModes:
+    - ReadWriteOnce
+  size: 10Gi
+  finalizers:
+    - kubernetes.io/pvc-protection
+  extraPvcLabels: {}
+
+datasources:
+ datasources.yaml:
+   apiVersion: 1
+   datasources:
+   - name: Prometheus
+     type: prometheus
+     url: "{{ seldon_monitoring_prometheus_url }}"
+     access: proxy
+     isDefault: true
+
+dashboardProviders:
+  dashboardproviders.yaml:
+    apiVersion: 1
+    providers:
+    - name: 'default'
+      orgId: 1
+      folder: ''
+      type: file
+      disableDeletion: false
+      allowUiUpdates: true
+      editable: true
+      options:
+        path: /var/lib/grafana/dashboards/default
+
+dashboards:
+  default:
+    {% for dashboard in grafana_preloaded_dashboards | default([]) -%}
+    {{ dashboard.name }}:
+      json: |-
+        {{ dashboard.json | to_nice_json(indent=2) | indent(8) }}
+      datasource:
+      - name: DS_PROMETHEUS
+        value: Prometheus
+    {% endfor -%}