Upgrading Enterprise PKS

Page last updated:

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

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

Overview

Enterprise PKS versions 1.4.2 and later support directly upgrading from Enterprise PKS v1.3.4 or later. For more information about your upgrade path, see Determine Your Upgrade Path below.

To plan and prepare before beginning your Enterprise PKS upgrade, follow the procedures in Prerequisites, below.

After completing the prerequisite steps, continue to the procedures in During the Upgrade, below. These steps guide you through upgrading the Enterprise PKS tile, upgrading Ops Manager, importing an updated stemcell, and applying the changes to your deployment.

After completing the upgrade, verify that your upgraded Enterprise PKS deployment is running properly by following the procedures in After the Upgrade, below.

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

Prerequisites

Before you upgrade Enterprise PKS, you must do the following:

  1. Determine Your Upgrade Path
  2. Prepare to Upgrade

On Azure, Enterprise PKS v1.4.0 is compatible only with Ops Manager v2.4.2, v2.4.3, v2.4.13, and v2.5.5 and later. For all other IaaSes, Enterprise PKS v1.4.0 is compatible with Ops Manager v2.4.2+ and v2.5.x.

Determine Your Upgrade Path

Use the following table to determine your upgrade path to Enterprise PKS v1.4.

If your current version of PKS is… Then use the following upgrade path:
v1.2.7 or earlier, or v1.3.0
  1. Upgrade to Ops Manager v2.4.2 or later in the 2.4 version line. If upgrading on Azure, upgrade to Ops Manager v2.4.2, v2.4.3, or v2.4.13.
  2. To upgrade to PKS v1.3.2, follow the procedures in PKS upgrade approach for CRITICAL CVE: 2019-3779 (67116) in the Pivotal Knowledge Base.
  3. Upgrade to Enterprise PKS v1.4.1.
  4. (Optional) Upgrade to Enterprise PKS v1.4.2 or later.
  5. (Optional) Upgrade to Ops Manager v2.5.x. If upgrading on Azure, upgrade to Ops Manager v2.5.5 or later in the 2.5 version line.
v1.2.8 or later, or v1.3.1
  1. Upgrade to Ops Manager v2.4.2 or later in the 2.4 version line. If upgrading on Azure, upgrade to Ops Manager v2.4.2, v2.4.3, or v2.4.13.
  2. Review the upgrade procedures in PKS upgrade approach for CRITICAL CVE: 2019-3779 (67116) in the Pivotal Knowledge Base.
  3. Upgrade to Enterprise PKS v1.3.4.
  4. Upgrade to Enterprise PKS v1.4.2 or later.
  5. (Optional) Upgrade to Ops Manager v2.5.x. If upgrading on Azure, upgrade to Ops Manager v2.5.5 or later in the 2.5 version line.
v1.3.2 or v1.3.3
  1. Upgrade to Ops Manager v2.4.2 or later in the 2.4 version line. If upgrading on Azure, upgrade to Ops Manager v2.4.2, v2.4.3, or v2.4.13.
  2. Upgrade to Enterprise PKS v1.4.1.
  3. (Optional) Upgrade to Enterprise PKS v1.4.2 or later.
  4. (Optional) Upgrade to Ops Manager v2.5.x. If upgrading on Azure, upgrade to Ops Manager v2.5.5 or later in the 2.5 version line.
v1.3.4 or later, or 1.4.0 or later
  1. Upgrade to Ops Manager v2.4.2 or later in the 2.4 version line. If upgrading on Azure, upgrade to Ops Manager v2.4.2, v2.4.3, or v2.4.13.
  2. Upgrade to Enterprise PKS v1.4.2 or later.
  3. (Optional) Upgrade to Ops Manager v2.5.x. If upgrading on Azure, upgrade to Ops Manager v2.5.5 or later in the 2.5 version line.

Prepare to Upgrade

Complete all of the steps in the Upgrade Preparation Checklist for PKS v1.4.

During the Upgrade

To upgrade to Enterprise PKS v1.4.x, complete the following steps:

  1. Upgrade to Enterprise PKS v1.2.7 or Later
  2. Upgrade to Ops Manager v2.4.2 or Later
  3. Upgrade to Enterprise PKS v1.3.2
  4. Upgrade to Enterprise PKS v1.3.4
  5. Upgrade to Enterprise PKS v1.4.x

