This document shows how to plan your IP addresses for an installation of Google Distributed Cloud.
Before you begin
Read the Google Distributed Cloud overview and the overview of installation.
Example of IP address allocation
This section gives an example of how to allocate static IP addresses in an installation that includes these elements:
An admin workstation
An admin cluster
One high-availability (HA) user cluster that has five worker nodes
One non-HA user cluster that has four worker nodes
Admin cluster nodes
For an admin cluster that has seven nodes, you need to set aside eight IP addresses. The extra address is required, because it is needed during cluster upgrade, update, and auto repair. For example, you could set aside the following IP addresses for nodes in your admin cluster:
- One node that runs the control plane for the admin cluster
- Two nodes that run add-ons for the admin cluster
- Three nodes that run the control plane for the HA user cluster
- One node that runs the control plane for the non-HA user cluster
- A temporary node to be used during upgrade, update, and auto repair
Load balancing
For this example, assume that the clusters are using the MetalLB load balancer. This load balancer runs on the cluster nodes, so no additional VMs are needed for load balancing.
Subnets
For this example, assume that each cluster is on its own VLAN, and the clusters are in these subnets:
| VMs | Subnet | Default gateway |
|---|---|---|
| Admin workstation and admin cluster | 172.16.20.0/24 | 172.16.20.1 |
| User cluster 1 | 172.16.21.0/24 | 172.16.21.1 |
| User cluster 2 | 172.16.22.0/24 | 172.16.22.1 |
The following diagram illustrates the three VLANs and subnets. Notice that VIPs are not shown associated with any particular node in a cluster. That is because the MetalLB load balancer can choose which node announces the VIP for an individual Service. For example, in user cluster 1, one worker node could announce 172.16.21.31, and a different worker node could announce 172.16.21.32.
Example IP address: admin workstation
In this example, the admin workstation is in the same subnet as the admin cluster: 172.16.20.0/24. An address near the node addresses would be suitable for the admin workstation. For example, 172.16.20.20.
Example IP addresses: admin cluster nodes
The following table gives an example of how IP addresses could be used for the nodes in the admin cluster. The table shows an extra node: admin-vm-8. The extra is needed during cluster upgrades. For more information, see Manage node IP addresses.
| VM hostname | Description | IP address |
|---|---|---|
| admin-vm-1 | Admin cluster control-plane node | 172.16.20.2 |
| admin-vm-2 | Admin cluster add-on node | 172.16.20.3 |
| admin-vm-3 | Admin cluster add-on node | 172.16.20.4 |
| admin-vm-4 | Control-plane node for user cluster 1. This node is in the admin cluster. |
172.16.20.5 |
| admin-vm-5 | Control-plane node for user cluster 1. This node is in the admin cluster. |
172.16.20.6 |
| admin-vm-6 | Control-plane node for user cluster 1. This node is in the admin cluster. |
172.16.20.7 |
| admin-vm-7 | Control-plane node for user cluster 2 This node is in the admin cluster. |
172.16.20.8 |
| admin-vm-8 | 172.16.20.9 |
Example IP addresses: VIPs in the admin cluster subnet
The following table gives an example of how you could designate VIPs to be
configured on the load balancer for the admin cluster. Notice that the VIPs
for the Kubernetes API servers of the user clusters must be on the admin cluster
subnet. That is because the Kubernetes API server for a user cluster runs on a
node in the admin cluster. Note that in the cluster configuration files, the
field where you specify the VIP for a Kubernetes API server is called
controlPlaneVIP:
| VIP | IP address |
|---|---|
| VIP for the Kubernetes API server of the admin cluster | 172.16.20.30 |
| Admin cluster add-ons VIP | 172.16.20.31 |
| VIP for the Kubernetes API server of user cluster 1 | 172.16.20.32 |
| VIP for the Kubernetes API server of user cluster 2 | 172.16.20.33 |
Example IP addresses: User cluster 1 nodes
The following table gives an example of how IP addresses could be used for the nodes in the user cluster 1. The table shows an extra node: user-1-vm-6. The extra is needed during cluster upgrade, update, and auto repair. For more information, see Manage node IP addresses.
| VM hostname | Description | IP address |
|---|---|---|
| user-1-vm-1 | User cluster worker node | 172.16.21.2 |
| user-1-vm-2 | User cluster worker node | 172.16.21.3 |
| user-1-vm-3 | User cluster worker node | 172.16.21.4 |
| user-1-vm-4 | User cluster worker node | 172.16.21.5 |
| user-1-vm-5 | User cluster worker node | 172.16.21.6 |
| user-1-vm-6 | 172.16.21.7 |
Example IP addresses: VIPs in the user cluster 1 subnet
The following table gives an example of how you could designate VIPs to be configured on the load balancer for user cluster 1:
| VIP | Description | IP address |
|---|---|---|
| Ingress VIP for user cluster 1 | Configured on the load balancer for user cluster 1 | 172.16.21.30 |
| Service VIPs for user cluster 1 | Ten addresses for Services of type LoadBalancer.Configured as needed on the load balancer for user cluster 1. Notice that this range includes the ingress VIP. This is a requirement for the MetalLB load balancer. |
172.16.21.30 - 172.16.21.39 |
Example IP addresses: User cluster 2 nodes
The following table gives an example of how IP addresses could be used for the nodes in user-cluster-2. The table shows an extra node: user-2-vm-5. The extra is needed during cluster upgrade, update, and auto repair. For more information, see Manage node IP addresses.
| VM hostname | Description | IP address |
|---|---|---|
| user-2-vm-1 | User cluster worker node | 172.16.22.2 |
| user-2-vm-2 | User cluster worker node | 172.16.22.3 |
| user-2-vm-3 | User cluster worker node | 172.16.22.4 |
| user-2-vm-4 | User cluster worker node | 172.16.22.5 |
| user-2-vm-5 | 172.16.22.6 |
Example IP addresses: VIPs in the user cluster 2 subnet
The following table gives an example of how you could designate VIPs to be configured on the load balancer for user cluster 2:
| VIP | Description | IP address |
|---|---|---|
| Ingress VIP for user cluster 2 | Configured on the load balancer for user cluster 2 | 172.16.22.30 |
| Service VIPs for user cluster 2 | Ten addresses for Services of type LoadBalancer.Configured as needed on the load balancer for user cluster 2. Notice that this range includes the ingress VIP. This is a requirement for the MetalLB load balancer. |
172.16.22.30 - 172.16.22.39 |
Example IP addresses: Pods and Services
Before you create a cluster, you must specify a
CIDR
range to be used for Pod IP addresses and another CIDR range to be used for
the ClusterIP addresses of Kubernetes Services.
Decide what CIDR ranges you want to use for Pods and Services. For example:
| Purpose | CIDR range |
|---|---|
| Pods in the admin cluster | 192.168.0.0/16 |
| Pods in user cluster 1 | 192.168.0.0/16 |
| Pods in user cluster 2 | 192.168.0.0/16 |
| Services in the admin cluster | 10.96.232.0/24 |
| Services in user cluster 1 | 10.96.0.0/20 |
| Services in user cluster 2 | TODO |
The preceding examples illustrate these points:
The Pod CIDR range can be the same for multiple clusters.
Typically you need more Pods than Services, so for a given cluster, you probably want a Pod CIDR range that is larger than the Service CIDR range. For example, the default Pod range for a user cluster is 192.168.0.0/16, which has 2^(32-16) = 2^16 addresses. But the default Service range for a user cluster is 10.96.0.0/20, which has only 2^(32-20) = 2^12 addresses.
Avoid overlap
You might want to use non-default CIDR ranges to avoid overlapping with IP addresses that are reachable in your network. The Service and Pod ranges must not overlap with any address outside the cluster that you want to reach from inside the cluster.
For example, suppose your Service range is 10.96.232.0/24, and your Pod range is 192.168.0.0/16 (192.168.0.1 - 192.168.255.254). Any traffic sent from a Pod to an address in either of those ranges will be treated as in-cluster traffic and will not reach any destination outside the cluster.
In particular, the Service and Pod ranges must not overlap with:
IP addresses of nodes in any cluster
IP addresses used by load balancer machines
VIPs used by control-plane nodes and load balancers
IP addresses of vCenter servers, DNS servers, and NTP servers
We recommend that your Service and Pod ranges be in the RFC 1918 private address space.
Here is one reason for the recommendation to use RFC 1918 addresses. Suppose your Pod or Service range contains external IP addresses. Any traffic sent from a Pod to one of those external addresses will be treated as in-cluster traffic and will not reach the external destination.
DNS server and default gateway
Before you fill in your configuration files, you must know the IP address of a DNS server that can be used by your admin workstation and cluster nodes.
You must also know the IP address of the default gateway for each of your subnets. In the preceding examples, the default gateway for each subnet is the first address in the range. For example, in the subnet for the admin cluster, the default gateway is shown as 172.16.20.1.