[operator] Change runbook_url to an actual url in the PrometheusRule (#1317)

* Change runbook_url to an actual url in the operator chart

* chart bump

* move url to values

* revert

* Use correct url

Author: bogdan-at-adobe

charts/opentelemetry-operator/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: opentelemetry-operator
-version: 0.68.1
+version: 0.68.2
 description: OpenTelemetry Operator Helm chart for Kubernetes
 type: application
 home: https://opentelemetry.io/

charts/opentelemetry-operator/examples/default/rendered/admission-webhooks/operator-webhook-with-cert-manager.yaml

@@ -6,7 +6,7 @@ metadata:
   annotations:
     cert-manager.io/inject-ca-from: default/example-opentelemetry-operator-serving-cert
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm
@@ -91,7 +91,7 @@ metadata:
   annotations:
     cert-manager.io/inject-ca-from: default/example-opentelemetry-operator-serving-cert
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/examples/default/rendered/certmanager.yaml

@@ -4,7 +4,7 @@ apiVersion: cert-manager.io/v1
 kind: Certificate
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm
@@ -30,7 +30,7 @@ apiVersion: cert-manager.io/v1
 kind: Issuer
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/examples/default/rendered/clusterrole.yaml

@@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm
@@ -223,7 +223,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm
@@ -242,7 +242,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/examples/default/rendered/clusterrolebinding.yaml

@@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm
@@ -26,7 +26,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/examples/default/rendered/deployment.yaml

@@ -4,7 +4,7 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/examples/default/rendered/role.yaml

@@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: Role
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/examples/default/rendered/rolebinding.yaml

@@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: RoleBinding
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/examples/default/rendered/service.yaml

@@ -4,7 +4,7 @@ apiVersion: v1
 kind: Service
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm
@@ -32,7 +32,7 @@ apiVersion: v1
 kind: Service
 metadata:
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/examples/default/rendered/serviceaccount.yaml

@@ -6,7 +6,7 @@ metadata:
   name: opentelemetry-operator
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/examples/default/rendered/tests/test-certmanager-connection.yaml

@@ -6,7 +6,7 @@ metadata:
   name: "example-opentelemetry-operator-cert-manager"
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/examples/default/rendered/tests/test-service-connection.yaml

@@ -6,7 +6,7 @@ metadata:
   name: "example-opentelemetry-operator-metrics"
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm
@@ -44,7 +44,7 @@ metadata:
   name: "example-opentelemetry-operator-webhook"
   namespace: default
   labels:
-    helm.sh/chart: opentelemetry-operator-0.68.1
+    helm.sh/chart: opentelemetry-operator-0.68.2
     app.kubernetes.io/name: opentelemetry-operator
     app.kubernetes.io/version: "0.107.0"
     app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/templates/prometheusrule.yaml

@@ -32,7 +32,7 @@ spec:
         {{- end }}
       annotations:
         description: '{{`Reconciliation errors for {{ $labels.controller }} is increasing and has now reached {{ humanize $value }} `}}'
-        runbook_url: 'Check manager logs for reasons why this might happen'
+        runbook_url: '{{ default "https://opentelemetry.io/docs/kubernetes/operator/troubleshooting/prometheus-alerts-runbooks/" .Values.manager.prometheusRule.runbookUrl }}#reconcileerrors'
         {{- with .Values.manager.prometheusRule.defaultRules.additionalRuleAnnotations }}
           {{- toYaml . | nindent 8 }}
         {{- end }}
@@ -46,7 +46,7 @@ spec:
         {{- end }}
       annotations:
         description: '{{`Queue depth for {{ $labels.name }} has reached {{ $value }} `}}'
-        runbook_url: 'Check manager logs for reasons why this might happen'
+        runbook_url: '{{ default "https://opentelemetry.io/docs/kubernetes/operator/troubleshooting/prometheus-alerts-runbooks/" .Values.manager.prometheusRule.runbookUrl }}#workqueuedepth'
         {{- with .Values.manager.prometheusRule.defaultRules.additionalRuleAnnotations }}
           {{- toYaml . | nindent 8 }}
         {{- end }}

charts/opentelemetry-operator/values.schema.json

@@ -919,6 +919,14 @@
                             "required": [],
                             "properties": {},
                             "examples": [{}]
+                        },
+                        "runbookUrl": {
+                            "type": "string",
+                            "default": "",
+                            "title": "The runbookUrl Schema",
+                            "required": [],
+                            "properties": {},
+                            "examples": [{}]
                         }
                     },
                     "examples": [{

charts/opentelemetry-operator/values.yaml

@@ -136,6 +136,9 @@ manager:
     extraLabels: {}
     # add annotations on the PrometheusRule object
     annotations: {}
+    # change the default runbook urls.
+    # the alert name will get appended at the end of the url as an anchor.
+    runbookUrl: ""
 
   # Whether the operator should create RBAC permissions for collectors. See README.md for more information.
   createRbacPermissions: false