openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

Removing xrefs

Browse Source
This commit is contained in:
libander
2024-09-30 16:20:31 -05:00
committed by ashiot
parent d7366c4d02
commit 3a75eb5066
31 changed files with 285 additions and 319 deletions
Download Patch File Download Diff File Expand all files Collapse all files

243
_topic_maps/_topic_map.yml
View File

@@ -2992,32 +2992,32 @@ Topics:
Dir: logging
Distros: openshift-enterprise,openshift-origin
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: 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: Logging 6.0
Dir: logging-6.0
Topics:
- 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: API reference 6.0
# File: log6x-api-reference
- 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: API reference 6.0
# File: log6x-api-reference
- Name: Logging 6.1
Dir: logging-6.1
Topics:
@@ -3035,110 +3035,107 @@ Topics:
File: log6x-opentelemetry-data-model-6.1
- Name: Visualization for logging
File: log6x-visual-6.1
- 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
Distros: openshift-enterprise,openshift-origin
- 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
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Configuring CPU and memory limits for Logging components
File: cluster-logging-memory
- Name: Configuring systemd-journald for Logging
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
Distros: openshift-enterprise,openshift-origin
- Name: API reference
Dir: api_reference
Topics:
# - 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
# 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
# Distros: openshift-enterprise,openshift-origin
# - Name: Visualizing logs
# 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
# Distros: openshift-enterprise,openshift-origin
# Topics:
# - Name: Configuring CPU and memory limits for Logging components
# File: cluster-logging-memory
# - Name: Configuring systemd-journald for Logging
# 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
# 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
# Distros: openshift-enterprise,openshift-origin
# - 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: 5.6 Logging API reference
# File: logging-5-6-reference
# - Name: Glossary
# File: logging-common-terms
- Name: Distributed tracing
Dir: distr_tracing
Distros: openshift-enterprise

218
_topic_maps/_topic_map_osd.yml
View File

@@ -1231,120 +1231,118 @@ Topics:
File: troubleshooting-monitoring-issues
- Name: Config map reference for the Cluster Monitoring Operator
File: config-map-reference-for-the-cluster-monitoring-operator
- Name: Logging
Dir: logging
Distros: openshift-dedicated
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: Logging
# Dir: logging
# Distros: openshift-dedicated
# 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
# Dir: log_collection_forwarding
# Topics:
# - Name: About log collection and forwarding
# File: log-forwarding
# - Name: Log 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
# - Name: 5.6 Logging API reference
# File: logging-5-6-reference
# - Name: Glossary
# File: logging-common-terms
---
Name: Service Mesh
Dir: service_mesh

6
adding_service_cluster/adding-service.adoc
View File

@@ -21,9 +21,3 @@ include::modules/adding-service-existing.adoc[leveloffset=+1]
include::modules/access-service.adoc[leveloffset=+1]
include::modules/deleting-service.adoc[leveloffset=+1]
//include::modules/deleting-service-cli.adoc[leveloffset=+1]
ifdef::openshift-rosa[]
[role="_additional-resources"]
== Additional resources
* xref:../observability/logging/log_collection_forwarding/configuring-log-forwarding.adoc#cluster-logging-collector-log-forward-cloudwatch_configuring-log-forwarding[Forwarding logs to Amazon CloudWatch]
endif::[]

1
adding_service_cluster/rosa-available-services.adoc
View File

@@ -16,7 +16,6 @@ include::modules/aws-cloudwatch.adoc[leveloffset=+1]
.Additional resources
* link:https://aws.amazon.com/cloudwatch/[Amazon CloudWatch product information]
* xref:../observability/logging/log_collection_forwarding/configuring-log-forwarding.adoc#cluster-logging-collector-log-forward-cloudwatch_configuring-log-forwarding[Forwarding logs to Amazon CloudWatch]
include::modules/osd-rhoam.adoc[leveloffset=+1]

1
architecture/index.adoc
View File

