Skip to content

[OSDOCS-20639]: CQA: HCP observability#115277

Open
lahinson wants to merge 1 commit into
openshift:mainfrom
lahinson:osdocs-20639-cqa-hcp-observability
Open

[OSDOCS-20639]: CQA: HCP observability#115277
lahinson wants to merge 1 commit into
openshift:mainfrom
lahinson:osdocs-20639-cqa-hcp-observability

Conversation

@lahinson

@lahinson lahinson commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Version(s): 4.20+

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

Link to docs preview: https://115277--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hcp-observability.html

QE review:
N/A no technical changes

Additional information:

@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 13, 2026
@lahinson lahinson changed the title [OSDOCS-20639]: CQA: HCP observability [OSDOCS-20639]: CQA: HCP observability (1 of 2) Jul 13, 2026

@lahinson lahinson Jul 13, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This content was originally in modules/hosted-control-planes-metrics-sets.adoc. It has not been changed.

@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 13, 2026

Copy link
Copy Markdown

🤖 Mon Jul 13 20:40:57 - Prow CI generated the docs preview:

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

= SRE metrics set example

[role="_abstract"]
When you specify the `SRE` metrics set, the HyperShift Operator looks for a config map named `sre-metric-set` with a single key: `config`. The value of the `config` key must contain a set of `RelabelConfigs` that are organized by control plane component.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ignoring - this usage is a correct reference to the HyperShift Operator

To configure a metrics set, set the `METRICS_SET` environment variable in the HyperShift Operator deployment by entering the following command:
.Procedure

* To configure a metrics set, set the `METRICS_SET` environment variable in the HyperShift Operator deployment by entering the following command:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ignoring - this is an accurate reference to the HyperShift Operator

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This content was originally in modules/hosted-control-planes-monitoring-dashboard.adoc. It has not been changed.

@lahinson lahinson changed the title [OSDOCS-20639]: CQA: HCP observability (1 of 2) [OSDOCS-20639]: CQA: HCP observability Jul 13, 2026
= Dashboard customization

[role="_abstract"]
To generate dashboards for each hosted cluster, the HyperShift Operator uses a template that is stored in the `monitoring-dashboard-template` config map in the Operator namespace (`hypershift`). This template contains a set of Grafana panels that contain the metrics for the dashboard.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

+
The `--monitoring-dashboards --metrics-set=All` flag adds the monitoring dashboard for all metrics.

. Wait a couple of minutes for the HyperShift Operator deployment in the `hypershift` namespace to be updated to include the following environment variable:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@lahinson lahinson force-pushed the osdocs-20639-cqa-hcp-observability branch from 6850efb to 6623493 Compare July 13, 2026 20:33
@openshift-ci

openshift-ci Bot commented Jul 13, 2026

Copy link
Copy Markdown

@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 lahinson added the merge-review-needed Signifies that the merge review team needs to review this PR label Jul 13, 2026
@lahinson lahinson added this to the Continuous Release milestone Jul 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 branch/enterprise-5.0 merge-review-needed Signifies that the merge review team needs to review this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants