chore(dashboards): Updating grafana dashboards and adding them to Gra…

…fana Portal (#1285) # Description This PR cover multiple aspects regarding Grafana Dashboards. - It updates the Grafana dashboards for the Retina project and adds them to the Grafana Portal. - Retina Dashboards and JSON files have been renamed to reflect which ones are meant to work with Standard or Hubble control plane, as well as control plane agnostic. - All files have been moved to a new common folder `deploy/grafana-dashboards/` - Simplified dashboard test has been modified to fail in case the folder structure is changed in the future. - Documentation has been updated. ## Related Issue [pods and dns dashboards are not part of the published Grafana dashboards #178](#178) ## Screenshots (if applicable) or Testing Completed Only names are changed on the dashboards. Layouts and queries remain the same. ![image](https://github.com/user-attachments/assets/8d2390ea-462b-4567-a43a-f9143fbe6e7d) ![image](https://github.com/user-attachments/assets/1a9eb497-d667-46a0-b3b3-d068b87b14b8) ![image](https://github.com/user-attachments/assets/7a2d7f1f-dd32-4116-bb17-2b0bfbcbe369) ![image](https://github.com/user-attachments/assets/7f73a372-41c1-493d-9c23-a849cfd41188) ![image](https://github.com/user-attachments/assets/75d8cd96-3901-47ad-9101-236ba217b461) ## Checklist - [X] I have read the [contributing documentation](https://retina.sh/docs/contributing). - [X] I signed and signed-off the commits (`git commit -S -s ...`). See [this documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) on signing commits. - [X] I have correctly attributed the author(s) of the code. - [X] I have tested the changes locally. - [X] I have followed the project's style guidelines. - [X] I have updated the documentation, if necessary. - [ ] I have added tests, if applicable. ## Additional Notes New Retina Grafana account has been created as part of this PR. Also, the scope has been extended to cover dashboards for Hubble control plane which was not mentioned in the original issue. --- Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more information on how to contribute to this project.
microsoft · Feb 20, 2025 · 0db1237 · 0db1237
1 parent c5a67ad
commit 0db1237
Show file tree

Hide file tree

Showing 11 changed files with 61 additions and 3,783 deletions.
diff --git a/...standard/grafana/dashboards/clusters.json → deploy/grafana-dashboards/clusters.json b/...standard/grafana/dashboards/clusters.json → deploy/grafana-dashboards/clusters.json
@@ -48,10 +48,10 @@
       "includeVars": true,
       "keepTime": true,
       "tags": [
-        "k8s:network-observability"
+        "k8s:retina-network-observability"
       ],
       "targetBlank": false,
-      "title": "Dashboards: Network Observability",
+      "title": "Dashboards: Retina Network Observability",
       "tooltip": "",
       "type": "dashboards",
       "url": ""
@@ -66,7 +66,7 @@
       "title": "Documentation",
       "tooltip": "",
       "type": "link",
-      "url": "https://www.retina.sh"
+      "url": "https://retina.sh/docs/Introduction/intro"
     }
   ],
   "liveNow": true,
@@ -3669,7 +3669,7 @@
   "schemaVersion": 38,
   "style": "dark",
   "tags": [
-    "k8s:network-observability"
+    "k8s:retina-network-observability"
   ],
   "templating": {
     "list": [
@@ -3695,15 +3695,15 @@
           "type": "prometheus",
           "uid": "${datasource}"
         },
-        "definition": "label_values(kube_node_info, cluster)",
+        "definition": "label_values(up, cluster)",
         "hide": 0,
         "includeAll": false,
         "label": "Cluster",
         "multi": false,
         "name": "cluster",
         "options": [],
         "query": {
-          "query": "label_values(kube_node_info, cluster)",
+          "query": "label_values(up, cluster)",
           "refId": "StandardVariableQuery"
         },
         "refresh": 2,
@@ -3713,19 +3713,20 @@
         "type": "query"
       },
       {
+        "allValue": "(.*)",
         "current": {},
         "datasource": {
           "type": "prometheus",
           "uid": "${datasource}"
         },
-        "definition": "label_values(kube_node_info{cluster=\"$cluster\"}, node)",
+        "definition": "label_values(up{cluster=\"$cluster\"},instance)",
         "hide": 0,
         "includeAll": true,
         "label": "Nodes",
         "multi": true,
         "name": "Nodes",
         "options": [],
-        "query": "label_values(kube_node_info{cluster=\"$cluster\"}, node)",
+        "query": "label_values(up{cluster=\"$cluster\"},instance)",
         "refresh": 2,
         "regex": "",
         "skipUrlSync": false,
@@ -3753,7 +3754,7 @@
     ]
   },
   "timezone": "",
