Merge pull request #44904 from libander/RHDEVDOCS-3797-rename

RHDEVDOCS-3797 - Logging Name Change w/ Peer Review Edits v3

Author: JStickler

logging/cluster-logging-deploying.adoc

@@ -1,20 +1,17 @@
 :_content-type: ASSEMBLY
 :context: cluster-logging-deploying
 [id="cluster-logging-deploying"]
-= Installing OpenShift Logging
+= Installing the {logging-title}
 include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
 
-You can install OpenShift Logging 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 Red Hat OpenShift Logging Operator creates and manages the components of the logging stack.
+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 OpenShift Logging to {product-title} involves:
+The process for deploying the {logging} to {product-title} involves:
 
-* Reviewing the xref:../logging/config/cluster-logging-storage-considerations#cluster-logging-storage[OpenShift Logging storage considerations].
+* 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].
 
@@ -34,7 +31,7 @@ include::modules/cluster-logging-deploy-console.adoc[leveloffset=+1]
 
 If you plan to use Kibana, you must xref:#cluster-logging-visualizer-indices_cluster-logging-deploying[manually create your Kibana index patterns and visualizations] to explore and visualize data in Kibana.
 
-If your cluster network provider enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the OpenShift Logging operators].
+If your cluster network provider enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the {logging} Operators].
 
 
 include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+1]
@@ -43,7 +40,7 @@ include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+1]
 
 If you plan to use Kibana, you must xref:#cluster-logging-visualizer-indices_cluster-logging-deploying[manually create your Kibana index patterns and visualizations] to explore and visualize data in Kibana.
 
-If your cluster network provider enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the OpenShift Logging operators].
+If your cluster network provider enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the {logging} Operators].
 
 include::modules/cluster-logging-visualizer-indices.adoc[leveloffset=+2]
 

logging/cluster-logging-eventrouter.adoc

@@ -6,9 +6,9 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-The {product-title} Event Router is a pod that watches Kubernetes events and logs them for collection by OpenShift Logging. You must manually deploy the Event Router.
+The {product-title} Event Router is a pod that watches Kubernetes events and logs them for collection by the {logging}. You must manually deploy the Event Router.
 
-The Event Router collects events from all projects and writes them to `STDOUT`. Fluentd collects those events and forwards them into the {product-title} Elasticsearch instance. Elasticsearch indexes the events to the `infra` index.
+The Event Router collects events from all projects and writes them to `STDOUT`. The collector then forwards those events to the store defined in the `ClusterLogForwarder` custom resource (CR).
 
 [IMPORTANT]
 ====

logging/cluster-logging-exported-fields.adoc

@@ -6,12 +6,14 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-The following fields can be present in log records exported by OpenShift Logging. Although log records are typically formatted as JSON objects, the same data model can be applied to other encodings.
+The following fields can be present in log records exported by the {logging}. Although log records are typically formatted as JSON objects, the same data model can be applied to other encodings.
 
 To search these fields from Elasticsearch and Kibana, use the full dotted field name when searching. For example, with an Elasticsearch */_search URL*, to look for a Kubernetes pod name, use `/_search/q=kubernetes.pod_name:name-of-my-pod`.
 
 // The logging system can parse JSON-formatted log entries to external systems. These log entries are formatted as a fluentd message with extra fields such as `kubernetes`. The fields exported by the logging system and available for searching from Elasticsearch and Kibana are documented at the end of this document.
 
 include::modules/cluster-logging-exported-fields-top-level-fields.adoc[leveloffset=0]
+
 include::modules/cluster-logging-exported-fields-kubernetes.adoc[leveloffset=0]
+
 // add modules/cluster-logging-exported-fields-openshift when available

logging/cluster-logging-external.adoc

@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-By default, OpenShift Logging sends container and infrastructure logs to the default internal Elasticsearch log store defined in the `ClusterLogging` custom resource. However, it does not send audit logs to the internal store because it does not provide secure storage. If this default configuration meets your needs, you do not need to configure the Cluster Log Forwarder.
+By default, the {logging} sends container and infrastructure logs to the default internal Elasticsearch log store defined in the `ClusterLogging` custom resource. However, it does not send audit logs to the internal store because it does not provide secure storage. If this default configuration meets your needs, you do not need to configure the Cluster Log Forwarder.
 
 To send logs to other log aggregators, you use the {product-title} Cluster Log Forwarder. This API enables you to send container, infrastructure, and audit logs to specific endpoints within or outside your cluster. In addition, you can send different types of logs to various systems so that various individuals can access each type. You can also enable Transport Layer Security (TLS) support to send logs securely, as required by your organization.
 
@@ -15,7 +15,7 @@ To send logs to other log aggregators, you use the {product-title} Cluster Log F
 To send audit logs to the default internal Elasticsearch log store, use the Cluster Log Forwarder as described in xref:../logging/config/cluster-logging-log-store.adoc#cluster-logging-elasticsearch-audit_cluster-logging-store[Forward audit logs to the log store].
 ====
 
-When you forward logs externally, the Red Hat OpenShift Logging Operator creates or modifies a Fluentd config map to send logs using your desired protocols. You are responsible for configuring the protocol on the external log aggregator.
+When you forward logs externally, the {logging} creates or modifies a Fluentd config map to send logs using your desired protocols. You are responsible for configuring the protocol on the external log aggregator.
 
 [IMPORTANT]
 ====

