Skip to content

Commit 59a65c0

Browse files
[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
1 parent cef4836 commit 59a65c0

15 files changed

+32
-21
lines changed

charts/opentelemetry-operator/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: opentelemetry-operator
3-
version: 0.68.1
3+
version: 0.68.2
44
description: OpenTelemetry Operator Helm chart for Kubernetes
55
type: application
66
home: https://opentelemetry.io/

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ metadata:
66
annotations:
77
cert-manager.io/inject-ca-from: default/example-opentelemetry-operator-serving-cert
88
labels:
9-
helm.sh/chart: opentelemetry-operator-0.68.1
9+
helm.sh/chart: opentelemetry-operator-0.68.2
1010
app.kubernetes.io/name: opentelemetry-operator
1111
app.kubernetes.io/version: "0.107.0"
1212
app.kubernetes.io/managed-by: Helm
@@ -91,7 +91,7 @@ metadata:
9191
annotations:
9292
cert-manager.io/inject-ca-from: default/example-opentelemetry-operator-serving-cert
9393
labels:
94-
helm.sh/chart: opentelemetry-operator-0.68.1
94+
helm.sh/chart: opentelemetry-operator-0.68.2
9595
app.kubernetes.io/name: opentelemetry-operator
9696
app.kubernetes.io/version: "0.107.0"
9797
app.kubernetes.io/managed-by: Helm

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apiVersion: cert-manager.io/v1
44
kind: Certificate
55
metadata:
66
labels:
7-
helm.sh/chart: opentelemetry-operator-0.68.1
7+
helm.sh/chart: opentelemetry-operator-0.68.2
88
app.kubernetes.io/name: opentelemetry-operator
99
app.kubernetes.io/version: "0.107.0"
1010
app.kubernetes.io/managed-by: Helm
@@ -30,7 +30,7 @@ apiVersion: cert-manager.io/v1
3030
kind: Issuer
3131
metadata:
3232
labels:
33-
helm.sh/chart: opentelemetry-operator-0.68.1
33+
helm.sh/chart: opentelemetry-operator-0.68.2
3434
app.kubernetes.io/name: opentelemetry-operator
3535
app.kubernetes.io/version: "0.107.0"
3636
app.kubernetes.io/managed-by: Helm

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
44
kind: ClusterRole
55
metadata:
66
labels:
7-
helm.sh/chart: opentelemetry-operator-0.68.1
7+
helm.sh/chart: opentelemetry-operator-0.68.2
88
app.kubernetes.io/name: opentelemetry-operator
99
app.kubernetes.io/version: "0.107.0"
1010
app.kubernetes.io/managed-by: Helm
@@ -223,7 +223,7 @@ apiVersion: rbac.authorization.k8s.io/v1
223223
kind: ClusterRole
224224
metadata:
225225
labels:
226-
helm.sh/chart: opentelemetry-operator-0.68.1
226+
helm.sh/chart: opentelemetry-operator-0.68.2
227227
app.kubernetes.io/name: opentelemetry-operator
228228
app.kubernetes.io/version: "0.107.0"
229229
app.kubernetes.io/managed-by: Helm
@@ -242,7 +242,7 @@ apiVersion: rbac.authorization.k8s.io/v1
242242
kind: ClusterRole
243243
metadata:
244244
labels:
245-
helm.sh/chart: opentelemetry-operator-0.68.1
245+
helm.sh/chart: opentelemetry-operator-0.68.2
246246
app.kubernetes.io/name: opentelemetry-operator
247247
app.kubernetes.io/version: "0.107.0"
248248
app.kubernetes.io/managed-by: Helm

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
44
kind: ClusterRoleBinding
55
metadata:
66
labels:
7-
helm.sh/chart: opentelemetry-operator-0.68.1
7+
helm.sh/chart: opentelemetry-operator-0.68.2
88
app.kubernetes.io/name: opentelemetry-operator
99
app.kubernetes.io/version: "0.107.0"
1010
app.kubernetes.io/managed-by: Helm
@@ -26,7 +26,7 @@ apiVersion: rbac.authorization.k8s.io/v1
2626
kind: ClusterRoleBinding
2727
metadata:
2828
labels:
29-
helm.sh/chart: opentelemetry-operator-0.68.1
29+
helm.sh/chart: opentelemetry-operator-0.68.2
3030
app.kubernetes.io/name: opentelemetry-operator
3131
app.kubernetes.io/version: "0.107.0"
3232
app.kubernetes.io/managed-by: Helm

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apiVersion: apps/v1
44
kind: Deployment
55
metadata:
66
labels:
7-
helm.sh/chart: opentelemetry-operator-0.68.1
7+
helm.sh/chart: opentelemetry-operator-0.68.2
88
app.kubernetes.io/name: opentelemetry-operator
99
app.kubernetes.io/version: "0.107.0"
1010
app.kubernetes.io/managed-by: Helm

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
44
kind: Role
55
metadata:
66
labels:
7-
helm.sh/chart: opentelemetry-operator-0.68.1
7+
helm.sh/chart: opentelemetry-operator-0.68.2
88
app.kubernetes.io/name: opentelemetry-operator
99
app.kubernetes.io/version: "0.107.0"
1010
app.kubernetes.io/managed-by: Helm

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
44
kind: RoleBinding
55
metadata:
66
labels:
7-
helm.sh/chart: opentelemetry-operator-0.68.1
7+
helm.sh/chart: opentelemetry-operator-0.68.2
88
app.kubernetes.io/name: opentelemetry-operator
99
app.kubernetes.io/version: "0.107.0"
1010
app.kubernetes.io/managed-by: Helm

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apiVersion: v1
44
kind: Service
55
metadata:
66
labels:
7-
helm.sh/chart: opentelemetry-operator-0.68.1
7+
helm.sh/chart: opentelemetry-operator-0.68.2
88
app.kubernetes.io/name: opentelemetry-operator
99
app.kubernetes.io/version: "0.107.0"
1010
app.kubernetes.io/managed-by: Helm
@@ -32,7 +32,7 @@ apiVersion: v1
3232
kind: Service
3333
metadata:
3434
labels:
35-
helm.sh/chart: opentelemetry-operator-0.68.1
35+
helm.sh/chart: opentelemetry-operator-0.68.2
3636
app.kubernetes.io/name: opentelemetry-operator
3737
app.kubernetes.io/version: "0.107.0"
3838
app.kubernetes.io/managed-by: Helm

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ metadata:
66
name: opentelemetry-operator
77
namespace: default
88
labels:
9-
helm.sh/chart: opentelemetry-operator-0.68.1
9+
helm.sh/chart: opentelemetry-operator-0.68.2
1010
app.kubernetes.io/name: opentelemetry-operator
1111
app.kubernetes.io/version: "0.107.0"
1212
app.kubernetes.io/managed-by: Helm

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ metadata:
66
name: "example-opentelemetry-operator-cert-manager"
77
namespace: default
88
labels:
9-
helm.sh/chart: opentelemetry-operator-0.68.1
9+
helm.sh/chart: opentelemetry-operator-0.68.2
1010
app.kubernetes.io/name: opentelemetry-operator
1111
app.kubernetes.io/version: "0.107.0"
1212
app.kubernetes.io/managed-by: Helm

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ metadata:
66
name: "example-opentelemetry-operator-metrics"
77
namespace: default
88
labels:
9-
helm.sh/chart: opentelemetry-operator-0.68.1
9+
helm.sh/chart: opentelemetry-operator-0.68.2
1010
app.kubernetes.io/name: opentelemetry-operator
1111
app.kubernetes.io/version: "0.107.0"
1212
app.kubernetes.io/managed-by: Helm
@@ -44,7 +44,7 @@ metadata:
4444
name: "example-opentelemetry-operator-webhook"
4545
namespace: default
4646
labels:
47-
helm.sh/chart: opentelemetry-operator-0.68.1
47+
helm.sh/chart: opentelemetry-operator-0.68.2
4848
app.kubernetes.io/name: opentelemetry-operator
4949
app.kubernetes.io/version: "0.107.0"
5050
app.kubernetes.io/managed-by: Helm

charts/opentelemetry-operator/templates/prometheusrule.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ spec:
3232
{{- end }}
3333
annotations:
3434
description: '{{`Reconciliation errors for {{ $labels.controller }} is increasing and has now reached {{ humanize $value }} `}}'
35-
runbook_url: 'Check manager logs for reasons why this might happen'
35+
runbook_url: '{{ default "https://opentelemetry.io/docs/kubernetes/operator/troubleshooting/prometheus-alerts-runbooks/" .Values.manager.prometheusRule.runbookUrl }}#reconcileerrors'
3636
{{- with .Values.manager.prometheusRule.defaultRules.additionalRuleAnnotations }}
3737
{{- toYaml . | nindent 8 }}
3838
{{- end }}
@@ -46,7 +46,7 @@ spec:
4646
{{- end }}
4747
annotations:
4848
description: '{{`Queue depth for {{ $labels.name }} has reached {{ $value }} `}}'
49-
runbook_url: 'Check manager logs for reasons why this might happen'
49+
runbook_url: '{{ default "https://opentelemetry.io/docs/kubernetes/operator/troubleshooting/prometheus-alerts-runbooks/" .Values.manager.prometheusRule.runbookUrl }}#workqueuedepth'
5050
{{- with .Values.manager.prometheusRule.defaultRules.additionalRuleAnnotations }}
5151
{{- toYaml . | nindent 8 }}
5252
{{- end }}

charts/opentelemetry-operator/values.schema.json

+8
Original file line numberDiff line numberDiff line change
@@ -919,6 +919,14 @@
919919
"required": [],
920920
"properties": {},
921921
"examples": [{}]
922+
},
923+
"runbookUrl": {
924+
"type": "string",
925+
"default": "",
926+
"title": "The runbookUrl Schema",
927+
"required": [],
928+
"properties": {},
929+
"examples": [{}]
922930
}
923931
},
924932
"examples": [{

charts/opentelemetry-operator/values.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,9 @@ manager:
136136
extraLabels: {}
137137
# add annotations on the PrometheusRule object
138138
annotations: {}
139+
# change the default runbook urls.
140+
# the alert name will get appended at the end of the url as an anchor.
141+
runbookUrl: ""
139142

140143
# Whether the operator should create RBAC permissions for collectors. See README.md for more information.
141144
createRbacPermissions: false

0 commit comments

Comments
 (0)