Enable ServiceMonitor to use cert-manager-managed serving-cert with TLS verification

Adds a patch to configure ServiceMonitor with  to ensure TLS verification using cert-manager certificates. Updates documentation and corrects misaligned comments.

Author: camilamacedo86

docs/book/src/cronjob-tutorial/testdata/project/cmd/main.go

@@ -123,16 +123,17 @@ func main() {
 	metricsServerOptions := metricsserver.Options{
 		BindAddress:   metricsAddr,
 		SecureServing: secureMetrics,
-		// TODO(user): TLSOpts is used to allow configuring the TLS config used for the server. If certificates are
-		// not provided, self-signed certificates will be generated by default. This option is not recommended for
-		// production environments as self-signed certificates do not offer the same level of trust and security
-		// as certificates issued by a trusted Certificate Authority (CA). The primary risk is potentially allowing
-		// unauthorized access to sensitive metrics data. Consider replacing with CertDir, CertName, and KeyName
-		// to provide certificates, ensuring the server communicates using trusted and secure certificates.
-		TLSOpts: tlsOpts,
+		TLSOpts:       tlsOpts,
 	}
 
 	if secureMetrics {
+		// TODO(user): If cert-manager is enabled under config/default/kustomizaton.yaml, you can uncomment the following
+		// lines to use the certificate managed by cert-manager, mounted as a Kubernetes secret named 'serving-cert'.
+		// This setup is recommended for production environments to ensure trusted and secure communication.
+		// metricsServerOptions.CertDir = "/var/run/secrets/kubernetes.io/certs"
+		// metricsServerOptions.CertName = "tls.crt"
+		// metricsServerOptions.KeyName = "tls.key"
+
 		// FilterProvider is used to protect the metrics endpoint with authn/authz.
 		// These configurations ensure that only authorized users and service accounts
 		// can access the metrics endpoint. The RBAC are configured in 'config/rbac/kustomization.yaml'. More info:

docs/book/src/cronjob-tutorial/testdata/project/config/default/kustomization.yaml

@@ -41,8 +41,15 @@ patches:
   target:
     kind: Deployment
 
+# [CERTMANAGER] The following patch configures the ServiceMonitor under ../prometheus
+# to securely reference certificates created and managed by cert-manager. Also, uncomment the 
+# [WEBHOOK] patch bellow to mount the "serving-cert" in the Manager Deployment.
+#- path: ../prometheus/monitor_tls_patch.yaml
+#target:
+#  kind: ServiceMonitor
+
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
-# crd/kustomization.yaml
+# crd/kustomization.yaml.
 - path: manager_webhook_patch.yaml
 
 # [CERTMANAGER] To enable cert-manager, uncomment all sections with 'CERTMANAGER' prefix.

docs/book/src/cronjob-tutorial/testdata/project/config/prometheus/monitor.yaml

@@ -16,14 +16,10 @@ spec:
       bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
       tlsConfig:
         # TODO(user): The option insecureSkipVerify: true is not recommended for production since it disables
-        # certificate verification. This poses a significant security risk by making the system vulnerable to
-        # man-in-the-middle attacks, where an attacker could intercept and manipulate the communication between
-        # Prometheus and the monitored services. This could lead to unauthorized access to sensitive metrics data,
-        # compromising the integrity and confidentiality of the information.
-        # Please use the following options for secure configurations:
-        # caFile: /etc/metrics-certs/ca.crt
-        # certFile: /etc/metrics-certs/tls.crt
-        # keyFile: /etc/metrics-certs/tls.key
+        # certificate verification, exposing the system to potential man-in-the-middle attacks.
+        # For production environments, it is recommended to use cert-manager for automatic TLS certificate management.
+        # To apply this configuration, enable cert-manager and use the patch located at config/prometheus/servicemonitor_tls_patch.yaml,
+        # which securely references the certificate from the 'serving-cert' secret.
         insecureSkipVerify: true
   selector:
     matchLabels:

docs/book/src/cronjob-tutorial/testdata/project/config/prometheus/monitor_tls_patch.yaml

@@ -0,0 +1,22 @@
+# Patch for Prometheus ServiceMonitor to enable secure TLS configuration
+# using certificates managed by cert-manager
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: controller-manager-metrics-monitor
+  namespace: system
+spec:
+  endpoints:
+    - tlsConfig:
+        insecureSkipVerify: false
+        ca:
+          secret:
+            name: serving-cert
+            key: ca.crt
+        cert:
+          secret:
+            name: serving-cert
+            key: tls.crt
+        keySecret:
+          name: serving-cert
+          key: tls.key

docs/book/src/getting-started/testdata/project/cmd/main.go

@@ -103,16 +103,17 @@ func main() {
 	metricsServerOptions := metricsserver.Options{
 		BindAddress:   metricsAddr,
 		SecureServing: secureMetrics,
-		// TODO(user): TLSOpts is used to allow configuring the TLS config used for the server. If certificates are
-		// not provided, self-signed certificates will be generated by default. This option is not recommended for
-		// production environments as self-signed certificates do not offer the same level of trust and security
-		// as certificates issued by a trusted Certificate Authority (CA). The primary risk is potentially allowing
-		// unauthorized access to sensitive metrics data. Consider replacing with CertDir, CertName, and KeyName
-		// to provide certificates, ensuring the server communicates using trusted and secure certificates.
-		TLSOpts: tlsOpts,
+		TLSOpts:       tlsOpts,
 	}
 
 	if secureMetrics {
+		// TODO(user): If cert-manager is enabled under config/default/kustomizaton.yaml, you can uncomment the following
+		// lines to use the certificate managed by cert-manager, mounted as a Kubernetes secret named 'serving-cert'.
+		// This setup is recommended for production environments to ensure trusted and secure communication.
+		// metricsServerOptions.CertDir = "/var/run/secrets/kubernetes.io/certs"
+		// metricsServerOptions.CertName = "tls.crt"
+		// metricsServerOptions.KeyName = "tls.key"
+
 		// FilterProvider is used to protect the metrics endpoint with authn/authz.
 		// These configurations ensure that only authorized users and service accounts
 		// can access the metrics endpoint. The RBAC are configured in 'config/rbac/kustomization.yaml'. More info:

docs/book/src/getting-started/testdata/project/config/default/kustomization.yaml

@@ -41,8 +41,15 @@ patches:
   target:
     kind: Deployment
 
+# [CERTMANAGER] The following patch configures the ServiceMonitor under ../prometheus
+# to securely reference certificates created and managed by cert-manager. Also, uncomment the 
+# [WEBHOOK] patch bellow to mount the "serving-cert" in the Manager Deployment.
+#- path: ../prometheus/monitor_tls_patch.yaml
+#target:
+#  kind: ServiceMonitor
+
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
-# crd/kustomization.yaml
+# crd/kustomization.yaml.
 #- path: manager_webhook_patch.yaml
 
 # [CERTMANAGER] To enable cert-manager, uncomment all sections with 'CERTMANAGER' prefix.

docs/book/src/getting-started/testdata/project/config/prometheus/monitor.yaml

@@ -16,14 +16,10 @@ spec:
       bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
       tlsConfig:
         # TODO(user): The option insecureSkipVerify: true is not recommended for production since it disables
-        # certificate verification. This poses a significant security risk by making the system vulnerable to
-        # man-in-the-middle attacks, where an attacker could intercept and manipulate the communication between
-        # Prometheus and the monitored services. This could lead to unauthorized access to sensitive metrics data,
-        # compromising the integrity and confidentiality of the information.
-        # Please use the following options for secure configurations:
-        # caFile: /etc/metrics-certs/ca.crt
-        # certFile: /etc/metrics-certs/tls.crt
-        # keyFile: /etc/metrics-certs/tls.key
+        # certificate verification, exposing the system to potential man-in-the-middle attacks.
+        # For production environments, it is recommended to use cert-manager for automatic TLS certificate management.
+        # To apply this configuration, enable cert-manager and use the patch located at config/prometheus/servicemonitor_tls_patch.yaml,
+        # which securely references the certificate from the 'serving-cert' secret.
         insecureSkipVerify: true
   selector:
     matchLabels:

docs/book/src/getting-started/testdata/project/config/prometheus/monitor_tls_patch.yaml

@@ -0,0 +1,22 @@
+# Patch for Prometheus ServiceMonitor to enable secure TLS configuration
+# using certificates managed by cert-manager
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: controller-manager-metrics-monitor
+  namespace: system
+spec:
+  endpoints:
+    - tlsConfig:
+        insecureSkipVerify: false
+        ca:
+          secret:
+            name: serving-cert
+            key: ca.crt
+        cert:
+          secret:
+            name: serving-cert
+            key: tls.crt
+        keySecret:
+          name: serving-cert
+          key: tls.key

docs/book/src/multiversion-tutorial/testdata/project/cmd/main.go

@@ -122,16 +122,17 @@ func main() {
 	metricsServerOptions := metricsserver.Options{
 		BindAddress:   metricsAddr,
 		SecureServing: secureMetrics,
-		// TODO(user): TLSOpts is used to allow configuring the TLS config used for the server. If certificates are
-		// not provided, self-signed certificates will be generated by default. This option is not recommended for
-		// production environments as self-signed certificates do not offer the same level of trust and security
-		// as certificates issued by a trusted Certificate Authority (CA). The primary risk is potentially allowing
-		// unauthorized access to sensitive metrics data. Consider replacing with CertDir, CertName, and KeyName
-		// to provide certificates, ensuring the server communicates using trusted and secure certificates.
-		TLSOpts: tlsOpts,
+		TLSOpts:       tlsOpts,
 	}
 
 	if secureMetrics {
+		// TODO(user): If cert-manager is enabled under config/default/kustomizaton.yaml, you can uncomment the following
+		// lines to use the certificate managed by cert-manager, mounted as a Kubernetes secret named 'serving-cert'.
+		// This setup is recommended for production environments to ensure trusted and secure communication.
+		// metricsServerOptions.CertDir = "/var/run/secrets/kubernetes.io/certs"
+		// metricsServerOptions.CertName = "tls.crt"
+		// metricsServerOptions.KeyName = "tls.key"
+
 		// FilterProvider is used to protect the metrics endpoint with authn/authz.
 		// These configurations ensure that only authorized users and service accounts
 		// can access the metrics endpoint. The RBAC are configured in 'config/rbac/kustomization.yaml'. More info:

docs/book/src/multiversion-tutorial/testdata/project/config/default/kustomization.yaml

@@ -41,8 +41,15 @@ patches:
   target:
     kind: Deployment
 
+# [CERTMANAGER] The following patch configures the ServiceMonitor under ../prometheus
+# to securely reference certificates created and managed by cert-manager. Also, uncomment the 
+# [WEBHOOK] patch bellow to mount the "serving-cert" in the Manager Deployment.
+#- path: ../prometheus/monitor_tls_patch.yaml
+#target:
+#  kind: ServiceMonitor
+
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
-# crd/kustomization.yaml
+# crd/kustomization.yaml.
 - path: manager_webhook_patch.yaml
 
 # [CERTMANAGER] To enable cert-manager, uncomment all sections with 'CERTMANAGER' prefix.