@@ -25,7 +25,6 @@ endif::openshift-dedicated,openshift-rosa[]
* For more information on storage, see xref:../storage/index.adoc#index[{product-title} storage].
* For more information on authentication, see xref:../authentication/index.adoc#index[{product-title} authentication].
* For more information on Operator Lifecycle Manager (OLM), see xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[OLM].
* For more information on logging, see xref:../observability/logging/cluster-logging.adoc#cluster-logging[About Logging].
// Topic not included in the OSD/ROSA docs
ifndef::openshift-dedicated,openshift-rosa[]
* For more information on over-the-air (OTA) updates, see xref:../updating/understanding_updates/intro-to-updates.adoc#understanding-openshift-updates[Introduction to OpenShift updates].

4
cicd/gitops/viewing-argo-cd-logs.adoc
View File

@@ -10,7 +10,9 @@ You can view the Argo CD logs with {logging}. {logging-uc} visualizes the logs o
include::modules/gitops-storing-and-retrieving-argo-cd-logs.adoc[leveloffset=+1]
////
[role="_additional-resources"]
[id="additional-resources_viewing-argo-cd-logs"]
== Additional resources
* xref:../../observability/logging/cluster-logging-deploying.adoc#cluster-logging-deploy-console_cluster-logging-deploying[Installing {logging} using the web console]
* xref :../../observability/logging/cluster-logging-deploying.adoc#cluster-logging-deploy-console_cluster-logging-deploying[Installing {logging} using the web console]
////

8
cicd/pipelines/viewing-pipeline-logs-using-the-openshift-logging-operator.adoc
View File

@@ -23,9 +23,11 @@ Before trying to view pipeline logs in a Kibana dashboard, ensure the following:
include::modules/op-viewing-pipeline-logs-in-kibana.adoc[leveloffset=+1]
////
[role="_additional-resources"]
[id="additional-resources_viewing-pipeline-logs-using-the-openshift-logging-operator"]
== Additional resources
* xref:../../observability/logging/cluster-logging-deploying.adoc#cluster-logging-deploying[Installing OpenShift Logging]
* xref:../../observability/logging/log_visualization/log-visualization.adoc#log-visualization-resource-logs_log-visualization[Viewing logs for a resource]
* xref:../../observability/logging/log_visualization/logging-kibana.adoc#logging-kibana[Log visualization with Kibana]
* xref :../../observability/logging/cluster-logging-deploying.adoc#cluster-logging-deploying[Installing OpenShift Logging]
* xref :../../observability/logging/log_visualization/log-visualization.adoc#log-visualization-resource-logs_log-visualization[Viewing logs for a resource]
* xref :../../observability/logging/log_visualization/logging-kibana.adoc#logging-kibana[Log visualization with Kibana]
////

12
cloud_experts_tutorials/cloud-experts-deploying-application/cloud-experts-deploying-application-logging.adoc
View File

@@ -16,15 +16,15 @@ There are various methods to view your logs in {product-rosa} (ROSA). Use the fo
====
ROSA is not preconfigured with a logging solution.
====
////
.Prerequisites
* Set up a logging solution before viewing your logs. See the xref:../../observability/logging/cluster-logging-deploying.adoc#cluster-logging-deploying[Installing logging] documentation for more information.
* Set up a logging solution before viewing your logs. See the xref :../../observability/logging/cluster-logging-deploying.adoc#cluster-logging-deploying[Installing logging] documentation for more information.
[role="_additional-resources"]
.Additional resources
* xref:../../observability/logging/cluster-logging.adoc#cluster-logging[Cluster logging]
* xref :../../observability/logging/cluster-logging.adoc#cluster-logging[Cluster logging]
////
== Forwarding logs to CloudWatch
Install the logging add-on service to forward the logs to AWS CloudWatch.
@@ -126,7 +126,7 @@ pod/ostoy-frontend-679cb85695-5cn7x <1>
pod/ostoy-microservice-86b4c6f559-p594d
----
<1> The pod name is `ostoy-frontend-679cb85695-5cn7x`.
+
+
. Run the following command to see both the `stdout` and `stderr` messages:
+
[source,terminal]
@@ -174,4 +174,4 @@ image:cloud-experts-deploying-application-logging-messages.png[]
[role="_additional-resources"]
.Additional resources
* link:https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html[What is Amazon CloudWatch]
* link:https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html[What is Amazon CloudWatch]

