Before you can use the Tanzu Kubernetes Grid CLI or installer interface to deploy a management cluster, you must prepare your vSphere environment. You must make sure that vSphere meets the general requirements, and import the base OS templates from which Tanzu Kubernetes Grid creates node VMs.
You have a vSphere 6.7u3 with an Enterprise Plus license.
If you have vSphere 7.0, see Deploying Management Clusters on vSphere 7.0 below.
Your vSphere instance has the following objects in place:
A network with a DHCP server to which to connect the cluster node VMs that Tanzu Kubernetes Grid deploys. The node VMs must be able to connect to vSphere.
NOTE: If you intend to deploy multiple Tanzu Kubernetes Grid instances to this vSphere instance, create a dedicated resource pool, VM folder, and network for each instance that you deploy.
datecommand to see the timezone settings.
esxcli system time set.
If you have vSphere 7.0 and the vSphere with Kubernetes feature is enabled, the built-in Supervisor Cluster that vSphere with Kubernetes provides performs the same role as the Tanzu Kubernetes Grid management cluster. You do not need to deploy a management cluster in this case, and the Tanzu Kubernetes Grid installer prevents you from doing so. You can use the Tanzu Kubernetes Grid CLI to connect to the Supervisor Cluster and deploy and manage Tanzu Kubernetes clusters in vSphere 7.0. This allows you to use the same Tanzu Kubernetes Grid CLI instance to manage clusters across Amazon EC2, vSphere 6.7u3, and vSphere with Kubernetes instances. For more information, see Deploying Tanzu Kubernetes Clusters on vSphere 7.0 below.
If the vSphere with Kubernetes feature is not enabled, you can deploy a Tanzu Kubernetes Grid management cluster to vSphere 7.0. However, for the best experience of Kubernetes on vSphere 7.0, you should enable the vSphere with Kubernetes feature and use the built-in Supervisor Cluster, rather than a Tanzu Kubernetes Grid management cluster. For information about the vSphere with Kubernetes feature in vSphere 7.0, see vSphere with Kubernetes Configuration and Management in the vSphere 7.0 documentation.
You do not need to deploy Tanzu Kubernetes Grid management clusters to vSphere 7.0 when the vSphere with Kubernetes feature is enabled, because you can connect the Tanzu Kubernetes Grid CLI to a vSphere with Kubernetes Supervisor Cluster. You can then use the Tanzu Kubernetes Grid CLI to deploy Tanzu Kubernetes clusters to vSphere with Kubernetes. For information about how to deploy Tanzu Kubernetes clusters to vSphere 7.0, see Use the Tanzu Kubernetes Grid CLI with a vSphere with Kubernetes Supervisor Cluster.
If you have vSphere 7.0 and the vSphere with Kubernetes feature is not enabled, it is possible to deploy a management cluster to vSphere 7.0 and use the Tanzu Kubernetes Grid CLI to deploy Tanzu Kubernetes clusters, in the same way as for vSphere 6.7u3.
The vCenter Single Sign On account that you provide to Tanzu Kubernetes Grid when you deploy a management cluster must have at the correct permissions in order to perform the required operations in vSphere.
It is not recommended to provide a vSphere administrator account to Tanzu Kubernetes Grid, because this provides Tanzu Kubernetes Grid with far greater permissions than it needs. The best way to assign permissions to Tanzu Kubernetes Grid is to create a role and a user account, and then to grant that user account that role on vSphere objects.
NOTE: If you are deploying Tanzu Kubernetes clusters to vSphere 7 and vSphere with Kubernetes is enabled, you must set the Global > Cloud Admin permission in addition to the permissions listed below.
In the vSphere Client, go to Administration > Access Control > Roles, and create a new role, for example
TKG, with the following permissions.
|vSphere Object||Required Permission|
Low level file operations
|Resource||Assign virtual machine to resource pool|
|Virtual machine|| Change Configuration > Add existing disk
Change Configuration > Add new disk
Change Configuration > Add or remove device
Change Configuration > Advanced configuration
Change Configuration > Change CPU count
Change Configuration > Change Memory
Change Configuration > Change Settings
Change Configuration > Configure Raw device
Change Configuration > Extend virtual disk
Change Configuration > Modify device settings
Change Configuration > Remove disk
Edit Inventory > Create from existing
Edit Inventory > Remove
Interaction > Power On
Interaction > Power Off
Provisioning > Deploy template
In the Hosts and Clusters, VMs and Templates, Storage, and Networking views, right-click the objects that your Tanzu Kubernetes Grid deployment will use, select Add Permission, and assign the
tkg-user with the
TKG role to each object.
In order for Tanzu Kubernetes Grid VMs to run tasks in vSphere, you must provide the public key part of an SSH key pair to Tanzu Kubernetes Grid when you deploy the management cluster. You can use a tool such as
ssh-keygen to generate a key pair.
On the machine on which you will run the Tanzu Kubernetes Grid CLI, run the following
ssh-keygen -t rsa -b 4096 -C "email@example.com"
Enter file in which to save the key (/root/.ssh/id_rsa):press Enter to accept the default.
Add the private key to the SSH agent running on your machine, and enter the password you created in the previous step.
.ssh/id_rsa.pubin a text editor so that you can easily copy and paste it when you deploy a management cluster.
Before you can deploy a Tanzu Kubernetes Grid management cluster or Tanzu Kubernetes clusters to vSphere, you must provide a base OS image template to vSphere. Tanzu Kubernetes Grid creates the management cluster and Tanzu Kubernetes cluster node VMs from this template. Tanzu Kubernetes Grid provides a base OS image template in OVA format for you to import into vSphere. After importing the OVA, you must convert the resulting VM into a VM template. The base OS image template includes the version of Kubernetes that Tanzu Kubernetes Grid uses to create clusters.
NOTE: Tanzu Kubernetes Grid 1.1.3 adds support for Kubernetes v1.18.6 and v1.17.9. You can also use Tanzu Kubernetes Grid 1.1.3 to deploy clusters that run Kubernetes versions that were supported in previous releases of Tanzu Kubernetes Grid. If you want to deploy clusters with older versions of Kubernetes, either install or retain in your vSphere inventory the versions of the base OS image templates from the previous Tanzu Kubernetes Grid releases, alongside the new Kubernetes templates for this release. For information about the versions of Kubernetes that each Tanzu Kubernetes Grid release supports, see the release notes for that release.
Download the Tanzu Kubernetes Grid OVAs for node VMs.
If you want to use Tanzu Kubernetes Grid 1.1.3 to deploy Kubernetes clusters with older versions as well as Kubernetes v1.18.6 and v1.17.9 clusters, after downloading the OVAs above, select version 1.1.2, 1.1.0, or 1.0.0 in the downloads page, and download the Photon v3 Kubernetes OVAs for those releases.
Follow the installer prompts to deploy a VM from the OVA temaplate.
NOTE: If you select thick provisioning as the disk format, when Tanzu Kubernetes Grid creates cluster node VMs from the template, the full size of each node's disk will be reserved. This can rapidly consume storage if you deploy many clusters or clusters with many nodes. However, if you select thin provisioning, as you deploy clusters this can give a false impression of the amount of storage that is available. If you select thin provisioning, there might be enough storage available at the time that you deploy clusters, but storage might run out as the clusters run and accumulate data.
When the OVA deployment finishes, right-click the VM and select Template > Convert to Template.
NOTE: Do not power on the VM before you convert it to a template.
In the VMs and Templates view, right-click the new template, select Add Permission, and assign the
tkg-user to the template with the
For information about how to create the user and role for Tanzu Kubernetes Grid, see Required Permissions for the vSphere Account above.
Repeat the procedure for each of the Kubernetes versions for which you downloaded the OVA file.
You must also provide an API server load balancer to vSphere as a VM template. The API server load balancer is provided as an OVA file, Photon v3 capv haproxy v1.2.4 OVA. Tanzu Kubernetes Grid versions 1.1.0, 1.1.2, and 1.1.3 use the same version of the API server load balancer OVA.
The procedure to upload the API server load balancer OVA to vSphere is identical to that for base OS image OVA files. Import the
photon-3-haproxy-v1.2.4-vmware.1.ova file into vSphere, convert the resulting VM to a VM template, and assign the
tkg-user account to the template with the
If you are using Tanzu Kubernetes Grid in an environment with an external internet connection, you are now ready to deploy Tanzu Kubernetes Grid management clusters to vSphere.