Merge pull request #13877 from mburke5678/logging-team-edits

 Edits to Logging 4.0 topics per team review

Author: mburke5678

_topic_map.yml

@@ -431,7 +431,7 @@ Distros: openshift-*
 Topics:
 - Name: About cluster logging
   File: efk-logging
-- Name: Deploying EFK stack
+- Name: Deploying cluster logging
   File: efk-logging-deploy
 - Name: Configuring cluster logging
   File: efk-logging-configuring
@@ -451,11 +451,11 @@ Topics:
   File: efk-logging-external
 - Name: Manually rolling out Elasticsearch
   File: efk-logging-manual-rollout
-- Name: Troubleshooting Kubernetes
+- Name: Troubleshooting Kibana
   File: efk-logging-troubleshooting
 - Name: Exported fields
   File: efk-logging-exported-fields
-- Name: Uninstalling the EFK stack
+- Name: Uninstalling cluster logging
   File: efk-logging-uninstall
 ---
 Name: CLI reference

logging/efk-logging-configuring.adoc

@@ -6,27 +6,27 @@ include::modules/common-attributes.adoc[]
 toc::[]
 
 Cluster logging is configurable using a Cluster Logging Custom Resource (CR) deployed
-in the **openshift-logging** namespace.
+in the `openshift-logging` project. 
 
-The Cluster Logging Operator watches for changes in the Cluster Logging CR 
-and adjusts the logging deployment accordingly.
+The Cluster Logging Operator watches for changes to xref:efk-logging-configuring-about-sample#efk-logging-configuring[Cluster Logging CRs], 
+creates any missing logging components, and adjusts the logging deployment accordingly.
 
 The Cluster Logging CR is based on the Cluster Logging Custom Resource Definition (CRD), which defines a complete cluster logging deployment
 and includes all the components of the logging stack to collect, store and visualize logs.
 
-.Sample Cluster Logging Custom Resource Definition (CRD)
+.Sample Cluster Logging Custom Resource (CR)
 [source,yaml]
 ----
 apiVersion: "logging.openshift.io/v1alpha1"
 kind: "ClusterLogging"
 metadata:
-  name: "example"
+  name: "instance"
 spec:
   managementState: "Managed"
   logStore:
     type: "elasticsearch"
     elasticsearch:
-      nodeCount: 1
+      nodeCount: 3
       storage: {}
       redundancyPolicy: "SingleRedundancy"
   visualization:
@@ -43,22 +43,25 @@ spec:
       fluentd: {}
 ----
 
-You can configure the following components of cluster logging:
+You can configure the following for cluster logging:
 
 * You can place cluster logging into an unmanaged state that allows an administrator to assume full control of individual
 component configurations and upgrades.
 
 * You can overwrite the image for each cluster logging component by modifying the appropriate
 environment variable in the `cluster-logging-operator` Deployment.
 
-* You can specify specific nodes for the logging components.
+* You can specify specific nodes for the logging components using node selectors.
 
+////
+4.1
 * You can specify the Log collectors to deploy to each node in a cluster, either Fluentd or Rsyslog.
 
 [IMPORTANT]
 ====
 The Rsyslog log collector is currently a Technology Preview feature.
 ====
+////
 
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference
@@ -69,6 +72,4 @@ include::modules/efk-logging-management-state-changing.adoc[leveloffset=+1]
 
 include::modules/efk-logging-configuring-image-about.adoc[leveloffset=+1]
 
-include::modules/efk-logging-configuring-image.adoc[leveloffset=+2]
-
 include::modules/efk-logging-configuring-node-selector.adoc[leveloffset=+1]

logging/efk-logging-curator.adoc

@@ -5,8 +5,7 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-As an administrator, you can use the built-in Elasticsearch Curator tool to configure scheduled Elasticsearch maintenance operations
-to be performed automatically on a per-project basis. Curator performs actions daily based on its configuration. Only one Curator Pod is
+The Elasticsearch Curator tool performs scheduled maintenance operations on a per-project basis. Curator performs actions daily based on its configuration. Only one Curator Pod is
 recommended per Elasticsearch cluster. 
 
 The cluster logging installation creates a Curator configuration map, `curator` in the `openshift-logging` project, which incorporates the Curator configuration file, *_curator5.yaml_* and an {product-title} custom configuration file, *_config.yaml_*. 