-  "title": "Kubernetes / Networking / Clusters",
-  "uid": "Retina11",
-  "version": 1
+  "title": "Kubernetes / Networking / Retina / Clusters",
+  "uid": "RetinaClusters",
+  "version": 2
 }
diff --git a/deploy/hubble/grafana/dashboards/dns.json → deploy/grafana-dashboards/hubble-dns.json b/deploy/hubble/grafana/dashboards/dns.json → deploy/grafana-dashboards/hubble-dns.json
@@ -36,10 +36,10 @@
       "includeVars": true,
       "keepTime": true,
       "tags": [
-        "k8s:network-observability"
+        "k8s:retina-network-observability"
       ],
       "targetBlank": false,
-      "title": "Dashboards: Network Observability",
+      "title": "Dashboards: Retina Network Observability",
       "tooltip": "",
       "type": "dashboards",
       "url": ""
@@ -54,7 +54,7 @@
       "title": "Documentation",
       "tooltip": "",
       "type": "link",
-      "url": "https://aka.ms/NetObsAddonDoc"
+      "url": "https://retina.sh/docs/Introduction/intro"
     }
   ],
   "liveNow": true,
@@ -930,7 +930,7 @@
   "schemaVersion": 38,
   "style": "dark",
   "tags": [
-    "k8s:network-observability"
+    "k8s:retina-network-observability"
   ],
   "templating": {
     "list": [
@@ -1016,7 +1016,7 @@
     ]
   },
   "timezone": "",
-  "title": "Kubernetes / Networking / DNS",
-  "uid": "NetObsDNS6741",
+  "title": "Kubernetes / Networking / Retina (Hubble) / DNS",
+  "uid": "RetinaHubbleDNS",
   "version": 1
 }
diff --git a/...afana/dashboards/pod-flows-namespace.json → ...ashboards/hubble-pod-flows-namespace.json b/...afana/dashboards/pod-flows-namespace.json → ...ashboards/hubble-pod-flows-namespace.json
@@ -48,10 +48,10 @@
       "includeVars": true,
       "keepTime": true,
       "tags": [
-        "k8s:network-observability"
+        "k8s:retina-network-observability"
       ],
       "targetBlank": false,
-      "title": "Dashboards: Network Observability",
+      "title": "Dashboards: Retina Network Observability",
       "tooltip": "",
       "type": "dashboards",
       "url": ""
@@ -66,7 +66,7 @@
       "title": "Documentation",
       "tooltip": "Documentation",
       "type": "link",
-      "url": "https://aka.ms/NetObsAddonDoc"
+      "url": "https://retina.sh/docs/Introduction/intro"
     }
   ],
   "liveNow": true,
@@ -4150,7 +4150,7 @@
   "schemaVersion": 38,
   "style": "dark",
   "tags": [
-    "k8s:network-observability"
+    "k8s:retina-network-observability"
   ],
   "templating": {
     "list": [
@@ -4263,7 +4263,7 @@
     ]
   },
   "timezone": "",
-  "title": "Kubernetes / Networking / Pod Flows (Namespace)",
-  "uid": "NetObsFlowsNamespace6739",
+  "title": "Kubernetes / Networking / Retina (Hubble) / Pod Flows (Namespace)",
+  "uid": "RetinaHubblePodFlowsNamespace",
   "version": 1
 }
diff --git a/...rafana/dashboards/pod-flows-workload.json → ...dashboards/hubble-pod-flows-workload.json b/...rafana/dashboards/pod-flows-workload.json → ...dashboards/hubble-pod-flows-workload.json
@@ -42,10 +42,10 @@
       "includeVars": true,
       "keepTime": true,
       "tags": [
-        "k8s:network-observability"
+        "k8s:retina-network-observability"
       ],
       "targetBlank": false,