Upgrade to Enterprise PKS v1.2.7 or Later

Skip this step if you are already running Enterprise PKS v1.2.7 or later.

To upgrade to Enterprise PKS v1.2.7 or later, follow the procedures detailed in Upgrading PKS in the PKS v1.2 documentation.

Upgrade to Ops Manager v2.4.2 or Later

Skip this step if you are already running Ops Manager v2.4.2 or later.

Before you upgrade to Enterprise PKS v1.3.x and Enterprise PKS v1.4.x, you must upgrade to Ops Manager v2.4.2 or later.

  1. Follow the procedures detailed in 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 Enterprise PKS tile, selecting the Status tab, and reviewing the Pivotal Container Service VM’s data points. If any data points are at capacity, scale your deployment accordingly.

Upgrade to Enterprise PKS v1.3.2

Skip this step if you are already running Enterprise PKS v1.3.2 or v1.3.4 or later.

To upgrade to Enterprise PKS v1.4.1, you must upgrade from PKS v1.3.2.

Follow the procedures detailed in Upgrading Enterprise PKS in the PKS v1.3 documentation.

For more information about this upgrade, see PKS upgrade approach for CRITICAL CVE: 2019-3779 (67116).

Upgrade to Enterprise PKS v1.3.4

Skip this step if you are already running Enterprise PKS v1.3.2 or v1.3.4 or later.

Follow the procedures detailed in Upgrading Enterprise PKS in the PKS v1.3 documentation.

For more information about this upgrade, see PKS upgrade approach for CRITICAL CVE: 2019-3779 (67116).

Upgrade to Enterprise PKS v1.4.x

To upgrade to Enterprise PKS v1.4.x, complete the follow steps:

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

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

    Note: To upgrade to Enterprise PKS v1.4.2, you must upgrade from Enterprise PKS v1.3.4 or later, or v1.4.0 or later.

    Warning: Before upgrading from Enterprise PKS v1.3.x to v1.4.x, you must increase the size of persistent disk for the PKS VM. For more information, see Upgrade Fails Due to Insufficient Disk Space in the Known Issues.

  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 Enterprise PKS. This adds the tile to your staging area.

    Note: Your configuration settings migrate to the new version automatically.

  5. Complete the steps in Download and Import the Stemcell, below.

  6. Complete the steps in Verify Errand Configuration, below.

  7. Complete the steps in Apply Changes to the Enterprise PKS Tile, below.

Download and Import the Stemcell

Enterprise PKS v1.4.x uses a Xenial stemcell.

If Ops Manager does not have the Xenial stemcell required for Enterprise PKS, the Enterprise 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 Enterprise PKS tile, click on the Missing stemcell link.

    Verify stemcell assignment

  2. In the Stemcell Library, locate Enterprise PKS tile 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 Enterprise PKS tile 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 Enterprise PKS.

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

Verify Errand Configuration

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

  1. Click the newly-added Enterprise PKS 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-deployed Kubernetes clusters can temporarily interrupt the service, as described in Service Interruptions.

    Warning: If you are upgrading Enterprise 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 Enterprise PKS tile is aborted.

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

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

Apply Changes to the Enterprise PKS Tile

Perform the following steps to complete the upgrade to the Enterprise 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 Enterprise PKS deployment. For more information, see Managing Enterprise 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 Enterprise PKS v1.4.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 Enterprise PKS.

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

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

Verify the Upgrade

After you apply changes to the Enterprise 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 Enterprise PKS tile, selecting the 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 to Ops Manager v2.5.x

Enterprise PKS v1.4.x is compatible with Ops Manager v2.5.x on all IaaS except Azure. On Azure, Enterprise PKS v1.4.x is compatible only with Ops Manager v2.5.5 or later.

To upgrade Ops Manager, perform the following steps:

  1. Follow the procedures detailed in Upgrade Ops Manager and Installed Products to v2.5.

  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 Enterprise PKS tile, selecting the Status tab, and reviewing the Pivotal Container Service VM’s data points. If any data points are at capacity, scale your deployment accordingly.

Upgrade vSphere

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

For vSphere version requirements for Enterprise PKS, refer to the VMware Product Interoperability Matrices.


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