Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
Sep 6, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7710b91
Change runbook_url to an actual url in the operator chart
bogdan-at-adobe Aug 27, 2024
ec30116
chart bump
bogdan-at-adobe Aug 28, 2024
231aa23
move url to values
bogdan-at-adobe Aug 29, 2024
cf98c0a
revert
bogdan-at-adobe Aug 30, 2024
f3778b8
Merge branch 'main' into change_runbook_url_promrule
bogdan-at-adobe Aug 30, 2024
eecb736
Use correct url
bogdan-at-adobe Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/
Expand Down
4 changes: 2 additions & 2 deletions ...ator/examples/default/rendered/admission-webhooks/operator-webhook-with-cert-manager.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions charts/opentelemetry-operator/examples/default/rendered/certmanager.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions charts/opentelemetry-operator/examples/default/rendered/clusterrole.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions charts/opentelemetry-operator/examples/default/rendered/clusterrolebinding.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/examples/default/rendered/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/examples/default/rendered/role.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/examples/default/rendered/rolebinding.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions charts/opentelemetry-operator/examples/default/rendered/service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/examples/default/rendered/serviceaccount.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ...s/opentelemetry-operator/examples/default/rendered/tests/test-certmanager-connection.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions charts/opentelemetry-operator/examples/default/rendered/tests/test-service-connection.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions charts/opentelemetry-operator/templates/prometheusrule.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand All @@ -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 }}
Expand Down
8 changes: 8 additions & 0 deletions charts/opentelemetry-operator/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -919,6 +919,14 @@
"required": [],
"properties": {},
"examples": [{}]
},
"runbookUrl": {
"type": "string",
"default": "",
"title": "The runbookUrl Schema",
"required": [],
"properties": {},
"examples": [{}]
}
},
"examples": [{
Expand Down
3 changes: 3 additions & 0 deletions charts/opentelemetry-operator/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading