OSDOCS-16874-5: CQA for SCALE-4 Low-Latency/CNF Debugging and Related

dfitzmau · dfitzmau · commit 3b05d7153441 · 2026-03-03T15:25:55.000Z
diff --git a/modules/node-observability-create-custom-resource.adoc b/modules/node-observability-create-custom-resource.adoc
@@ -6,11 +6,12 @@
 [id="creating-node-observability-custom-resource_{context}"]
 = Creating the Node Observability custom resource
 
-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`.
+[role="_abstract"]
+You must create and run the `NodeObservability` custom resource (CR) before you run the profiling query. When you run the `NodeObservability` CR, the CR creates the necessary machine config and machine config pool CRs to enable the CRI-O profiling on the compute nodes matching the `nodeSelector`.
 
 [IMPORTANT]
 ====
-If CRI-O profiling is not enabled on the worker nodes, the `NodeObservabilityMachineConfig` resource gets created. Worker nodes matching the `nodeSelector` specified in `NodeObservability` CR restarts. This might take 10 or more minutes to complete.
+If CRI-O profiling is not enabled on the compute nodes, the `NodeObservabilityMachineConfig` resource gets created. Compute nodes matching the `nodeSelector` specified in `NodeObservability` CR restarts. This might take 10 or more minutes to complete.
 ====
 
 [NOTE]
@@ -21,8 +22,9 @@ 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 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.
-* You have installed the OpenShift CLI (oc).
+* You have installed the {oc-first}.
 * You have access to the cluster with `cluster-admin` privileges.
 
 .Procedure
@@ -45,25 +47,25 @@ $ oc project node-observability-operator
 +
 [source,yaml]
 ----
-    apiVersion: nodeobservability.olm.openshift.io/v1alpha2
-    kind: NodeObservability
-    metadata:
-      name: cluster <1>
-    spec:
-      nodeSelector:
-        kubernetes.io/hostname: <node_hostname> <2>
-      type: crio-kubelet
+apiVersion: nodeobservability.olm.openshift.io/v1alpha2
+kind: NodeObservability
+metadata:
+  name: cluster
+spec:
+  nodeSelector:
+    kubernetes.io/hostname: <node_hostname>
+  type: crio-kubelet
 ----
-<1> You must specify the name as `cluster` because there should be only one `NodeObservability` CR per cluster.
-<2> Specify the nodes on which the Node Observability agent must be deployed.
++
+** `metadata.name`: Specifies the name as `cluster` because there should be only one `NodeObservability` CR per cluster.
+** `spec.nodeSelector.kubernetes.io/hostname`: Specifies the nodes on which the Node Observability agent must be deployed.
 
 . Run the `NodeObservability` CR:
 +
 [source,terminal]
 ----
 oc apply -f nodeobservability.yaml
 ----
-
 +
 .Example output
 [source,terminal]
@@ -77,7 +79,6 @@ nodeobservability.olm.openshift.io/cluster created
 ----
 $ oc get nob/cluster -o yaml | yq '.status.conditions'
 ----
-
 +
 .Example output
 [source,terminal]
@@ -91,6 +92,5 @@ conditions:
     status: "True"
     type: Ready
 ----
-
 +
 `NodeObservability` CR run is completed when the reason is `Ready` and the status is `True`.
diff --git a/modules/node-observability-high-level-workflow.adoc b/modules/node-observability-high-level-workflow.adoc
@@ -6,6 +6,9 @@
 [id="workflow-node-observability-operator_{context}"]
 = Workflow of the Node Observability Operator
 
+[role="_abstract"]
+To systematically query and analyze profiling data, follow the workflow for the Node Observability Operator. By understanding this process, you can collect metrics and troubleshoot performance issues on your compute nodes.
+
 The following workflow outlines on how to query the profiling data using the Node Observability Operator:
 
 . Install the Node Observability Operator in the {product-title} cluster.
diff --git a/modules/node-observability-install-cli.adoc b/modules/node-observability-install-cli.adoc
@@ -6,11 +6,12 @@
 [id="install-node-observability-using-cli_{context}"]
 = Installing the Node Observability Operator using the CLI
 
-You can install the Node Observability Operator by using the OpenShift CLI (oc).
+[role="_abstract"]
+You can install the Node Observability Operator by using the {oc-first}.
 
 .Prerequisites
 
-* You have installed the OpenShift CLI (oc).
+* You have installed the {oc-first}.
 * You have access to the cluster with `cluster-admin` privileges.
 
 .Procedure
@@ -21,7 +22,6 @@ You can install the Node Observability Operator by using the OpenShift CLI (oc).
 ----
 $ oc get packagemanifests -n openshift-marketplace node-observability-operator
 ----
-
 +
 .Example output
 [source,terminal]
@@ -78,7 +78,6 @@ EOF
 ----
 $ oc -n node-observability-operator get sub node-observability-operator -o yaml | yq '.status.installplan.name'
 ----
-
 +
 .Example output
 [source,terminal]
@@ -94,7 +93,6 @@ $ oc -n node-observability-operator get ip <install_plan_name> -o yaml | yq '.st
 ----
 +
 `<install_plan_name>` is the install plan name that you obtained from the output of the previous command.
-
 +
 .Example output
 [source,terminal]
@@ -108,7 +106,6 @@ COMPLETE
 ----
 $ oc get deploy -n node-observability-operator
 ----
-
 +
 .Example output
 [source,terminal]
diff --git a/modules/node-observability-install-web-console.adoc b/modules/node-observability-install-web-console.adoc
@@ -6,6 +6,7 @@
 [id="install-node-observability-using-web-console_{context}"]
 = Installing the Node Observability Operator using the web console
 
+[role="_abstract"]
 You can install the Node Observability Operator from the {product-title} web console.
 
 .Prerequisites
@@ -16,16 +17,27 @@ You can install the Node Observability Operator from the {product-title} web con
 .Procedure
 
 . Log in to the {product-title} web console.
+
 . In the Administrator's navigation panel, select *Ecosystem* -> *Software Catalog*.
+
 . In the *All items* field, enter *Node Observability Operator* and select the *Node Observability Operator* tile.
+
 . Click *Install*.
+
 . On the *Install Operator* page, configure the following settings:
++
 .. In the *Update channel* area, click *alpha*.
++
 .. In the *Installation mode* area, click *A specific namespace on the cluster*.
++
 .. From the *Installed Namespace* list, select *node-observability-operator* from the list.
++
 .. In the *Update approval* area, select *Automatic*.
++
 .. Click *Install*.
 
 .Verification
+
 . In the Administrator's navigation panel, expand *Ecosystem* -> *Installed Operators*.
+
 . Verify that the Node Observability Operator is listed in the Operators list.
diff --git a/modules/node-observability-installation.adoc b/modules/node-observability-installation.adoc
@@ -4,6 +4,7 @@
 
 :_mod-docs-content-type: CONCEPT
 [id="install-node-observability-operator_{context}"]
-= Installing the Node Observability Operator
+= Node Observability Operator installation methods
 
+[role="_abstract"]
 The Node Observability Operator is not installed in {product-title} by default. You can install the Node Observability Operator by using the {product-title} CLI or the web console.
diff --git a/modules/node-observability-run-profiling-query.adoc b/modules/node-observability-run-profiling-query.adoc
@@ -6,14 +6,18 @@
 [id="running-profiling-query_{context}"]
 = Running the profiling query
 
-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. The lifetime of data is bound to the agent pod through the `emptyDir` volume, so you can access the profiling data while the agent pod is in the `running` status.
+[role="_abstract"]
+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. The lifetime of data is bound to the agent pod through the `emptyDir` volume, so you can access the profiling data while the agent pod is in the `running` status.
 
 [IMPORTANT]
 ====
 You can request only one profiling query at any point of time.
 ====
 
 .Prerequisites
+
 * You have installed the Node Observability Operator.
 * You have created the `NodeObservability` custom resource (CR).
 * You have access to the cluster with `cluster-admin` privileges.
@@ -31,6 +35,7 @@ metadata:
 spec:
   nodeObservabilityRef:
     name: cluster
+# ...
 ----
 
 . Trigger the profiling query by running the `NodeObservabilityRun` resource:
@@ -46,7 +51,6 @@ $ oc apply -f nodeobservabilityrun.yaml
 ----
 $ oc get nodeobservabilityrun nodeobservabilityrun -o yaml  | yq '.status.conditions'
 ----
-
 +
 .Example output
 [source,terminal]
@@ -63,7 +67,6 @@ conditions:
   status: "True"
   type: Finished
 ----
-
 +
 The profiling query is complete once the status is `True` and type is `Finished`.
 
diff --git a/modules/node-observability-scripting-cr.adoc b/modules/node-observability-scripting-cr.adoc
@@ -6,9 +6,11 @@
 [id="node-observability-scripting-cr_{context}"]
 = Creating the Node Observability custom resource for scripting
 
-You must create and run the `NodeObservability` custom resource (CR) before you run the scripting. When you run the `NodeObservability` CR, it enables the agent in scripting mode on the compute nodes matching the `nodeSelector` label. 
+[role="_abstract"]
+You must create and run the `NodeObservability` custom resource (CR) before you run the scripting. When you run the `NodeObservability` CR, the CR enables the agent in scripting mode on the compute nodes matching the `nodeSelector` label. 
 
 .Prerequisites
+
 * You have installed the Node Observability Operator.
 * You have installed the {oc-first}.
 * You have access to the cluster with `cluster-admin` privileges.
@@ -33,27 +35,26 @@ $ oc project node-observability-operator
 +
 [source,yaml]
 ----
-    apiVersion: nodeobservability.olm.openshift.io/v1alpha2
-    kind: NodeObservability
-    metadata:
-      name: cluster <1>
-    spec:
-      nodeSelector:
-        kubernetes.io/hostname: <node_hostname> <2>
-      type: scripting <3>
+apiVersion: nodeobservability.olm.openshift.io/v1alpha2
+kind: NodeObservability
+metadata:
+  name: cluster
+spec:
+  nodeSelector:
+    kubernetes.io/hostname: <node_hostname>
+  type: scripting <3>
 ----
-<1> You must specify the name as `cluster` because there should be only one `NodeObservability` CR per cluster.
-<2> Specify the nodes on which the Node Observability agent must be deployed.
-<3> To deploy the agent in scripting mode, you must set the type to `scripting`.
-
++
+** `metadata.name`: Specifies the name as `cluster` because there should be only one `NodeObservability` CR per cluster.
+** `spec.nodeSelector.kubernetes.io/hostname`: Specifies the nodes on which the Node Observability agent must be deployed.
+** `spec.type`: Specifies the type to `scripting` to deploy the agent in scripting mode.
 
 . Create the `NodeObservability` CR by running the following command:
 +
 [source,terminal]
 ----
 $ oc apply -f nodeobservability.yaml
 ----
-
 +
 .Example output
 [source,terminal]
@@ -67,7 +68,6 @@ nodeobservability.olm.openshift.io/cluster created
 ----
 $ oc get nob/cluster -o yaml | yq '.status.conditions'
 ----
-
 +
 .Example output
 [source,terminal]
@@ -81,6 +81,5 @@ conditions:
     status: "True"
     type: Ready
 ----
-
 +
 The `NodeObservability` CR run is completed when the `reason` is `Ready` and `status` is `"True"`.
diff --git a/scalability_and_performance/node-observability-operator.adoc b/scalability_and_performance/node-observability-operator.adoc
@@ -6,10 +6,10 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-The Node Observability Operator collects and stores CRI-O and Kubelet profiling or metrics from scripts of compute nodes.
-
-With the Node Observability Operator, you can query the profiling data, enabling analysis of performance trends in CRI-O and Kubelet. It supports debugging performance-related issues and executing embedded scripts for network metrics by using the `run` field in the custom resource definition. To enable CRI-O and Kubelet profiling or scripting, you can configure the `type` field in the custom resource definition.
+[role="_abstract"]
+To analyze performance trends and debug issues on your compute nodes, use the Node Observability Operator to collect and query CRI-O and Kubelet metrics. By reviewing this profiling data, you can optimize system performance and execute embedded scripts for network analysis.
 
+With the Node Observability Operator, you can query the profiling data, enabling analysis of performance trends in CRI-O and Kubelet. The Operator supports debugging performance-related issues and executing embedded scripts for network metrics by using the `run` field in the custom resource definition. To enable CRI-O and Kubelet profiling or scripting, you can configure the `type` field in the custom resource definition.
 
 :FeatureName: The Node Observability Operator
 include::snippets/technology-preview.adoc[leveloffset=+0]
@@ -22,7 +22,6 @@ include::modules/node-observability-install-cli.adoc[leveloffset=+2]
 
 include::modules/node-observability-install-web-console.adoc[leveloffset=+2]
 
-
 [id="requesting-crio-kubelet-profiling-using-noo_{context}"]
 == Requesting CRI-O and Kubelet profiling data using the Node Observability Operator
 
@@ -32,13 +31,12 @@ include::modules/node-observability-create-custom-resource.adoc[leveloffset=+2]
 
 include::modules/node-observability-run-profiling-query.adoc[leveloffset=+2]
 
-
 [id="node-observability-operator-scripting_{context}"]
 == Node Observability Operator scripting
 
-Scripting allows you to run pre-configured bash scripts, using the current Node Observability Operator and Node Observability Agent.
+By scripting, you can run pre-configured bash scripts by using the current Node Observability Operator and Node Observability Agent.
 
-These scripts monitor key metrics like CPU load, memory pressure, and worker node issues. They also collect sar reports and custom performance metrics.
+These scripts monitor key metrics like CPU load, memory pressure, and compute node issues. They also collect sar reports and custom performance metrics.
 
 include::modules/node-observability-scripting-cr.adoc[leveloffset=+2]
 
