OSDOCS-3397: Logging book port to OSD/ROSA

adellape · Jan 25, 2023 · ecb1eac · ecb1eac
1 parent fcdecec
commit ecb1eac
Show file tree

Hide file tree

Showing 48 changed files with 522 additions and 284 deletions.
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -251,6 +251,79 @@ Topics:
     - Name: Configuring custom domains for applications
       File: osd-config-custom-domains-applications
 ---
+Name: Logging
+Dir: logging
+Distros: openshift-dedicated
+Topics:
+- Name: Release notes
+  File: cluster-logging-release-notes
+- Name: About Logging
+  File: cluster-logging
+- Name: Installing Logging
+  File: cluster-logging-deploying
+- Name: Accessing the service logs
+  File: sd-accessing-the-service-logs
+- Name: Configuring your Logging deployment
+  Dir: config
+  Topics:
+  - Name: About the Cluster Logging custom resource
+    File: cluster-logging-configuring-cr
+  - Name: Configuring the logging collector
+    File: cluster-logging-collector
+  - Name: Configuring the log store
+    File: cluster-logging-log-store
+  - Name: Configuring the log visualizer
+    File: cluster-logging-visualizer
+  - Name: Configuring Logging storage
+    File: cluster-logging-storage-considerations
+  - Name: Configuring CPU and memory limits for Logging components
+    File: cluster-logging-memory
+  - Name: Using tolerations to control Logging pod placement
+    File: cluster-logging-tolerations
+  - Name: Moving the Logging resources with node selectors
+    File: cluster-logging-moving-nodes
+  - Name: Configuring systemd-journald and Fluentd
+    File: cluster-logging-systemd
+  - Name: Maintenance and support
+    File: cluster-logging-maintenance-support
+- Name: Logging with the LokiStack
+  File: cluster-logging-loki
+- Name: Viewing logs for a specific resource
+  File: viewing-resource-logs
+- Name: Viewing cluster logs in Kibana
+  File: cluster-logging-visualizer
+  Distros: openshift-dedicated
+- Name: Forwarding logs to third party systems
+  File: cluster-logging-external
+- Name: Enabling JSON logging
+  File: cluster-logging-enabling-json-logging
+- Name: Collecting and storing Kubernetes events
+  File: cluster-logging-eventrouter
+# - Name: Forwarding logs using ConfigMaps
+#  File: cluster-logging-external-configmap
+#  Distros: openshift-dedicated
+- Name: Updating Logging
+  File: cluster-logging-upgrading
+- Name: Viewing cluster dashboards
+  File: cluster-logging-dashboards
+- Name: Troubleshooting Logging
+  Dir: troubleshooting
+  Topics:
+  - Name: Viewing Logging status
+    File: cluster-logging-cluster-status
+  - Name: Viewing the status of the log store
+    File: cluster-logging-log-store-status
+  - Name: Understanding Logging alerts
+    File: cluster-logging-alerts
+  - Name: Collecting logging data for Red Hat Support
+    File: cluster-logging-must-gather    
+  - Name: Troubleshooting for Critical Alerts
+    File: cluster-logging-troubleshooting-for-critical-alerts
+- Name: Uninstalling Logging
+  File: cluster-logging-uninstall
+- Name: Exported fields
+  File: cluster-logging-exported-fields
+---
 Name: Serverless
 Dir: serverless
 Distros: openshift-dedicated

diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -212,16 +212,6 @@ Topics:
     Distros: openshift-rosa
   - Name: About autoscaling nodes on a cluster
     File: rosa-nodes-about-autoscaling-nodes
-- Name: Logging
-  Dir: rosa_logging
-  Distros: openshift-rosa
-  Topics:
-  - Name: Accessing the service logs
-    File: rosa-accessing-the-service-logs
-  - Name: Installing the CloudWatch logging service
-    File: rosa-install-logging
-  - Name: Viewing cluster logs in the AWS Console
-    File: rosa-viewing-logs
 - Name: Monitoring user-defined projects
   Dir: rosa_monitoring
   Distros: openshift-rosa
@@ -365,6 +355,79 @@ Topics:
 # - Name: Using the internal registry
 #   File: rosa-using-internal-registry
 ---
