LATEST VERSION: v1.3 - RELEASE NOTES
Pivotal Container Service v1.3

Upgrading PKS

Page last updated:

This topic explains how to upgrade the Pivotal Container Service (PKS) tile and existing Kubernetes clusters.

The supported upgrade paths to PKS v1.3.x are from PKS v1.2.5 and later. PKS v1.3.x is compatible with Ops Manager v2.3.1 or later and Ops Manager v2.4.x.

For conceptual information about upgrading the PKS tile and PKS-provisioned Kubernetes clusters, see What Happens During PKS Upgrades.

For information about upgrading PKS on vSphere with NSX-T integration, see Upgrading PKS with NSX-T.

WARNING: Do not manually upgrade your Kubernetes version. The PKS service includes the compatible Kubernetes version.

Note: Upgrading from PKS v1.2.5+ to PKS v1.3.x causes all certificates to be automatically regenerated. The old certificate authority is still trusted, and has a validity of one year. But the new certificates are signed with a new certificate authority, which is valid for four years.

Before You Upgrade

This section describes the activities you must perform before upgrading PKS.

Determine Your Upgrade Path

Use the following table to determine your upgrade path to PKS v1.3.x.

If your current version of PKS is… Then use the following upgrade path:
v1.1.4 or earlier
  1. Upgrade to PKS v1.1.5 or later.
  2. Upgrade to Ops Manager v2.3.1 or later.
  3. Upgrade to PKS v1.2.5.
  4. (Optional) Upgrade to Ops Manager v2.4.x.
  5. Upgrade to PKS v1.3.x.
v1.1.5 to v1.2.4
  1. Upgrade to Ops Manager v2.3.1 or later.
  2. Upgrade to PKS v1.2.5.
  3. (Optional) Upgrade to Ops Manager v2.4.x.
  4. Upgrade to PKS v1.3.x.
v1.2.5 or later
  1. Upgrade to Ops Manager v2.3.1 or later, or Ops Manager v2.4.x.
  2. Upgrade to PKS v1.3.x.

Prepare to Upgrade

If you have not already, complete the steps in the Upgrade Preparation Checklist for PKS v1.3.

During the Upgrade

This section describes the steps required to upgrade to PKS v1.3.x.

Step 1: Upgrade to PKS v1.2.5 or Later

Skip this step if you are already running PKS v1.2.5+.

Follow the procedures detailed in Upgrading PKS in the PKS v1.2 documentation.

Step 2: Upgrade to Ops Manager v2.3.1+ or v2.4.x

Before you upgrade to PKS v1.3.x, you must upgrade to Ops Manager v2.3.1+ or v2.4.x.

  1. Follow the procedures detailed in Upgrade Ops Manager and Installed Products to v2.3 or Upgrade Ops Manager and Installed Products to v2.4.

  2. Verify that the PKS control plane remains functional by performing the following steps:

    1. Add more workloads and create an additional cluster. For more information about performing those actions, see About Workload Upgrades in Maintaining Workload Uptime and Creating Clusters.
    2. Monitor the PKS control plane VM by clicking the Pivotal Container Service tile, selecting Status tab, and reviewing the Pivotal Container Service VM’s data points. If any data points are at capacity, scale your deployment accordingly.

Step 3: Upgrade to PKS v1.3.x

To upgrade to PKS v1.3.x, follow the same Ops Manager process that you use to install the tile for the first time.

Your configuration settings migrate to the new version automatically. Follow the steps below to perform an upgrade.

  1. Review the Release Notes for the version you are upgrading to.

  2. Download the desired version of the product from Pivotal Network.

  3. Navigate to the Ops Manager Installation Dashboard and click Import a Product to upload the product file.

  4. Under the Import a Product button, click + next to Pivotal Container Service. This adds the tile to your staging area.

Step 4: Download and Import the Stemcell

PKS v1.3.x uses a Xenial stemcell.

If Ops Manager does not have the Xenial stemcell required for PKS, the PKS tile displays the message Missing stemcell.

Note: If the Stemcell Library in Ops Manager already has a compatible Xenial stemcell, the Missing stemcell link does not appear. You do not need to download or import a new stemcell and can skip this step.

