[OSDOCS-22109]: HCP per-cluster metrics forwarding by lahinson · Pull Request #119848 · openshift/openshift-docs

lahinson · 2026-09-15T18:28:41Z

Version(s): 5.0+ (will be released after OCP 5.0 GA because HCP is an async release)

Issue: https://redhat.atlassian.net/browse/OSDOCS-22109

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

ocpdocs-previewbot · 2026-09-15T18:47:01Z

🤖 Wed Sep 16 18:44:27 - Prow CI generated the docs preview:

https://119848--ocpdocs-pr.netlify.app/
https://119848--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-observability.html
https://119848--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-release-notes.html

ocpdocs-vale-bot · 2026-09-15T18:49:28Z

+. Determine the metrics set value to use for each cluster.
+
+The annotation enables forwarding but does not specify a metrics set.
+The HyperShift Operator uses the global `METRICS_SET` environment variable as the source.


🤖 [error] RedHat.TermsErrors: Use 'hosted control planes' rather than 'HyperShift'. For more information, see RedHat.TermsErrors.

Ignoring. "HyperShift Operator" is a valid usage of "HyperShift".

ocpdocs-vale-bot · 2026-09-15T18:49:30Z

+  -o jsonpath='{.spec.template.spec.containers[?(@.name=="operator")].env[?(@.name=="METRICS_SET")].value}'
+----
+
+`hypershift` is the namespace where the HyperShift Operator is typically installed,


🤖 [error] RedHat.TermsErrors: Use 'hosted control planes' rather than 'HyperShift'. For more information, see RedHat.TermsErrors.

Ignoring. "HyperShift Operator" is a valid usage of "HyperShift".

ocpdocs-vale-bot · 2026-09-15T18:49:33Z

+You can enable and configure control plane metrics forwarding independently for each hosted cluster
+by setting the `spec.monitoring.metricsForwarding` field on the `HostedCluster` object.
+This lets you select different metrics sets for different hosted clusters on the same management cluster
+without changing the global HyperShift Operator configuration.


🤖 [error] RedHat.TermsErrors: Use 'hosted control planes' rather than 'HyperShift'. For more information, see RedHat.TermsErrors.

Ignoring. "HyperShift Operator" is a valid usage of "HyperShift".

ocpdocs-vale-bot · 2026-09-15T18:49:35Z

+Replace `<hosted_cluster_namespace>` with the namespace of the hosted cluster
+and `<hosted_cluster_name>` with the name of the hosted cluster.
+
+When you set `mode: Forward`, the HyperShift Operator deploys the `metrics-proxy` and


🤖 [error] RedHat.TermsErrors: Use 'hosted control planes' rather than 'HyperShift'. For more information, see RedHat.TermsErrors.

Ignoring. "HyperShift Operator" is a valid usage of "HyperShift".

ocpdocs-vale-bot · 2026-09-15T18:49:37Z

+. Optional: Set the metrics set for this hosted cluster.
+
+If you omit this step, the cluster inherits the global `METRICS_SET` environment variable
+from the HyperShift Operator deployment, which defaults to `Telemetry`.


🤖 [error] RedHat.TermsErrors: Use 'hosted control planes' rather than 'HyperShift'. For more information, see RedHat.TermsErrors.

Ignoring. "HyperShift Operator" is a valid usage of "HyperShift".

ocpdocs-vale-bot · 2026-09-16T14:49:52Z

+
+. `spec.monitoring.metricsForwarding.metricsSet` on the `HostedCluster` object
+. `spec.monitoring.metricsSet` on the `HostedCluster` object
+. Global `METRICS_SET` environment variable on the HyperShift Operator deployment (defaults to `Telemetry` if not set)


🤖 [error] RedHat.TermsErrors: Use 'hosted control planes' rather than 'HyperShift'. For more information, see RedHat.TermsErrors.

Ignoring. "HyperShift Operator" is a valid use of "HyperShift".

ocpdocs-vale-bot · 2026-09-16T14:49:58Z

+= Configuring per-cluster control plane metrics forwarding
+
+[role="_abstract"]
+You can enable and configure control plane metrics forwarding independently for each hosted cluster by setting the `spec.monitoring.metricsForwarding` field on the `HostedCluster` object. As a result, you can select different metrics sets for different hosted clusters on the same management cluster without changing the global HyperShift Operator configuration.


🤖 [error] RedHat.TermsErrors: Use 'hosted control planes' rather than 'HyperShift'. For more information, see RedHat.TermsErrors.

Ignoring. "HyperShift Operator" is a valid use of "HyperShift".

ocpdocs-vale-bot · 2026-09-16T14:50:01Z

+
+[NOTE]
+====
+If the deprecated `hypershift.openshift.io/enable-metrics-forwarding` annotation is also set on the `HostedCluster` object, the `spec.monitoring.metricsForwarding` field takes precedence. For information about the deprecated annotation and migrating to the new API, see "Deprecated annotation: hypershift.openshift.io/enable-metrics-forwarding".


🤖 [error] RedHat.TermsErrors: Use 'hosted control planes' rather than 'hypershift'. For more information, see RedHat.TermsErrors.

Ignoring. This usage is a valid usage of "hypershift".

ocpdocs-vale-bot · 2026-09-16T16:33:29Z

+
+The annotation continues to be honored when `spec.monitoring` is not set on the `HostedCluster` object. If you set `spec.monitoring.metricsForwarding` on a cluster, the spec field takes precedence and the annotation is ignored for that cluster, even if both are present.
+
+Migrate all hosted clusters that use the `hypershift.openshift.io/enable-metrics-forwarding` annotation to use `spec.monitoring.metricsForwarding` before the annotation is removed in a future release. For more information, see xref:../hosted_control_planes/hcp-observability.adoc#hcp-cp-metrics-forwarding-migrate_hcp-observability[Migrating from annotation-based to API-based metrics forwarding].


🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).

ocpdocs-vale-bot · 2026-09-16T18:46:18Z

+  -o jsonpath='{.spec.template.spec.containers[?(@.name=="operator")].env[?(@.name=="METRICS_SET")].value}'
+----
+
+In the command, `hypershift` is the namespace where the HyperShift Operator is typically installed, and `operator` is the standard deployment name. These values might differ in non-standard installations.


🤖 [error] RedHat.TermsErrors: Use 'hosted control planes' rather than 'HyperShift'. For more information, see RedHat.TermsErrors.

openshift-ci · 2026-09-16T18:46:38Z

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

lahinson added this to the Continuous Release milestone Sep 15, 2026

lahinson added the branch/enterprise-5.0 label Sep 15, 2026

openshift-ci Bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Sep 15, 2026