+Name: Logging
+Dir: logging
+Distros: openshift-rosa
+Topics:
+- Name: Release notes
+  File: cluster-logging-release-notes
+- Name: About Logging
+  File: cluster-logging
+- Name: Installing Logging
+  File: cluster-logging-deploying
+- Name: Accessing the service logs
+  File: sd-accessing-the-service-logs
+- Name: Viewing cluster logs in the AWS Console
+  File: rosa-viewing-logs
+- Name: Configuring your Logging deployment
+  Dir: config
+  Topics:
+  - Name: About the Cluster Logging custom resource
+    File: cluster-logging-configuring-cr
+  - Name: Configuring the logging collector
+    File: cluster-logging-collector
+  - Name: Configuring the log store
+    File: cluster-logging-log-store
+  - Name: Configuring the log visualizer
+    File: cluster-logging-visualizer
+  - Name: Configuring Logging storage
+    File: cluster-logging-storage-considerations
+  - Name: Configuring CPU and memory limits for Logging components
+    File: cluster-logging-memory
+  - Name: Using tolerations to control Logging pod placement
+    File: cluster-logging-tolerations
+  - Name: Moving the Logging resources with node selectors
+    File: cluster-logging-moving-nodes
+  - Name: Configuring systemd-journald and Fluentd
+    File: cluster-logging-systemd
+  - Name: Maintenance and support
+    File: cluster-logging-maintenance-support
+- Name: Logging with the LokiStack
+  File: cluster-logging-loki
+- Name: Viewing logs for a specific resource
+  File: viewing-resource-logs
+- Name: Viewing cluster logs in Kibana
+  File: cluster-logging-visualizer
+- Name: Forwarding logs to third party systems
+  File: cluster-logging-external
+- Name: Enabling JSON logging
+  File: cluster-logging-enabling-json-logging
+- Name: Collecting and storing Kubernetes events
+  File: cluster-logging-eventrouter
+# - Name: Forwarding logs using ConfigMaps
+#  File: cluster-logging-external-configmap
+- Name: Updating Logging
+  File: cluster-logging-upgrading
+- Name: Viewing cluster dashboards
+  File: cluster-logging-dashboards
+- Name: Troubleshooting Logging
+  Dir: troubleshooting
+  Topics:
+  - Name: Viewing Logging status
+    File: cluster-logging-cluster-status
+  - Name: Viewing the status of the log store
+    File: cluster-logging-log-store-status
+  - Name: Understanding Logging alerts
+    File: cluster-logging-alerts
+  - Name: Collecting logging data for Red Hat Support
+    File: cluster-logging-must-gather
+  - Name: Troubleshooting for Critical Alerts
+    File: cluster-logging-troubleshooting-for-critical-alerts
+- Name: Uninstalling Logging
+  File: cluster-logging-uninstall
+- Name: Exported fields
+  File: cluster-logging-exported-fields
+---
 Name: Service Mesh
 Dir: service_mesh
 Distros: openshift-rosa

diff --git a/adding_service_cluster/adding-service.adoc b/adding_service_cluster/adding-service.adoc
@@ -25,5 +25,5 @@ include::modules/deleting-service.adoc[leveloffset=+1]
 ifdef::openshift-rosa[]
 [role="_additional-resources"]
 == Additional resources
-* For information about the `cluster-logging-operator` and the AWS CloudWatch log forwarding service, see xref:../rosa_cluster_admin/rosa_logging/rosa-install-logging.adoc#rosa-install-logging[Install the logging add-on service]
+* For information about the `cluster-logging-operator` and the AWS CloudWatch log forwarding service, see xref:../logging/cluster-logging-external.adoc#cluster-logging-collector-log-forward-cloudwatch_cluster-logging-external[Forwarding logs to Amazon CloudWatch]
 endif::[]
diff --git a/adding_service_cluster/rosa-available-services.adoc b/adding_service_cluster/rosa-available-services.adoc
@@ -16,7 +16,7 @@ include::modules/aws-cloudwatch.adoc[leveloffset=+1]
 .Additional resources
 
 * link:https://aws.amazon.com/cloudwatch/[Amazon CloudWatch product information]
-* xref:../rosa_cluster_admin/rosa_logging/rosa-install-logging.adoc#rosa-install-logging[Installing the CloudWatch logging service]
+* xref:../logging/cluster-logging-external.adoc#cluster-logging-collector-log-forward-cloudwatch_cluster-logging-external[Forwarding logs to Amazon CloudWatch]
 
 include::modules/osd-rhoam.adoc[leveloffset=+1]
 

diff --git a/logging/cluster-logging-dashboards.adoc b/logging/cluster-logging-dashboards.adoc
@@ -1,12 +1,20 @@
 :_content-type: ASSEMBLY
-:context: cluster-logging-dashboards
+include::_attributes/common-attributes.adoc[]
+include::_attributes/attributes-openshift-dedicated.adoc[]
 [id="cluster-logging-dashboards"]
 = Viewing cluster dashboards
-include::_attributes/common-attributes.adoc[]
+:context: cluster-logging-dashboards
 
 toc::[]
 