To download and import a new Xenial stemcell, follow the steps below:

  1. On the Pivotal Container Service tile, click on the Missing stemcell link.

    Verify stemcell assignment

  2. In the Stemcell Library, locate Pivotal Container Service and note the required stemcell version.

  3. Visit the Stemcells for PCF (Ubuntu Xenial) page on Pivotal Network, and download the required stemcell version appropriate for your IaaS.

  4. Return to the Installation Dashboard in Ops Manager, and click on Stemcell Library.

  5. On the Stemcell Library page, click Import Stemcell and select the stemcell file you downloaded from Pivotal Network.

  6. Select Pivotal Container Service and click Apply Stemcell to Products.

  7. Verify that Ops Manager successfully applied the stemcell. The stemcell version you imported and applied appears in the Staged column for Pivotal Container Service.

  8. Select the Installation Dashboard link to return to the Installation Dashboard.

Step 5: Verify Errand Configuration

To verify that errands are configured correctly in the PKS tile, perform the following steps.

  1. Click the newly-added Pivotal Container Service tile.

  2. Click Errands.

  3. Under Post-Deploy Errands, verify that the Upgrade all clusters errand is set to Default (On). The errand upgrades a single Kubernetes cluster at a time. Upgrading PKS Kubernetes clusters can temporarily interrupt the service, as described in Service Interruptions.

    WARNING: If you are upgrading PKS, you must enable the Upgrade All Clusters errand.

  4. Under Post-Deploy Errands, set the Run smoke tests errand to On. The errand uses the PKS Command Line Interface (PKS CLI) to create a Kubernetes cluster and then delete it. If the creation or deletion fails, the errand fails and the installation of the PKS tile is aborted.

  5. Review the other configuration panes. Click Save on any panes where you make changes.

    Note: When you upgrade PKS, you must place singleton jobs in the AZ you selected when you first installed the PKS tile. You cannot move singleton jobs to another AZ.

Step 6: Apply Changes to the PKS Tile

Perform the following steps to complete the upgrade to the PKS tile.

  1. Return to the Installation Dashboard in Ops Manager.

  2. Click Review Pending Changes. For more information about this Ops Manager page, see Reviewing Pending Product Changes.

  3. Click Apply Changes.

  4. (Optional) To monitor the progress of the Upgrade all clusters errand using the BOSH CLI, do the following:

    1. Log in to the BOSH Director by running bosh -e MY-ENVIRONMENT log-in from a VM that can access your PKS deployment. For more information, see Managing PKS Deployments with BOSH.
    2. Run bosh -e MY-ENVIRONMENT tasks.
    3. Locate the task number for the errand in the # column of the BOSH output.
    4. Run bosh task TASK-NUMBER, replacing TASK-NUMBER with the task number you located in the previous step.

After the Upgrade

After you complete the upgrade to PKS v1.3.x, complete the following verifications and upgrades.

Update PKS and Kubernetes CLIs

Update the PKS and Kubernetes CLIs on any local machine where you run commands that interact with your upgraded version of PKS.

To update your CLIs, download and re-install the PKS and Kubernetes CLI distributions that are provided with PKS on Pivotal Network.

For more information about installing the CLIs, see the following topics:

Verify the Upgrade

After you apply changes to the PKS tile and the upgrade is complete, perform the following steps:

  1. Verify that your Kubernetes environment is healthy. To verify the health of your Kubernetes environment, see Verifying Deployment Health.

  2. Verify that the PKS control plane remains functional by performing the following steps:

    1. Add more workloads and create an additional cluster. For more information about performing those actions, see About Workload Upgrades in Maintaining Workload Uptime and Creating Clusters.
    2. Monitor the PKS control plane VM by clicking the Pivotal Container Service tile, selecting Status tab, and reviewing the Pivotal Container Service VM’s data points. If any data points are at capacity, scale your deployment accordingly.

(Optional) Upgrade vSphere

If you are deploying PKS on vSphere, consult the chart below, and upgrade vSphere if necessary.

Versions Editions
  • VMware vSphere 6.7 U1
  • VMware vSphere 6.7.0
  • VMware vSphere 6.5 U2
  • VMware vSphere 6.5 U1
  • vSphere Enterprise Plus
  • vSphere with Operations Management Enterprise Plus

Note: VMware vSphere 6.7 is only supported with Ops Manager v2.3.1 or later.


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

Create a pull request or raise an issue on the source for this page in GitHub