2
machine_management/creating-infrastructure-machinesets.adoc
View File

@@ -130,5 +130,3 @@ include::modules/nodes-cluster-resource-override-move-infra.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources
* 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]
* xref:../observability/logging/scheduling_resources/logging-node-selectors.adoc#logging-node-selectors[Using node selectors to move logging resources]
* 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]

2
migrating_from_ocp_3_to_4/index.adoc
View File

@@ -14,7 +14,7 @@ Before migrating from {product-title} 3 to 4, you can check xref:../migrating_fr
* xref:../architecture/architecture.adoc#architecture[Architecture]
* xref:../architecture/architecture-installation.adoc#architecture-installation[Installation and update]
* xref:../storage/index.adoc#index[Storage], xref:../networking/understanding-networking.adoc#understanding-networking[network], xref:../observability/logging/cluster-logging.adoc#cluster-logging[logging], xref:../security/index.adoc#index[security], and xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[monitoring considerations]
* xref:../storage/index.adoc#index[Storage], xref:../networking/understanding-networking.adoc#understanding-networking[network], xref:../security/index.adoc#index[security], and xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[monitoring considerations]
[id="mtc-3-to-4-overview-planning-network-considerations-mtc"]
== Planning network considerations

6
migrating_from_ocp_3_to_4/planning-migration-3-4.adoc
View File

@@ -193,22 +193,16 @@ Review the following logging changes to consider when transitioning from {produc
{product-title} 4 provides a simple deployment mechanism for OpenShift Logging, by using a Cluster Logging custom resource.
For more information, see xref:../observability/logging/cluster-logging-deploying.adoc#cluster-logging-deploying_cluster-logging-deploying[Installing OpenShift Logging].
[discrete]
==== Aggregated logging data
You cannot transition your aggregate logging data from {product-title} 3.11 into your new {product-title} 4 cluster.
For more information, see xref:../observability/logging/cluster-logging.adoc#cluster-logging-about_cluster-logging[About OpenShift Logging].
[discrete]
==== Unsupported logging configurations
Some logging configurations that were available in {product-title} 3.11 are no longer supported in {product-title} {product-version}.
For more information on the explicitly unsupported logging cases, see the xref:../observability/logging/cluster-logging-support.adoc#cluster-logging-support[logging support documentation].
[id="migration-preparing-security"]
=== Security considerations

3
observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc
View File

@@ -16,7 +16,7 @@ During an update, the {DTProductName} Operators upgrade the managed {DTShortName
[IMPORTANT]
====
If you have not already updated your {es-op} as described in xref:../../../observability/logging/cluster-logging-upgrading.adoc#cluster-logging-upgrading[Updating OpenShift Logging], complete that update before updating your {JaegerName} Operator.
If you have not already updated your {es-op}, complete that update before updating your {JaegerName} Operator.
====
[role="_additional-resources"]
@@ -25,4 +25,3 @@ If you have not already updated your {es-op} as described in xref:../../../obser
* xref:../../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager concepts and resources]
* xref:../../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators]
* xref:../../../observability/logging/cluster-logging-upgrading.adoc#cluster-logging-upgrading[Updating OpenShift Logging]

14
observability/logging/cluster-logging.adoc
View File

