Added OSDOCS-215 to 4.0 files

Author: mburke5678

modules/efk-logging-about-fluentd.adoc

@@ -7,7 +7,7 @@
 
 {product-title} uses Fluentd to collect data about your cluster.
 
-Fluentd is deployed as a DaemonSet in {product-title} that deploys replicas according to a node
+Fluentd is deployed as a DaemonSet in {product-title} that deploys nodes according to a node
 label selector, which you can specify with the inventory parameter
 `openshift_logging_fluentd_nodeselector` and the default is `logging-infra-fluentd`.
 As part of the OpenShift cluster installation, it is recommended that you add the

modules/efk-logging-deploy-pre.adoc

@@ -22,7 +22,7 @@ various areas of the EFK stack.
 +
 .. Ensure that you have deployed a router for the cluster.
 +
-** Ensure that you have the necessary persistent storage for Elasticsearch. Note that each Elasticsearch replica
+** Ensure that you have the necessary persistent storage for Elasticsearch. Note that each Elasticsearch node
 requires its own storage volume. 
 
 . Specify a node selector
@@ -34,22 +34,3 @@ node selector should be used.
 $ oc adm new-project logging --node-selector=""
 ----
 
-* Choose a project. 
-+
-Once deployed, the EFK stack collects logs for every
-project within your {product-title} cluster. But the stack requires a dedicated project, by default *openshift-logging*.
-The Ansible playbook creates the project for you. You only need to create a project if you want
-to specify a node-selector on it. 
-+
-----
-$ oc adm new-project logging --node-selector=""
-$ oc project logging
-----
-+
-[NOTE]
-====
-Specifying an empty node selector on the project is recommended, as Fluentd should be deployed
-throughout the cluster and any selector would restrict where it is
-deployed. To control component placement, specify node selectors per component to
-be applied to their deployment configurations.
-====

modules/efk-logging-deploy-variables.adoc

@@ -344,7 +344,7 @@ server cert. The default is the internal CA.
 |The location of the client key Fluentd uses for `openshift_logging_es_host`.
 
 |`openshift_logging_es_cluster_size`
-|Elasticsearch replicas to deploy. Redundancy requires at least three or more.
+|Elasticsearch nodes to deploy. Redundancy requires at least three or more.
 
 |`openshift_logging_es_cpu_limit`
 |The amount of CPU limit for the ES cluster.

modules/efk-logging-elasticsearch-persistent-storage.adoc

@@ -74,7 +74,7 @@ $ chown 1000:1000 /usr/local/es-storage
 ----
 
 Then, use *_/usr/local/es-storage_* as a host-mount as described below.
-Use a different backing file as storage for each Elasticsearch replica.
+Use a different backing file as storage for each Elasticsearch node.
 
 This loopback must be maintained manually outside of {product-title}, on the
 node. You must not maintain it from inside a container.
@@ -94,7 +94,7 @@ $ oc adm policy add-scc-to-user privileged  \
 <1> Use the project you created earlier (for example, *logging*) when running the
 logging playbook.
 
-. Each Elasticsearch replica definition must be patched to claim that privilege,
+. Each Elasticsearch node definition must be patched to claim that privilege,
 for example:
 +
 ----
@@ -107,7 +107,7 @@ $ for dc in $(oc get deploymentconfig --selector logging-infra=elasticsearch -o
 
 . The Elasticsearch replicas must be located on the correct nodes to use the local
 storage, and should not move around even if those nodes are taken down for a
-period of time. This requires giving each Elasticsearch replica a node selector
+period of time. This requires giving each Elasticsearch node a node selector
 that is unique to a node where an administrator has allocated storage for it. To
 configure a node selector, edit each Elasticsearch deployment configuration and
 add or edit the *nodeSelector* section to specify a unique label that you have

modules/efk-logging-fluentd-log-location.adoc

@@ -5,7 +5,7 @@
 [id='efk-logging-fluentd-log-location_{context}']
 = Configuring Fluentd log location
 
-Fluentd writes logs to a specified file, by default `/var/log/fluentd/fluentd.log`, or to the console, based on the `LOGGING_FILE_PATH` environment variable.  
+Fluentd writes logs to a specified file or to the default location, `/var/log/fluentd/fluentd.log`, based on the `LOGGING_FILE_PATH` environment variable.  
 
 .Procedure
 
@@ -18,8 +18,8 @@ in the default inventory file. You can specify a particular file or to STDOUT:
 LOGGING_FILE_PATH=console <1>
 LOGGING_FILE_PATH=<path-to-log/fluentd.log> <2>
 ----
-<1> Sends the log output to STDOUT.
-<2> Sends the log output to the specified file.
+<1> Sends the log output to the Fluentd default location. Retrieve the logs with the `oc logs -f <pod_name>` command.
+<2> Sends the log output to the specified file. Retrieve the logs with the `oc exec <pod_name> -- logs` command.
 
 . Re-run the logging installer playbook:
 +

modules/efk-logging-fluentd-log-rotation.adoc

@@ -41,5 +41,9 @@ $ oc set env ds/logging-fluentd LOGGING_FILE_AGE=30 LOGGING_FILE_SIZE=1024000"
 ----
 
 Turn off log rotation by setting `LOGGING_FILE_PATH=console`. 
-This causes Fluentd to write logs to STDOUT where they can be retrieved using the `oc logs -f <pod_name>` command.
+This causes Fluentd to write logs to the Fluentd default location, *_/var/log/fluentd/fluentd.log_*, where you can retrieve them using the `oc logs -f <pod_name>` command.
+
+----
+oc set env ds/fluentd LOGGING_FILE_PATH=console
+----
 

modules/efk-logging-fluentd-log-viewing.adoc

@@ -10,19 +10,19 @@ How you view logs depends upon the `LOGGING_FILE_PATH` setting.
 * If `LOGGING_FILE_PATH` points to a file, use the *logs* utility to print out the contents of Fluentd log files:
 +
 ----
-oc exec <pod> logs <1>
+oc exec <pod> -- logs <1>
 ----
-<1> Specify the name of the Fluentd pod.
+<1> Specify the name of the Fluentd pod. Note the space before `logs`.
 +
 For example:
 +
 ----
-oc exec logging-fluentd-lmvms logs
+oc exec logging-fluentd-lmvms -- logs
 ----
 +
 The contents of log files are printed out, starting with the oldest log.  Use `-f` option to follow what is being written into the logs.
 
-* If you are using `LOGGING_FILE_PATH=console`, fluentd to write logs to STDOUT. You can retrieve the logs with the `oc logs -f <pod_name>` command.
+* If you are using `LOGGING_FILE_PATH=console`,  Fluentd writes logs to its default location, `/var/log/fluentd/fluentd.log`. You can retrieve the logs with the `oc logs -f <pod_name>` command.
 +
 For example
 +

modules/efk-logging-manual-rollout-full.adoc

@@ -52,7 +52,7 @@ $ oc exec -c elasticsearch <any_es_pod_in_the_cluster> --
           -d '{ "transient": { "cluster.routing.allocation.enable" : "none" } }'
 ----
 
-. Once complete, for each `dc` you have for an ES cluster, scale down all replicas:
+. Once complete, for each `dc` you have for an ES cluster, scale down all nodes:
 +
 ----
 $ oc scale dc <dc_name> --replicas=0
@@ -69,7 +69,7 @@ You will see a new pod deployed. Once the pod has two ready containers, you can
 move on to the next `dc`.
 
 . Once deployment is complete, for each `dc` you have for an ES cluster, scale up
-replicas:
+nodes:
 +
 ----
 $ oc scale dc <dc_name> --replicas=1