[helm] Add support for monitoring stack (#1325)

Author: the-glu

deploy/infrastructure/dependencies/terraform-commons-dss/helm.tf

@@ -91,6 +91,32 @@ resource "local_file" "helm_chart_values" {
     global = {
       cloudProvider = var.kubernetes_cloud_provider_name
     }
+
+    monitoring = {
+      enabled = false
+    },
+
+    prometheus = {
+      server = {
+        persistentVolume = {
+          storageClass = var.kubernetes_storage_class
+        }
+
+        global = {
+          external_labels = {
+            environment = "dev"
+            k8s_cluster = var.cluster_name
+          }
+        }
+      }
+    }
+
+    grafana = {
+      persistence = {
+        storageClassName = var.kubernetes_storage_class
+      }
+    }
+
     }) : yamlencode({
     cockroachdb = {
       enabled = false
@@ -261,6 +287,31 @@ resource "local_file" "helm_chart_values" {
     global = {
       cloudProvider = var.kubernetes_cloud_provider_name
     }
+
+    monitoring = {
+      enabled = false
+    },
+
+    prometheus = {
+      server = {
+        persistentVolume = {
+          storageClass = var.kubernetes_storage_class
+        }
+
+        global = {
+          external_labels = {
+            environment = "dev"
+            k8s_cluster = var.cluster_name
+          }
+        }
+      }
+    }
+
+    grafana = {
+      persistence = {
+        storageClassName = var.kubernetes_storage_class
+      }
+    }
   })
 
 }

deploy/infrastructure/dependencies/terraform-commons-dss/variables.gen.tf

@@ -55,6 +55,15 @@ variable "node_count" {
 }
 
 
+variable "cluster_name" {
+  type        = string
+  description = <<-EOT
+  Name of the kubernetes cluster that will host this DSS instance (should generally describe the DSS instance being hosted)
+
+  Example: `dss-che-1`
+  EOT
+}
+
 variable "image" {
   type        = string
   description = <<-EOT

deploy/infrastructure/modules/terraform-aws-dss/main.tf

@@ -16,6 +16,7 @@ module "terraform-aws-kubernetes" {
 
 module "terraform-commons-dss" {
   # See variables.tf for variables description.
+  cluster_name                     = var.cluster_name
   image                            = var.image
   image_pull_secret                = var.image_pull_secret
   kubernetes_namespace             = var.kubernetes_namespace

deploy/infrastructure/modules/terraform-google-dss/main.tf

@@ -16,6 +16,7 @@ module "terraform-google-kubernetes" {
 
 module "terraform-commons-dss" {
   # See variables.tf for variables description.
+  cluster_name                     = var.cluster_name
   image                            = var.image
   kubernetes_namespace             = var.kubernetes_namespace
   kubernetes_storage_class         = var.google_kubernetes_storage_class

deploy/infrastructure/utils/variables.py

@@ -23,7 +23,7 @@
 
 # Variables per project
 # For all */terraform-*
-GLOBAL_VARIABLES = ["app_hostname", "db_hostname_suffix", "datastore_type", "node_count"]
+GLOBAL_VARIABLES = ["app_hostname", "db_hostname_suffix", "datastore_type", "node_count", "cluster_name"]
 
 # dependencies/terraform-commons-dss
 COMMONS_DSS_VARIABLES = GLOBAL_VARIABLES + [
@@ -59,7 +59,6 @@
 
 # dependencies/terraform-*-kubernetes
 COMMON_KUBERNETES_VARIABLES = GLOBAL_VARIABLES + [
-    "cluster_name",
     "kubernetes_version",
 ]
 

deploy/services/helm-charts/dss/Chart.yaml

@@ -13,3 +13,11 @@ dependencies:
     repository: https://interuss.github.io/yugabyte-charts/
     version: 2025.1.0
     condition: yugabyte.enabled
+  - name: prometheus
+    repository: https://prometheus-community.github.io/helm-charts
+    version: 27.51.0
+    condition: monitoring.enabled
+  - name: grafana
+    repository: https://grafana.github.io/helm-charts
+    version: 10.3.1
+    condition: monitoring.enabled

deploy/services/helm-charts/dss/grafana_dashboards

@@ -0,0 +1 @@
+../../tanka/grafana_dashboards

deploy/services/helm-charts/dss/templates/grafana-dashboards.yaml

@@ -0,0 +1,17 @@
+{{- if $.Values.monitoring.enabled }}
+
+---
+
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: dss-grafana-dashboards-default
+  labels:
+    grafana_dashboard: "1"
+data:
+{{- range $path, $bytes := .Files.Glob "grafana_dashboards/*.json" }}
+  {{ base $path }}: |-
+{{ $.Files.Get $path | indent 4 }}
+  {{- end }}
+
+{{- end }}

deploy/services/helm-charts/dss/values.example.yaml

@@ -77,3 +77,15 @@ loadBalancers:
 
 global:
   cloudProvider: google
+
+monitoring:  # Set to true to enable monitoring stack
+  enabled: true
+
+prometheus:
+  server:
+    persistentVolume:
+      storageClass: standard  # If you need a specfic storage class, set it there
+
+grafana:
+  persistence:
+    storageClassName: standard  # If you need a specfic storage class, set it there

deploy/services/helm-charts/dss/values.schema.json

@@ -342,12 +342,23 @@
         }
       },
       "required": ["cloudProvider"]
+    },
+    "monitoring": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Enable monitoring stack with prometheus and grafana."
+        }
+      },
+      "required": ["enabled"]
     }
   },
   "required": [
     "loadBalancers",
     "dss",
-    "global"
+    "global",
+    "monitoring"
   ],
   "title": "Values",
   "type": "object"