redhat-cop / redhat-cop/group-sync-operator

Revisit instructions about metrics configuration?

Open
#311 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
132
Forks
71
PR merge metrics
No merged PRs in 30d

Description

https://github.com/redhat-cop/resource-locker-operator/issues/68#issue-1464664260

The instructions at https://github.com/redhat-cop/group-sync-operator#metrics are problematic for a couple of reasons:

  • Only namespaces of OCP "core" and Red Hat certified components are supposed to be labeled with openshift.io/cluster-monitoring="true" . Anything else should be scraped by the user-defined monitoring stack or a custom deployed Prometheus. The current advice goes against the support conditions, meaning that we could consider the cluster to be unsupported.
  • If a user "forgets" to label the namespace and user-defined monitoring is enabled, the PrometheusOperatorRejectedResources alert will fire because the service monitor uses bearerTokenFile which is forbidden in this case (to avoid users getting access to the service account's token).
  • Managed OpenShift (OSD, ROSA) forbids non-platform namespaces from being labeled with openshift.io/cluster-monitoring="true".

A better solution would be to support user-defined monitoring.

cc @jan--f @coffeegoesincodecomesout @w1dg3r

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the metrics instructions in the group-sync-operator README and review the linked resource-locker-operator issue. Then inspect the ServiceMonitor configuration, focusing on bearerTokenFile and the requirements for user-defined monitoring. Done means the guidance and monitoring configuration support user-defined monitoring without requiring the cluster-monitoring label or triggering PrometheusOperatorRejectedResources.

Written by the indexing model from the issue text.

Assessment

Tech stack
prometheus
Domain
documentation, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.