From dd2ad3ba23af81c0c6edcd969e67a9afc7f76073 Mon Sep 17 00:00:00 2001 From: EricPonvelle Date: Tue, 25 Mar 2025 13:30:47 -0400 Subject: [PATCH] OSDOCS-13068: Classic to HCP Logging Migration --- _topic_maps/_topic_map_rosa_hcp.yml | 119 ++++++++++++++++++ .../configuring-log-forwarding.adoc | 4 +- .../logging_alerts/custom-logging-alerts.adoc | 4 +- .../default-logging-alerts.adoc | 4 +- .../troubleshooting-logging-alerts.adoc | 4 +- 5 files changed, 127 insertions(+), 8 deletions(-) diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index c16a7a85e5..7e81173ba7 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -1233,3 +1233,122 @@ Topics: # Topics: # - Name: Adding worker nodes to single-node OpenShift clusters # File: nodes-sno-worker-nodes +--- +Name: Observability +Dir: observability +Distros: openshift-rosa-hcp +Topics: +- Name: Logging + Dir: logging + Distros: openshift-rosa-hcp + Topics: + - Name: Release notes + Dir: logging_release_notes + Topics: + - Name: Logging 5.9 + File: logging-5-9-release-notes + - Name: Logging 5.8 + File: logging-5-8-release-notes + - Name: Logging 5.7 + File: logging-5-7-release-notes + - Name: Support + File: cluster-logging-support + - Name: Troubleshooting logging + Dir: troubleshooting + Topics: + - Name: Viewing Logging status + File: cluster-logging-cluster-status + - Name: Troubleshooting log forwarding + File: log-forwarding-troubleshooting + - Name: Troubleshooting logging alerts + File: troubleshooting-logging-alerts + - Name: Viewing the status of the Elasticsearch log store + File: cluster-logging-log-store-status + - Name: About Logging + File: cluster-logging + - Name: Installing Logging + File: cluster-logging-deploying + - Name: Updating Logging + File: cluster-logging-upgrading + - Name: Visualizing logs + Dir: log_visualization + Topics: + - Name: About log visualization + File: log-visualization + - Name: Log visualization with the web console + File: log-visualization-ocp-console + - Name: Viewing cluster dashboards + File: cluster-logging-dashboards + - Name: Log visualization with Kibana + File: logging-kibana + - Name: Configuring your Logging deployment + Dir: config + Topics: + - Name: Configuring CPU and memory limits for Logging components + File: cluster-logging-memory + #- Name: Configuring systemd-journald and Fluentd + # File: cluster-logging-systemd + - Name: Log collection and forwarding + Dir: log_collection_forwarding + Topics: + - Name: About log collection and forwarding + File: log-forwarding + - Name: Log output types + File: logging-output-types + - Name: Enabling JSON log forwarding + File: cluster-logging-enabling-json-logging + - Name: Configuring log forwarding + File: configuring-log-forwarding + - Name: Configuring the logging collector + File: cluster-logging-collector + - Name: Collecting and storing Kubernetes events + File: cluster-logging-eventrouter + - Name: Log storage + Dir: log_storage + Topics: + - Name: About log storage + File: about-log-storage + - Name: Installing log storage + File: installing-log-storage + - Name: Configuring the LokiStack log store + File: cluster-logging-loki + - Name: Configuring the Elasticsearch log store + File: logging-config-es-store + - Name: Logging alerts + Dir: logging_alerts + Topics: + - Name: Default logging alerts + File: default-logging-alerts + - Name: Custom logging alerts + File: custom-logging-alerts + - Name: Performance and reliability tuning + Dir: performance_reliability + Topics: + - Name: Flow control mechanisms + File: logging-flow-control-mechanisms + - Name: Filtering logs by content + File: logging-content-filtering + - Name: Filtering logs by metadata + File: logging-input-spec-filtering + - Name: Scheduling resources + Dir: scheduling_resources + Topics: + - Name: Using node selectors to move logging resources + File: logging-node-selectors + - Name: Using tolerations to control logging pod placement + File: logging-taints-tolerations + - Name: Uninstalling Logging + File: cluster-logging-uninstall + - Name: Exported fields + File: cluster-logging-exported-fields + - Name: API reference + Dir: api_reference + Topics: + # - Name: 5.8 Logging API reference + # File: logging-5-8-reference + # - Name: 5.7 Logging API reference + # File: logging-5-7-reference + - Name: 5.6 Logging API reference + File: logging-5-6-reference + - Name: Glossary + File: logging-common-terms diff --git a/observability/logging/log_collection_forwarding/configuring-log-forwarding.adoc b/observability/logging/log_collection_forwarding/configuring-log-forwarding.adoc index 456ccd3f1f..4547ddf00a 100644 --- a/observability/logging/log_collection_forwarding/configuring-log-forwarding.adoc +++ b/observability/logging/log_collection_forwarding/configuring-log-forwarding.adoc @@ -72,6 +72,6 @@ endif::[] [role="_additional-resources"] .Additional resources * link:https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html[AWS STS API Reference] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator[Cloud Credential Operator (CCO)] -endif::[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/observability/logging/logging_alerts/custom-logging-alerts.adoc b/observability/logging/logging_alerts/custom-logging-alerts.adoc index 6c7cb78279..f405a4702b 100644 --- a/observability/logging/logging_alerts/custom-logging-alerts.adoc +++ b/observability/logging/logging_alerts/custom-logging-alerts.adoc @@ -33,9 +33,9 @@ include::modules/logging-enabling-loki-alerts.adoc[leveloffset=+1] ifdef::openshift-dedicated,openshift-rosa[] * xref:../../../observability/monitoring/monitoring-overview.adoc#about-openshift-monitoring[About {product-title} monitoring] endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-enterprise[] * xref:../../../post_installation_configuration/configuring-alert-notifications.adoc#configuring-alert-notifications[Configuring alert notifications] endif::[] diff --git a/observability/logging/logging_alerts/default-logging-alerts.adoc b/observability/logging/logging_alerts/default-logging-alerts.adoc index 5f8d0836c4..5f149ce10b 100644 --- a/observability/logging/logging_alerts/default-logging-alerts.adoc +++ b/observability/logging/logging_alerts/default-logging-alerts.adoc @@ -22,6 +22,6 @@ include::modules/cluster-logging-elasticsearch-rules.adoc[leveloffset=+1] ifdef::openshift-dedicated,openshift-rosa[] * xref:../../../observability/monitoring/managing-alerts.adoc#modifying-core-platform-alerting-rules_managing-alerts[Modifying core platform alerting rules] endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/managing-alerts/managing-alerts-as-an-administrator.adoc#modifying-core-platform-alerting-rules_managing-alerts-as-an-administrator[Modifying core platform alerting rules] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc b/observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc index d2190f18b7..f17e01622a 100644 --- a/observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc +++ b/observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc @@ -15,9 +15,9 @@ include::modules/es-cluster-health-is-red.adoc[leveloffset=+1] ifdef::openshift-dedicated,openshift-rosa[] * xref:../../../observability/monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards] endif::openshift-dedicated,openshift-rosa[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#reviewing-monitoring-dashboards-admin_accessing-metrics-as-an-administrator[Reviewing monitoring dashboards as a cluster administrator] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * link:https://www.elastic.co/guide/en/elasticsearch/reference/7.13/fix-common-cluster-issues.html#fix-red-yellow-cluster-status[Fix a red or yellow cluster status] [id="elasticsearch-cluster-health-is-yellow"]