[enterprise-4.16] OCPBUGS#55102: Include reserved HCP CIDR ranges

xenolinux · xenolinux · commit b5479ffe8850 · 2025-05-13T18:24:01.000+05:30
diff --git a/hosted_control_planes/hcp-getting-started.adoc b/hosted_control_planes/hcp-getting-started.adoc
@@ -18,6 +18,7 @@ You can view the procedures by selecting from one of the following providers:
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-cluster-workload-distributing[Distributing hosted cluster workloads]
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#firewall-port-reqs-bare-metal[Bare metal firewall and port requirements]
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#infrastructure-reqs-bare-metal[Bare metal infrastructure requirements]: Review the infrastructure requirements to create a hosted cluster on bare metal.
+* xref:../hosted_control_planes/hcp-getting-started.adoc#hcp-cidr-ranges_hcp-getting-started[CIDR ranges for {hcp}]
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-configure-bm[Configuring hosted control plane clusters on bare metal]:
 ** Configure DNS
 ** Create a hosted cluster and verify cluster creation
@@ -33,7 +34,8 @@ You can view the procedures by selecting from one of the following providers:
 == {VirtProductName}
 
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-sizing-guidance[Hosted control plane sizing guidance]
-* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface]
+* xref:../hosted_control_planes/hcp-getting-started.adoc#hcp-cidr-ranges_hcp-getting-started[CIDR ranges for {hcp}]
+* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command-line interface]
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-cluster-workload-distributing[Distributing hosted cluster workloads]
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-control-planes-manage-kubevirt[Managing hosted control plane clusters on OpenShift Virtualization]: Create {product-title} clusters with worker nodes that are hosted by KubeVirt virtual machines.
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#configure-hosted-disconnected[Configuring {hcp} in a disconnected environment]
@@ -45,6 +47,7 @@ You can view the procedures by selecting from one of the following providers:
 == {aws-first}
 
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosting-cluster-aws-infra-reqs[AWS infrastructure requirements]: Review the infrastructure requirements to create a hosted cluster on {aws-short}.
+* xref:../hosted_control_planes/hcp-getting-started.adoc#hcp-cidr-ranges_hcp-getting-started[CIDR ranges for {hcp}]
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosting-service-cluster-configure-aws[Configuring hosted control plane clusters on AWS]: The tasks to configure hosted control plane clusters on {aws-short} include creating the {aws-short} S3 OIDC secret, creating a routable public zone, enabling external DNS, enabling {aws-short} PrivateLink, and deploying a hosted cluster.
 * xref:../networking/networking_operators/sr-iov-operator/configuring-sriov-operator.adoc#sriov-operator-hosted-control-planes_configuring-sriov-operator[Deploying the SR-IOV Operator for {hcp}]: After you configure and deploy your hosting service cluster, you can create a subscription to the Single Root I/O Virtualization (SR-IOV) Operator on a hosted cluster. The SR-IOV pod runs on worker machines rather than the control plane.
 
@@ -57,7 +60,8 @@ You can view the procedures by selecting from one of the following providers:
 :FeatureName: {hcp-capital} on the {ibm-z-title} platform
 include::snippets/technology-preview.adoc[]
 
-* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface]
+* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command-line interface]
+* xref:../hosted_control_planes/hcp-getting-started.adoc#hcp-cidr-ranges_hcp-getting-started[CIDR ranges for {hcp}]
 * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-ibmz[Configuring the hosting cluster on x86 bare metal for IBM Z compute nodes (Technology Preview)]
 
 [id="hcp-getting-started-ibmpower"]
@@ -66,17 +70,18 @@ include::snippets/technology-preview.adoc[]
 :FeatureName: {hcp-capital} on the {ibm-power-title} platform
 include::snippets/technology-preview.adoc[]
 
-* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface]
-* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#config-hosted-service-ibmpower[Configuring the hosting cluster on a 64-bit x86 OpenShift Container Platform cluster to create {hcp} for IBM Power compute nodes (Technology Preview)]
+* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command-line interface]
+* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#config-hosted-service-ibmpower[Configuring the hosting cluster on a 64-bit x86 {product-title} cluster to create {hcp} for IBM Power compute nodes (Technology Preview)]
 
 [id="hcp-getting-started-non-bm-agent"]
-== Non bare metal agent machines
+== Non-bare-metal agent machines
 
-:FeatureName: {hcp-capital} clusters using non bare metal agent machines
+:FeatureName: {hcp-capital} clusters using non-bare-metal agent machines
 include::snippets/technology-preview.adoc[]
 
-* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface]
-* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-configure-agent-non-bm[Configuring hosted control plane clusters using non bare metal agent machines (Technology Preview)]
+* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command-line interface]
+* xref:../hosted_control_planes/hcp-getting-started.adoc#hcp-cidr-ranges_hcp-getting-started[CIDR ranges for {hcp}]
+* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-configure-agent-non-bm[Configuring hosted control plane clusters using non-bare-metal agent machines (Technology Preview)]
 
