Update a Tanzu Kubernetes Cluster by Changing the Storage Class

You can update a Tanzu Kubernetes cluster by changing the storage class used by the cluster nodes.

The Tanzu Kubernetes Grid Service supports updating a cluster by changing the StorageClass for the node pools, that is, by changing the property .spec.topology.controlPlane.storageClass or the property .spec.topology.workers.storageClass. See About Tanzu Kubernetes Grid Service Cluster Updates.

Prerequisites

This task uses the command kubectl edit tanzukubernetescluster/CLUSTER-NAME to update the cluster manifest. The kubectl edit command opens the cluster manifest in the text editor defined by your KUBE_EDITOR or EDITOR environment variable. When you save the file, the cluster is updated with the changes. See Specify a Default Text Editor for Kubectl.

Procedure

1. Authenticate with the Supervisor Cluster. See Connect to the Supervisor Cluster as a vCenter Single Sign-On User.

   kubectl vsphere login --server=IP-ADDRESS --vsphere-username USERNAME

2. Switch context to the vSphere Namespace where the target Tanzu Kubernetes cluster is provisioned.

   kubectl config use-context SUPERVISOR-NAMESPACE

3. To determine available storage classes and decide which to use, run the following command.

   kubectl describe tanzukubernetescluster CLUSTER-NAME

4. Run the following command to edit the cluster manifest.

   kubectl edit tanzukubernetescluster/CLUSTER-NAME

5. Edit the manifest by changing the storageClass value.
   For example, change the cluster manifest from the silver-storage-class class for control plane and worker nodes:

   spec:
     topology:
       controlPlane:
         ...
         storageClass: silver-storage-class
       workers:
         ...      
         storageClass: silver-storage-class

   To the gold-storage-class class for control plane and worker nodes:

   spec:
     topology:
       controlPlane:
         ...
         storageClass: gold-storage-class
       workers:
         ...      
         storageClass: gold-storage-class

6. Save the changes you made to the manifest file.
   When you save the file, kubectl applies the changes to the cluster. In the background, the Tanzu Kubernetes Grid Service provisions the new node VMs and spins down the old ones.
7. Verify that kubectl reports that the manifest edits were successfully recorded.

   kubectl edit tanzukubernetescluster/tkgs-cluster-1
   tanzukubernetescluster.run.tanzu.vmware.com/tkgs-cluster-1 edited

   Note: If you receive an error, or kubectl does not report that the cluster manifest was successfully edited, make sure you have properly configured your default text editor using the KUBE_EDITOR environment variable. See Specify a Default Text Editor for Kubectl.
8. Verify that the cluster is updating.

   kubectl get tanzukubernetescluster
   NAME             CONTROL PLANE   WORKER   DISTRIBUTION                     AGE   PHASE
   tkgs-cluster-1   3               3        v1.18.5+vmware.1-tkg.1.c40d30d   21h   updating

9. Verify that the cluster is updated.

   kubectl get tanzukubernetescluster
   NAME             CONTROL PLANE   WORKER   DISTRIBUTION                     AGE   PHASE
   tkgs-cluster-1   3               3        v1.18.5+vmware.1-tkg.1.c40d30d   22h   running