Skip to content

Commit 4e9723d

Browse files
lahinsonlahinson
authored
Merge pull request #103701 from lahinson/osdocs-17528-hcp-troubleshooting-internal-subnets
[OSDOCS-17528]: Adding troubleshooting docs for HCP subnets
2 parents 47008c9 + 2d8c3a1 commit 4e9723d

File tree

7 files changed

+171
-1
lines changed

7 files changed

+171
-1
lines changed

‎hosted_control_planes/hcp-troubleshooting.adoc‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,16 @@ include::modules/hosted-control-planes-pause-reconciliation.adoc[leveloffset=+1]
7777

7878
include::modules/scale-down-data-plane.adoc[leveloffset=+1]
7979

80-
include::modules/agent-service-failure.adoc[leveloffset=+1]
80+
include::modules/agent-service-failure.adoc[leveloffset=+1]
81+
82+
include::modules/hcp-ts-internal-subnets.adoc[leveloffset=+1]
83+
84+
include::modules/hcp-ts-ovnkubernetes.adoc[leveloffset=+2]
85+
86+
include::modules/hcp-ts-identical-subnet-fields.adoc[leveloffset=+2]
87+
88+
include::modules/hcp-ts-subnet-cidr-format.adoc[leveloffset=+2]
89+
90+
include::modules/hcp-ts-cidr-overlap.adoc[leveloffset=+2]
91+
92+
include::modules/hcp-ts-nodes-not-ready.adoc[leveloffset=+2]

‎modules/hcp-ts-cidr-overlap.adoc‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * hosted_control_planes/hcp-troubleshooting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="hcp-ts-cidr-overlap_{context}"]
7+
= Avoiding an overlap between OVN subnets and CIDR values
8+
9+
If the configured OVN subnets overlap with the machine classless inter-domain routing (CIDR), service CIDR, cluster network CIDR, or with each other, an error occurs.
10+
11+
.Procedure
12+
13+
* Use subnets that do not overlap with any network CIDR. You can use a CIDR calculator to verify that no overlaps exist.
14+
+
15+
.Example of configuration with no overlaps
16+
[source,yaml]
17+
----
18+
spec:
19+
networking:
20+
machineCIDR: 10.0.0.0/16
21+
serviceCIDR: 172.30.0.0/16
22+
clusterNetwork:
23+
- cidr: 10.128.0.0/14
24+
25+
operatorConfiguration:
26+
clusterNetworkOperator:
27+
ovnKubernetesConfig:
28+
ipv4:
29+
internalJoinSubnet: "100.99.0.0/16"
30+
internalTransitSwitchSubnet: "100.69.0.0/16"
31+
----

‎modules/hcp-ts-identical-subnet-fields.adoc‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * hosted_control_planes/hcp-troubleshooting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="hcp-ts-identical-subnet-fields_{context}"]
7+
= Setting CIDR values in internal subnet fields
8+
9+
If the `internalJoinSubnet` field and the `internalTransitSwitchSubnet` field are set to the same CIDR values, an error occurs.
10+
11+
.Procedure
12+
13+
* Use different subnets for each field, as shown in the following example:
14+
+
15+
[source,yaml]
16+
----
17+
# ...
18+
ovnKubernetesConfig:
19+
ipv4:
20+
internalJoinSubnet: "100.99.0.0/16"
21+
internalTransitSwitchSubnet: "100.69.0.0/16"
22+
# ...
23+
----

‎modules/hcp-ts-internal-subnets.adoc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * hosted_control_planes/hcp-troubleshooting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="hcp-ts-internal-subnets_{context}"]
7+
= Troubleshooting internal subnets for hosted clusters
8+
9+
If you encounter issues releated to subnets on {hcp}, the following information can help you determine the cause and find a resolution.
10+
11+
The following known limitations exist related to internal subnets on hosted clusters:
12+
13+
* IPv6 subnets are not supported.
14+
* The {hcp} command-line interface, `hcp`, might not have native flags for the subnet fields. Manual YAML editing or `oc patch` is required.
15+
* Modifying OVN subnets after you create a cluster triggers a rollout of OVN components, which might cause brief network disruptions.
16+
* You cannot modify OVN subnet configuration while a cluster update is in progress or scheduled.

‎modules/hcp-ts-nodes-not-ready.adoc‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * hosted_control_planes/hcp-troubleshooting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="hcp-ts-nodes-not-ready_{context}"]
7+
= Resolving a stuck OVN rollout
8+
9+
After you change an existing configuration, the OVN component rollout might take a long time or encounter issues.
10+
11+
.Procedure
12+
13+
. Check the status of the `ovnkube-node` DaemonSet rollout by entering the following command:
14+
+
15+
[source,terminal]
16+
----
17+
$ oc rollout status daemonset/ovnkube-node \
18+
-n openshift-ovn-kubernetes \
19+
--kubeconfig=hosted-kubeconfig
20+
----
21+
22+
. Check the pod logs for errors by entering the following command:
23+
+
24+
[source,terminal]
25+
----
26+
$ oc logs -n openshift-ovn-kubernetes \
27+
-l app=ovnkube-node \
28+
--kubeconfig=hosted-kubeconfig
29+
----
30+
31+
If the rollout is stuck, you might need to revert the configuration change.

‎modules/hcp-ts-ovnkubernetes.adoc‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * hosted_control_planes/hcp-troubleshooting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="hcp-ts-ovnkubernetes_{context}"]
7+
= Configuring the ovnKubernetesConfig object fails with an error
8+
9+
When you try to configure the `ovnKubernetesConfig` object on a hosted cluster by using a different network type, such as `OpenShiftSDN`, an error occurs because {hcp} works only with the `OVNKubernetes` network type.
10+
11+
.Procedure
12+
13+
* Verify the network type of your hosted cluster by entering the following command:
14+
+
15+
[source,terminal]
16+
----
17+
$ oc get hostedcluster <hosted_cluster_name> -n <hosted_control_plane_namespace> \
18+
-o jsonpath='{.spec.networking.networkType}'
19+
----

‎modules/hcp-ts-subnet-cidr-format.adoc‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * hosted_control_planes/hcp-troubleshooting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="hcp-ts-subnet-cidr-format_{context}"]
7+
= Ensuring a valid IPv4 CIDR format
8+
9+
If you do not specify subnets in a valid CIDR format, an error occurs.
10+
11+
.Procedure
12+
13+
* Ensure that the CIDR format follows the following format:
14+
+
15+
[source,text]
16+
----
17+
X.X.X.X/Y
18+
----
19+
+
20+
where:
21+
+
22+
`X`:: is a value from `0` to `255`. The first octet must not be `0`.
23+
`Y`:: is a value from `0` to `30`.
24+
25+
.Valid examples
26+
[source,text]
27+
----
28+
100.99.0.0/16
29+
192.168.1.0/24
30+
----
31+
32+
.Invalid examples
33+
[source,text]
34+
----
35+
100.99.0.0
36+
256.1.1.0/16
37+
0.99.0.0/16
38+
----

0 commit comments

Comments
 (0)