[release-4.18] Enable NROP metrics to be to scraped securely by Prometheus #1140
Conversation
This file contains 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
rbaturov
changed the title
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ffromani, rbaturov The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
|
needs rebase |
Signed-off-by: Ronny Baturov <[email protected]>
This commit consist of the following changes: * Enabled secureserving in the metrics server. * Added a Service for the deployment with a special annotation, which is monitored by the Service CA operator. This operator will generate the tls.key and tls.crt files inside the metrics-service-cert secret, which is used by manager container. * Added volume and volumeMount to enable the deployment to consume the metrics secret generated with the tls.key and tls.crt. * Added Role and RoleBinding resources to grant the necessary permissions to the Prometheus service account. * modified ServiceMonitor resource to enable Prometheus pods to scrape metrics. Most of this configuration was based on this guide: https://rhobs-handbook.netlify.app/products/openshiftmonitoring/collecting_metrics.md/ Signed-off-by: Ronny Baturov <[email protected]>
* Added the openshift.io/cluster-monitoring: "true" label to the NROP namespace. This label is required to enable Prometheus to scrape metrics from the namespace. * Added the annotation operatorframework.io/cluster-monitoring=true. This will cause the OpenShift console to display a checkbox during installation, allowing users to enable cluster monitoring for the operator. Signed-off-by: Ronny Baturov <[email protected]>
Signed-off-by: Ronny Baturov <[email protected]>
* Added a Role and RoleBinding for the manager pod, allowing the operator to manage Services exclusively within the NROP namespace. * Removed the Service-related RBAC permissions previously granted in the ClusterRole. Signed-off-by: Ronny Baturov <[email protected]>
This ensures the informer can successfully watch and list Service objects. Without this restriction, the operator will encounter the following failures: reflector.go:561] sigs.k8s.io/controller-runtime/pkg/cache/internal/informers.go:106: failed to list *v1.Service: services is forbidden: User "system:serviceaccount:numaresources:numaresources-controller-manager" cannot list resource "services" in API group "" at the cluster scope reflector.go:158] "Unhandled Error" err="sigs.k8s.io/controller-runtime/pkg/cache/internal/informers.go:106: Failed to watch *v1.Service: failed to list *v1.Service: services is forbidden: User \"system:serviceaccount:numaresources:numaresources-controller-manager\" cannot list resource \"services\" in API group \"\" at the cluster scope" logger="UnhandledError" Signed-off-by: Ronny Baturov <[email protected]>
rbaturov
force-pushed
the
enable-secure-metrics-4.18
branch
from
e990e3b to
1904cfc
Compare
openshift-merge-bot
bot
merged commit 93834c9
into
openshift-kni:release-4.18
15 checks passed
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.
This PR is a combined backport of #1106 and #1133.
This PR encompasses all the required changes to reintegrate NROP metrics with Prometheus. This implementation uses the metrics server API from the controller-runtime.
The majority of the changes in this PR follow the guidelines outlined in the following guide:
https://rhobs-handbook.netlify.app/products/openshiftmonitoring/collecting_metrics.md/
The difference between this implementation and the guide's is that we use a
bearerTokenFilefor Prometheus authentication instead of tls.crt and tls.key. This approach uses TLS but does not implement mTLS.A follow-up PR will be issued to ensure we implement this for RTE metrics as well.
To validate that this PR is functioning correctly, please follow these steps:
make docker-build docker-push)make deployoc exec -it prometheus-k8s-0 -n openshift-monitoring /bin/bash