Configuring the Upgrade Pipeline

This topic describes how to configure a Concourse pipeline to automatically upgrade a VMware Tanzu Kubernetes Grid Integrated Edition (TKGI) installation.

Overview

You can configure Concourse pipeline to automatically upgrade your TKGI installation when a new TKGI release becomes available on Broadcom Support.

By default, the pipeline upgrades when a new major patch version is available.

For more information about configuring and using Concourse for continuous integration (CI), see the Concourse documentation.

Download the Upgrade Pipeline

Perform the following steps:

1. From a browser, log in to Broadcom Support.

2. Navigate to the Platform Automation Tools product page to download the upgrade-tile pipeline.

   Note: If you cannot access Platform Automation Tools on Broadcom Support, contact Support.

3. (Optional) Edit params.yml to configure the pipeline.

   • For example, edit the product_version_regex value to follow minor version updates.

4. Set the pipeline using the fly CLI for Concourse. See the upgrade-tile pipeline documentation for more information.

Configure Automated Ops Manager and Ubuntu Jammy Stemcell for Tanzu Downloading

If you use an automated pipeline to upgrade TKGI, you must configure your pipeline to download only Ops Manager and Ubuntu Jammy Stemcell for VMware Tanzu versions that are compatible with your version of TKGI.

Warning: VMware recommends that you review the Broadcom Support metadata for your version of TKGI and confirm Ops Manager and stemcell version compatibility before using the Broadcom Support APIs to update Ops Manager and Ubuntu Jammy Stemcells for VMware Tanzu in your automated pipeline.

To configure your automated TKGI upgrade pipeline:

1. To retrieve the Ops Manager and Ubuntu Jammy Stemcells for VMware Tanzu versions compatible with your TKGI version:

   curl -X GET https://network.tanzu.vmware.com/api/v2/products/pivotal-container-service/releases/RELEASE-ID/dependencies
   

   Where RELEASE-ID is the Broadcom Support ID for your TKGI version. You can see the RELEASE-ID in the Broadcom Support URL for your TKGI version.
   
   For example:
   
   The following example returns the versions of TKGI dependencies that are compatible with TKGI v1.16:

   curl -X GET https://network.tanzu.vmware.com/api/v2/products/pivotal-container-service/releases/1250933/dependencies  
   {
      "dependencies":[
         {
            "release":{
                "id":1249995,
                "version":"3.0.4",
               "product":{
                  "id":208,
                  "slug":"ops-manager",
                  "name":"VMware Tanzu Operations Manager"
               },
               "_links":{
                  "self":{
                     "href":"https://network.tanzu.vmware.com/api/v2/products/ops-manager/releases/1249995"
                  }
               }
            }
         },
         {
            "release":{
               "id":1249953,
               "version":"1.83",
               "product":{
                  "id":206,
                  "slug":"stemcells-ubuntu-jammy",
                  "name":"Pivotal Stemcells (Ubuntu Jammy)"
               },
               "_links":{
                  "self":{
                     "href":"https://network.tanzu.vmware.com/api/v2/products/stemcells-ubuntu-jammy/releases/1249953"
                  }
               }
            }
         }
      ],
      "_links":{
         "self":{
            "href":"https://network.tanzu.vmware.com/api/v2/products/pivotal-container-service/releases/1250933/dependencies"
         }
      }
   }
   

   The example returned metadata above indicates that TKGI v1.16 is compatible with only Ops Manager versions v3.0.4 and Ubuntu Jammy Stemcells for VMware Tanzu version v1.83.

2. Configure your automated pipeline to upgrade to only a component version specified in the returned metadata for your version of TKGI.

For more information on retrieving TKGI dependencies, see API reference in the Broadcom Support documentation.