-      "title": "Dashboards: Network Observability",
+      "title": "Dashboards: Retina Network Observability",
       "tooltip": "",
       "type": "dashboards",
       "url": ""
@@ -60,7 +60,7 @@
       "title": "Documentation",
       "tooltip": "Documentation",
       "type": "link",
-      "url": "https://aka.ms/NetObsAddonDoc"
+      "url": "https://retina.sh/docs/Introduction/intro"
     }
   ],
   "liveNow": true,
@@ -3875,7 +3875,7 @@
   "schemaVersion": 38,
   "style": "dark",
   "tags": [
-    "k8s:network-observability"
+    "k8s:retina-network-observability"
   ],
   "templating": {
     "list": [
@@ -4004,7 +4004,7 @@
     ]
   },
   "timezone": "",
-  "title": "Kubernetes / Networking / Pod Flows (Workload)",
-  "uid": "NetObsFlowsWorkload6740",
+  "title": "Kubernetes / Networking / Retina (Hubble) / Pod Flows (Workload)",
+  "uid": "RetinaHubblePodFlowsWorkload",
   "version": 1
 }
diff --git a/deploy/standard/grafana/dashboards/dns.json → deploy/grafana-dashboards/standard-dns.json b/deploy/standard/grafana/dashboards/dns.json → deploy/grafana-dashboards/standard-dns.json
@@ -36,10 +36,10 @@
       "includeVars": true,
       "keepTime": true,
       "tags": [
-        "k8s:network-observability"
+        "k8s:retina-network-observability"
       ],
       "targetBlank": false,
-      "title": "Dashboards: Network Observability",
+      "title": "Dashboards: Retina Network Observability",
       "tooltip": "",
       "type": "dashboards",
       "url": ""
@@ -54,7 +54,7 @@
       "title": "Documentation",
       "tooltip": "",
       "type": "link",
-      "url": "https://www.retina.sh"
+      "url": "https://retina.sh/docs/Introduction/intro"
     }
   ],
   "liveNow": true,
@@ -836,7 +836,7 @@
   "schemaVersion": 38,
   "style": "dark",
   "tags": [
-    "k8s:network-observability"
+    "k8s:retina-network-observability"
   ],
   "templating": {
     "list": [
@@ -920,7 +920,7 @@
     ]
   },
   "timezone": "",
-  "title": "Kubernetes / Networking / DNS",
-  "uid": "Retina55",
+  "title": "Kubernetes / Networking / Retina (Standard) / DNS",
+  "uid": "RetinaStandardDNS",
   "version": 1
 }
diff --git a/...tandard/grafana/dashboards/pod-level.json → ...rafana-dashboards/standard-pod-level.json b/...tandard/grafana/dashboards/pod-level.json → ...rafana-dashboards/standard-pod-level.json
@@ -36,10 +36,10 @@
       "includeVars": true,
       "keepTime": true,
       "tags": [
-        "k8s:network-observability"
+        "k8s:retina-network-observability"
       ],
       "targetBlank": false,
-      "title": "Dashboards: Network Observability",
+      "title": "Dashboards: Retina Network Observability",
       "tooltip": "",
       "type": "dashboards",
       "url": ""
@@ -54,7 +54,7 @@
       "title": "Documentation",
       "tooltip": "",
       "type": "link",
-      "url": "https://www.retina.sh"
+      "url": "https://retina.sh/docs/Introduction/intro"
     }
   ],
   "liveNow": false,
@@ -1058,7 +1058,7 @@
   "schemaVersion": 38,
   "style": "dark",
   "tags": [
-    "k8s:network-observability"
+    "k8s:retina-network-observability"
   ],
   "templating": {
     "list": [
@@ -1108,7 +1108,7 @@
   },
   "timepicker": {},
   "timezone": "",
-  "title": "Kubernetes / Networking / Pod Traffic",
-  "uid": "Retina22",
+  "title": "Kubernetes / Networking / Retina (Standard) / Pod Traffic",
+  "uid": "RetinaStandardPodTraffic",
   "version": 1
 }
diff --git a/deploy/hubble/grafana/dashboards/README.md b/deploy/hubble/grafana/dashboards/README.md