Skip to content

Commit 1391373

Browse files
committed
OSDOCS-12564: Adds all of the Observability book to HCP
1 parent 34f661d commit 1391373

10 files changed

+149
-114
lines changed

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1238,6 +1238,37 @@ Name: Observability
12381238
Dir: observability
12391239
Distros: openshift-rosa-hcp
12401240
Topics:
1241+
- Name: Observability overview
1242+
Dir: overview
1243+
Topics:
1244+
- Name: About Observability
1245+
File: index
1246+
- Name: Monitoring
1247+
Dir: monitoring
1248+
Distros: openshift-rosa-hcp
1249+
Topics:
1250+
- Name: Monitoring overview
1251+
File: monitoring-overview
1252+
- Name: Accessing monitoring for user-defined projects
1253+
File: sd-accessing-monitoring-for-user-defined-projects
1254+
- Name: Configuring the monitoring stack
1255+
File: configuring-the-monitoring-stack
1256+
- Name: Disabling monitoring for user-defined projects
1257+
File: sd-disabling-monitoring-for-user-defined-projects
1258+
- Name: Enabling alert routing for user-defined projects
1259+
File: enabling-alert-routing-for-user-defined-projects
1260+
- Name: Managing metrics
1261+
File: managing-metrics
1262+
- Name: Managing alerts
1263+
File: managing-alerts
1264+
- Name: Reviewing monitoring dashboards
1265+
File: reviewing-monitoring-dashboards
1266+
- Name: Accessing third-party monitoring APIs
1267+
File: accessing-third-party-monitoring-apis
1268+
- Name: Troubleshooting monitoring issues
1269+
File: troubleshooting-monitoring-issues
1270+
- Name: Config map reference for the Cluster Monitoring Operator
1271+
File: config-map-reference-for-the-cluster-monitoring-operator
12411272
- Name: Logging
12421273
Dir: logging
12431274
Distros: openshift-rosa-hcp

observability/monitoring/accessing-third-party-monitoring-apis.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ include::modules/monitoring-resources-reference-for-the-cluster-monitoring-opera
4040
[id="additional-resources_{context}"]
4141
== Additional resources
4242

43-
ifndef::openshift-dedicated,openshift-rosa[]
43+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4444
* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects-uwm_enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
45-
endif::openshift-dedicated,openshift-rosa[]
45+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4646
* xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-remote-write-storage_configuring-the-monitoring-stack[Configuring remote write storage]
4747
* xref:../../observability/monitoring/managing-metrics.adoc#managing-metrics[Managing metrics]
4848
* xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]

observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ toc::[]
1818
Parts of {product-title} cluster monitoring are configurable.
1919
The API is accessible by setting parameters defined in various config maps.
2020

21-
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
21+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2222
* To configure monitoring components, edit the `ConfigMap` object named `cluster-monitoring-config` in the `openshift-monitoring` namespace.
2323
These configurations are defined by link:#clustermonitoringconfiguration[ClusterMonitoringConfiguration].
24-
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
24+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2525

2626
* To configure monitoring components that monitor user-defined projects, edit the `ConfigMap` object named `user-workload-monitoring-config` in the `openshift-user-workload-monitoring` namespace.
2727
These configurations are defined by link:#userworkloadconfiguration[UserWorkloadConfiguration].
@@ -33,12 +33,12 @@ The configuration file is always defined under the `config.yaml` key in the conf
3333
* Not all configuration parameters for the monitoring stack are exposed.
3434
Only the parameters and fields listed in this reference are supported for configuration.
3535
For more information about supported configurations, see
36-
ifndef::openshift-dedicated,openshift-rosa[]
36+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3737
* xref:../../observability/monitoring/getting-started/maintenance-and-support-for-monitoring.adoc#maintenance-and-support-for-monitoring[Maintenance and support for monitoring]
38-
endif::openshift-dedicated,openshift-rosa[]
39-
ifdef::openshift-dedicated,openshift-rosa[]
38+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
39+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4040
xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#maintenance-and-support_configuring-the-monitoring-stack[Maintenance and support for monitoring].
41-
endif::openshift-dedicated,openshift-rosa[]
41+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4242
4343
* Configuring cluster monitoring is optional.
4444
* If a configuration does not exist or is empty, default values are used.

0 commit comments

Comments
 (0)