-* To destroy a hosted cluster on non bare metal agent machines, follow the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hypershift-cluster-destroy-non-bm[Destroying a hosted cluster on non bare metal agent machines]
+* To destroy a hosted cluster on non bare metal agent machines, follow the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hypershift-cluster-destroy-non-bm[Destroying a hosted cluster on non-bare-metal agent machines]
 * If you want to disable the hosted control plane feature, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#disable-hosted-control-planes[Disabling the hosted control plane feature].
diff --git a/hosted_control_planes/hcp-prepare/hcp-cidr-ranges.adoc b/hosted_control_planes/hcp-prepare/hcp-cidr-ranges.adoc
@@ -0,0 +1,15 @@
+// Module included in the following assemblies:
+//
+// * hosted_control_planes/hcp-getting-started.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="hcp-cidr-ranges_{context}"]
+= CIDR ranges for {hcp}
+
+For deploying {hcp} on {product-title}, consider the following required Classless Inter-Domain Routing (CIDR) subnet ranges:
+
+* `v4InternalSubnet`: 100.65.0.0/16 (OVN-Kubernetes)
+* `clusterNetwork`: 10.132.0.0/14 (pod network)
+* `serviceNetwork`: 172.31.0.0/16
+
+To know {product-title} CIDR range definitions, see xref:../../networking/cidr-range-definitions.adoc#cidr-range-definitions[CIDR range definitions].
diff --git a/modules/hcp-cidr-ranges.adoc b/modules/hcp-cidr-ranges.adoc
diff --git a/networking/cidr-range-definitions.adoc b/networking/cidr-range-definitions.adoc
@@ -9,13 +9,13 @@ endif::openshift-dedicated,openshift-rosa[]
 
 toc::[]
 
-If your cluster uses OVN-Kubernetes, you must specify non-overlapping ranges for Classless Inter-Domain Routing (CIDR) subnet ranges.  
+If your cluster uses OVN-Kubernetes, you must specify non-overlapping ranges for Classless Inter-Domain Routing (CIDR) subnet ranges.
 
 The following subnet types are mandatory for a cluster that uses OVN-Kubernetes:
 
-* Join: Uses a join switch to connect gateway routers to distributed routers. A join switch reduces the number of IP addresses for a distributed router. For a cluster that uses the OVN-Kubernetes plugin, an IP address from a dedicated subnet is assigned to any logical port that attaches to the join switch. 
+* Join: Uses a join switch to connect gateway routers to distributed routers. A join switch reduces the number of IP addresses for a distributed router. For a cluster that uses the OVN-Kubernetes plugin, an IP address from a dedicated subnet is assigned to any logical port that attaches to the join switch.
 * Masquerade: Prevents collisions for identical source and destination IP addresses that are sent from a node as hairpin traffic to the same node after a load balancer makes a routing decision.
-* Transit: A transit switch is a type of distributed switch that spans across all nodes in the cluster. A transit switch routes traffic between different zones. For a cluster that uses the OVN-Kubernetes plugin, an IP address from a dedicated subnet is assigned to any logical port that attaches to the transit switch. 
+* Transit: A transit switch is a type of distributed switch that spans across all nodes in the cluster. A transit switch routes traffic between different zones. For a cluster that uses the OVN-Kubernetes plugin, an IP address from a dedicated subnet is assigned to any logical port that attaches to the transit switch.
 
 [NOTE]
 ====
@@ -40,6 +40,12 @@ OVN-Kubernetes, the default network provider in {product-title} 4.14 and later v
 The previous list includes join, transit, and masquerade IPv4 and IPv6 address subnets. If your cluster uses OVN-Kubernetes, do not include any of these IP address subnet ranges in any other CIDR definitions in your cluster or infrastructure.
 ====
 
+For {hcp} on {product-title}, consider the following required CIDR ranges:
+
+* `v4InternalSubnet`: 100.65.0.0/16 (OVN-Kubernetes)
+* `clusterNetwork`: 10.132.0.0/14 (pod network)
+* `serviceNetwork`: 172.31.0.0/16
+
 ifndef::openshift-rosa,openshift-dedicated[]
 [role="_additional-resources"]
 .Additional resources
@@ -115,4 +121,4 @@ endif::openshift-rosa,openshift-dedicated[]
 
 ifdef::openshift-enterprise[]
 For example, if the host prefix is set to `/23`, each machine is assigned a `/23` subnet from the pod CIDR address range. The default is `/23`, allowing 510 cluster nodes, and 510 pod IP addresses per node.
-endif::openshift-enterprise[]
+endif::openshift-enterprise[]
