Merge pull request #14125 from mburke5678/BZ-1688295

logging CR options not fully documented

Author: mburke5678

_topic_map.yml

@@ -451,12 +451,12 @@ Topics:
   File: efk-logging-configuring
 - Name: Configuring Elasticsearch
   File: efk-logging-elasticsearch
-- Name: Configuring Fluentd
-  File: efk-logging-fluentd
 - Name: Configuring Kibana
   File: efk-logging-kibana
 - Name: Configuring Curator
   File: efk-logging-curator
+- Name: Configuring Fluentd
+  File: efk-logging-fluentd
 - Name: Deploying and Configuring the Event Router
   File: efk-logging-eventrouter
 - Name: Configuring systemd-journald and rsyslog

modules/efk-logging-deploy-subscription.adoc

@@ -75,6 +75,12 @@ Then, click *Subscribe*.
 .. Ensure that *Cluster Logging* and *Elasticsearch Operator* are listed on
 the *InstallSucceeded* tab with a *Status* of *InstallSucceeded*. Change the project to *all projects* if necessary.
 +
+[NOTE]
+====
+During installation an operator might display a *Failed* status. If the operator then installs with an *InstallSucceeded* message,
+you can safely ignore the *Failed* message.
+====
+
 If either operator does not appear as installed, to troubleshoot further:
 
 * On the *Copied* tab of the *Installed Operators* page, if an operator show a *Status* of
@@ -102,29 +108,42 @@ You might need to refresh the page to load the data.
 apiVersion: "logging.openshift.io/v1alpha1"
 kind: "ClusterLogging"
 metadata:
-  name: "instance"
+  name: "instance"  <1>
   namespace: "openshift-logging"
 spec:
-  managementState: "Managed"
+  managementState: "Managed"  <2>
   logStore:
-    type: "elasticsearch"
+    type: "elasticsearch"  <3>
     elasticsearch:
       nodeCount: 3
       storage: {}
       redundancyPolicy: "SingleRedundancy"
   visualization:
-    type: "kibana"
+    type: "kibana"  <4>
     kibana:
       replicas: 1
   curation:
-    type: "curator"
+    type: "curator"  <5>
     curator:
       schedule: "30 3 * * *"
   collection:
     logs:
-      type: "fluentd"
+      type: "fluentd"  <6>
       fluentd: {}
 ----
+<1> The name of the Cluster Logging Custom Resource.
+<2> The cluster logging management state. In most cases, if you change the default cluster logging defaults, you will need to set this to `Unmanaged`. 
+However, an unmanaged deployment does not receive updates until the cluster logging is placed back into a managed state. For more information, see *Changing cluster logging management state*.
+<3> Settings for configuring Elasticsearch. Using the CR, you can configure shard replication policy and persistent storage. For more information, see *Configuring Elasticsearch*.
+<4> Settings for configuring Kibana. Using the CR, you can scale Kibana for redundancy and configure the CPU and memory for your Kibana nodes. For more information, see *Configuring Kibana*.
+<5> Settings for configuring Curator. Using the CR, you can set the Curator schedule. For more information, see *Configuring Curator*.
+<6> Settings for configuring Fluentd. Using the CR, you can configure Fluentd CPU and memory limits. For more information, see *Configuring Fluentd*.
++
+[NOTE]
+====
+The default cluster logging configuration should support a wide array of environments. Review the topics on tuning and 
+configuring the cluster logging components for information on modifications you can make to your cluster logging cluster.
+==== 
 
 .. Click *Create*. This creates the Cluster Logging Custom Resource, which you
 can edit to make changes to your cluster logging cluster.