Merge pull request #97261 from JoeAldinger/OSDOCS-15232

OSDOCS-15232: CQA PR verifying connectivity

Author: JoeAldinger

modules/nw-pod-network-connectivity-check-object.adoc

@@ -2,6 +2,7 @@
 //
 // * networking/verifying-connectivity-endpoint.adoc
 
+:_mod-docs-content-type: REFERENCE
 [id="nw-pod-network-connectivity-check-object_{context}"]
 = PodNetworkConnectivityCheck object fields
 
@@ -125,7 +126,6 @@ The following table describes the fields for objects in the `status.conditions`
 
 |===
 
-[discrete]
 == Connection log fields
 
 The fields for a connection log entry are described in the following table. The object is used in the following fields:

modules/nw-pod-network-connectivity-checks.adoc

@@ -2,8 +2,9 @@
 //
 // * networking/verifying-connectivity-endpoint.adoc
 
+:_mod-docs-content-type: REFERENCE
 [id="nw-pod-network-connectivity-checks_{context}"]
-= Connection health checks performed
+= Connection health checks that are performed
 
 To verify that cluster resources are reachable, a TCP connection is made to each of the following cluster API services:
 

modules/nw-pod-network-connectivity-configuration.adoc

@@ -14,7 +14,7 @@ As a cluster administrator, you can configure which nodes the connectivity check
 
 .Procedure
 
-. To edit the connectivity check configuration, enter the following command:
+. Edit the connectivity check configuration by entering the following command:
 +
 [source,terminal]
 ----
@@ -23,11 +23,11 @@ $ oc edit network.config.openshift.io cluster
 
 . In the text editor, update the `networkDiagnostics` stanza to specify the node selectors that you want for the source and target pods.
 
-. To commit your changes, save your changes and exit the text editor.
+. Save your changes and exit the text editor.
 
 .Verification
 
-To verify that the source and target pods are running on the intended nodes, enter the following command:
+* Verify that the source and target pods are running on the intended nodes by entering the following command:
 
 [source,terminal]
 ----

modules/nw-pod-network-connectivity-implementation.adoc

@@ -2,6 +2,7 @@
 //
 // * networking/verifying-connectivity-endpoint.adoc
 
+:_mod-docs-content-type: CONCEPT
 [id="nw-pod-network-connectivity-implementation_{context}"]
 = Implementation of connection health checks
 
@@ -47,6 +48,6 @@ spec:
 ----
 <1> Specifies the network diagnostics configuration. If a value is not specified or an empty object is specified, and `spec.disableNetworkDiagnostics=true` is set in the `network.operator.openshift.io` custom resource named `cluster`, network diagnostics are disabled. If set, this value overrides `spec.disableNetworkDiagnostics=true`.
 <2> Specifies the diagnostics mode. The value can be the empty string, `All`, or `Disabled`. The empty string is equivalent to specifying `All`.
-<3> Optional: Specifies a selector for connectivity check source pods. You can use the `nodeSelector` and `tolerations` fields to further specify the `sourceNode` pods. You do not have to use both `nodeSelector` and `tolerations`, however, for both the source and target pods. These are optional fields that can be omitted.
+<3> Optional: Specifies a selector for connectivity check source pods. You can use the `nodeSelector` and `tolerations` fields to further specify the `sourceNode` pods. These are optional for both source and target pods. You can omit them, use both, or use only one of them.
 <4> Optional: Specifies a selector for connectivity check target pods.
-You can use the `nodeSelector` and `tolerations` fields to further specify the `targetNode` pods. You do not have to use both `nodeSelector` and `tolerations`, however, for both the source and target pods. These are optional fields that can be omitted.
+You can use the `nodeSelector` and `tolerations` fields to further specify the `targetNode` pods. These are optional for both source and target pods. You can omit them, use both, or use only one of them.

modules/nw-pod-network-connectivity-verify.adoc

@@ -15,7 +15,7 @@ As a cluster administrator, you can verify the connectivity of an endpoint, such
 
 .Procedure
 
-. To confirm that network diagnostics are enabled, enter the following command:
+. Confirm that network diagnostics are enable by entering the following command:
 +
 [source,terminal]
 ----
@@ -36,7 +36,7 @@ $ oc get network.config.openshift.io cluster -o yaml
       type: NetworkDiagnosticsAvailable
 ----
 
-. To list the current `PodNetworkConnectivityCheck` objects, enter the following command:
+. List the current `PodNetworkConnectivityCheck` objects by entering the following command:
 +
 [source,terminal]
 ----
@@ -69,7 +69,7 @@ network-check-source-ci-ln-x5sv9rb-f76d1-4rzrp-worker-b-6xdmh-to-openshift-apise
 
 . View the connection test logs:
 .. From the output of the previous command, identify the endpoint that you want to review the connectivity logs for.
-.. To view the object, enter the following command:
+.. View the object by entering the following command:
 +
 [source,terminal]
 ----

networking/advanced_networking/verifying-connectivity-endpoint.adoc

@@ -10,7 +10,11 @@ The Cluster Network Operator (CNO) runs a controller, the connectivity check con
 By reviewing the results of the health checks, you can diagnose connection problems or eliminate network connectivity as the cause of an issue that you are investigating.
 
 include::modules/nw-pod-network-connectivity-checks.adoc[leveloffset=+1]
+
 include::modules/nw-pod-network-connectivity-implementation.adoc[leveloffset=+1]
+
 include::modules/nw-pod-network-connectivity-configuration.adoc[leveloffset=+1]
+
 include::modules/nw-pod-network-connectivity-check-object.adoc[leveloffset=+1]
+
 include::modules/nw-pod-network-connectivity-verify.adoc[leveloffset=+1]