Skip to content

Commit ebb8b84

Browse files
authored
Merge pull request #89062 from eromanova97/manual-cp-88454-to-4.15
[enterprise-4.15] Monitoring docs restructure integration
2 parents 07fbddc + 50cf29b commit ebb8b84

File tree

162 files changed

+2860
-1585
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+2860
-1585
lines changed

_topic_maps/_topic_map.yml

Lines changed: 61 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2725,24 +2725,68 @@ Topics:
27252725
Dir: monitoring
27262726
Distros: openshift-enterprise,openshift-origin
27272727
Topics:
2728-
- Name: Monitoring overview
2729-
File: monitoring-overview
2730-
- Name: Common monitoring configuration scenarios
2731-
File: common-monitoring-configuration-scenarios
2732-
- Name: Configuring the monitoring stack
2733-
File: configuring-the-monitoring-stack
2734-
- Name: Enabling monitoring for user-defined projects
2735-
File: enabling-monitoring-for-user-defined-projects
2736-
- Name: Enabling alert routing for user-defined projects
2737-
File: enabling-alert-routing-for-user-defined-projects
2738-
- Name: Managing metrics
2739-
File: managing-metrics
2728+
- Name: About OpenShift Container Platform monitoring
2729+
Dir: about-ocp-monitoring
2730+
Topics:
2731+
- Name: About OpenShift Container Platform monitoring
2732+
File: about-ocp-monitoring
2733+
- Name: Monitoring stack architecture
2734+
File: monitoring-stack-architecture
2735+
- Name: Key concepts
2736+
File: key-concepts
2737+
- Name: Getting started
2738+
Dir: getting-started
2739+
Topics:
2740+
- Name: Maintenance and support for monitoring
2741+
File: maintenance-and-support-for-monitoring
2742+
- Name: Core platform monitoring first steps
2743+
File: core-platform-monitoring-first-steps
2744+
- Name: User workload monitoring first steps
2745+
File: user-workload-monitoring-first-steps
2746+
- Name: Developer and non-administrator steps
2747+
File: developer-and-non-administrator-steps
2748+
- Name: Configuring core platform monitoring
2749+
Dir: configuring-core-platform-monitoring
2750+
Topics:
2751+
- Name: Preparing to configure the monitoring stack
2752+
File: preparing-to-configure-the-monitoring-stack
2753+
- Name: Configuring performance and scalability
2754+
File: configuring-performance-and-scalability
2755+
- Name: Storing and recording data
2756+
File: storing-and-recording-data
2757+
- Name: Configuring metrics
2758+
File: configuring-metrics
2759+
- Name: Configuring alerts and notifications
2760+
File: configuring-alerts-and-notifications
2761+
- Name: Configuring user workload monitoring
2762+
Dir: configuring-user-workload-monitoring
2763+
Topics:
2764+
- Name: Preparing to configure the monitoring stack
2765+
File: preparing-to-configure-the-monitoring-stack-uwm
2766+
- Name: Configuring performance and scalability
2767+
File: configuring-performance-and-scalability-uwm
2768+
- Name: Storing and recording data
2769+
File: storing-and-recording-data-uwm
2770+
- Name: Configuring metrics
2771+
File: configuring-metrics-uwm
2772+
- Name: Configuring alerts and notifications
2773+
File: configuring-alerts-and-notifications-uwm
2774+
- Name: Accessing metrics
2775+
Dir: accessing-metrics
2776+
Topics:
2777+
- Name: Accessing metrics as an administrator
2778+
File: accessing-metrics-as-an-administrator
2779+
- Name: Accessing metrics as a developer
2780+
File: accessing-metrics-as-a-developer
2781+
- Name: Accessing monitoring APIs by using the CLI
2782+
File: accessing-monitoring-apis-by-using-the-cli
27402783
- Name: Managing alerts
2741-
File: managing-alerts
2742-
- Name: Reviewing monitoring dashboards
2743-
File: reviewing-monitoring-dashboards
2744-
- Name: Accessing monitoring APIs by using the CLI
2745-
File: accessing-third-party-monitoring-apis
2784+
Dir: managing-alerts
2785+
Topics:
2786+
- Name: Managing alerts as an administrator
2787+
File: managing-alerts-as-an-administrator
2788+
- Name: Managing alerts as a developer
2789+
File: managing-alerts-as-a-developer
27462790
- Name: Troubleshooting monitoring issues
27472791
File: troubleshooting-monitoring-issues
27482792
- Name: Config map reference for the Cluster Monitoring Operator

applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,9 @@ include::modules/odc-monitoring-your-app-vulnerabilities.adoc[leveloffset=+1]
3131
[role="_additional-resources"]
3232
[id="additional-resources-odc-monitoring-project-and-application-metrics-using-developer-perspective"]
3333
== Additional resources
34+
ifdef::openshift-rosa,openshift-dedicated[]
3435
* xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
36+
endif::openshift-rosa,openshift-dedicated[]
37+
ifndef::openshift-rosa,openshift-dedicated[]
38+
* xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]
39+
endif::openshift-rosa,openshift-dedicated[]

backup_and_restore/application_backup_and_restore/troubleshooting.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,14 +145,14 @@ include::modules/migration-combining-must-gather.adoc[leveloffset=+2]
145145
include::modules/oadp-monitoring.adoc[leveloffset=+1]
146146
[role="_additional-resources"]
147147
.Additional resources
148-
* xref:../../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring[Monitoring stack]
148+
* xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]
149149

150150
include::modules/oadp-monitoring-setup.adoc[leveloffset=+2]
151151
include::modules/oadp-creating-service-monitor.adoc[leveloffset=+2]
152152
include::modules/oadp-creating-alerting-rule.adoc[leveloffset=+2]
153153
[role="_additional-resources"]
154154
.Additional resources
155-
* xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]
155+
* xref:../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerts-as-an-administrator[Managing alerts as an Administrator]
156156

157157
include::modules/oadp-list-of-metrics.adoc[leveloffset=+2]
158158
include::modules/oadp-viewing-metrics-ui.adoc[leveloffset=+2]

cicd/gitops/monitoring-argo-cd-custom-resource-workloads.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can enable and disable the setting for monitoring Argo CD custom resource wo
1919
* {gitops-title} is installed in your cluster.
2020
* The monitoring stack is configured in your cluster in the `openshift-monitoring` project. In addition, the Argo CD instance is in a namespace that you can monitor through Prometheus.
2121
* The `kube-state-metrics` service is running in your cluster.
22-
* Optional: If you are enabling monitoring for an Argo CD instance already present in a user-defined project, ensure that the monitoring is xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects_enabling-monitoring-for-user-defined-projects[enabled for user-defined projects] in your cluster.
22+
* Optional: If you are enabling monitoring for an Argo CD instance already present in a user-defined project, ensure that the monitoring is xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[enabled for user-defined projects] in your cluster.
2323
+
2424
[NOTE]
2525
====
@@ -35,4 +35,4 @@ include::modules/gitops-disabling-monitoring-for-argo-cd-custom-resource-workloa
3535
[role="_additional-resources"]
3636
[id="additional-resources_monitoring-argo-cd-custom-resource-workloads"]
3737
== Additional resources
38-
* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
38+
* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]

cicd/pipelines/creating-applications-with-cicd-pipelines.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ include::modules/op-enabling-monitoring-of-event-listeners-for-triggers-for-user
6868
[role="_additional-resources"]
6969
.Additional resources
7070

71-
* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
71+
* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
7272

7373
include::modules/op-configuring-pull-request-capabilities-in-GitHub-interceptor.adoc[leveloffset=+1]
7474

getting_started/openshift-overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ be reviewed by cluster administrators and xref:../operators/admin/olm-adding-ope
108108

109109
* **xref:../updating/updating_a_cluster/updating_disconnected_cluster/disconnected-update-osus.adoc#update-service-overview_updating-restricted-network-cluster-osus[Using the OpenShift Update Service in a disconnected environement]**: Learn about installing and managing a local OpenShift Update Service for recommending {product-title} updates in disconnected environments.
110110

111-
* **xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitor clusters]**:
112-
Learn to xref:../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack].
113-
After configuring monitoring, use the web console to access xref:../observability/monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[monitoring dashboards]. In addition to infrastructure metrics, you can also scrape and view metrics for your own services.
111+
* **xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[Monitor clusters]**:
112+
Learn to xref:../observability/monitoring/getting-started/core-platform-monitoring-first-steps.adoc#core-platform-monitoring-first-steps[configure the monitoring stack].
113+
After configuring monitoring, use the web console to access xref:../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#reviewing-monitoring-dashboards-admin_accessing-metrics-as-an-administrator[monitoring dashboards]. In addition to infrastructure metrics, you can also scrape and view metrics for your own services.
114114

