MON-4569: Add ResourceStateMetrics feature-gate

[rexagod]

Enables Resource State Metrics in TP only. This feature-gate will be used in cluster-monitoring-operator to deploy this component in TP clusters as opposed to the current OpenShift State Metrics component.

[openshift-merge-bot]

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

[openshift-ci-robot]

@rexagod: This pull request references MON-4569 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Enables Resource State Metrics in TP only. This feature-gate will be used in cluster-monitoring-operator to deploy this component in TP clusters as opposed to the current OpenShift State Metrics component.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

Hello @rexagod! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: ee9f2ad9-3e54-4601-b82e-8d76f82370f4

📥 Commits

Reviewing files that changed from the base of the PR and between 4b19930 and 32224cb.

📒 Files selected for processing (10)

• features.md
• features/features.go
• payload-manifests/featuregates/featureGate-4-10-Hypershift-Default.yaml
• payload-manifests/featuregates/featureGate-4-10-Hypershift-DevPreviewNoUpgrade.yaml
• payload-manifests/featuregates/featureGate-4-10-Hypershift-OKD.yaml
• payload-manifests/featuregates/featureGate-4-10-Hypershift-TechPreviewNoUpgrade.yaml
• payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-Default.yaml
• payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-DevPreviewNoUpgrade.yaml
• payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-OKD.yaml
• payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-TechPreviewNoUpgrade.yaml

💤 Files with no reviewable changes (8)

• payload-manifests/featuregates/featureGate-4-10-Hypershift-TechPreviewNoUpgrade.yaml
• payload-manifests/featuregates/featureGate-4-10-Hypershift-OKD.yaml
• payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-OKD.yaml
• payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-Default.yaml
• payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-TechPreviewNoUpgrade.yaml
• payload-manifests/featuregates/featureGate-4-10-Hypershift-DevPreviewNoUpgrade.yaml
• payload-manifests/featuregates/featureGate-4-10-Hypershift-Default.yaml
• payload-manifests/featuregates/featureGate-4-10-SelfManagedHA-DevPreviewNoUpgrade.yaml

✅ Files skipped from review due to trivial changes (1)

• features.md

🚧 Files skipped from review as they are similar to previous changes (1)

• features/features.go

---

📝 Walkthrough

Walkthrough

This pull request introduces a new feature gate named ResourceStateMetrics. The gate is registered in features/features.go with kubernetes scope and enabled for inTechPreviewNoUpgrade() and inDevPreviewNoUpgrade(). features.md is updated to show ResourceStateMetrics as enabled. Payload FeatureGate YAMLs are updated to add ResourceStateMetrics to enabled lists for Dev/Tech preview variants and to disabled lists for Default and OKD variants across Hypershift and SelfManagedHA.

🚥 Pre-merge checks | ✅ 15

✅ Passed checks (15 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately identifies the primary change: adding a new ResourceStateMetrics feature gate, which is confirmed across all modified files.
Description check	✅ Passed	The description is directly related to the changeset, explaining that this feature gate enables Resource State Metrics in TP only for use by cluster-monitoring-operator.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names	✅ Passed	The PR does not modify any Ginkgo test files. Changes are limited to: features.md (documentation), features/features.go (feature gate declaration), and 8 YAML manifest files. No test code with dyna...
Test Structure And Quality	✅ Passed	The test (okd_featureset_parity_test.go) uses standard Go testing, not Ginkgo. It has single responsibility, excellent error messages with context (ClusterProfile, count, list of missing gates), no...
Microshift Test Compatibility	✅ Passed	PR adds no Ginkgo e2e tests—only feature gate registration code and YAML configurations. Check for test compatibility is not applicable.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	No Ginkgo e2e tests are added in this PR. Changes are limited to feature gate documentation (features.md), Go feature gate definitions (features/features.go), and YAML manifest configurations. Chec...
Topology-Aware Scheduling Compatibility	✅ Passed	This PR only adds a feature gate declaration (ResourceStateMetrics) in the openshift/api repository. No deployment manifests, operator code, or controllers with scheduling constraints are introduce...
Ote Binary Stdout Contract	✅ Passed	This PR only modifies feature gate library code (features/features.go), documentation (features.md), and YAML manifests. None are OTE test binaries with process-level code that could violate the st...
Ipv6 And Disconnected Network Test Compatibility	✅ Passed	No Ginkgo e2e tests were added in this PR. Changes are limited to feature gate documentation, Go feature gate registration, and YAML manifest configuration files. Check is not applicable.
No-Weak-Crypto	✅ Passed	PR adds ResourceStateMetrics feature gate only—no cryptographic code, imports, or weak crypto patterns (MD5, SHA1, DES, RC4, 3DES, Blowfish, ECB) detected in changes.
Container-Privileges	✅ Passed	No container manifests with privileged settings found. All changes are FeatureGate resource definitions, Go code, and documentation—not container specifications.
No-Sensitive-Data-In-Logs	✅ Passed	No logging code is present in this PR; all changes are declarative feature gate configurations, YAML manifests, and documentation. No sensitive data exposure risk exists.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.12.2)

