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

Author: xenolinux

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].

modules/hcp-cidr-ranges.adoc

@@ -0,0 +1,14 @@
+// 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].

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]
 ====
@@ -47,7 +47,7 @@ ifndef::openshift-rosa,openshift-dedicated[]
 * For more information about configuring join subnets or transit subnets, see xref:../networking/ovn_kubernetes_network_provider/configure-ovn-kubernetes-subnets.adoc#configure-ovn-kubernetes-subnets[Configuring OVN-Kubernetes internal IP address subnets].
 endif::openshift-rosa,openshift-dedicated[]
 
-[id="machine-cidr-description"]
+[id="machine-cidr-description_{context}"]
 == Machine CIDR
 
 In the Machine classless inter-domain routing (CIDR) field, you must specify the IP address range for machines or cluster nodes.
@@ -77,15 +77,15 @@ ifndef::openshift-rosa,openshift-dedicated[]
 * xref:../networking/networking_operators/cluster-network-operator.adoc#nw-operator-cr_cluster-network-operator[Cluster Network Operator configuration]
 endif::[]
 
-[id="service-cidr-description"]
+[id="service-cidr-description_{context}"]
 == Service CIDR
 In the Service CIDR field, you must specify the IP address range for services.
 ifdef::openshift-rosa,openshift-dedicated[]
 It is recommended, but not required, that the address block is the same between clusters. This will not create IP address conflicts.
 endif::openshift-rosa,openshift-dedicated[]
 The range must be large enough to accommodate your workload. The address block must not overlap with any external service accessed from within the cluster. The default is `172.30.0.0/16`.
 
-[id="pod-cidr-description"]
+[id="pod-cidr-description_{context}"]
 == Pod CIDR
 In the pod CIDR field, you must specify the IP address range for pods.
 
@@ -105,14 +105,23 @@ You can expand the range after cluster installation.
 * xref:../networking/configuring-cluster-network-range.adoc#configuring-cluster-network-range[Configuring the cluster network range]
 endif::openshift-enterprise[]
 
-[id="host-prefix-description"]
+[id="host-prefix-description_{context}"]
 == Host Prefix
 In the Host Prefix field, you must specify the subnet prefix length assigned to pods scheduled to individual machines. The host prefix determines the pod IP address pool for each machine.
 
+[id="hcp-cidr-description_{context}"]
+== {hcp-capital} CIDR
+
+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
+
 ifdef::openshift-rosa,openshift-dedicated[]
 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 512 cluster nodes, and 512 pods per node (both of which are beyond our maximum supported).
 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[]