logging/cluster-logging-release-notes.adoc

@@ -8,9 +8,9 @@ toc::[]
 
 include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1]
 
-[id="cluster-logging-supported-versions"]
-== Supported Versions
-include::modules/cluster-logging-supported-versions.adoc[leveloffset=+1]
+[id="cluster-logging-ocp-compatibility"]
+= {product-title} compatibility
+The {logging-title} is provided as an installable component, with a distinct release cycle from the core {product-title}. The link:https://access.redhat.com/support/policy/updates/openshift#logging[Red Hat OpenShift Container Platform Life Cycle Policy] outlines release compatibility.
 
 // Release Notes by version
 [id="cluster-logging-release-notes-5-3-0"]

logging/cluster-logging-uninstall.adoc

@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-You can remove OpenShift Logging from your {product-title} cluster.
+You can remove the {logging} from your {product-title} cluster.
 
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference

logging/cluster-logging-upgrading.adoc

@@ -6,14 +6,9 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-.{product-title} version support for Red Hat OpenShift Logging (RHOL)
-[options="header"]
-|====
-|        |4.7          |4.8          |4.9
-|RHOL 5.0|X            |X            |
-|RHOL 5.1|X            |X            |
-|RHOL 5.2|X            |X            |X
-|====
+[id="cluster-logging-supported-versions"]
+== Supported Versions
+For version compatibility and support information, see link:https://access.redhat.com/support/policy/updates/openshift#logging[Red Hat OpenShift Container Platform Life Cycle Policy]
 
 To upgrade from cluster logging in {product-title} version 4.6 and earlier to OpenShift Logging 5.x, you update the {product-title} cluster to version 4.7 or 4.8. Then, you update the following operators:
 
@@ -23,4 +18,5 @@ To upgrade from cluster logging in {product-title} version 4.6 and earlier to Op
 To upgrade from a previous version of OpenShift Logging to the current version, you update OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator to their current versions.
 
 include::modules/cluster-logging-updating-logging-to-5-0.adoc[leveloffset=+1]
+
 include::modules/cluster-logging-updating-logging-to-5-1.adoc[leveloffset=+1]

logging/cluster-logging-visualizer.adoc

@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-OpenShift Logging includes a web console for visualizing collected log data. Currently, {product-title} deploys the Kibana console for visualization.
+The {logging} includes a web console for visualizing collected log data. Currently, {product-title} deploys the Kibana console for visualization.
 
 Using the log visualizer, you can do the following with your data:
 
@@ -15,7 +15,7 @@ Using the log visualizer, you can do the following with your data:
 * create and view custom dashboards using the *Dashboard* tab.
 
 Use and configuration of the Kibana interface is beyond the scope of this documentation. For more information,
-on using the interface, see the link:https://www.elastic.co/guide/en/kibana/6.8/connect-to-elasticsearch.html[Kibana documentation]. 
+on using the interface, see the link:https://www.elastic.co/guide/en/kibana/6.8/connect-to-elasticsearch.html[Kibana documentation].
 
 [NOTE]
 ====
@@ -29,5 +29,3 @@ The audit logs are not stored in the internal {product-title} Elasticsearch inst
 
 include::modules/cluster-logging-visualizer-indices.adoc[leveloffset=+1]
 include::modules/cluster-logging-visualizer-kibana.adoc[leveloffset=+1]
-
-

logging/cluster-logging.adoc

@@ -1,19 +1,19 @@
 :_content-type: ASSEMBLY
 :context: cluster-logging
 [id="cluster-logging"]
-= Understanding Red Hat OpenShift Logging
+= Understanding the {logging-title}
 include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
 
 
 ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
-As a cluster administrator, you can deploy OpenShift Logging to
+As a cluster administrator, you can deploy the {logging} to
 aggregate all the logs from your {product-title} cluster, such as node system audit logs, application container logs, and infrastructure logs.
-OpenShift Logging aggregates these logs from throughout your cluster and stores them in a default log store. You can xref:../logging/cluster-logging-visualizer.adoc#cluster-logging-visualizer[use the Kibana web console to visualize log data].
+The {logging} aggregates these logs from throughout your cluster and stores them in a default log store. You can xref:../logging/cluster-logging-visualizer.adoc#cluster-logging-visualizer[use the Kibana web console to visualize log data].
 
-OpenShift Logging aggregates the following types of logs:
+The {logging} aggregates the following types of logs:
 
 * `application` - Container logs generated by user applications running in the cluster, except infrastructure container applications.
 * `infrastructure` - Logs generated by infrastructure components running in the cluster and {product-title} nodes, such as journal logs. Infrastructure components are pods that run in the `openshift*`, `kube*`, or `default` projects.

logging/config/cluster-logging-collector.adoc

@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-{product-title} uses Fluentd to collect operations and application logs from your cluster and enriches the data with Kubernetes pod and project metadata.
+{logging-title-uc} collects operations and application logs from your cluster and enriches the data with Kubernetes pod and project metadata.
 
 You can configure the CPU and memory limits for the log collector and xref:../../logging/config/cluster-logging-moving-nodes.adoc#cluster-logging-moving[move the log collector pods to specific nodes]. All supported modifications to the log collector can be performed though the `spec.collection.log.fluentd` stanza in the `ClusterLogging` custom resource (CR).