115115
* **xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring_about-remote-health-monitoring[Remote health monitoring]**: {product-title} collects anonymized aggregated information about your cluster. Using Telemetry and the Insights Operator, this data is received by Red Hat and used to improve {product-title}. You can view the xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring_showing-data-collected-by-remote-health-monitoring[data collected by remote health monitoring].

installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ include::modules/vsphere-problem-detector-metrics.adoc[leveloffset=+1]
3030
[role="_additional-resources"]
3131
== Additional resources
3232

33-
* xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
33+
* xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring]

installing/overview/installing-preparing.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,12 @@ For a production cluster, you must configure the following integrations:
110110

111111
* xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Persistent storage]
112112
* xref:../../authentication/understanding-identity-provider.adoc#understanding-identity-provider[An identity provider]
113-
* xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Monitoring core OpenShift Container Platform components]
113+
* xref:../../observability/monitoring/getting-started/core-platform-monitoring-first-steps.adoc#core-platform-monitoring-first-steps[Monitoring core {product-title} components]
114114

115115
[id="installing-preparing-cluster-for-workloads"]
116116
== Preparing your cluster for workloads
117117

118-
Depending on your workload needs, you might need to take extra steps before you begin deploying applications. For example, after you prepare infrastructure to support your application xref:../../cicd/builds/build-strategies.adoc#build-strategies[build strategy], you might need to make provisions for xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-low-latency-perf-profile[low-latency] workloads or to xref:../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets[protect sensitive workloads]. You can also configure xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[monitoring] for application workloads.
118+
Depending on your workload needs, you might need to take extra steps before you begin deploying applications. For example, after you prepare infrastructure to support your application xref:../../cicd/builds/build-strategies.adoc#build-strategies[build strategy], you might need to make provisions for xref:../../scalability_and_performance/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-low-latency-perf-profile[low-latency] workloads or to xref:../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets[protect sensitive workloads]. You can also configure xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[monitoring] for application workloads.
119119
If you plan to run xref:../../windows_containers/enabling-windows-container-workloads.adoc#enabling-windows-container-workloads[Windows workloads], you must enable xref:../../networking/ovn_kubernetes_network_provider/configuring-hybrid-networking.adoc#configuring-hybrid-networking[hybrid networking with OVN-Kubernetes] during the installation process; hybrid networking cannot be enabled after your cluster is installed.
120120

121121
[id="supported-installation-methods-for-different-platforms"]

installing/validation_and_troubleshooting/validating-an-installation.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ include::modules/checking-cluster-resource-availability-and-utilization.adoc[lev
5656
[role="_additional-resources"]
5757
.Additional resources
5858

59-
* See xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack.
59+
* See xref:../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] for more information about the {product-title} monitoring stack.
6060
6161
//Listing alerts that are firing
6262
include::modules/listing-alerts-that-are-firing.adoc[leveloffset=+1]
6363

6464
[role="_additional-resources"]
6565
.Additional resources
6666

67-
* See xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts] for further details about alerting in {product-title}.
67+
* See xref:../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#managing-alerts-as-an-administrator[Managing alerts as an Administrator] for further details about alerting in {product-title}.
6868
6969
[id="validating-an-installation-next-steps"]
7070
== Next steps

machine_management/creating-infrastructure-machinesets.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,6 @@ include::modules/infrastructure-moving-monitoring.adoc[leveloffset=+2]
131131

132132
[role="_additional-resources"]
133133
.Additional resources
134-
* xref:../observability/monitoring/configuring-the-monitoring-stack.adoc#moving-monitoring-components-to-different-nodes_configuring-the-monitoring-stack[Moving monitoring components to different nodes]
134+
* xref:../observability/monitoring/configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc#moving-monitoring-components-to-different-nodes-cpm_configuring-performance-and-scalability[Moving monitoring components to different nodes]
135135
* xref:../observability/logging/scheduling_resources/logging-node-selectors.adoc#logging-node-selectors[Using node selectors to move logging resources]
136136
* xref:../observability/logging/scheduling_resources/logging-taints-tolerations.adoc#cluster-logging-logstore-tolerations_logging-taints-tolerations[Using taints and tolerations to control logging pod placement]

0 commit comments

Comments
 (0)