@@ -11,40 +11,40 @@ As a cluster administrator, you can deploy {logging} on an {product-title} clust
include::snippets/logging-kibana-dep-snip.adoc[]
{product-title} cluster administrators can deploy {logging} by using Operators. For information, see xref:../../observability/logging/cluster-logging-deploying.adoc#cluster-logging-deploying[Installing {logging}].
{product-title} cluster administrators can deploy {logging} by using Operators. For information, see xref :../../observability/logging/cluster-logging-deploying.adoc#cluster-logging-deploying[Installing {logging}].
The Operators are responsible for deploying, upgrading, and maintaining {logging}. After the Operators are installed, you can create a `ClusterLogging` custom resource (CR) to schedule {logging} pods and other resources necessary to support {logging}. You can also create a `ClusterLogForwarder` CR to specify which logs are collected, how they are transformed, and where they are forwarded to.
[NOTE]
====
Because the internal {product-title} Elasticsearch log store does not provide secure storage for audit logs, audit logs are not stored in the internal Elasticsearch instance by default. If you want to send the audit logs to the default internal Elasticsearch log store, for example to view the audit logs in Kibana, you must use the Log Forwarding API as described in xref:../../observability/logging/log_storage/logging-config-es-store.adoc#cluster-logging-elasticsearch-audit_logging-config-es-store[Forward audit logs to the log store].
Because the internal {product-title} Elasticsearch log store does not provide secure storage for audit logs, audit logs are not stored in the internal Elasticsearch instance by default. If you want to send the audit logs to the default internal Elasticsearch log store, for example to view the audit logs in Kibana, you must use the Log Forwarding API as described in xref :../../observability/logging/log_storage/logging-config-es-store.adoc#cluster-logging-elasticsearch-audit_logging-config-es-store[Forward audit logs to the log store].
====
include::modules/logging-architecture-overview.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../../observability/logging/log_visualization/log-visualization-ocp-console.adoc#log-visualization-ocp-console[Log visualization with the web console]
* xref :../../observability/logging/log_visualization/log-visualization-ocp-console.adoc#log-visualization-ocp-console[Log visualization with the web console]
include::modules/cluster-logging-about.adoc[leveloffset=+1]
ifdef::openshift-rosa,openshift-dedicated[]
include::modules/cluster-logging-cloudwatch.adoc[leveloffset=+1]
For information, see xref:../../observability/logging/log_collection_forwarding/log-forwarding.adoc#about-log-collection_log-forwarding[About log collection and forwarding].
For information, see xref :../../observability/logging/log_collection_forwarding/log-forwarding.adoc#about-log-collection_log-forwarding[About log collection and forwarding].
endif::[]
include::modules/cluster-logging-json-logging-about.adoc[leveloffset=+2]
include::modules/cluster-logging-collecting-storing-kubernetes-events.adoc[leveloffset=+2]
For information, see xref:../../observability/logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[About collecting and storing Kubernetes events].
For information, see xref :../../observability/logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[About collecting and storing Kubernetes events].
include::modules/cluster-logging-troubleshoot-logging.adoc[leveloffset=+2]
include::modules/cluster-logging-export-fields.adoc[leveloffset=+2]
For information, see xref:../../observability/logging/cluster-logging-exported-fields.adoc#cluster-logging-exported-fields[About exporting fields].
For information, see xref :../../observability/logging/cluster-logging-exported-fields.adoc#cluster-logging-exported-fields[About exporting fields].
include::modules/cluster-logging-eventrouter-about.adoc[leveloffset=+2]
For information, see xref:../../observability/logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[Collecting and storing Kubernetes events].
For information, see xref :../../observability/logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[Collecting and storing Kubernetes events].

2
observability/logging/log_collection_forwarding/log-forwarding.adoc
View File

