openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

Merge pull request #93439 from openshift-cherrypick-robot/cherry-pick-93335-to-enterprise-4.19

Browse Source 
[enterprise-4.19] OSDOCS#13953:  Add --metrics-set=All in the HCP monitoring dashboard flag
This commit is contained in:
Servesha Dudhgaonkar
2025-05-15 21:45:01 +05:30
committed by GitHub
parent 3232e493ab 1890d8e06c
commit f516df7dd8
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
modules/hosted-control-planes-monitoring-dashboard.adoc
View File

@@ -6,11 +6,11 @@
[id="hosted-control-planes-monitoring-dashboard_{context}"]
= Enabling monitoring dashboards in a hosted cluster
To enable monitoring dashboards in a hosted cluster, complete the following steps:
You can enable monitoring dashboards in a hosted cluster by creating a config map.
.Procedure
. Create the `hypershift-operator-install-flags` config map in the `local-cluster` namespace, being sure to specify the `--monitoring-dashboards` flag in the `data.installFlagsToAdd` section. For example:
. Create the `hypershift-operator-install-flags` config map in the `local-cluster` namespace. See the following example configuration:
+
[source,yaml]
@@ -21,9 +21,10 @@ metadata:
name: hypershift-operator-install-flags
namespace: local-cluster
data:
installFlagsToAdd: "--monitoring-dashboards"
installFlagsToAdd: "--monitoring-dashboards --metrics-set=All" <1>
installFlagsToRemove: ""
----
<1> 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:
@@ -39,9 +40,9 @@ When monitoring dashboards are enabled, for each hosted cluster that the HyperSh
. To view the dashboard, log in to the management cluster's console and go to the dashboard for the hosted cluster by clicking *Observe -> Dashboards*.
. Optional: To disable a monitoring dashboards in a hosted cluster, remove the `--monitoring-dashboards` flag from the `hypershift-operator-install-flags` config map. When you delete a hosted cluster, its corresponding dashboard is also deleted.
. Optional: To disable monitoring dashboards in a hosted cluster, remove the `--monitoring-dashboards --metrics-set=All` flag from the `hypershift-operator-install-flags` config map. When you delete a hosted cluster, its corresponding dashboard is also deleted.
[#hosted-control-planes-customize-dashboards]
[id="hosted-control-planes-customize-dashboards_{context}"]
== Dashboard customization
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. You can edit the content of the config map to customize the dashboards.