Skip to content

Commit a2f43e0

Browse files
committed
OSDOCS-15232: CQA PR verifying connectivity
1 parent f9313f4 commit a2f43e0

6 files changed

+17
-10
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// * networking/verifying-connectivity-endpoint.adoc
44

5+
:_mod-docs-content-type: REFERENCE
56
[id="nw-pod-network-connectivity-check-object_{context}"]
67
= PodNetworkConnectivityCheck object fields
78

@@ -125,7 +126,6 @@ The following table describes the fields for objects in the `status.conditions`
125126

126127
|===
127128

128-
[discrete]
129129
== Connection log fields
130130

131131
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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
//
33
// * networking/verifying-connectivity-endpoint.adoc
44

5+
:_mod-docs-content-type: REFERENCE
56
[id="nw-pod-network-connectivity-checks_{context}"]
6-
= Connection health checks performed
7+
= Connection health checks that are performed
78

89
To verify that cluster resources are reachable, a TCP connection is made to each of the following cluster API services:
910

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// * networking/verifying-connectivity-endpoint.adoc
44

5+
:_mod-docs-content-type: PROCEDURE
56
[id="nw-pod-network-connectivity-configuration_{context}"]
67
= Configuring pod connectivity check placement
78

@@ -13,7 +14,7 @@ As a cluster administrator, you can configure which nodes the connectivity check
1314
1415
.Procedure
1516

16-
. To edit the connectivity check configuration, enter the following command:
17+
. Edit the connectivity check configuration by entering the following command:
1718
+
1819
[source,terminal]
1920
----
@@ -22,11 +23,11 @@ $ oc edit network.config.openshift.io cluster
2223

2324
. In the text editor, update the `networkDiagnostics` stanza to specify the node selectors that you want for the source and target pods.
2425

25-
. To commit your changes, save your changes and exit the text editor.
26+
. Save your changes and exit the text editor.
2627

2728
.Verification
2829

29-
To verify that the source and target pods are running on the intended nodes, enter the following command:
30+
* Verify that the source and target pods are running on the intended nodes by entering the following command:
3031
3132
[source,terminal]
3233
----

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// * networking/verifying-connectivity-endpoint.adoc
44

5+
:_mod-docs-content-type: CONCEPT
56
[id="nw-pod-network-connectivity-implementation_{context}"]
67
= Implementation of connection health checks
78

@@ -47,6 +48,6 @@ spec:
4748
----
4849
<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`.
4950
<2> Specifies the diagnostics mode. The value can be the empty string, `All`, or `Disabled`. The empty string is equivalent to specifying `All`.
50-
<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.
51+
<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.
5152
<4> Optional: Specifies a selector for connectivity check target pods.
52-
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.
53+
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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ As a cluster administrator, you can verify the connectivity of an endpoint, such
1515
1616
.Procedure
1717

18-
. To confirm that network diagnostics are enabled, enter the following command:
18+
. Confirm that network diagnostics are enable by entering the following command:
1919
+
2020
[source,terminal]
2121
----
@@ -36,7 +36,7 @@ $ oc get network.config.openshift.io cluster -o yaml
3636
type: NetworkDiagnosticsAvailable
3737
----
3838

39-
. To list the current `PodNetworkConnectivityCheck` objects, enter the following command:
39+
. List the current `PodNetworkConnectivityCheck` objects by entering the following command:
4040
+
4141
[source,terminal]
4242
----
@@ -69,7 +69,7 @@ network-check-source-ci-ln-x5sv9rb-f76d1-4rzrp-worker-b-6xdmh-to-openshift-apise
6969

7070
. View the connection test logs:
7171
.. From the output of the previous command, identify the endpoint that you want to review the connectivity logs for.
72-
.. To view the object, enter the following command:
72+
.. View the object by entering the following command:
7373
+
7474
[source,terminal]
7575
----

networking/advanced_networking/verifying-connectivity-endpoint.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@ The Cluster Network Operator (CNO) runs a controller, the connectivity check con
1010
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.
1111

1212
include::modules/nw-pod-network-connectivity-checks.adoc[leveloffset=+1]
13+
1314
include::modules/nw-pod-network-connectivity-implementation.adoc[leveloffset=+1]
15+
1416
include::modules/nw-pod-network-connectivity-configuration.adoc[leveloffset=+1]
17+
1518
include::modules/nw-pod-network-connectivity-check-object.adoc[leveloffset=+1]
19+
1620
include::modules/nw-pod-network-connectivity-verify.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)