@@ -35,7 +35,7 @@ To use the multi log forwarder feature, you must create a service account and cl
[IMPORTANT]
====
In order to support multi log forwarding in additional namespaces other than the `openshift-logging` namespace, you must xref:../../../observability/logging/cluster-logging-upgrading.adoc#logging-operator-upgrading-all-ns_cluster-logging-upgrading[update the {clo} to watch all namespaces]. This functionality is supported by default in new {clo} version 5.8 installations.
In order to support multi log forwarding in additional namespaces other than the `openshift-logging` namespace, you must update the {clo} to watch all namespaces]. This functionality is supported by default in new {clo} version 5.8 installations.
====
include::modules/log-collection-rbac-permissions.adoc[leveloffset=+3]

6
observability/network_observability/installing-operators.adoc
View File

@@ -11,7 +11,7 @@ The {loki-op} integrates a gateway that implements multi-tenancy and authenticat
[NOTE]
====
The {loki-op} can also be used for xref:../../observability/logging/log_storage/cluster-logging-loki.adoc#cluster-logging-loki[configuring the LokiStack log store]. The Network Observability Operator requires a dedicated LokiStack separate from the {logging}.
The {loki-op} can also be used for configuring the LokiStack log store]. The Network Observability Operator requires a dedicated LokiStack separate from the {logging}.
====
include::modules/network-observability-without-loki.adoc[leveloffset=+1]
@@ -24,9 +24,9 @@ include::modules/network-observability-loki-install.adoc[leveloffset=+1]
include::modules/network-observability-loki-secret.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources
* xref:../../observability/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[Flow Collector API Reference]
* xref:../../observability/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[Flow Collector API Reference]
* xref:../../observability/network_observability/configuring-operator.adoc#network-observability-flowcollector-view_network_observability[Flow Collector sample resource]
* xref:../../observability/logging/log_storage/installing-log-storage.adoc#logging-loki-storage_installing-log-storage[Loki object storage]
//* xref :../../observability/logging/log_storage/installing-log-storage.adoc#logging-loki-storage_installing-log-storage[Loki object storage]
include::modules/network-observability-lokistack-create.adoc[leveloffset=+2]
include::modules/logging-creating-new-group-cluster-admin-user-role.adoc[leveloffset=+2]

2
observability/otel/otel-forwarding-telemetry-data.adoc
View File

@@ -11,7 +11,9 @@ You can use the OpenTelemetry Collector to forward your telemetry data.
include::modules/otel-forwarding-traces.adoc[leveloffset=+1]
include::modules/otel-forwarding-logs-to-tempostack.adoc[leveloffset=+1]
////
[role="_additional-resources"]
.Additional resources
* xref:../logging/log_storage/installing-log-storage.adoc#installing-log-storage[Installing LokiStack log storage]
////

2
observability/overview/index.adoc
View File

@@ -48,8 +48,6 @@ endif::openshift-dedicated,openshift-rosa[]
== Logging
Collect, visualize, forward, and store log data to troubleshoot issues, identify performance bottlenecks, and detect security threats. In logging 5.7 and later versions, users can configure the LokiStack deployment to produce customized alerts and recorded metrics.
For more information, see xref:../../observability/logging/cluster-logging.adoc#cluster-logging[About Logging].
ifdef::openshift-enterprise,openshift-origin[]
[id="distr-tracing-architecture-index_{context}"]
== Distributed tracing

12
post_installation_configuration/cluster-tasks.adoc
View File

@@ -296,13 +296,11 @@ include::modules/infrastructure-moving-registry.adoc[leveloffset=+2]
include::modules/infrastructure-moving-monitoring.adoc[leveloffset=+2]
[id="custer-tasks-moving-logging-resources"]
=== Moving {logging} resources
For information about moving {logging} resources, see:
* xref:../observability/logging/scheduling_resources/logging-node-selectors.adoc#logging-node-selectors[Using node selectors to move logging resources]
* 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]
include::modules/cluster-autoscaler-about.adoc[leveloffset=+1]
include::modules/cluster-autoscaler-cr.adoc[leveloffset=+2]
:FeatureName: cluster autoscaler
:FeatureResourceName: ClusterAutoscaler
include::modules/deploying-resource.adoc[leveloffset=+2]
[id="custer-tasks-applying-autoscaling"]
== Applying autoscaling to your cluster

