This document shows how to set up minimal vSphere and Google Cloud environments for a small proof-of-concept installation of Google Distributed Cloud.
The installation includes an admin workstation, an admin cluster, and a user cluster.
Before you begin
Read the Anthos clusters on VMware overview.
See vSphere license requirements. For this minimal installation, a vSphere Standard license is sufficient.
You need a running instance of vCenter Server.
You need a vCenter user account with sufficient privileges. Make a note of the username and password for this account.
CPU, RAM and storage requirements
For this minimal installation, you can use a single physical host running ESXi.
These are the minimum resource requirements for your ESXi host:
- 8 physical CPUs @ 2.7GHz with hyperthreading enabled
- 80 gibibytes (GiB) RAM
The minimum storage requirement is 470 GiB.
Example host and datastore
Here's an example of an ESXi host and a vSphere datastore that meet the requirements:
ESXi host configuration:
- Manufacturer: Dell Inc.
- Physical CPUs: 8 CPUs @ 2.7 GHz
- Processor type: Intel(R) Xeon(R) Platinum 8168 CPU @ 2.70 GHz
- Processor sockets: 2
- ESXi version: 6.7U3
- vCenter Server version: 6.7U3
- Hyperthreading: enabled
Datastore configuration:
- Type: VMFS 6.82
- Drive type: SSD
- Vendor: DELL
- Drive type: logical
- RAID level: RAID1
vSphere objects
Set up the following objects in your vSphere environment:
Load balancing
The clusters in this minimal installation use the MetalLB load balancer. This load balancer runs on the cluster nodes, so no additional VMs are needed for load balancing
Plan your IP addresses
Later when you create basic clusters, you will specify static IP addresses for your cluster nodes.
For this small installation, we recommend that you put your admin workstation, admin cluster nodes, and user cluster nodes on the same VLAN in your vSphere network. For example, suppose all IP addresses in the 172.16.20.0/24 range are routed to a particular VLAN. Also suppose your network administrator says you can use 172.16.20.49 - 172.16.20.72 for VMs and virtual IP addresses (VIPs).
The following diagram illustrates a VLAN that has an admin workstation, an admin cluster, and a user cluster. 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 the user cluster, one worker node could announce 172.16.20.63, and a different worker node could announce 172.16.20.64.
Example IP address: admin workstation
For the admin workstation, this example uses the first address in the range given to you by your network administrator: 172.16.20.49.
Example IP addresses: cluster nodes
The following table gives an example of how IP addresses could be used for cluster nodes. The table shows two extra nodes: admin-vm-5 and user-vm-4. The extra nodes are needed during cluster upgrade, update, and auto repair. For more information, see Manage node IP addresses.
| VM hostname | Description | IP address |
|---|---|---|
| admin-vm-1 | Control-plane node for the admin cluster | 172.16.20.50 |
| admin-vm-2 | Admin cluster add-on node | 172.16.20.51 |
| admin-vm-3 | Admin cluster add-on node | 172.16.20.52 |
| admin-vm-4 | Control-plane node for the user cluster. This node is in the admin cluster. |
172.16.20.53 |
| admin-vm-5 | 172.16.20.54 | |
| user-vm-1 | User cluster worker node | 172.16.20.55 |
| user-vm-2 | User cluster worker node | 172.16.20.56 |
| user-vm-3 | User cluster worker node | 172.16.20.57 |
| user-vm-4 | 172.16.20.58 |
Example IP addresses: VIPs for the admin cluster
The following table gives an example of how you could specify VIPs for your admin cluster:
| VIP | Description | IP address |
|---|---|---|
| VIP for the Kubernetes API server of the admin cluster | Configured on the load balancer for the admin cluster | 172.16.20.59 |
| Admin cluster add-ons VIP | Configured on the load balancer for the admin cluster | 172.16.20.60 |
Example IP addresses: VIPs for the user cluster
The following table gives an example of how you could specify VIPs for your user cluster.
Notice that the VIP for the Kubernetes API server of the user cluster is
configured on the load balancer of the admin cluster. 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 | Description | IP address |
|---|---|---|
| VIP for the Kubernetes API server of the user cluster | Configured on the load balancer for the admin cluster | 172.16.20.61 |
| Ingress VIP | Configured on the load balancer for the user cluster | 172.16.20.62 |
| Service VIPs | Ten addresses for Services of type LoadBalancer.Configured as needed on the load balancer for the user cluster. Notice that this range includes the ingress VIP. This is a requirement for the MetalLB load balancer. |
172.16.20.62 - 172.16.20.71 |
IP addresses for 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. Unless you have a reason to do otherwise, you can use the following default ranges:
| Purpose | Default CIDR range |
|---|---|
| Admin cluster Pods | 192.168.0.0/16 |
| User cluster Pods | 192.168.0.0/16 |
| Admin cluster Services | 10.96.232.0/24 |
| User cluster Services | 10.96.0.0/20 |
The default values illustrate these points:
The Pod CIDR range can be the same for multiple clusters.
The Service CIDR range of a cluster must not overlap with the Service CIDR range of any other cluster.
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 has 2^(32-16) = 2^16 addresses, but the default Service range for a user cluster has only 2^(32-20) = 2^12 addresses.
Avoid overlap
You might need to use non-default CIDR ranges to avoid overlapping with IP addresses that are reachable on 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. Any traffic sent from a Pod to an address in either of those ranges will be treated as in-cluster 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 address of vCenter servers, DNS servers, and NTP servers
We recommend that you use the private IP address ranges defined by RFC 1918 for your Pod and Service ranges.
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 create your admin and user clusters, you must know the IP addresses of:
A DNS server that can be used by your admin workstation and cluster nodes
The IP address of the default gateway for the subnet that has your admin workstation and cluster nodes. For example, suppose your admin workstation, admin cluster nodes, and user cluster nodes are all in the 172.16.20.0/24 subnet. The address of the default gateway for the subnet might be 172.16.20.1.
Configure your firewall and proxy
Configure your firewall and proxy according to Proxy and firewall rules.
Set up Google Cloud resources
Choose an existing Google Cloud project or create a new one. Make a note of your Google Cloud project ID.
In your Google Cloud project, create a service account for access to Google Distributed Cloud components. This is called your component access service account:
gcloud iam service-accounts create component-access-sa \
--display-name "Component Access Service Account" \
--project PROJECT_ID
Replace PROJECT_ID with the ID of your Google Cloud project.
Create a JSON key for your component access service account:
gcloud iam service-accounts keys create component-access-key.json \ --iam-account SERVICE_ACCOUNT_EMAIL
Replace SERVICE_ACCOUNT_EMAIL with the email address of your component access service account.
Grant IAM roles to your component access service account:
gcloud projects add-iam-policy-binding PROJECT_ID \
--member "serviceAccount:SERVICE_ACCOUNT_EMAIL" \
--role "roles/serviceusage.serviceUsageViewer"
gcloud projects add-iam-policy-binding PROJECT_ID \
--member "serviceAccount:SERVICE_ACCOUNT_EMAIL" \
--role "roles/iam.roleViewer"
gcloud projects add-iam-policy-binding PROJECT_ID \
--member "serviceAccount:SERVICE_ACCOUNT_EMAIL" \
--role "roles/iam.serviceAccountViewer"
For more information about the component access service account and granting IAM roles, see Service accounts and keys.
Enable Google APIs
Enable the following Google APIs in your Google Cloud project.
gcloud services enable --project PROJECT_ID \
anthos.googleapis.com \
anthosgke.googleapis.com \
anthosaudit.googleapis.com \
cloudresourcemanager.googleapis.com \
container.googleapis.com \
gkeconnect.googleapis.com \
gkehub.googleapis.com \
serviceusage.googleapis.com \
stackdriver.googleapis.com \
opsconfigmonitoring.googleapis.com \
monitoring.googleapis.com \
logging.googleapis.com \
iam.googleapis.com \
storage.googleapis.com