Skip to content

Commit f516df7

Browse files
authored
Merge pull request #93439 from openshift-cherrypick-robot/cherry-pick-93335-to-enterprise-4.19
[enterprise-4.19] OSDOCS#13953: Add --metrics-set=All in the HCP monitoring dashboard flag
2 parents 3232e49 + 1890d8e commit f516df7

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

modules/hosted-control-planes-monitoring-dashboard.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
[id="hosted-control-planes-monitoring-dashboard_{context}"]
77
= Enabling monitoring dashboards in a hosted cluster
88

9-
To enable monitoring dashboards in a hosted cluster, complete the following steps:
9+
You can enable monitoring dashboards in a hosted cluster by creating a config map.
1010

1111
.Procedure
1212

13-
. 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:
13+
. Create the `hypershift-operator-install-flags` config map in the `local-cluster` namespace. See the following example configuration:
1414

1515
+
1616
[source,yaml]
@@ -21,9 +21,10 @@ metadata:
2121
name: hypershift-operator-install-flags
2222
namespace: local-cluster
2323
data:
24-
installFlagsToAdd: "--monitoring-dashboards"
24+
installFlagsToAdd: "--monitoring-dashboards --metrics-set=All" <1>
2525
installFlagsToRemove: ""
2626
----
27+
<1> The `--monitoring-dashboards --metrics-set=All` flag adds the monitoring dashboard for all metrics.
2728

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

@@ -39,9 +40,9 @@ When monitoring dashboards are enabled, for each hosted cluster that the HyperSh
3940

4041
. 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*.
4142

42-
. 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.
43+
. 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.
4344

44-
[#hosted-control-planes-customize-dashboards]
45+
[id="hosted-control-planes-customize-dashboards_{context}"]
4546
== Dashboard customization
4647

4748
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.

0 commit comments

Comments
 (0)