2
rosa_architecture/about-hcp.adoc
View File

@@ -260,4 +260,4 @@ For additional information about ROSA installation, see link:https://www.redhat.
* link:https://www.openshift.com/products/amazon-openshift[ROSA product page]
* link:https://aws.amazon.com/rosa/[AWS product page]
* link:https://access.redhat.com/products/red-hat-openshift-service-aws[Red{nbsp}Hat Customer Portal]
* link:https://learn.openshift.com[Learn about OpenShift]
* link:https://learn.openshift.com[Learn about OpenShift]

2
rosa_architecture/index.adoc
View File

@@ -272,8 +272,6 @@ Use the Cluster Version Operator (CVO) to upgrade your {product-title} cluster.
=== Observe a cluster
- **xref:../observability/logging/cluster-logging.adoc#cluster-logging[OpenShift Logging]**: Learn about logging and configure different logging components, such as log storage, log collectors, and the logging web console plugin.
- **xref:../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distr-tracing-architecture[Red Hat OpenShift distributed tracing platform]**: Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use the distributed tracing platform for monitoring distributed transactions, gathering insights into your instrumented services, network profiling, performance and latency optimization, root cause analysis, and troubleshooting the interaction between components in modern cloud-native microservices-based applications.
// xreffing to the installation page until further notice because OTEL content is currently planned for internal restructuring across pages that is likely to result in renamed page files

2
rosa_architecture/learn_more_about_openshift.adoc
View File

