Merge pull request #50699 from darshan-nagaraj/node-observability

No JIRA/BZ. Updates the node observability section

Author: abrennan89

_topic_maps/_topic_map.yml

@@ -2337,7 +2337,7 @@ Topics:
 - Name: Deploying distributed units at scale in a disconnected environment
   File: ztp-deploying-disconnected
   Distros: openshift-origin,openshift-enterprise
-- Name: Requesting CRI-O and Kubelet profiling data using the Node Observability Operator
+- Name: Requesting CRI-O and Kubelet profiling data by using the Node Observability Operator
   File: node-observability-operator
   Distros: openshift-origin,openshift-enterprise
 ---

modules/node-observability-create-custom-resource.adoc

@@ -6,21 +6,19 @@
 [id="creating-node-observability-custom-resource_{context}"]
 = Creating the Node Observability custom resource
 
-Before you run profiling queries, you must create a `NodeObservability` custom resource (CR).
+You must create and run the `NodeObservability` custom resource (CR) before you run the profiling query. When you run the `NodeObservability` CR, it creates the necessary machine config and machine config pool CRs to enable the CRI-O profiling on the worker nodes matching the `nodeSelector`.
 
 [IMPORTANT]
 ====
 The worker nodes matching the `nodeSelector` specified in `NodeObservability` CR are rebooted. It might take 10 or more minutes to complete.
 ====
 
-When you apply the `NodeObservability` CR, the necessary machine config and machine config pool CRs are created to enable the CRI-O profiling on the worker nodes matching the `nodeSelector`.
-
 [NOTE]
 ====
 Kubelet profiling is enabled by default.
 ====
 
-The CRI-O unix socket of the node is mounted on the agent pod, which allows the agent to communicate with CRIO to run the pprof request. Similiarly, the `kubelet-serving-ca` certificate chain is mounted on the agent pod, which allows secure communication between the agent and node's kubelet endpoint.
+The CRI-O unix socket of the node is mounted on the agent pod, which allows the agent to communicate with CRI-O to run the pprof request. Similarly, the `kubelet-serving-ca` certificate chain is mounted on the agent pod, which allows secure communication between the agent and node's kubelet endpoint.
 
 .Prerequisites
 * You have installed the Node Observability Operator.
@@ -29,7 +27,7 @@ The CRI-O unix socket of the node is mounted on the agent pod, which allows the
 
 .Procedure
 
-. Log in to the {product-title} CLI as a user with the `cluster-admin` role by running the following command:
+. Log in to the {product-title} CLI by running the following command:
 +
 [source,terminal]
 ----

modules/node-observability-high-level-workflow.adoc

@@ -4,8 +4,10 @@
 
 :_content-type: CONCEPT
 [id="workflow-node-observability-operator_{context}"]
-= High level workflow of the Node Observability Operator
+= Workflow of the Node Observability Operator
 
-After you install the Node Observability Operator in the {product-title} cluster, you have to create a `NodeObservability` custom resource, which creates a DaemonSet to deploy a Node Observability agent on each worker node.
+The following workflow outlines on how to query the profiling data using the Node Observability Operator:
 
-To request a profiling query, you have to create a `NodeObservabilityRun` resource that requests the deployed Node Observability agent to trigger the CRI-O and Kubelet profiling. After the profiling is completed, the Node Observability agent stores the profiling data inside the container file system `/run/node-observability` directory, which is available for query.
+. Install the Node Observability Operator in the {product-title} cluster.
+. Create a NodeObservability custom resource to enable the CRI-O profiling on the worker nodes of your choice.
+. Run the profiling query to generate the profiling data.

modules/node-observability-install-cli.adoc

@@ -30,7 +30,7 @@ NAME                            CATALOG                AGE
 node-observability-operator     Red Hat Operators      9h
 ----
 
-. Create the `node-observability-operator` namespace by running the following command::
+. Create the `node-observability-operator` namespace by running the following command:
 +
 [source,terminal]
 ----

modules/node-observability-run-profiling-query.adoc

@@ -4,9 +4,9 @@
 
 :_content-type: PROCEDURE
 [id="running-profiling-query_{context}"]
-= Running profiling query
+= Running the profiling query
 
-Profiling query is a blocking operation that fetches CRI-O and Kubelet profiling data for a duration of 30 seconds. The Node Observability Operator stores the profiling data inside the container file system `/run/node-observability` directory. To request profiling data query, you have to create a `NodeObservabilityRun` resource.
+To run the profiling query, you must create a `NodeObservabilityRun` resource. The profiling query is a blocking operation that fetches CRI-O and Kubelet profiling data for a duration of 30 seconds. After the profiling query is complete, you must retrieve the profiling data inside the container file system `/run/node-observability` directory.
 
 [IMPORTANT]
 ====
@@ -33,7 +33,7 @@ spec:
     name: cluster
 ----
 
-. Run the `NodeObservabilityRun` to trigger the profiling:
+. Trigger the profiling query by running the `NodeObservabilityRun` resource:
 +
 [source,terminal]
 ----
@@ -65,9 +65,9 @@ conditions:
 ----
 
 +
-Profiling query is complete when the status is `True` and type is `Finished`.
+The profiling query is complete once the status is `True` and type is `Finished`.
 
-. Run the following bash script to retrieve the profiling data from container's `/run/node-observability` path:
+. Retrieve the profiling data from the container's `/run/node-observability` path by running the following bash script:
 +
 [source,bash]
 ----

scalability_and_performance/node-observability-operator.adoc

@@ -1,17 +1,17 @@
 :_content-type: ASSEMBLY
 [id="using-node-observability-operator"]
-= Understanding the Node Observability Operator
+= Requesting CRI-O and Kubelet profiling data by using the Node Observability Operator
 include::_attributes/common-attributes.adoc[]
 :context: node-observability-operator
 
 toc::[]
 
 
+The Node Observability Operator collects and stores the CRI-O and Kubelet profiling data of worker nodes. You can query the profiling data to analyze the CRI-O and Kubelet performance trends and debug the performance-related issues.
+
 :FeatureName: The Node Observability Operator
 include::snippets/technology-preview.adoc[leveloffset=+0]
 
-The Node Observability Operator collects and stores the CRI-O and Kubelet profiling data of worker nodes. You can use the profiling data to analyze the CRI-O and Kubelet performance trends and debug the performance related issues.
-
 include::modules/node-observability-high-level-workflow.adoc[leveloffset=+1]
 
 include::modules/node-observability-installation.adoc[leveloffset=+1]