OBSDOCS-603: Update attributes and additional improvements - part 2

abrennan89 · abrennan89 · commit afa1f0773b27 · 2023-11-10T14:12:51.000-06:00
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2566,7 +2566,7 @@ Topics:
   Topics:
   - Name: Viewing Logging status
     File: cluster-logging-cluster-status
-  - Name: Viewing the status of the log store
+  - Name: Viewing the status of the Elasticsearch log store
     File: cluster-logging-log-store-status
 - Name: Uninstalling Logging
   File: cluster-logging-uninstall
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -1038,7 +1038,7 @@ Topics:
   Topics:
   - Name: Viewing Logging status
     File: cluster-logging-cluster-status
-  - Name: Viewing the status of the log store
+  - Name: Viewing the status of the Elasticsearch log store
     File: cluster-logging-log-store-status
 - Name: Uninstalling Logging
   File: cluster-logging-uninstall
diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -421,7 +421,7 @@ Topics:
     File: dedicated-aws-dc
 - Name: Cluster autoscaling
   File: rosa-cluster-autoscaling
-- Name: Manage nodes using machine pools 
+- Name: Manage nodes using machine pools
   Dir: rosa_nodes
   Distros: openshift-rosa
   Topics:
@@ -1211,7 +1211,7 @@ Topics:
   Topics:
   - Name: Viewing Logging status
     File: cluster-logging-cluster-status
-  - Name: Viewing the status of the log store
+  - Name: Viewing the status of the Elasticsearch log store
     File: cluster-logging-log-store-status
 - Name: Uninstalling Logging
   File: cluster-logging-uninstall
diff --git a/logging/troubleshooting/cluster-logging-cluster-status.adoc b/logging/troubleshooting/cluster-logging-cluster-status.adoc
@@ -1,18 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
 :context: cluster-logging-cluster-status
 [id="cluster-logging-cluster-status"]
-= Viewing OpenShift Logging status
+= Viewing Logging status
 include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-You can view the status of the Red Hat OpenShift Logging Operator and for a number of {logging} components.
-
-// 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.
-
+You can view the status of the {clo} and other {logging} components.
 
 include::modules/cluster-logging-clo-status.adoc[leveloffset=+1]
 
diff --git a/logging/troubleshooting/cluster-logging-log-store-status.adoc b/logging/troubleshooting/cluster-logging-log-store-status.adoc
@@ -6,13 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-You can view the status of the OpenShift Elasticsearch Operator and for a number of Elasticsearch components.
-
-// 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.
-
+You can view the status of the {es-op} and for a number of Elasticsearch components.
 
 include::modules/cluster-logging-log-store-status-viewing.adoc[leveloffset=+1]
 
diff --git a/modules/cluster-logging-clo-status-comp.adoc b/modules/cluster-logging-clo-status-comp.adoc
@@ -10,7 +10,7 @@ You can view the status for a number of {logging} components.
 
 .Prerequisites
 
-* The Red Hat OpenShift Logging and Elasticsearch Operators must be installed.
+* The {clo} and {es-op} are installed.
 
 .Procedure
 
diff --git a/modules/cluster-logging-clo-status.adoc b/modules/cluster-logging-clo-status.adoc
@@ -4,26 +4,24 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="cluster-logging-clo-status_{context}"]
-= Viewing the status of the Red Hat OpenShift Logging Operator
+= Viewing the status of the {clo}
 
-You can view the status of your Red Hat OpenShift Logging Operator.
+You can view the status of the {clo}.
 
 .Prerequisites
 
-* The Red Hat OpenShift Logging and Elasticsearch Operators must be installed.
+* The {clo} and {es-op} are installed.
 
 .Procedure
 
-. Change to the `openshift-logging` project.
+. Change to the `openshift-logging` project by running the following command:
 +
 [source,terminal]
 ----
 $ oc project openshift-logging
 ----
 
-. To view the OpenShift Logging status:
-
-.. Get the OpenShift Logging status:
+. Get the `ClusterLogging` instance status by running the following command:
 +
 [source,terminal]
 ----
@@ -114,10 +112,7 @@ visualization:  <4>
 [id="cluster-logging-clo-status-message_{context}"]
 == Example condition messages
 
-The following are examples of some condition messages from the `Status.Nodes` section of the OpenShift Logging instance.
-
-
-// https://github.com/openshift/elasticsearch-operator/pull/92
+The following are examples of some condition messages from the `Status.Nodes` section of the `ClusterLogging` instance.
 
 A status message similar to the following indicates a node has exceeded the configured low watermark and no shard will be allocated to this node:
 
@@ -156,7 +151,7 @@ A status message similar to the following indicates a node has exceeded the conf
 A status message similar to the following indicates the Elasticsearch node selector in the CR does not match any nodes in the cluster:
 
 .Example output
-[source,text]
+[source,terminal]
 ----
     Elasticsearch Status:
       Shard Allocation Enabled:  shard allocation unknown
@@ -204,7 +199,7 @@ A status message similar to the following indicates the Elasticsearch node selec
 A status message similar to the following indicates that the requested PVC could not bind to PV:
 
 .Example output
-[source,text]
+[source,terminal]
 ----
       Node Conditions:
         elasticsearch-cdm-mkkdys93-1:
