feat(openshift): add mTLS for Prometheus metrics#3473
Open
jkhelil wants to merge 1 commit into
Open
Conversation
tekton-robot
added
the
release-note-none
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
tekton-robot
added
the
size/XL
|
/kind feature |
tekton-robot
added
the
kind/feature
tekton-robot
added
release-note
jkhelil
changed the title
jkhelil
changed the title
tekton-robot
added
the
do-not-merge/work-in-progress
jkhelil
changed the title
tekton-robot
removed
the
do-not-merge/work-in-progress
Secure component metrics endpoints with mutual TLS on OpenShift. Each reconciler syncs the Prometheus client CA bundle from kube-system/extension-apiserver-authentication into the component namespace as a metrics-client-ca ConfigMap. OpenShift's serving-cert controller is triggered via annotation on each metrics Service to provision a per-component TLS Secret. Two new manifest transformers (InjectMetricsServingCert, ApplyMetricsTLS) wire the Secret and ConfigMap as volumes and inject METRICS_PROMETHEUS_TLS_* env vars so that the knative/pkg prometheus.Server enables mTLS with require client auth. ServiceMonitor resources are updated with scheme: https, scrapeClass tls-client-certificate-auth, and tlsConfig.serverName. The existing UpdateServiceMonitorTargetNamespace transformer is extended to also patch the namespace segment inside serverName at runtime. Relates-To: SRVKP-8172 Signed-off-by: Jawed khelil <[email protected]> Assisted-by: Claude Sonnet 4.6 (via Cursor) Co-authored-by: Cursor <[email protected]>
There was a problem hiding this comment.
Pull request overview
Adds OpenShift-specific mutual TLS support for Prometheus scraping of Tekton component metrics endpoints by annotating metrics Services for serving cert issuance, mounting TLS materials into workloads, and updating ServiceMonitors to scrape over HTTPS.
Changes:
- Introduces OpenShift manifest transformers to inject serving-cert annotations, mount metrics TLS Secret + client-CA ConfigMap, and set
METRICS_PROMETHEUS_TLS_*env vars. - Updates OpenShift component reconcilers to apply the new metrics mTLS transformers to Deployments/StatefulSets and patch ServiceMonitors.
- Extends ServiceMonitor namespace rewriting to also patch the namespace segment in
tlsConfig.serverName.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| pkg/reconciler/openshift/tektontrigger/extension.go | Applies metrics mTLS transformers to Triggers controller. |
| pkg/reconciler/openshift/tektonresult/extension.go | Applies metrics mTLS transformers to Results watcher/API. |
| pkg/reconciler/openshift/tektonpruner/extension.go | Applies metrics mTLS transformers to Pruner controller. |
| pkg/reconciler/openshift/tektonpipeline/extension.go | Applies metrics mTLS transformers to Pipelines controllers and refines monitoring transforms. |
| pkg/reconciler/openshift/tektonconfig/extension.go | Ensures the metrics client CA ConfigMap is synced into the target namespace. |
| pkg/reconciler/openshift/tektonchain/extension.go | Applies metrics mTLS transformers to Chains metrics Service / controller. |
| pkg/reconciler/openshift/openshiftpipelinesascode/extension.go | Applies metrics mTLS transformers and updates PAC ServiceMonitors for HTTPS scraping. |
| pkg/reconciler/openshift/common/transformer.go | Extends ServiceMonitor namespace transformer to also update tlsConfig.serverName. |
| pkg/reconciler/openshift/common/metricstls.go | New: common transformers/helpers for metrics mTLS (Service annotation/port rename, workload mounts/env, ServiceMonitor TLS wiring). |
| pkg/reconciler/openshift/common/metricsca.go | New: sync logic for Prometheus client CA into component namespaces. |
| cmd/openshift/operator/kodata/openshift-monitoring/00-monitoring.yaml | Updates Pipelines controller ServiceMonitor endpoint to HTTPS with TLS config. |
| cmd/openshift/operator/kodata/openshift-monitoring/01-trigger-monitoring.yaml | Updates Triggers ServiceMonitor endpoint to HTTPS with TLS config. |
| cmd/openshift/operator/kodata/openshift-monitoring/02-chains-monitoring.yaml | Updates Chains ServiceMonitor endpoint to HTTPS with TLS config. |
| cmd/openshift/operator/kodata/openshift-monitoring/03-pipeline-webhook-monitoring.yaml | Explicitly sets webhook ServiceMonitor scheme to HTTP. |
| cmd/openshift/operator/kodata/openshift-monitoring/05-results-monitoring.yaml | Updates Results ServiceMonitors endpoints to HTTPS with TLS config. |
| cmd/openshift/operator/kodata/openshift-monitoring/06-pruner-monitoring.yaml | Updates Pruner ServiceMonitor endpoint to HTTPS with TLS config. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+89
to
+91
| func InjectMetricsServingCertWithPort(serviceName, portName string) mf.Transformer { | ||
| targetPortName := "https-" + portName | ||
| return func(u *unstructured.Unstructured) error { |
Comment on lines
+153
to
+155
| if epMap["port"] == portName { | ||
| epMap["port"] = "https-" + portName | ||
| } |
Comment on lines
+156
to
+163
| epMap["scheme"] = "https" | ||
| epMap["tlsConfig"] = map[string]interface{}{ | ||
| "caFile": promCAFile, | ||
| "certFile": promCertFile, | ||
| "keyFile": promKeyFile, | ||
| "serverName": serviceName + "." + targetNamespace + ".svc", | ||
| } | ||
| endpoints[i] = epMap |
Comment on lines
60
to
+64
| - interval: 10s | ||
| port: http-metrics | ||
| port: https-metrics | ||
| honorLabels: true | ||
| scheme: https | ||
| tlsConfig: |
Comment on lines
27
to
+30
| - interval: 10s | ||
| port: http-metrics | ||
| port: https-metrics | ||
| scheme: https | ||
| tlsConfig: |
Comment on lines
56
to
+60
| - interval: 10s | ||
| port: prometheus | ||
| port: https-prometheus | ||
| honorLabels: true | ||
| scheme: https | ||
| tlsConfig: |
Comment on lines
183
to
187
| nsSelector, found, err := unstructured.NestedFieldNoCopy(u.Object, "spec", "namespaceSelector") | ||
| if !found || err != nil { | ||
| return err | ||
| } | ||
| nsSelector.(map[string]interface{})["matchNames"].([]interface{})[0] = targetNamespace |
Comment on lines
+192
to
209
| endpoints, _, _ := unstructured.NestedSlice(u.Object, "spec", "endpoints") | ||
| for i, ep := range endpoints { | ||
| epMap, ok := ep.(map[string]interface{}) | ||
| if !ok { | ||
| continue | ||
| } | ||
| if tlsCfg, ok := epMap["tlsConfig"].(map[string]interface{}); ok { | ||
| if sn, ok := tlsCfg["serverName"].(string); ok { | ||
| tlsCfg["serverName"] = replaceServerNameNamespace(sn, targetNamespace) | ||
| } | ||
| } | ||
| endpoints[i] = epMap | ||
| } | ||
| if len(endpoints) > 0 { | ||
| _ = unstructured.SetNestedSlice(u.Object, endpoints, "spec", "endpoints") | ||
| } | ||
|
|
||
| return nil |
Comment on lines
+253
to
+261
| // Add the client-CA ConfigMap volume. | ||
| clientCAVol := corev1.Volume{ | ||
| Name: metricsClientCAVolume, | ||
| VolumeSource: corev1.VolumeSource{ | ||
| ConfigMap: &corev1.ConfigMapVolumeSource{ | ||
| LocalObjectReference: corev1.LocalObjectReference{ | ||
| Name: MetricsClientCAConfigMap, | ||
| }, | ||
| }, |
Comment on lines
+70
to
+83
| // InjectMetricsServingCert is a manifest transformer that targets the named | ||
| // Service and: | ||
| // | ||
| // 1. Annotates it with the OpenShift serving-cert annotation so that | ||
| // OpenShift automatically creates a TLS Secret named | ||
| // "<service-name>-metrics-tls". | ||
| // 2. Renames the port from "http-metrics" to "https-metrics". | ||
| // | ||
| // Call once per service that exposes an http-metrics port and whose workload | ||
| // understands the METRICS_PROMETHEUS_TLS_* env vars. | ||
| // For services that use a different port name use InjectMetricsServingCertWithPort. | ||
| func InjectMetricsServingCert(serviceName string) mf.Transformer { | ||
| return InjectMetricsServingCertWithPort(serviceName, metricsHTTPPort) | ||
| } |
infernus01
reviewed
Jun 9, 2026
| occommon.InjectMetricsServingCertWithPort(tektonResultWatcherName, "metrics"), | ||
| occommon.ApplyMetricsTLS("StatefulSet", tektonResultWatcherName, | ||
| occommon.MetricsServingCertSecretName(tektonResultWatcherName)), | ||
| occommon.InjectMetricsServingCertWithPort(serviceAPI, "prometheus"), |
Member
There was a problem hiding this comment.
This might create annotation conflict with injectResultsAPISeerviceCACert as this already sets service.beta.openshift.io/serving-cert-secret-name to "tekton-results-tls" on tekton-results-api-service. This transformer overwrites that same annotation with "tekton-results-api-service-metrics-tls" (via MetricsServingCertSecretName).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Secure component metrics endpoints with mutual TLS on OpenShift. Each reconciler syncs the Prometheus client CA bundle from kube-system/extension-apiserver-authentication into the component namespace as a metrics-client-ca ConfigMap.
OpenShift's serving-cert controller is triggered via annotation on each metrics Service to provision a per-component TLS Secret. Two new manifest transformers (InjectMetricsServingCert, ApplyMetricsTLS) wire the Secret and ConfigMap as volumes and inject METRICS_PROMETHEUS_TLS_* env vars so that the knative/pkg prometheus.Server enables mTLS with require client auth.
ServiceMonitor resources are updated with scheme: https, scrapeClass tls-client-certificate-auth, and tlsConfig.serverName. The existing UpdateServiceMonitorTargetNamespace transformer is extended to also patch the namespace segment inside serverName at runtime.
Relates-To: SRVKP-8172
Assisted-by: Claude Sonnet 4.6 (via Cursor)
Changes
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
make test lintbefore submitting a PRSee the contribution guide for more details.
Release Notes