-The *Logging/Elasticsearch Nodes* and *Openshift Logging* dashboards in the {product-title} web console show in-depth details about your Elasticsearch instance and the individual Elasticsearch nodes that you can use to prevent and diagnose problems.
+The *Logging/Elasticsearch Nodes* and *Openshift Logging* dashboards in the 
+ifndef::openshift-rosa,openshift-dedicated[]
+{product-title} web console 
+endif::[]
+ifdef::openshift-rosa,openshift-dedicated[]
+{cluster-manager-url} 
+endif::[]
+contain in-depth details about your Elasticsearch instance and the individual Elasticsearch nodes that you can use to prevent and diagnose problems.
 
 The *OpenShift Logging* dashboard contains charts that show details about your Elasticsearch instance at a cluster level, including cluster resources, garbage collection, shards in the cluster, and Fluentd statistics.
 

diff --git a/logging/cluster-logging-deploying.adoc b/logging/cluster-logging-deploying.adoc
@@ -3,17 +3,21 @@
 [id="cluster-logging-deploying"]
 = Installing the {logging-title}
 include::_attributes/common-attributes.adoc[]
+include::_attributes/attributes-openshift-dedicated.adoc[]
 
 toc::[]
 
-
 You can install the {logging-title} by deploying the OpenShift Elasticsearch and Red Hat OpenShift Logging Operators. The OpenShift Elasticsearch Operator creates and manages the Elasticsearch cluster used by OpenShift Logging. The {logging} Operator creates and manages the components of the logging stack.
 
-The process for deploying the {logging} to {product-title} involves:
+The process for deploying the {logging} to {product-title} 
+ifdef::openshift-rosa[]
+(ROSA)
+endif::[]
+ involves:
 
 * Reviewing the xref:../logging/config/cluster-logging-storage-considerations#cluster-logging-storage[{logging-uc} storage considerations].
 
-* Installing the OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator using the {product-title} xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-console_cluster-logging-deploying[web console] or xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-cli_cluster-logging-deploying[CLI].
+* Installing the logging subsystem for {product-title} using xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-console_cluster-logging-deploying[the web console] or xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploy-cli_cluster-logging-deploying[the CLI].
 
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference
@@ -25,7 +29,14 @@ include::modules/cluster-logging-deploy-console.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
+ifdef::openshift-enterprise,openshift-origin[]
 * xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub]
+* xref:../logging/config/cluster-logging-collector.adoc#cluster-logging-removing-unused-components-if-no-elasticsearch_cluster-logging-collector[Removing unused components if you do not use the default Elasticsearch log store]
+endif::[]
+ifdef::openshift-rosa,openshift-dedicated[]
+* link:https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html[Installing Operators from OperatorHub]
+* link:https://docs.openshift.com/container-platform/latest/logging/config/cluster-logging-collector.html#cluster-logging-removing-unused-components-if-no-elasticsearch_cluster-logging-collector[Removing unused components if you do not use the default Elasticsearch log store]
+endif::[]
 
 == Post-installation tasks
 
@@ -49,10 +60,16 @@ include::modules/cluster-logging-deploy-multitenant.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
 
+ifdef::openshift-enterprise,openshift-origin[]
 * xref:../networking/network_policy/about-network-policy.adoc[About network policy]
-* xref:../networking/openshift_sdn/about-openshift-sdn.adoc[About the OpenShift SDN network plugin]
-* xref:../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc[About the OVN-Kubernetes network plugin]
-
+* xref:../networking/openshift_sdn/about-openshift-sdn.adoc[About the OpenShift SDN default CNI network provider]
+* xref:../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc[About the OVN-Kubernetes default Container Network Interface (CNI) network provider]
+endif::[]
+ifdef::openshift-rosa,openshift-dedicated[]
+* link:https://docs.openshift.com/container-platform/latest/networking/network_policy/about-network-policy.html[About network policy]
+* link:https://docs.openshift.com/container-platform/latest/networking/openshift_sdn/about-openshift-sdn.html[About the OpenShift SDN default CNI network provider]
+* link:https://docs.openshift.com/container-platform/latest/networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.html[About the OVN-Kubernetes default Container Network Interface (CNI) network provider]
+endif::[]
 
 // include::modules/cluster-logging-deploy-memory.adoc[leveloffset=+1]
 

diff --git a/logging/cluster-logging-exported-fields.adoc b/logging/cluster-logging-exported-fields.adoc
@@ -1,8 +1,9 @@
 :_content-type: ASSEMBLY
-:context: cluster-logging-exported-fields
 [id="cluster-logging-exported-fields"]
 = Log Record Fields
 include::_attributes/common-attributes.adoc[]
+include::_attributes/attributes-openshift-dedicated.adoc[]
+:context: cluster-logging-exported-fields
 
 toc::[]