Error: build linters: unable to load custom analyzer "kubeapilinter": tools/_output/bin/kube-api-linter.so, plugin: not implemented
The command is terminated due to an error: build linters: unable to load custom analyzer "kubeapilinter": tools/_output/bin/kube-api-linter.so, plugin: not implemented

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign joelspeed for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[rexagod]

/test verify-client-go

[JoelSpeed]

@rexagod What is the upstream status of this feature gate?

How much downstream work is there for this?

Which upstream components change behaviour when this gate is enabled?

[rexagod]

@JoelSpeed Thank you for the review!

What is the upstream status of this feature gate?

This is pending BETA graduation: kubernetes/enhancements#4785.

How much downstream work is there for this?

The currently-estimated work is tracked in MON-4568. The overall expectations regarding downstream maintenance and onboarding are almost same as other CMO dependency mirror, for e.g., MON-3153.

Which upstream components change behaviour when this gate is enabled?

None. RSM is a metrics exporter, and doesn't influence behaviors for any other components directly. The repository lives upstream as a sub-project under kubernetes-sigs, and relies on the APIServer and etcd for expected needs.

Please note that we aim to replace OSM in CMO with this in the near-future.

[openshift-ci]

@rexagod: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[rexagod]

Friendly ping, @JoelSpeed @everettraven 🙇🏼

[JoelSpeed]

@rexagod It looks to me like you intending to implement openshift specific code behind this feature gate? This has historically been an issue as it means you tie the upstream and downstream promotions together, blocking rebases of o/k.

Do we actually need to control/have an opinion on the upstream feature or do we just need to add some stuff downstream and gate that?

Are you trying to move an upstream off-by-default feature to on-by-default in TPNU OCP?

[rexagod]

It looks to me like you intending to implement openshift specific code behind this feature gate?

Correct. We'll use this feature-gate to surface RSM in the cluster-monitoring-operator.

This has historically been an issue as it means you tie the upstream and downstream promotions together, blocking rebases of o/k.

Not sure I grasp this fully. Downstream fork of RSM will have its own release cadence, even if the upstream counterpart surpasses it. An OCP version can ship with a non-latest release of RSM, as we've seen with other CMO dependencies that originate upstream. The mechanism followed will be exactly the same as we've seen for all CMO dependencies, and between their upstream sources and downstream forks. Here's one such dependency repository for reference: https://github.com/openshift/kube-state-metrics.

Do we actually need to control/have an opinion on the upstream feature or do we just need to add some stuff downstream and gate that?

We actually already have the former, as I am a SIG Instrumentation co-chair and currently overseeing that all stakeholder concerns, for upstream as well as downstream, are addressed before this goes GA. I also believe I'm the only person that will maintain this for the foreseeable near-future. Having said that, in the scope of this gate, the latter's true as well, since we'll allow this component to be configured through CMO.

Are you trying to move an upstream off-by-default feature to on-by-default in TPNU OCP?

Please note that this does not reflect a k/k in-tree feature. This is a sub-project upstream that's only deployed if the users do so explicitly, however, OCP will indeed have an option through CMO to facilitate this OOTB, just like kubernetes/kube-state-metrics, for instance.

[rexagod]

FYI RSM's downstream fork lives in https://github.com/openshift/kubernetes-sigs-resource-state-metrics

[JoelSpeed]

Please note that this does not reflect a k/k in-tree feature. This is a sub-project upstream that's only deployed if the users do so explicitly, however, OCP will indeed have an option through CMO to facilitate this OOTB, just like kubernetes/kube-state-metrics, for instance.

This is where my confusion lies.

The productScope you set is kubernetes rather than openshift.

The kubernetes scope is for k/k in-tree features. Everything else should be openshift. Which then also means you need an openshift enhancement to explain what you are doing, how you are planning to deploy this, and how you are going to test this before you promote it to GA within openshift