From dd18168682786b4efbe90868cc6e8b65e71d0617 Mon Sep 17 00:00:00 2001 From: EricPonvelle Date: Thu, 3 Jul 2025 14:16:57 -0500 Subject: [PATCH] OSDOCS-14125: Updated Logging to remove <6.0 content --- _topic_maps/_topic_map_rosa.yml | 151 ++++++------------ _topic_maps/_topic_map_rosa_hcp.yml | 151 ++++++------------ observability/logging/about-logging.adoc | 20 +++ .../logging/logging-6.0/log6x-visual.adoc | 6 + .../logging/logging-6.1/log6x-visual-6.1.adoc | 7 + .../logging/logging-6.2/log6x-visual-6.2.adoc | 6 + ...ity-operator-due-to-logging-ui-plugin.adoc | 9 +- 7 files changed, 141 insertions(+), 209 deletions(-) create mode 100644 observability/logging/about-logging.adoc diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index 72f8bf8ed8..350d5cd97f 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -1554,116 +1554,59 @@ Topics: Dir: logging Distros: openshift-rosa 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 + File: about-logging + - Name: Logging 6.2 + Dir: logging-6.2 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: Support + File: log62-cluster-logging-support + - Name: Release notes + File: log6x-release-notes-6.2 + - Name: About logging 6.2 + File: log6x-about-6.2 - Name: Configuring log forwarding - File: configuring-log-forwarding + File: log6x-clf-6.2 - 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 + File: 6x-cluster-logging-collector-6.2 + - Name: Configuring LokiStack storage + File: log6x-loki-6.2 + - Name: Configuring LokiStack for OTLP + File: log6x-configuring-lokistack-otlp-6.2 + - Name: Visualization for logging + File: log6x-visual-6.2 + - Name: Logging 6.1 + Dir: logging-6.1 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 + - Name: Release notes + File: log6x-release-notes-6.1 + - Name: About logging 6.1 + File: log6x-about-6.1 + - Name: Configuring log forwarding + File: log6x-clf-6.1 + - Name: Configuring LokiStack storage + File: log6x-loki-6.1 + - Name: Configuring LokiStack for OTLP + File: log6x-configuring-lokistack-otlp-6.1 + - Name: OpenTelemetry data model + File: log6x-opentelemetry-data-model-6.1 + - Name: Visualization for logging + File: log6x-visual-6.1 + - Name: Logging 6.0 + Dir: logging-6.0 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 + - Name: Release notes + File: log6x-release-notes + - Name: About logging 6.0 + File: log6x-about + - Name: Upgrading to Logging 6.0 + File: log6x-upgrading-to-6 + - Name: Configuring log forwarding + File: log6x-clf + - Name: Configuring LokiStack storage + File: log6x-loki + - Name: Visualization for logging + File: log6x-visual --- Name: Service Mesh Dir: service_mesh diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index 6801d8e573..9f28aa3fe5 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -1217,116 +1217,59 @@ Topics: 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 + File: about-logging + - Name: Logging 6.2 + Dir: logging-6.2 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: Support + File: log62-cluster-logging-support + - Name: Release notes + File: log6x-release-notes-6.2 + - Name: About logging 6.2 + File: log6x-about-6.2 - Name: Configuring log forwarding - File: configuring-log-forwarding + File: log6x-clf-6.2 - 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 + File: 6x-cluster-logging-collector-6.2 + - Name: Configuring LokiStack storage + File: log6x-loki-6.2 + - Name: Configuring LokiStack for OTLP + File: log6x-configuring-lokistack-otlp-6.2 + - Name: Visualization for logging + File: log6x-visual-6.2 + - Name: Logging 6.1 + Dir: logging-6.1 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 + - Name: Release notes + File: log6x-release-notes-6.1 + - Name: About logging 6.1 + File: log6x-about-6.1 + - Name: Configuring log forwarding + File: log6x-clf-6.1 + - Name: Configuring LokiStack storage + File: log6x-loki-6.1 + - Name: Configuring LokiStack for OTLP + File: log6x-configuring-lokistack-otlp-6.1 + - Name: OpenTelemetry data model + File: log6x-opentelemetry-data-model-6.1 + - Name: Visualization for logging + File: log6x-visual-6.1 + - Name: Logging 6.0 + Dir: logging-6.0 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 + - Name: Release notes + File: log6x-release-notes + - Name: About logging 6.0 + File: log6x-about + - Name: Upgrading to Logging 6.0 + File: log6x-upgrading-to-6 + - Name: Configuring log forwarding + File: log6x-clf + - Name: Configuring LokiStack storage + File: log6x-loki + - Name: Visualization for logging + File: log6x-visual --- Name: Service Mesh Dir: service_mesh diff --git a/observability/logging/about-logging.adoc b/observability/logging/about-logging.adoc new file mode 100644 index 0000000000..9614cc5118 --- /dev/null +++ b/observability/logging/about-logging.adoc @@ -0,0 +1,20 @@ +:_mod-docs-content-type: ASSEMBLY +include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] +[id="about-logging"] += About Logging +:context: cluster-logging + +toc::[] + +As a cluster administrator, you can deploy {logging} on an {product-title} cluster, and use it to collect and aggregate node system audit logs, application container logs, and infrastructure logs. + +You can use {logging} to perform the following tasks: + +* Forward logs to your chosen log outputs, including on-cluster, Red{nbsp}Hat managed log storage. +* Visualize your log data in the {product-title} web console. + +[NOTE] +==== +Because {logging} releases on a different cadence from {product-title}, the {logging} documentation is available as a separate documentation set at link:https://docs.redhat.com/en/documentation/red_hat_openshift_logging/[Red{nbsp}Hat OpenShift {logging-uc}]. +==== diff --git a/observability/logging/logging-6.0/log6x-visual.adoc b/observability/logging/logging-6.0/log6x-visual.adoc index 71ad2db3ac..4ebe2028d4 100644 --- a/observability/logging/logging-6.0/log6x-visual.adoc +++ b/observability/logging/logging-6.0/log6x-visual.adoc @@ -2,10 +2,16 @@ [id="log6x-visual"] = Visualization for logging include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: logging-6x toc::[] +ifndef::openshift-rosa,openshift-rosa-hcp[] Visualization for logging is provided by deploying the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] of the xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator], which requires Operator installation. +endif::openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-rosa,openshift-rosa-hcp[] +Visualization for logging is provided by deploying the Logging UI Plugin of the Cluster Observability Operator, which requires Operator installation. +endif::openshift-rosa,openshift-rosa-hcp[] include::snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc[] diff --git a/observability/logging/logging-6.1/log6x-visual-6.1.adoc b/observability/logging/logging-6.1/log6x-visual-6.1.adoc index 0b94c5ada4..04d2fafe2f 100644 --- a/observability/logging/logging-6.1/log6x-visual-6.1.adoc +++ b/observability/logging/logging-6.1/log6x-visual-6.1.adoc @@ -2,10 +2,17 @@ [id="log6x-visual-6-1"] = Visualization for logging include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: logging-6x-6.1 toc::[] +ifndef::openshift-rosa,openshift-rosa-hcp[] Visualization for logging is provided by deploying the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] of the xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator], which requires Operator installation. +endif::openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-rosa,openshift-rosa-hcp[] +Visualization for logging is provided by deploying the Logging UI Plugin of the Cluster Observability Operator, which requires Operator installation. +endif::openshift-rosa,openshift-rosa-hcp[] + include::snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc[] diff --git a/observability/logging/logging-6.2/log6x-visual-6.2.adoc b/observability/logging/logging-6.2/log6x-visual-6.2.adoc index 59d1e1b7a6..6738506d51 100644 --- a/observability/logging/logging-6.2/log6x-visual-6.2.adoc +++ b/observability/logging/logging-6.2/log6x-visual-6.2.adoc @@ -2,10 +2,16 @@ [id="log6x-visual-6-2"] = Visualization for logging include::_attributes/common-attributes.adoc[] +include::_attributes/attributes-openshift-dedicated.adoc[] :context: logging-6x-6.2 toc::[] +ifndef::openshift-rosa,openshift-rosa-hcp[] Visualization for logging is provided by deploying the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] of the xref:../../../observability/cluster_observability_operator/cluster-observability-operator-overview.adoc#cluster-observability-operator-overview[Cluster Observability Operator], which requires Operator installation. +endif::openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-rosa,openshift-rosa-hcp[] +Visualization for logging is provided by deploying the Logging UI Plugin of the Cluster Observability Operator, which requires Operator installation. +endif::openshift-rosa,openshift-rosa-hcp[] include::snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc[] diff --git a/snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc b/snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc index 425bdd5c7a..eb31f1ea84 100644 --- a/snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc +++ b/snippets/logging-support-exception-for-cluster-observability-operator-due-to-logging-ui-plugin.adoc @@ -6,5 +6,12 @@ [IMPORTANT] ==== -Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA. +Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its +ifndef::openshift-rosa,openshift-rosa-hcp[] +xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI Plugin] +endif::openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-rosa,openshift-rosa-hcp[] +Logging UI Plugin +endif::openshift-rosa,openshift-rosa-hcp[] +on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA. ====