@@ -47,7 +47,6 @@ Use the following sections to find content to help you learn about and use {prod
| xref:../architecture/architecture.adoc#architecture[Architecture]
| xref:../machine_configuration/index.adoc#machine-config-overview[Machine configuration overview]
| xref:../observability/logging/cluster-logging.adoc#cluster-logging[Logging]
| link:https://access.redhat.com/articles/4217411[OpenShift Knowledgebase articles]
| link:https://learn.openshift.com/?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[OpenShift Interactive Learning Portal]
@@ -88,7 +87,6 @@ Use the following sections to find content to help you learn about and use {prod
| link:https://access.redhat.com/articles/4217411[OpenShift Knowledgebase articles]
|
| xref:../observability/logging/cluster-logging.adoc#cluster-logging[Logging]
| link:https://access.redhat.com/support/policy/updates/openshift#ocp4_phases[{product-title} Life Cycle]
|

5
scalability_and_performance/optimization/optimizing-storage.adoc
View File

@@ -31,8 +31,3 @@ include::modules/recommended-configurable-storage-technology.adoc[leveloffset=+1
include::modules/data-storage-management.adoc[leveloffset=+1]
include::modules/optimizing-storage-azure.adoc[leveloffset=+1]
[role="_additional-resources"]
[id="admission-plug-ins-additional-resources"]
== Additional resources
* xref:../../observability/logging/log_storage/logging-config-es-store.adoc#logging-config-es-store[Configuring the Elasticsearch log store]

2
security/audit-log-view.adoc
View File

@@ -33,5 +33,3 @@ ifndef::openshift-rosa,openshift-dedicated[]
* link:https://github.com/kubernetes/apiserver/blob/master/pkg/apis/audit/v1/types.go#L72[API audit log event structure]
* xref:../security/audit-log-policy-config.adoc#audit-log-policy-config[Configuring the audit log policy]
endif::[]
* xref:../observability/logging/log_collection_forwarding/log-forwarding.adoc#log-forwarding[About log forwarding]
endif::openshift-rosa-hcp[]

2
security/container_security/security-monitoring.adoc
View File

@@ -25,5 +25,5 @@ include::modules/security-monitoring-audit-logging.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../../nodes/clusters/nodes-containers-events.adoc#nodes-containers-events[List of system events]
* xref:../../observability/logging/cluster-logging.adoc#cluster-logging[Understanding OpenShift Logging]
//* xref :../../observability/logging/cluster-logging.adoc#cluster-logging[Understanding OpenShift Logging]
* xref:../../security/audit-log-view.adoc#audit-log-view[Viewing audit logs]

4
service_mesh/v1x/ossm-custom-resources.adoc
View File

@@ -41,8 +41,4 @@ include::modules/ossm-jaeger-config-elasticsearch-v1x.adoc[leveloffset=+2]
include::modules/ossm-jaeger-config-es-cleaner-v1x.adoc[leveloffset=+2]
ifdef::openshift-enterprise[]
For more information about configuring Elasticsearch with {product-title}, see xref:../../observability/logging/log_storage/logging-config-es-store.adoc#logging-config-es-store[Configuring the Elasticsearch log store].
endif::[]
include::modules/ossm-cr-threescale.adoc[leveloffset=+1]

4
service_mesh/v1x/preparing-ossm-installation.adoc
View File

@@ -40,10 +40,6 @@ include::modules/ossm-supported-configurations-v1x.adoc[leveloffset=+1]
include::modules/ossm-installation-activities.adoc[leveloffset=+1]
ifdef::openshift-enterprise[]
[WARNING]
====
See xref:../../observability/logging/log_storage/logging-config-es-store.adoc#logging-config-es-store[Configuring the Elasticsearch log store] for details on configuring the default Jaeger parameters for Elasticsearch in a production environment.
====
== Next steps

2
service_mesh/v2x/ossm-reference-jaeger.adoc
View File

@@ -44,7 +44,7 @@ include::modules/distr-tracing-config-sampling.adoc[leveloffset=+2]
include::modules/distr-tracing-config-storage.adoc[leveloffset=+2]
ifdef::openshift-enterprise[]
For more information about configuring Elasticsearch with {product-title}, see xref:../../observability/logging/log_storage/logging-config-es-store.adoc#logging-config-es-store[Configuring the Elasticsearch log store] or xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-jaeger-configuring[Configuring and deploying distributed tracing].
For more information about configuring Elasticsearch with {product-title}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-jaeger-configuring[Configuring and deploying {DTShortName}].
//TO DO For information about connecting to an external Elasticsearch instance, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#jaeger-config-external-es_jaeger-deploying[Connecting to an existing Elasticsearch instance].
endif::[]

17
support/index.adoc
View File

@@ -122,14 +122,15 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
** Investigate why user-defined metrics are unavailable.
** Determine why Prometheus is consuming a lot of disk space.
// TODO: Include this in ROSA HCP when the Logging book is migrated.
ifndef::openshift-rosa-hcp[]
* xref:../observability/logging/cluster-logging.adoc#cluster-logging[Logging issues]: A cluster administrator can follow the procedures in the "Support" and "Troubleshooting logging" sections to resolve logging issues:
////
----
* xref :../observability/logging/cluster-logging.adoc#cluster-logging[Logging issues]: A cluster administrator can follow the procedures in the "Support" and "Troubleshooting logging" sections to resolve logging issues:
** xref:../observability/logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-clo-status_cluster-logging-cluster-status[Viewing the status of the {clo}]
** xref:../observability/logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-clo-status-comp_cluster-logging-cluster-status[Viewing the status of {logging} components]
** xref:../observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc#troubleshooting-logging-alerts[Troubleshooting logging alerts]
** xref:../observability/logging/cluster-logging-support.adoc#cluster-logging-must-gather-collecting_cluster-logging-support[Collecting information about your logging environment by using the `oc adm must-gather` command]
endif::openshift-rosa-hcp[]
** xref :../observability/logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-clo-status_cluster-logging-cluster-status[Viewing the status of the {clo}]
** xref :../observability/logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-clo-status-comp_cluster-logging-cluster-status[Viewing the status of {logging} components]
** xref :../observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc#troubleshooting-logging-alerts[Troubleshooting logging alerts]
** xref :../observability/logging/cluster-logging-support.adoc#cluster-logging-must-gather-collecting_cluster-logging-support[Collecting information about your logging environment by using the `oc adm must-gather` command]
----
////
* xref:../support/troubleshooting/diagnosing-oc-issues.adoc#diagnosing-oc-issues[{oc-first} issues]: Investigate {oc-first} issues by increasing the log level.

4
virt/support/virt-troubleshooting.adoc
View File

@@ -83,8 +83,8 @@ include::modules/virt-loki-log-queries.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources for LokiStack and LogQL
* xref:../../observability/logging/log_storage/about-log-storage.adoc#about-log-storage[About log storage]
* xref:../../observability/logging/log_storage/installing-log-storage.adoc#cluster-logging-loki-deploy_installing-log-storage[Deploying the LokiStack]
//* xref :../../observability/logging/log_storage/about-log-storage.adoc#about-log-storage[About log storage]
//* xref :../../observability/logging/log_storage/installing-log-storage.adoc#cluster-logging-loki-deploy_installing-log-storage[Deploying the LokiStack]
* link:https://grafana.com/docs/loki/latest/logql/log_queries/[LogQL log queries] in the Grafana documentation
include::modules/virt-common-error-messages.adoc[leveloffset=+1]

2
welcome/about-hcp.adoc
View File

@@ -53,7 +53,7 @@ Use the following sections to find content to help you learn about and use {hcp-
| xref:../architecture/rosa-architecture-models.adoc#rosa-architecture-models[{hcp-title} architecture]
| xref:../rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc#rosa-hcp-sts-creating-a-cluster-quickly[Installing {hcp-title}]
| xref:../observability/logging/cluster-logging.adoc#cluster-logging[Logging]
// | xref :../observability/logging/cluster-logging.adoc#cluster-logging[Logging]
| xref:../support/index.adoc#support-overview[Getting Support]
| link:https://learn.openshift.com/?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[OpenShift Interactive Learning Portal]

12
welcome/learn_more_about_openshift.adoc
View File

@@ -211,8 +211,8 @@ a|* xref:../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-cr
|===
|Learn about {product-title} |Optional additional resources
| xref:../observability/logging/cluster-logging.adoc#cluster-logging[OpenShift Logging]
| xref:../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[Logging UI pluigin]
// | //xref :../observability/logging/cluster-logging.adoc#cluster-logging[OpenShift Logging]
// |
| xref:../observability/distr_tracing/distr-tracing-rn.adoc#distr-tracing-rn[Release notes for the {DTProductName}]
| xref:../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distr-tracing-architecture[{jaegername}]
@@ -256,7 +256,11 @@ a| * xref:../storage/understanding-persistent-storage.adoc#understanding-persist
| xref:../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[Operators]
| xref:../operators/operator-reference.adoc#cluster-operator-reference[Cluster Operator reference]
| xref:../observability/logging/cluster-logging.adoc#cluster-logging[Logging]
|
// | xref :../observability/logging/cluster-logging.adoc#cluster-logging[Logging]
| link:https://access.redhat.com/support/policy/updates/openshift#ocp4_phases[{product-title} Life Cycle]
|
| link:https://www.openshift.com/blog/tag/logging[Blogs about logging]
|===
@@ -335,4 +339,4 @@ a| * xref:../hosted_control_planes/hcp-disconnected/hcp-deploy-dc-bm.adoc#hcp-de
| xref:../hosted_control_planes/hcp-troubleshooting.adoc#hcp-troubleshooting[Troubleshooting {hcp}]
a| xref:../hosted_control_planes/hcp-troubleshooting.adoc#hosted-control-planes-troubleshooting_hcp-troubleshooting[Gathering information to troubleshoot {hcp}]
|===
|===