Add stability level guideline

Signed-off-by: Pete Wall <pete.wall@grafana.com>
grafana · Oct 22, 2024 · ca27d88 · ca27d88
1 parent a1e6d6b
commit ca27d88
Show file tree

Hide file tree

Showing 16 changed files with 29 additions and 7 deletions.
diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-annotation-autodiscovery-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-annotation-autodiscovery-1.0.0.tgz
diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-application-observability-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-application-observability-1.0.0.tgz
diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-events-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-events-1.0.0.tgz
diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-metrics-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-cluster-metrics-1.0.0.tgz
diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-frontend-observability-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-frontend-observability-1.0.0.tgz
diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-integrations-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-integrations-1.0.0.tgz
diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-pod-logs-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-pod-logs-1.0.0.tgz
diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-profiling-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-profiling-1.0.0.tgz
diff --git a/charts/k8s-monitoring/charts/k8s-monitoring-feature-prometheus-operator-objects-1.0.0.tgz b/charts/k8s-monitoring/charts/k8s-monitoring-feature-prometheus-operator-objects-1.0.0.tgz
diff --git a/charts/k8s-monitoring/docs/examples/remote-config/README.md b/charts/k8s-monitoring/docs/examples/remote-config/README.md
@@ -12,6 +12,8 @@ cluster:
 
 alloy-metrics:
   enabled: true
+  alloy:
+    stabilityLevel: public-preview
   remoteConfig:
     enabled: true
     url: "https://remote-config.example.com/alloy"

diff --git a/charts/k8s-monitoring/docs/examples/remote-config/alloy-metrics.alloy b/charts/k8s-monitoring/docs/examples/remote-config/alloy-metrics.alloy
@@ -7,10 +7,11 @@ remotecfg {
     username = nonsensitive(remote.kubernetes.secret.alloy_metrics_remote_cfg.data["username"])
     password = remote.kubernetes.secret.alloy_metrics_remote_cfg.data["password"]
   }
-  id = "remote-config-example-cluster-default-" + constants.hostnamepoll_frequency = "5m"
+  id = "remote-config-example-cluster-default-" + constants.hostname
+  poll_frequency = "5m"
   attributes = {
     "cluster" = "remote-config-example-cluster",
     "platform" = "kubernetes",
-    "workloadType": "statefulset",
+    "workloadType" = "statefulset",
   }
 }
diff --git a/charts/k8s-monitoring/docs/examples/remote-config/output.yaml b/charts/k8s-monitoring/docs/examples/remote-config/output.yaml
@@ -32,11 +32,12 @@ data:
         username = nonsensitive(remote.kubernetes.secret.alloy_metrics_remote_cfg.data["username"])
         password = remote.kubernetes.secret.alloy_metrics_remote_cfg.data["password"]
       }
-      id = "remote-config-example-cluster-default-" + constants.hostnamepoll_frequency = "5m"
+      id = "remote-config-example-cluster-default-" + constants.hostname
+      poll_frequency = "5m"
       attributes = {
         "cluster" = "remote-config-example-cluster",
         "platform" = "kubernetes",
-        "workloadType": "statefulset",
+        "workloadType" = "statefulset",
       }
     }
 ---
@@ -267,7 +268,7 @@ spec:
             - --cluster.enabled=true
             - --cluster.join-addresses=ko-alloy-metrics-cluster
             - --cluster.name="alloy-metrics"
-            - --stability.level=generally-available
+            - --stability.level=public-preview
           env:
             - name: ALLOY_DEPLOY_MODE
               value: "helm"

diff --git a/charts/k8s-monitoring/docs/examples/remote-config/values.yaml b/charts/k8s-monitoring/docs/examples/remote-config/values.yaml
@@ -3,6 +3,8 @@ cluster:
 
 alloy-metrics:
   enabled: true
+  alloy:
+    stabilityLevel: public-preview
   remoteConfig:
     enabled: true
     url: "https://remote-config.example.com/alloy"

diff --git a/charts/k8s-monitoring/templates/collectors/_collector_remoteConfig.tpl b/charts/k8s-monitoring/templates/collectors/_collector_remoteConfig.tpl
@@ -14,12 +14,12 @@ remotecfg {
   id = {{ .id | quote }}
 {{- else }}
   id = "{{ $.Values.cluster.name }}-{{ $.Release.Namespace }}-" + constants.hostname
-{{- end -}}
+{{- end }}
   poll_frequency = {{ .pollFrequency | quote }}
   attributes = {
     "cluster" = {{ $.Values.cluster.name | quote }},
     "platform" = "kubernetes",
-    "workloadType": {{ (index $.Values $.collectorName).controller.type | quote }},
+    "workloadType" = {{ (index $.Values $.collectorName).controller.type | quote }},
 {{- range $key, $value := .extraAttributes }}
     {{ $key | quote }} = {{ $value | quote }},
 {{- end }}

diff --git a/charts/k8s-monitoring/templates/collectors/_collector_validations.tpl b/charts/k8s-monitoring/templates/collectors/_collector_validations.tpl
@@ -71,3 +71,18 @@
   {{- end }}
   {{- end }}
 {{- end }}
+
+{{- define "collectors.validate.remoteConfig" }}
+{{- if (index .Values .collectorName).enabled }}
+  {{- if (index .Values .collectorName).remoteConfig.enabled }}
+    {{- if not (has (index .Values .collectorName).alloy.stabilityLevel (list "public-preview" "experimental")) }}
+      {{- $msg := list "" "The remote configuratino feature requires Alloy to use the \"public-preview\" stability level. Please set:" }}
+      {{- $msg = append $msg (printf "%s:" .collectorName ) }}
+      {{- $msg = append $msg "  alloy:" }}
+      {{- $msg = append $msg "    stabilityLevel: public-preview" }}
+      {{- fail (join "\n" $msg) }}
+    {{- end }}
+  {{- end }}
+  {{- end }}
+{{- end }}
+
diff --git a/charts/k8s-monitoring/templates/validations.yaml b/charts/k8s-monitoring/templates/validations.yaml
@@ -12,5 +12,6 @@
 {{- include "collectors.validate.featuresEnabled" . }}
 {{- range $collectorName := ((include "collectors.list.enabled" .) | fromYamlArray) }}
   {{- include "collectors.validate.liveDebugging" (dict "collectorName" $collectorName "Values" $.Values) }}
+  {{- include "collectors.validate.remoteConfig" (dict "collectorName" $collectorName "Values" $.Values) }}
 {{- end }}
 ---