diff --git a/modules/cluster-logging-log-store-status-viewing.adoc b/modules/cluster-logging-log-store-status-viewing.adoc
@@ -4,17 +4,17 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="cluster-logging-log-store-comp-viewing_{context}"]
-= Viewing the status of the log store
+= Viewing the status of the Elasticsearch log store
 
-You can view the status of your log store.
+You can view the status of the Elasticsearch log store.
 
 .Prerequisites
 
-* The Red Hat OpenShift Logging and Elasticsearch Operators must be installed.
+* The {clo} and {es-op} are installed.
 
 .Procedure
 
-. Change to the `openshift-logging` project.
+. Change to the `openshift-logging` project by running the following command:
 +
 [source,terminal]
 ----
@@ -23,7 +23,7 @@ $ oc project openshift-logging
 
 . To view the status:
 
-.. Get the name of the log store instance:
+.. Get the name of the Elasticsearch log store instance by running the following command:
 +
 [source,terminal]
 ----
@@ -37,7 +37,7 @@ NAME            AGE
 elasticsearch   5h9m
 ----
 
-.. Get the log store status:
+.. Get the Elasticsearch log store status by running the following command:
 +
 [source,terminal]
 ----
@@ -54,7 +54,7 @@ $ oc get Elasticsearch elasticsearch -n openshift-logging -o yaml
 The output includes information similar to the following:
 +
 .Example output
-[source,terminal]
+[source,yaml]
 ----
 status: <1>
   cluster: <2>
@@ -101,31 +101,29 @@ status: <1>
   shardAllocationEnabled: all
 ----
 <1> In the output, the cluster status fields appear in the `status` stanza.
-<2> The status of the log store:
+<2> The status of the Elasticsearch log store:
 +
 * The number of active primary shards.
 * The number of active shards.
 * The number of shards that are initializing.
-* The number of log store data nodes.
-* The total number of log store nodes.
+* The number of Elasticsearch log store data nodes.
+* The total number of Elasticsearch log store nodes.
 * The number of pending tasks.
-* The log store status: `green`, `red`, `yellow`.
+* The Elasticsearch log store status: `green`, `red`, `yellow`.
 * The number of unassigned shards.
-<3> Any status conditions, if present. The log store status indicates the reasons from the scheduler if a pod could not be placed. Any events related to the following conditions are shown:
-* Container Waiting for both the log store and proxy containers.
-* Container Terminated for both the log store and proxy containers.
+<3> Any status conditions, if present. The Elasticsearch log store status indicates the reasons from the scheduler if a pod could not be placed. Any events related to the following conditions are shown:
+* Container Waiting for both the Elasticsearch log store and proxy containers.
+* Container Terminated for both the Elasticsearch log store and proxy containers.
 * Pod unschedulable.
 Also, a condition is shown for a number of issues; see *Example condition messages*.
-<4> The log store nodes in the cluster, with `upgradeStatus`.
-<5> The log store client, data, and master pods in the cluster, listed under 'failed`, `notReady`, or `ready` state.
+<4> The Elasticsearch log store nodes in the cluster, with `upgradeStatus`.
+<5> The Elasticsearch log store client, data, and master pods in the cluster, listed under `failed`, `notReady`, or `ready` state.
 
 [id="cluster-logging-elasticsearch-status-message_{context}"]
 == Example condition messages
 
 The following are examples of some condition messages from the `Status` section of the Elasticsearch instance.
 
-// https://github.com/openshift/elasticsearch-operator/pull/92
-
 The following status message indicates that a node has exceeded the configured low watermark, and no shard will be allocated to this node.
 
 [source,yaml]
@@ -160,7 +158,7 @@ status:
     upgradeStatus: {}
 ----
 
-The following status message indicates that the log store node selector in the CR does not match any nodes in the cluster:
+The following status message indicates that the Elasticsearch log store node selector in the custom resource (CR) does not match any nodes in the cluster:
 
 [source,yaml]
 ----
@@ -174,7 +172,7 @@ status:
         type: Unschedulable
 ----
 
-The following status message indicates that the log store CR uses a non-existent persistent volume claim (PVC).
+The following status message indicates that the Elasticsearch log store CR uses a non-existent persistent volume claim (PVC).
 
 [source,yaml]
 ----
@@ -188,7 +186,7 @@ status:
        type:                  Unschedulable
 ----
 
-The following status message indicates that your log store cluster does not have enough nodes to support the redundancy policy.
+The following status message indicates that your Elasticsearch log store cluster does not have enough nodes to support the redundancy policy.
 
 [source,yaml]
 ----
@@ -243,5 +241,5 @@ The `reason` and `type` fields specify the type of unsupported change:
 +
 [IMPORTANT]
 ====
-If you try to configure the `ClusterLogging` custom resource (CR) to switch from ephemeral to persistent storage, the OpenShift Elasticsearch Operator creates a persistent volume claim (PVC) but does not create a persistent volume (PV). To clear the `StorageStructureChangeIgnored` status, you must revert the change to the `ClusterLogging` CR and delete the PVC.
+If you try to configure the `ClusterLogging` CR to switch from ephemeral to persistent storage, the {es-op} creates a persistent volume claim (PVC) but does not create a persistent volume (PV). To clear the `StorageStructureChangeIgnored` status, you must revert the change to the `ClusterLogging` CR and delete the PVC.
 ====
