Configuring the Upgrade Pipeline

Page last updated:

This topic describes how to set up a Concourse pipeline to perform automatic upgrades of a VMware Tanzu Kubernetes Grid Integrated Edition installation.

When you configure the upgrade pipeline, the pipeline upgrades your installation when a new Tanzu Kubernetes Grid Integrated Edition release becomes available on VMware Tanzu Network.

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 VMware Tanzu Network.

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

    Note: If you cannot access Platform Automation Tools on VMware Tanzu Network, 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 Xenial Stemcell Downloading

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

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

To configure your automated TKGI upgrade pipeline:

  1. To retrieve the Ops Manager and Xenial Stemcell versions compatible with your TKGI version:

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

    Where RELEASE-ID is the VMware Tanzu Network ID for your TKGI version. You can see the RELEASE-ID in the VMware Tanzu Network URL for your TKGI version.

    For example:

    The following example returns the versions of TKGI dependencies that are compatible with TKGI v1.12.0:

    curl -X GET https://network.pivotal.io/api/v2/products/pivotal-container-service/releases/950934/dependencies
    
    {
       "dependencies":[
          {
             "release":{
                "id":960166,
                "version":"2.10.17",
                "product":{
                   "id":78,
                   "slug":"ops-manager",
                   "name":"VMware Tanzu Operations Manager"
                },
                "_links":{
                   "self":{
                      "href":"https://network.pivotal.io/api/v2/products/ops-manager/releases/960166"
                   }
                }
             }
          },
          {
             "release":{
                "id":926686,
                "version":"2.10.16",
                "product":{
                   "id":78,
                   "slug":"ops-manager",
                   "name":"VMware Tanzu Operations Manager"
                },
                "_links":{
                   "self":{
                      "href":"https://network.pivotal.io/api/v2/products/ops-manager/releases/926686"
                   }
                }
             }
          },
          {
             "release":{
                "id":950182,
                "version":"621.141",
                "product":{
                   "id":233,
                   "slug":"stemcells-ubuntu-xenial",
                   "name":"Pivotal Stemcells (Ubuntu Xenial)"
                },
                "_links":{
                   "self":{
                      "href":"https://network.pivotal.io/api/v2/products/stemcells-ubuntu-xenial/releases/950182"
                   }
                }
             }
          },
          {
             "release":{
                "id":960730,
                "version":"621.154",
                "product":{
                   "id":233,
                   "slug":"stemcells-ubuntu-xenial",
                   "name":"Pivotal Stemcells (Ubuntu Xenial)"
                },
                "_links":{
                   "self":{
                      "href":"https://network.pivotal.io/api/v2/products/stemcells-ubuntu-xenial/releases/960730"
                   }
                }
             }
          }
       ],
       "_links":{
          "self":{
             "href":"https://network.pivotal.io/api/v2/products/pivotal-container-service/releases/950934/dependencies"
          }
       }
    }
    

    The example returned metadata above indicates that TKGI v1.12.0 is compatible with only Ops Manager versions v2.10.16 and v2.10.17 and Xenial Stemcell versions v621.154 and v621.141.

  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 VMware Tanzu Network documentation.


Please send any feedback you have to pks-feedback@pivotal.io.