check-circle-line exclamation-circle-line close-line

<

To upgrade Tanzu Kubernetes Grid, you download and install the new version of the Tanzu Kubernetes Grid CLI on the machine that you use as the bootstrap environment. You must also download and install other components, depending on whether you are upgrading clusters that you previously deployed to vSphere or to AWS.

After you have installed the new versions of the components, you use the tkg upgrade management-cluster and tkg upgrade cluster CLI commands to upgrade clusters that you deployed with a previous version of Tanzu Kubernetes Grid.

For information about the supported upgrade paths for a Tanzu Kubernetes Grid release, see the release notes for that release.

Download and Install the New Version of the CLI

This procedure assumes that you are upgrading to Tanzu Kubernetes Grid v1.1.3.

NOTE: You can only upgrade the Windows CLI binary from Tanzu Kubernetes Grid version 1.1.0 or 1.1.2 to 1.1.3. There was no Windows CLI in v1.0.0.

  1. Go to https://www.vmware.com/go/get-tkg and log in with your My VMware credentials.
  2. Under Product Downloads, click Go to Downloads.
  3. Scroll to the VMware Tanzu Kubernetes Grid 1.1.3 CLI entries and click the Download Now button for the type of machine that you use as the bootstrap environment.

    • For Linux, download VMware Tanzu Kubernetes Grid CLI 1.1.3 Linux.
    • For Mac OS, download VMware Tanzu Kubernetes Grid CLI 1.1.3 Mac.
    • For Windows, download VMware Tanzu Kubernetes Grid CLI 1.1.3 Windows.
  4. Use either the gunzip command or the extraction tool of your choice to unpack the binaries. Run either one of the following commands:

    gunzip tkg-darwin-amd64-v1.1.3-vmware.1.gz

    gunzip tkg-linux-amd64-v1.1.3-vmware.1.gz

    gunzip tkg-windows-amd64-v1.1.3-vmware.1.gz

    The unpacked files are tkg-darwin-amd64-v1.1.3-vmware.1, tkg-linux-amd64-v1.1.3-vmware.1, or tkg-windows-amd64-v1.1.3-vmware.1.

  5. Navigate to the executable for the Tanzu Kubernetes Grid CLI.

  6. Rename the CLI binary for your platform to tkg, make sure that it is executable, and add it to your PATH.

    • Mac OS and Linux platforms:

      1. Move the binary into the /usr/local/bin folder and rename it to tkg.
        mv ./tkg-linux-amd64-v1.1.3-vmware.1 /usr/local/bin/tkg
        mv ./tkg-darwin-amd64-v1.1.3-vmware.1 /usr/local/bin/tkg
      2. Make sure that the file is executable.
        chmod +x /usr/local/bin/tkg
    • Windows platforms:

      1. Rename tkg-windows-amd64-v1.1.3-vmware.1 to tkg.exe.
      2. Copy the tkg.exe binary into the Program Files\tkg folder that you created when you installed the previous release.

      The Program Files\tkg folder should already be in your path, from when you installed the previous release.

  7. Run tkg version to check that the correct version of the binary is properly installed.

    You should see information about the installed Tanzu Kubernetes Grid CLI version.

    Client:
      Version: v1.1.3
      Git commit: 0e8e58f3363a1d4b4063b9641f44a3172f6ff406
    

For information about the new commands and options that are available in the new version of the CLI, see the release notes for that release.

Prepare to Upgrade Clusters on vSphere

If you are upgrading a Tanzu Kubernetes Grid deployment on vSphere, you must deploy the new versions of the Base OS Image Template and API Server Load Balancer OVAs into vSphere.

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, do not delete the previous versions of the base OS image templates and API Server Load Balancer OVAs from your vSphere inventory. For information about the versions of Kubernetes that each Tanzu Kubernetes Grid release supports, see the release notes for that release.

This procedure assumes that you are upgrading to Tanzu Kubernetes Grid v1.1.3.

  1. Go to https://www.vmware.com/go/get-tkg and log in with your My VMware credentials.
  2. Download the new Tanzu Kubernetes Grid OVAs for node VMs.

    • Kubernetes 1.18.3: Photon v3 Kubernetes 1.18.6 OVA
    • Kubernetes 1.17.6: Photon v3 Kubernetes 1.17.9 OVA
  3. In the vSphere Client, right-click an object in the vCenter Server inventory, select Deploy OVF template.

  4. Select Local file, click the button to upload files, and navigate to a downloaded OVA file on your local machine.
  5. Follow the installer prompts to deploy a VM from the OVA temaplate.

    • Accept or modify the appliance name
    • Select the destination datacenter or folder
    • Select the destination host, cluster, or resource pool
    • Accept the end user license agreements (EULA)
    • Select the disk format and destination datastore
    • Select the network for the VM to connect to
  6. Click Finish to deploy the VM.
  7. When the OVA deployment finishes, right-click the VM and select Template > Convert to Template.
  8. In the VMs and Templates view, right-click the new template, select Add Permission, and assign the tkg-user to the template with the TKG role.

