Upgrading a Supervisor Cluster

You can use the vSphere with Tanzu APIs to upgrade a single or a group of clusters to a specific version.

vSphere with Tanzu supports rolling upgrades through the vSphere Automation APIs for Supervisor Clusters and for the infrastructure supporting these clusters. This model ensures that there is minimal downtime for the cluster workloads during the upgrade process.

To retrieve a list of all available vSphere with Tanzu upgrade versions for a specific vCenter Server system, use the ClusterAvailableVersions service. You can get information about the release version, name, description, release date, and release notes for each available upgrade.

You must use the Clusters service in the namespace_management.software package for upgrading a Supervisor Cluster. You can retrieve upgrade information about all Supervisor Clusters enabled on a vCenter Server system by using the list() Java method or the GET https://<server>/api/vcenter/namespace-management/software/clusters HTTP request. You receive a list of basic upgrade-related information for each cluster, such as the current software version, the date of the last successful upgrade, the upgrade status of the cluster, and so on. In case some of the clusters are in the process of upgrading, you can retrieve also information about their desired upgrade version. If you want to view a more detailed upgrade-related information about a cluster, you must use the get(cluster_ID) method or the GET https://<server>/api/vcenter/namespace-management/software/clusters/<cluster_ID>.

After you view the details about the upgrade versions that you can apply on a single or multiple Supervisor Clusters, you can create upgrade specifications that define the versions you want to upgrade to. When you upgrade a batch of Supervisor Cluster and for some reason one of the clusters fails to upgrade, you receive information about the pre-check exceptions that led to that cluster upgrade failure.