@@ -105,6 +104,11 @@ data:
 
 Optionally, you can use the actions file, *_actions.yaml_*, directly. Editing this file allows you to use any action that Curator has available to it to be run periodically. However, this is only recommended for advanced users as modifying the file can be destructive to the cluster and can cause removal of required indices/settings from Elasticsearch. Most users only need to modify the Curator configuration map and never edit the *action file*.
 
+[NOTE]
+====
+Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing_efk-logging-configuring[Changing the cluster logging management state].
+====
+
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference
 // modules required to cover the user story. You can also include other

logging/efk-logging-deploy.adoc

@@ -5,9 +5,9 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-The process for deploying the EFK into {prouct-title} involves:
+The process for deploying cluster Logging to {prouct-title} involves:
 
-* Preparing yourself and your environment;
+* Preparing your environment;
 
 * Installing the Cluster Logging subscription using the web console.
 
@@ -16,8 +16,6 @@ The process for deploying the EFK into {prouct-title} involves:
 // modules required to cover the user story. You can also include other
 // assemblies.
 
-include::modules/efk-logging-deploy-pre.adoc[leveloffset=+1]
-
 include::modules/efk-logging-deploy-subscription.adoc[leveloffset=+1]
 
 include::modules/efk-logging-deploy-storage-considerations.adoc[leveloffset=+1]
@@ -27,3 +25,9 @@ include::modules/efk-logging-deploy-storage-considerations.adoc[leveloffset=+1]
 // include::modules/efk-logging-deploy-certificates.adoc[leveloffset=+1]
 
 // include::modules/efk-logging-deploy-label.adoc[leveloffset=+1]
+
+== Additional resources
+
+For more information on installing operators,see xref:../applications/operators/olm-adding-operators-to-cluster.html#olm-installing-operators-from-operatorhub-olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub].
+
+For information on scaling your Elasticsearch cluster, see xref:../logging/efk-logging-elasticsearch.adoc#efk-logging-elasticsearch-add-remove_efk-logging-elasticsearch[Scaling your Elasticsearch cluster].

logging/efk-logging-elasticsearch-storage.adoc

@@ -37,14 +37,22 @@ metadata:
             size: "200G"
 ----
 
+[NOTE]
+====
+Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing_efk-logging-configuring[Changing the cluster logging management state].
+====
+
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference
 // modules required to cover the user story. You can also include other
 // assemblies.
 
+include::modules/efk-logging-elasticsearch-storage.adoc[leveloffset=+1]
 
-include::modules/efk-logging-elasticsearch-persistent-storage-persistent.adoc[leveloffset=+1]
+include::modules/efk-logging-elasticsearch-persistent-storage-empty.adoc[leveloffset=+1]
 
-include::modules/efk-logging-elasticsearch-persistent-storage-local.adoc[leveloffset=+1]
+include::modules/efk-logging-elasticsearch-add-remove.adoc[leveloffset=+1]
 
-include::modules/efk-logging-elasticsearch-persistent-storage-empty.adoc[leveloffset=+1]
+include::modules/efk-logging-elasticsearch-exposing.adoc[leveloffset=+1]
+
+include::modules/efk-logging-elasticsearch-rules.adoc[leveloffset=+1]

logging/efk-logging-elasticsearch.adoc

@@ -5,11 +5,23 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-{product-title} uses Elasticsearch (ES) to organize the log data from Fleutnd into datastores, or _indices_.
+{product-title} uses Elasticsearch (ES) to store and organize the log data.
 
 You can add and remove nodes, configure storage for your Elasticsearch cluster, and 
 define how shards are replicated across data nodes in the cluster, from full replication to no replication.
 
+//Following paragraph also in modules/efk-logging-deploy-storage-considerations.adoc
+
+Elasticsearch is a memory-intensive application. Each Elasticsearch node needs 16G of memory for both memory requests and CPU limits 
+unless you specify otherwise the ClusterLogging custom resource. The initial set of {product-title} nodes might not be large enough 
+to support the Elasticsearch cluster. You must add additional nodes to the  {product-title} cluster to run with the recommended
+or higher memory. Each Elasticsearch node can operate with a lower memory setting though this is not recommended for production deployments.
+
+[NOTE]
+====
+Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing_efk-logging-configuring[Changing the cluster logging management state].
+====
+
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference
 // modules required to cover the user story. You can also include other
