[release-4.22] CNTRLPLANE-3526: Add spec.monitoring API for metrics forwarding

[muraee]

Summary

Manual backport of #8626 to release-4.22. The automated cherry-pick failed due to conflicts from the reconciliation loop restructuring on main.

Changes backported:

• Introduces spec.monitoring.metricsForwarding API on HostedCluster and HostedControlPlane, replacing the annotation-based hypershift.openshift.io/enable-metrics-forwarding mechanism
• Adds per-cluster metricsSet field (Telemetry/SRE/All) that overrides the global METRICS_SET env var on the HyperShift Operator
• Updates all consumers (CPO predicates, HCCO, HO SRE config sync) to use the new spec field
• Maintains backward compatibility: the deprecated annotation is honored when the spec field is not set
• Mirrors metrics forwarding spec to annotation for N-1 CPO compatibility

Excluded from backport:

• test/e2e/ changes (not needed for release-4.22)

Conflict resolution:

• hostedcluster_controller.go: Applied monitoring changes to the pre-refactor reconciliation flow (release-4.22 uses the linear flow, not the phase-based report.execute flow from main)
• resources.go: Used util.DeleteAllIfNeeded (release-4.22 import) instead of k8sutil.DeleteAllIfNeeded (main)
• reconcile_legacy.go: Skipped (file doesn't exist in release-4.22)
• hostedcluster_controller_test.go: Applied monitoring test additions manually to match release-4.22 imports and structure

Test plan

• go build ./hypershift-operator/controllers/hostedcluster/... compiles
• go build ./control-plane-operator/... compiles
• TestReconcileMetricsForwarder passes
• TestPredicate (endpoint_resolver) passes
• CI passes

/cc @openshift/hypershift-team

[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]

@muraee: This pull request references CNTRLPLANE-3526 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 story to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Summary

Manual backport of #8626 to release-4.22. The automated cherry-pick failed due to conflicts from the reconciliation loop restructuring on main.

Changes backported:

• Introduces spec.monitoring.metricsForwarding API on HostedCluster and HostedControlPlane, replacing the annotation-based hypershift.openshift.io/enable-metrics-forwarding mechanism
• Adds per-cluster metricsSet field (Telemetry/SRE/All) that overrides the global METRICS_SET env var on the HyperShift Operator
• Updates all consumers (CPO predicates, HCCO, HO SRE config sync) to use the new spec field
• Maintains backward compatibility: the deprecated annotation is honored when the spec field is not set
• Mirrors metrics forwarding spec to annotation for N-1 CPO compatibility

Excluded from backport:

• test/e2e/ changes (not needed for release-4.22)

Conflict resolution:

• hostedcluster_controller.go: Applied monitoring changes to the pre-refactor reconciliation flow (release-4.22 uses the linear flow, not the phase-based report.execute flow from main)
• resources.go: Used util.DeleteAllIfNeeded (release-4.22 import) instead of k8sutil.DeleteAllIfNeeded (main)
• reconcile_legacy.go: Skipped (file doesn't exist in release-4.22)
• hostedcluster_controller_test.go: Applied monitoring test additions manually to match release-4.22 imports and structure

Test plan

• go build ./hypershift-operator/controllers/hostedcluster/... compiles
• go build ./control-plane-operator/... compiles
• TestReconcileMetricsForwarder passes
• TestPredicate (endpoint_resolver) passes
• CI passes

/cc @openshift/hypershift-team

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]

@muraee: GitHub didn't allow me to request PR reviews from the following users: openshift/hypershift-team.

Note that only openshift members and repo collaborators can review this PR, and authors cannot review their own PRs.

Details

In response to this:

Summary

Manual backport of #8626 to release-4.22. The automated cherry-pick failed due to conflicts from the reconciliation loop restructuring on main.

Changes backported:

• Introduces spec.monitoring.metricsForwarding API on HostedCluster and HostedControlPlane, replacing the annotation-based hypershift.openshift.io/enable-metrics-forwarding mechanism
• Adds per-cluster metricsSet field (Telemetry/SRE/All) that overrides the global METRICS_SET env var on the HyperShift Operator
• Updates all consumers (CPO predicates, HCCO, HO SRE config sync) to use the new spec field
• Maintains backward compatibility: the deprecated annotation is honored when the spec field is not set
• Mirrors metrics forwarding spec to annotation for N-1 CPO compatibility

Excluded from backport:

• test/e2e/ changes (not needed for release-4.22)

Conflict resolution:

• hostedcluster_controller.go: Applied monitoring changes to the pre-refactor reconciliation flow (release-4.22 uses the linear flow, not the phase-based report.execute flow from main)
• resources.go: Used util.DeleteAllIfNeeded (release-4.22 import) instead of k8sutil.DeleteAllIfNeeded (main)
• reconcile_legacy.go: Skipped (file doesn't exist in release-4.22)
• hostedcluster_controller_test.go: Applied monitoring test additions manually to match release-4.22 imports and structure

Test plan

• go build ./hypershift-operator/controllers/hostedcluster/... compiles
• go build ./control-plane-operator/... compiles
• TestReconcileMetricsForwarder passes
• TestPredicate (endpoint_resolver) passes
• CI passes

/cc @openshift/hypershift-team

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.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

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

Review profile: CHILL

Plan: Enterprise

Run ID: 804f0f5a-4705-4606-887b-c490499db8ff

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: muraee
Once this PR has been reviewed and has the lgtm label, please assign sjenning 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 [muraee]
• api/OWNERS

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

[openshift-ci]

@muraee: 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.

[codecov]

Codecov Report

❌ Patch coverage is 71.05263% with 11 lines in your changes missing coverage. Please review.
✅ Project coverage is 35.83%. Comparing base (491d5ec) to head (0a76412).

Files with missing lines	Patch %	Lines
...trollers/hostedcluster/hostedcluster_controller.go	70.00%	8 Missing and 1 partial ⚠️
...stedcontrolplane/v2/endpoint_resolver/component.go	66.66%	1 Missing ⚠️
...s/hostedcontrolplane/v2/metrics_proxy/component.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@               Coverage Diff                @@
##           release-4.22    #8872      +/-   ##
================================================
+ Coverage         35.78%   35.83%   +0.05%     
================================================
  Files               774      774              
  Lines             94734    94755      +21     
================================================
+ Hits              33904    33960      +56     
+ Misses            58065    58025      -40     
- Partials           2765     2770       +5     

Files with missing lines	Coverage Δ
.../hostedcontrolplane/v2/metrics_proxy/deployment.go	86.02% <100.00%> (+13.84%)	⬆️
...rconfigoperator/controllers/resources/resources.go	50.76% <100.00%> (+0.27%)	⬆️
...stedcontrolplane/v2/endpoint_resolver/component.go	12.00% <66.66%> (-3.39%)	⬇️
...s/hostedcontrolplane/v2/metrics_proxy/component.go	0.00% <0.00%> (ø)
...trollers/hostedcluster/hostedcluster_controller.go	43.75% <70.00%> (+0.45%)	⬆️

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[muraee]

/lgtm

[openshift-ci]

@muraee: you cannot LGTM your own PR.

Details

In response to this:

/lgtm

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.