Configuring classic subnets and IP addresses
Change the pool of available portable public or private IP addresses by adding subnets to your Red Hat® OpenShift® on IBM Cloud® cluster.
Overview of classic networking in Red Hat OpenShift on IBM Cloud
Understand the basic concepts of classic networking in Red Hat OpenShift on IBM Cloud clusters. Red Hat OpenShift on IBM Cloud uses VLANs, subnets, and IP addresses to give cluster components network connectivity.
VLANs
When you create a cluster, the cluster's worker nodes are connected automatically to a VLAN. A VLAN configures a group of worker nodes and pods as if they were attached to the same physical wire and provides a channel for connectivity among the workers and pods.
- VLANs for standard clusters
- In standard clusters, the first time that you create a cluster in a zone, a public VLAN and a private VLAN in that zone are automatically provisioned for you in your IBM Cloud infrastructure account. For every subsequent cluster that you create in that zone, you must specify the VLAN pair that you want to use in that zone. You can reuse the same public and private VLANs that were created for you because multiple clusters can share VLANs. You can either connect your worker nodes to both a public VLAN and the private VLAN, or to the private VLAN only. If you want to connect your worker nodes to a private VLAN only, you can use the ID of an existing private VLAN or create a private VLAN and use the ID during cluster creation.
To see the VLANs that are provisioned in each zone for your account, run ibmcloud oc vlan ls --zone <zone>.
To see the VLANs that one cluster is provisioned on, run ibmcloud oc cluster get --cluster <cluster_name_or_ID> --show-resources
and look for the Subnet VLANs section.
IBM Cloud infrastructure manages the VLANs that are automatically provisioned when you create your first cluster in a zone. If you let a VLAN become unused, such as by removing all worker nodes from a VLAN, IBM Cloud infrastructure reclaims the VLAN. After, if you need a new VLAN, contact IBM Cloud support.
- Can I change my VLAN decision later?
- You can change your VLAN setup by modifying the worker pools in your cluster. For more information, see Changing your worker node VLAN connections.
Subnets and IP addresses
In addition to worker nodes and pods, subnets are also automatically provisioned onto VLANs. Subnets provide network connectivity to your cluster components by assigning IP addresses to them.
The following subnets are automatically provisioned on the default public and private VLANs.
Public VLAN subnets
- The primary public subnet determines the public IP addresses that are assigned to worker nodes during cluster creation. Multiple clusters on the same VLAN can share one primary public subnet.
- The portable public subnet is bound to one cluster only and provides the cluster with 8 public IP addresses. 3 IPs are reserved for IBM Cloud infrastructure functions. 1 IP is used by the default public Ingress ALB and 4 IPs can be used to create public network load balancer (NLB) services or more public ALBs. Portable public IPs are permanent, fixed IP addresses that can be used to access NLBs or ALBs over the internet. If you need more than 4 IPs for NLBs or ALBs, see Adding portable IP addresses. Note that these IP addresses are intended for use in Red Hat OpenShift on IBM Cloud. Do not use these IP addresses for other purposes outside of Red Hat OpenShift on IBM Cloud.
Private VLAN subnets
- The primary private subnet determines the private IP addresses that are assigned to worker nodes during cluster creation. Multiple clusters on the same VLAN can share one primary private subnet.
- The portable private subnet is bound to one cluster only and provides the cluster with 8 private IP addresses. 3 IPs are reserved for IBM Cloud infrastructure functions. 1 IP is used by the default private Ingress ALB and 4 IPs can be used to create private network load balancer (NLB) services or more private ALBs. Portable private IPs are permanent, fixed IP addresses that can be used to access NLBs or ALBs over a private network. If you need more than 4 IPs for private NLBs or ALBs, see Adding portable IP addresses. Note that these IP addresses are intended for use in Red Hat OpenShift on IBM Cloud. Do not use these IP addresses for other purposes outside of Red Hat OpenShift on IBM Cloud.
Finding subnets provisioned in your account
To see all the subnets provisioned in all resource groups of your account, run ibmcloud oc subnets --provider classic
. To see the portable public and portable private subnets that are bound to one cluster, you can run ibmcloud oc cluster get --cluster <cluster_name_or_ID> --show-resources
and look for the Subnet VLANs section.
In Red Hat OpenShift on IBM Cloud, VLANs have a limit of 40 subnets. If you reach this limit, first check to see whether you can reuse subnets in the VLAN to create new clusters. If you need a new VLAN, order one by contacting IBM Cloud support. Then, create a cluster that uses this new VLAN.
- Do the IP addresses for my worker nodes change?
- Your worker node is assigned an IP address on the public or private VLANs that your cluster uses. After the worker node is provisioned, the worker node IP address persists across
reboot
andupdate
operations, but the worker node IP address changes after areplace
operation. Additionally, the private IP address of the worker node is used for the worker node identity in mostoc
commands. If you change the VLANs that the worker pool uses, new worker nodes that are provisioned in that pool use the new VLANs for their IP addresses. Existing worker node IP addresses don't change, but you can choose to remove the worker nodes that use the old VLANs. - Can I specify subnets for pods and services in my cluster?
- If you plan to connect your cluster to on-premises networks through IBM Cloud Direct Link or a VPN service, you can avoid subnet conflicts by specifying a custom subnet CIDR that provides the private IP addresses for your pods, and a custom subnet CIDR to provide the private IP addresses for services.
To specify custom pod and service subnets during cluster creation, use the --pod-subnet
and --service-subnet
options in the ibmcloud oc cluster create
CLI command.
Pods
- Default range
-
All services that are deployed to the cluster are assigned a private IP address in the
172.30.0.0/16
range by default. - Size requirements
-
When you specify a custom subnet, consider the size of the cluster that you plan to create and the number of worker nodes that you might add in the future. The subnet must have a CIDR of at least
/23
, which provides enough pod IPs for a maximum of four worker nodes in a cluster. For larger clusters, use/22
to have enough pod IP addresses for eight worker nodes,/21
to have enough pod IP addresses for 16 worker nodes, and so on. - Range requirements
-
The pod and service subnets can't overlap each other, and the pod subnet can't overlap the subnets for your worker nodes. The subnet that you choose must be within one of the following ranges. -
172.17.0.0 - 172.17.255.255
-172.21.0.0 - 172.31.255.255
- `192.168.0.0 - 192.168.254.255` - `198.18.0.0 - 198.19.255.255`
-
The
172.16.0.0/16
,172.18.0.0/16
,172.19.0.0/16
, and172.20.0.0/16
ranges are prohibited.
Services
- Default range
-
All services that are deployed to the cluster are assigned a private IP address in the
172.21.0.0/16
range by default. - Size requirements
-
When you specify a custom subnet, the subnet must be specified in CIDR format with a size of at least
/24
, which allows a maximum of 255 services in the cluster, or larger. - Range requirements
-
The pod and service subnets can't overlap each other. The subnet that you choose must be within one of the following ranges: -
172.17.0.0 - 172.17.255.255
-172.21.0.0 - 172.31.255.255
- `192.168.0.0 - 192.168.254.255` - `198.18.0.0 - 198.19.255.255`
-
The
172.16.0.0/16
,172.18.0.0/16
,172.19.0.0/16
, and172.20.0.0/16
ranges are prohibited.
Network segmentation
Network segmentation describes the approach to divide a network into multiple sub-networks. Apps that run in one sub-network can't see or access apps in another sub-network. For more information about network segmentation options and how they relate to VLANs, see this cluster security topic.
However, in several situations, components in your cluster must be permitted to communicate across multiple private VLANs. For example, if you want to create a multizone cluster, if you have multiple VLANs for a cluster, or if you have multiple subnets on the same VLAN, the worker nodes on different subnets in the same VLAN or in different VLANs can't automatically communicate with each other. You must enable either a Virtual Router Function (VRF) or VLAN spanning for your IBM Cloud infrastructure account.
- Virtual Routing and Forwarding (VRF)
- VRF enables all the VLANs and subnets in your infrastructure account to communicate with each other. Additionally, a VRF is required to allow your workers and master to communicate over the private cloud service endpoint. To enable VRF,
see Enabling VRF. To check whether a VRF is already enabled, use the
ibmcloud account show
command. Note that VRF eliminates the VLAN spanning option for your account, because all VLANs are able to communicate unless you configure a gateway appliance to manage traffic. - VLAN spanning
- If you can't or don't want to enable VRF, enable VLAN spanning. To perform this action, you need the Network > Manage Network VLAN Spanning infrastructure permission,
or you can request the account owner to enable it. To check if VLAN spanning is already enabled, use the
ibmcloud oc vlan spanning get --region <region>
command. Note that you can't enable the private cloud service endpoint if you choose to enable VLAN spanning instead of a VRF. - How does VRF or VLAN spanning affect network segmentation?
- When VRF or VLAN spanning is enabled, any system that is connected to any of the private VLANs in the same IBM Cloud account can communicate with workers. You can isolate your cluster from other systems on the private network by applying Calico private network policies. Red Hat OpenShift on IBM Cloud is also compatible with all IBM Cloud infrastructure firewall offerings. You can set up a firewall, such as a Virtual Router Appliance, with custom network policies to provide dedicated network security for your standard cluster and to detect and remediate network intrusion.
Using existing subnets to create a cluster
When you create a standard cluster, subnets are automatically created for you. However, instead of using the automatically provisioned subnets, you can use existing portable subnets from your IBM Cloud infrastructure account or reuse subnets from a deleted cluster.
Use this option to retain stable static IP addresses across cluster removals and creations, or to order larger blocks of IP addresses. If instead you want to get more portable public or private IP addresses to create network load balancer (NLB) or Ingress application load balancer (ALB) services, see Adding portable IP addresses.
All subnets that were automatically ordered during cluster creation are immediately marked for deletion after you delete a cluster, and you can't reuse the subnets to create a new cluster.
Before you begin
- Access your Red Hat OpenShift cluster.
- To reuse user-managed private subnets from a cluster that you no longer need, delete the unneeded cluster.
ibmcloud oc cluster rm --cluster <cluster_name_or_ID>
- The
172.16.0.0/16
,172.18.0.0/16
,172.19.0.0/16
, and172.20.0.0/16
subnet ranges are prohibited.
To create a cluster by using existing subnets:
-
Get the subnet ID and the ID of the VLAN that the subnet is on.
ibmcloud oc subnets --provider classic
In this example output, the subnet ID is
1602829
and the VLAN ID is2234945
:GETting subnet list... OK ID Network Gateway VLAN ID Type Bound Cluster 1550165 10.xxx.xx.xxx/26 10.xxx.xx.xxx 2234947 private 1602829 169.xx.xxx.xxx/28 169.xx.xxx.xxx 2234945 public
-
Create a cluster from the CLI by using the VLAN ID that you identified. Include the
--no-subnet
option to prevent a new portable public IP subnet and a new portable private IP subnet from being created automatically.ibmcloud oc cluster create classic --zone dal10 --flavor b3c.4x16 --no-subnet --public-vlan 2234945 --private-vlan 2234947 --workers 3 --name my_cluster
If you can't remember which zone the VLAN is in for the
--zone
option, you can check whether the VLAN is in a certain zone by runningibmcloud oc vlan ls --zone <zone>
. -
Verify that the cluster was created. It can take up to 15 minutes for the worker node machines to be ordered and for the cluster to be set up and provisioned in your account.
ibmcloud oc cluster ls
When your cluster is fully provisioned, the State changes to
deployed
.NAME ID State Created Workers Zone Version Resource Group Name Provider mycluster aaf97a8843a29941b49a598f516da72101 deployed 20170201162433 3 dal10 1.31 Default classic
-
Check the status of the worker nodes.
ibmcloud oc worker ls --cluster <cluster_name_or_ID>
Before continuing to the next step, the worker nodes must be ready. The State changes to
normal
and the Status isReady
.ID Public IP Private IP Machine Type State Status Zone Version prod-dal10-pa8dfcc5223804439c87489886dbbc9c07-w1 169.xx.xxx.xxx 10.xxx.xx.xxx free normal Ready dal10 1.31
-
Add the subnet to your cluster by specifying the subnet ID. When you make a subnet available to a cluster, a Kubernetes ConfigMap is created for you that includes all available portable public IP addresses that you can use. If no Ingress ALBs exist in the zone where the subnet's VLAN is located, one portable public and one portable private IP address is automatically used to create the public and private ALBs for that zone. You can use all other portable public and private IP addresses from the subnet to create NLB services for your apps.
ibmcloud oc cluster subnet add --cluster <cluster_name_or_id> --subnet-id <subnet_ID>
-
Verify that the subnet is added to your cluster.
ibmcloud oc cluster get --cluster <cluster_name> --show-resources
-
Important: To enable communication between workers that are on different subnets on the same VLAN, you must enable routing between subnets on the same VLAN.
Managing existing portable IP addresses
By default, 4 portable public and 4 portable private IP addresses can be used to expose single apps to the public or private network by creating a network load balancer (NLB) service. To create an NLB or ALB service, you must have at least 1 portable IP address of the correct type available. You can view portable IP addresses that are available or free up a used portable IP address.
Viewing available portable public IP addresses
To list all the portable IP addresses in your cluster, both used and available, you can run the following command.
oc get cm ibm-cloud-provider-vlan-ip-config -n kube-system -o yaml
To list only portable public IP addresses that are available to create public NLBs or more public ALBs, you can use the following steps:
Before you begin
- Ensure that you have the Writer or Manager IBM Cloud IAM service access role for the
default
namespace. - Access your Red Hat OpenShift cluster.
To list available portable public IP addresses,
-
Create a Kubernetes service configuration file that is named
myservice.yaml
and define a service of typeLoadBalancer
with a dummy NLB IP address. The following example uses the IP address 1.1.1.1 as the NLB IP address. Replace<zone>
with the zone where you want to check for available IPs.apiVersion: v1 kind: Service metadata: labels: run: myservice name: myservice namespace: default annotations: service.kubernetes.io/ibm-load-balancer-cloud-provider-zone: "<zone>" spec: ports: - port: 80 protocol: TCP targetPort: 80 selector: run: myservice sessionAffinity: None type: LoadBalancer loadBalancerIP: 1.1.1.1
-
Create the service in your cluster.
oc apply -f myservice.yaml
-
Inspect the service.
oc describe service myservice
The creation of this service fails because the Kubernetes master can't find the specified NLB IP address in the Kubernetes ConfigMap. When you run this command, you can see the error message and a list of available public IP addresses for the cluster.
Error on cloud load balancer a8bfa26552e8511e7bee4324285f6a4a for service default/myservice with UID 8bfa2655-2e85-11e7-bee4-324285f6a4af: Requested cloud provider IP 1.1.1.1 is not available. The following cloud provider IP addresses are available: <list_of_IP_addresses>
Freeing up used IP addresses
You can free up a used portable IP address by deleting the network load balancer (NLB) service or disabling the Ingress application load balancer (ALB) that is using the portable IP address.
Before you begin
- Ensure that you have the Writer or Manager IBM Cloud IAM service access role for the
default
namespace. - Access your Red Hat OpenShift cluster.
To delete an NLB or disable an ALB,
- List available services in your cluster.
oc get services | grep LoadBalancer
- Remove the load balancer service or disable the ALB that uses a public or private IP address.
- Delete an NLB:
oc delete service <service_name>
- Disable an ALB:
ibmcloud oc ingress alb disable --alb <ALB_ID> -c <cluster_name_or_ID>
- Delete an NLB:
Adding portable IP addresses
By default, 4 portable public and 4 portable private IP addresses can be used to expose single apps to the public or private network by creating a network load balancer (NLB) service. To create more than 4 public or 4 private NLBs, you can get more portable IP addresses by adding network subnets to the cluster.
When you make a subnet available to a cluster, IP addresses of this subnet are used for cluster networking purposes. To avoid IP address conflicts, make sure to use a subnet with one cluster only. Do not use a subnet for multiple clusters or for other purposes outside of Red Hat OpenShift on IBM Cloud at the same time.
Adding portable IPs by ordering more subnets
You can get more portable IPs for NLB services by creating a new subnet in an IBM Cloud infrastructure account and making it available to your specified cluster.
Portable public IP addresses are charged monthly. If you remove portable public IP addresses after your subnet is provisioned, you still must pay the monthly charge, even if you used them only for a short amount of time.
Before you begin
- Ensure that you have the Operator or Administrator IAM platform access role for the cluster.
- Access your Red Hat OpenShift cluster.
To order a subnet,
-
Provision a new subnet.
ibmcloud oc cluster subnet create --cluster <cluster_name_or_id> --size <subnet_size> --vlan <VLAN_ID>
Parameters for a subnet Parameter Description <cluster_name_or_id>
Replace <cluster_name_or_id>
with the name or ID of the cluster.<subnet_size>
Replace <subnet_size>
with the number of IP addresses that you want to create in the portable subnet. Accepted values are 8, 16, 32, or 64. Note that when you add portable IP addresses for your subnet, three IP addresses are used to establish cluster-internal networking. You can't use these three IP addresses for your Ingress application load balancers (ALBs) or to create network load balancer (NLB) services. For example, if you request eight portable public IP addresses, you can use five of them to expose your apps to the public.<VLAN_ID>
Replace <VLAN_ID>
with the ID of the public or private VLAN on which you want to allocate the portable public or private IP addresses. You must select a public or private VLAN that an existing worker node is connected to. To review the public or private VLANs that your worker nodes are connected to, runibmcloud oc cluster get --cluster <cluster> --show-resources
and look for the Subnet VLANs section in the output. The subnet is provisioned in the same zone that the VLAN is in. -
Verify that the subnet was successfully created and added to your cluster. The subnet CIDR is listed in the Subnet VLANs section.
ibmcloud oc cluster get --cluster <cluster_name_or_ID> --show-resources
In this example output, a second subnet was added to the
2234945
public VLAN.Subnet VLANs VLAN ID Subnet CIDR Public User-managed 2234947 10.xxx.xx.xxx/29 false false 2234945 169.xx.xxx.xxx/29 true false 2234945 169.xx.xxx.xxx/29 true false
-
Important: To enable communication between workers that are on different subnets on the same VLAN, you must enable routing between subnets on the same VLAN.
Adding portable IPs by adding existing subnets to your cluster
You can get more portable IPs for NLB services by making an existing subnet in an IBM Cloud infrastructure account available to your cluster.
Before you begin
- Ensure that you have the Operator or Administrator IAM platform access role for the cluster.
- Access your Red Hat OpenShift cluster.
To make a subnet available to your cluster,
- Review the IDs of the public or private VLANs on which you want to allocate the portable public or private IP addresses. You must select a public or private VLAN that an existing worker node is connected to.
In the output, look for VLAN IDs in the Subnet VLANs section.ibmcloud oc cluster get --cluster <cluster_name_or_id> --show-resources
Subnet VLANs VLAN ID Subnet CIDR Public User-managed 2234947 10.xxx.xx.xxx/29 false false 2234945 169.xx.xxx.xxx/29 true false
- Get the ID of the subnet to use. Ensure that the subnet is on one of the VLAN IDs that you found in the previous step, and that the subnet is not already bound to another cluster.
In this example output, the subnet ID isibmcloud oc subnets --provider classic
1602829
, which is on the VLAN ID2234945
.GETting subnet list... OK ID Network Gateway VLAN ID Type Bound Cluster 1550165 10.xxx.xx.xxx/26 10.xxx.xx.xxx 2234947 private 1602829 169.xx.xxx.xxx/28 169.xx.xxx.xxx 2234945 public
- Make the subnet available to your cluster.
ibmcloud oc cluster subnet add --cluster <cluster_name_or_id> --subnet-id <subnet_ID>
- Verify that the subnet was successfully created and added to your cluster. The subnet CIDR is listed in the Subnet VLANs section.
In this example output, a second subnet was added to theibmcloud oc cluster get --cluster <cluster_name> --show-resources
2234945
public VLAN.Subnet VLANs VLAN ID Subnet CIDR Public User-managed 2234947 10.xxx.xx.xxx/29 false false 2234945 169.xx.xxx.xxx/29 true false 2234945 169.xx.xxx.xxx/29 true false
- Important: To enable communication between workers that are on different subnets on the same VLAN, you must enable routing between subnets on the same VLAN.
Managing subnet routing
In classic clusters, if you have multiple VLANs for your cluster, multiple subnets on the same VLAN, or a multizone classic cluster, you must enable a Virtual Router Function (VRF) for your IBM Cloud infrastructure account so your worker nodes can communicate with each other on the private network. To enable VRF, see Enabling VRF. To check
whether a VRF is already enabled, use the ibmcloud account show
command. If you can't or don't want to enable VRF, enable VLAN spanning. To perform this action,
you need the Network > Manage Network VLAN Spanning infrastructure permission, or you can request the account owner to enable it. To check whether VLAN spanning is already enabled, use the ibmcloud oc vlan spanning get --region <region>
command.
Review the following scenarios in which VLAN spanning is also required.
The VLAN spanning option is disabled for clusters that are created in a VRF-enabled account. When VRF is enabled, all VLANs in the account can automatically communicate with each other over the private network. For more information, see Planning your cluster network setup: Worker-to-worker communication.
Enabling routing between primary subnets on the same VLAN
When you create a cluster, primary public and private subnets are provisioned on the public and private VLANs. The primary public subnet ends in /28
and provides 14 public IPs for worker nodes. The primary private subnet ends
in /26
and provides private IPs for up to 62 worker nodes.
You might exceed the initial 14 public and 62 private IPs for worker nodes by having a large cluster or several smaller clusters in the same location on the same VLAN. When a public or private subnet reaches the limit of worker nodes, another primary subnet in the same VLAN is ordered.
To ensure that workers in these primary subnets on the same VLAN can communicate, you must turn on VLAN spanning. For instructions, see Enable or disable VLAN spanning.
To check if VLAN spanning is already enabled, use the ibmcloud oc vlan spanning get --region <region>
command.
Managing subnet routing for gateway appliances
When you create a cluster, a portable public and a portable private subnet are ordered on the VLANs that the cluster is connected to. These subnets provide IP addresses for Ingress application load balancer (ALB) and network load balancer (NLB) services.
However, if you have an existing router appliance, such as a Virtual Router Appliance (VRA), the newly added portable subnets from those VLANs that the cluster is connected to are not configured on the router. To use NLBs or Ingress ALBs, you must ensure that network devices can route between different subnets on the same VLAN by enabling a Virtual Router Function (VRF) for your IBM Cloud infrastructure account. To enable VRF, see Enabling VRF. If you can't or don't want to enable VRF, enable VLAN spanning.
Removing subnets from a cluster
If you no longer need subnets, you can remove them from your cluster. After you remove the subnet, it is no longer available to your cluster, but it still exists in your IBM Cloud infrastructure account.
Before you begin, review the following considerations.
- Subnets can only be detached from a cluster if none of the IP addresses derived from that subnet range are in use in your cluster.
- Portable public IP addresses are charged monthly. If you remove the subnet, you still must pay the monthly charge for the IP addresses, even if you used them only for a short amount of time.
- If your worker nodes previously used the subnet that you want to detach, but no workers are currently attached to any subnets on this subnet's VLAN, then the subnet is not visible to the cluster. You can instead cancel the subnet directly in the IBM Cloud Classic Infrastructure console.
- Find the CIDR for the subnet that you want to remove.
In this example output, the CIDR of the subnet to be removed isibmcloud oc cluster get --cluster <cluster_name> --show-resources
169.1.1.1/29
.Subnet VLANs VLAN ID Subnet CIDR Public User-managed 2234947 10.xxx.xx.xxx/29 false false 2234945 169.xx.xxx.xxx/29 true false 2234945 169.1.1.1/29 true false
- Using the CIDR that you found in the previous step, get the ID of the subnet to remove.
In this example output, the subnet with theibmcloud oc subnets --provider classic
169.1.1.1/29
CIDR has the ID1602829
.ID Network Gateway VLAN ID Type Bound Cluster ... 1602829 169.1.1.1/29 169.1.1.2 2234945 public df253b6025d64944ab99ed63bb4567b6
- Detach the subnet from your cluster. The subnet remains available in your IBM Cloud infrastructure account.
ibmcloud oc cluster subnet detach --cluster <cluster_name_or_ID> --subnet-id <subnet_ID>
- Verify that the subnet is no longer bound to your cluster.
In this example output, the subnet with theibmcloud oc cluster get --cluster <cluster_name> --show-resources
169.1.1.1/29
CIDR is removed.Subnet VLANs VLAN ID Subnet CIDR Public User-managed 2234947 10.xxx.xx.xxx/29 false false 2234945 169.xx.xxx.xxx/29 true false