@@ -21,17 +33,23 @@ include::modules/efk-logging-elasticsearch-ha.adoc[leveloffset=+1]
 
 include::modules/efk-logging-elasticsearch-storage.adoc[leveloffset=+1]
 
-include::modules/efk-logging-elasticsearch-persistent-storage-persistent.adoc[leveloffset=+2]
-
-include::modules/efk-logging-elasticsearch-persistent-storage-persistent-dynamic.adoc[leveloffset=+2]
-
-include::modules/efk-logging-elasticsearch-persistent-storage-local.adoc[leveloffset=+2]
-
-include::modules/efk-logging-elasticsearch-persistent-storage-empty.adoc[leveloffset=+2]
+include::modules/efk-logging-elasticsearch-persistent-storage-empty.adoc[leveloffset=+1]
 
 include::modules/efk-logging-elasticsearch-add-remove.adoc[leveloffset=+1]
 
 include::modules/efk-logging-elasticsearch-exposing.adoc[leveloffset=+1]
 
 include::modules/efk-logging-elasticsearch-rules.adoc[leveloffset=+1]
 
+////
+modules/efk-logging-elasticsearch-persistent-storage-persistent.adoc[leveloffset=+2]
+
+modules/efk-logging-elasticsearch-persistent-storage-persistent-dynamic.adoc[leveloffset=+2]
+
+modules/efk-logging-elasticsearch-persistent-storage-local.adoc[leveloffset=+2]
+////
+
+== Additional Resources
+
+//For information on installing Elasticsearch, see xref:../logging/efk-logging-deploy.adoc[Deploying cluster logging].
+

logging/efk-logging-exported-fields.adoc

@@ -38,7 +38,7 @@ include::modules/efk-logging-exported-fields-systemd.adoc[leveloffset=+1]
 
 include::modules/efk-logging-exported-fields-kubernetes.adoc[leveloffset=+1]
 
-include::modules/efk-logging-exported-fields-docker.adoc[leveloffset=+1]
+include::modules/efk-logging-exported-fields-container.adoc[leveloffset=+1]
 
 include::modules/efk-logging-exported-fields-ovirt.adoc[leveloffset=+1]
 

logging/efk-logging-external.adoc

@@ -8,6 +8,11 @@ toc::[]
 You can send Elasticsearch logs to external devices, such as an externally-hosted Elasticsearch instance
 or an external syslog server. You can also configure Fluentd to send logs to an external log aggregator. 
 
+[NOTE]
+====
+Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing_efk-logging-configuring[Changing the cluster logging management state].
+====
+
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference
 // modules required to cover the user story. You can also include other
@@ -19,5 +24,3 @@ include::modules/efk-logging-external-syslog.adoc[leveloffset=+1]
 
 include::modules/efk-logging-fluentd-external.adoc[leveloffset=+1]
 
-
-

logging/efk-logging-fluentd.adoc

@@ -5,10 +5,15 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-{product-title} uses Fluentd to collect data about your cluster.
+{product-title} uses Fluentd to collect operations and application logs from your cluster which {product-title} enriches with Kubernetes Pod and Namespace metadata.
 
 You can configure log rotation, log location, use an external log aggregator, and make other configurations.
 
+[NOTE]
+====
+Procedures in this topic require your cluster to be in an unmanaged state. For more information, see xref:../logging/efk-logging-configuring.html#efk-logging-elasticsearch-management-state-changing_efk-logging-configuring[Changing the cluster logging management state].
+====
+
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference
 // modules required to cover the user story. You can also include other
@@ -22,12 +27,15 @@ include::modules/efk-logging-fluentd-log-viewing.adoc[leveloffset=+1]
 
 include::modules/efk-logging-fluentd-limits.adoc[leveloffset=+1]
 
+////
+4.1
 include::modules/efk-logging-fluentd-collector.adoc[leveloffset=+1]
-
-include::modules/efk-logging-fluentd-log-location.adoc[leveloffset=+1]
+////
 
 include::modules/efk-logging-fluentd-log-rotation.adoc[leveloffset=+1]
 
+include::modules/efk-logging-fluentd-log-location.adoc[leveloffset=+1]
+
 include::modules/efk-logging-fluentd-external.adoc[leveloffset=+1]
 
 include::modules/efk-logging-fluentd-throttling.adoc[leveloffset=+1]