Repeat the procedure for each of the Kubernetes versions for which you downloaded the OVA file.

The procedure to upload the new version of 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, and convert the resulting VM to a VM template. 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.

Prepare to Upgrade Clusters on Amazon EC2

If you are upgrading a Tanzu Kubernetes Grid deployment on Amazon EC2, you must download and install the new version of the clusterawsadm utility.

This procedure assumes that you are upgrading to Tanzu Kubernetes Grid v1.1.3. In version 1.1.3, the version of clusterawsadm is v0.5.4-vmware.2. In 1.1.2 it is v0.5.4-vmware.1 and in 1.1.0 it is v0.5.3-vmware.1.

NOTE: You can only upgrade the Windows clusterawsadm binary from Tanzu Kubernetes Grid version 1.1.0 or 1.1.2. There was no Windows clusterawsadm in v1.0.0.

  1. Make sure that environment variables for your AWS account are set on your bootstrap environment.

    • Your AWS access key:

      AWS_ACCESS_KEY_ID=aws_access_key

    • Your AWS access key secret:

      AWS_SECRET_ACCESS_KEY=aws_access_key_secret

    • If you use multi-factor authentication, your AWS session token.

      AWS_SESSION_TOKEN=aws_session_token

    • The AWS region in which to deploy the cluster.

      For example:

      AWS_REGION=us-west-2

      For the full list of AWS regions, see AWS Service Endpoints.

  2. Go to https://www.vmware.com/go/get-tkg and log in with your My VMware credentials.
  3. Under Product Downloads, click Go to Downloads.
  4. Scroll to the ClusterAdmin AWS entries and click the Download Now button for the executable for your platform.

    • Linux: ClusterAdmin AWS v0.5.4 Linux
    • Mac OS: ClusterAdmin AWS v0.5.4 Mac
    • Windows: ClusterAdmin AWS v0.5.4 Windows
  5. Use either the gunzip command or the extraction tool of your choice to unpack the binary that corresponds to the OS of your bootstrap environment:

    gunzip clusterawsadm-darwin-amd64-v0.5.4-vmware.2.gz
    gunzip clusterawsadm-linux-amd64-v0.5.4-vmware.2.gz
    gunzip clusterawsadm-windows-amd64-v0.5.4-vmware.2.gz

    The resulting files are clusterawsadm-darwin-amd64-v0.5.4-vmware.2, clusterawsadm-linux-amd64-v0.5.4-vmware.2, or clusterawsadm-windows-amd64-v0.5.4-vmware.2.

  6. Replace the existing clusterawsadm binary with the new version.

    • Mac OS and Linux platforms:

      1. Move the binary into the /usr/local/bin folder and rename it to clusterawsadm.
        • Linux:
          mv ./clusterawsadm-linux-amd64-v0.5.4-vmware.2 /usr/local/bin/clusterawsadm
        • Mac OS:
          mv ./clusterawsadm-darwin-amd64-v0.5.4-vmware.2 /usr/local/bin/clusterawsadm
      2. Make sure the file is executable.
        chmod +x /usr/local/bin/clusterawsadm
    • Windows:

      1. Rename clusterawsadm-windows-amd64-v0.5.4-vmware.2 to clusterawsadm.exe.
      2. Copy the clusterawsadm.exe binary into the Program Files\clusterawsadm folder that you created for the previous release.

      The Program Files\clusterawsadm folder should already be in your path, from when you installed the previous release.

  7. Run the following clusterawsadm command to upgrade the CloudFoundation stack associated with your account.

    clusterawsadm alpha bootstrap create-stack

    You only need to run clusterawsadm once per account. The CloudFormation stack that is upgraded is not specific to any region.

Upgrade the Tanzu Kubernetes Grid Extensions and Crash Recovery and Diagnostics

If you implemented any or all of the Tanzu Kubernetes Grid extensions in version 1.0.0, 1.1.0, or 1.1.2, you upgrade the relevant management clusters and Tanzu Kubernetes clusters in the same way as you upgrade clusters without extensions. Any extensions for user authentication with Dex and Gangway, log forwarding with Fluentbit, and ingress control with Contour that you deployed with version 1.0, 1.1.0, or 1.1.2 will continue to function normally after you upgrade the clusters. No additional action is required to upgrade the Dex, Gangway, Fluentbit, or Contour services that are running on those clusters.

For information about how to upgrade Crash Recovery and Diagnostics, see Install or Upgrade the Crash Recovery and Diagnostics Binary.

What to Do Next

Your environment is now ready for you to upgrade management clusters that you have deployed to vSphere and Amazon EC2. After you have upgraded the management cluster, you can upgrade the Tanzu Kubernetes clusters that it manages.