VMware Tanzu Kubernetes Grid 1.5 Documentation

This documentation provides information about how to install, configure, and use all Tanzu Kubernetes Grid v1.5.x releases.

Caution: VMware recommends not installing or upgrading to Tanzu Kubernetes Grid v1.5.0-v1.5.3, due to a bug in the versions of etcd in the versions of Kubernetes used by Tanzu Kubernetes Grid v1.5.0-v1.5.3. Tanzu Kubernetes Grid v1.5.4 resolves this problem by incorporating a fixed version of etcd. For more information, see Resolved Issues in the TKG v1.5 Release Notes.

Tanzu Kubernetes Grid v1.5 Compatibilities

Tanzu Kubernetes Grid v1.5 supports the following infrastructure platforms, operating systems (OSs), Kubernetes versions, and Ingress resources. For a more detailed information on what’s supported in Tanzu Kubernetes Grid v1.5, see the Release Notes.

vSphere Amazon EC2 Azure
Infrastructure Platform
  • vSphere 6.7U3
  • vSphere 7
  • VMware Cloud on AWS
  • Azure VMware Solution
Native AWS Native Azure
Kubernetes node OS distributed with TKG Photon OS 3, Ubuntu 20.04 Amazon Linux 2, Ubuntu 20.04 Ubuntu 18.04, Ubuntu 20.04
Build your own image Photon OS 3, Red Hat Enterprise Linux 7, Ubuntu 18.04, Ubuntu 20.04 Amazon Linux 2, Ubuntu 18.04, Ubuntu 20.04 Ubuntu 18.04, Ubuntu 20.04
Ingress NSX Advanced Load Balancer Essentials and Avi Controller (v20.1.3 and v20.1.6), Contour (v1.17.2) Contour (v1.17.2) Contour (v1.17.2)

Documentation Sections

The documentation is divided into the following sections.

Concepts and References

Introduces the main components of Tanzu Kubernetes Grid. Most importantly, the Tanzu CLI Command Reference and Tanzu CLI Configuration File Variable Reference list all of the commands, options, and configuration variables of the Tanzu CLI, and provide links to the section in which they are documented.

Prepare to Deploy Management Clusters

Describes how to set up your environment for deployment of management clusters to vSphere, Azure, and Amazon EC2, as well as how to install the Tanzu CLI and other tools. This chapter also describes how to how to deploy Tanzu Kubernetes Grid on VMware Cloud on AWS and Azure VMware Solution and in environments that are not connected to the Internet.

Deploy Management Clusters

Provides instructions about how to deploy management clusters to your chosen provider, by using both the installer interface and from a configuration file. There is also information about how to use the Tanzu CLI with a vSphere with Tanzu Supervisor Cluster in vSphere 7. In addition, you can register your management cluster with Tanzu Mission Control, so that you can manage it and use it to deploy workload clusters directly in the Tanzu Mission Control interface, alongside all of your other clusters.

Deploy Tanzu Kubernetes Clusters

Explains how to use the Tanzu CLI to deploy Tanzu Kubernetes clusters from your management clusters, how to deploy clusters that run different versions of Kubernetes, how to manage node pools, and how to create persistent volumes. You can also modify the templates from which you deploy clusters. This chapter includes a tutorial that provides an example of how to deploy a workload on a cluster.

Manage Clusters

Describes how to connect to, manage, scale, restart, and delete your management clusters and Tanzu Kubernetes Clusters after deployment. This chapter also includes information about how to manage cluster secrets, configure machine health checks, and how to back up and restore clusters.

Install and Configure Packages

Shows how to use the Tanzu CLI install, configure, and manage packages on clusters.

Build Machine Images

Describes how to build your own Linux and Windows custom machine images to run in cluster nodes.

Upgrade Tanzu Kubernetes Grid

Provides instructions to upgrade your Tanzu Kubernetes Grid installation, and how to upgrade the management clusters and Tanzu Kubernetes clusters that you deployed with a previous version. This information covers both minor v1.4.x to v1.5.x and patch v1.5.x to v1.5.y upgrades.

Identity and Access Management

Explains how to configure identity and access management with LDAP and OIDC in Tanzu Kubernetes Grid, including how to configure Role Based Access Control.


Provides information about networking and network architectures for Tanzu Kubernetes Grid, including how to customize Tanzu Kubernetes cluster networking, and how to install, manage, and configure L7 ingress with NSX Advanced Load Balancer. This chapter also explains how to run Tanzu Kubernetes Grid in an IPv6-only networking environment on vSphere.

Security and Compliance

Lists information about ports and protocols, firewall rules, and CIS benchmarking to secure your Tanzu Kubernetes Grid infrastructure and comply with network security policies. The Security Overview Whitepaper describes the current state of the art of Tanzu Kubernetes Grid security. Information is provided about audit logging and about how Tanzu Kubernetes Grid conforms with NIST controls.

Logs and Troubleshooting

Includes tips to help you to troubleshoot common problems that you might encounter when installing Tanzu Kubernetes Grid and deploying management clusters and Tanzu Kubernetes clusters. This section also describes how to access the logs and use the Crash Recovery and Diagnostics tool.

For information about new features, compatibility, component versions, and resolved and known issues, see the VMware Tanzu Kubernetes Grid 1.5 Release Notes.

Intended Audience

This information is intended for:

  • Platform administrators who want to install Tanzu Kubernetes Grid and use it to create and manage Tanzu Kubernetes clusters and their associated resources.

  • Application administrators and developers who want to use Tanzu Kubernetes Grid to deploy and manage modern apps in a Kubernetes architecture.

The information is written for users who have a basic understanding of Kubernetes and are familiar with container deployment concepts. In-depth knowledge of Kubernetes is not required.

check-circle-line exclamation-circle-line close-line
Scroll to top icon