Upgrading Pivotal Platform

Page last updated:

This topic describes upgrading Pivotal Platform to v2.7.

Breaking Changes: Read the Ops Manager v2.7 Release Notes, Pivotal Application Service v2.7 Release Notes, Pivotal Isolation Segment v2.7 Release Notes, Pivotal Application Service for Windows v2.7 Release Notes, and Ops Manager v2.7 and Runtime Breaking Changes for this release, including the Known Issues sections, before starting the upgrade process.

Warning: Pivotal does not recommend that you skip minor versions when upgrading Pivotal Platform. Skipping minor versions when upgrading Pivotal Platform may result in breaking changes. To avoid additional breaking changes, upgrade Pivotal Platform to the minor version that directly follows your current version of Pivotal Platform.


The procedure below describes upgrading Pivotal Operations Manager, Pivotal Application Service (PAS), and product tiles.

The apps in your deployment continue to run during the upgrade. However, you cannot write to your deployment or make changes to apps during the upgrade.

For details about how upgrading Pivotal Platform impacts individual PAS components, see What Happens During PAS Upgrades.

Task 1: Prepare to Upgrade

If you have not already, complete the steps in the Upgrade Preparation Checklist for Pivotal Platform v2.7.

Task 2: Upgrade Ops Manager and Installed Products to v2.7

The following sections describe how to upgrade Ops Manager and installed products to Pivotal Platform v2.7:

Import Installation to Ops Manager v2.7 VM

To import your Ops Manager installation to the Ops Manager v2.7 VM:

  1. Download the Ops Manager VM Template v2.7 from the Pivotal Network site.

  2. Record the fully qualified domain name (FQDN) address of the existing Ops Manager VM.

  3. To avoid conflicts, power off the existing Ops Manager VM.

  4. Deploy the new Ops Manager VM by following the steps in one of these topics:

  5. When redirected to the Welcome to Ops Manager page, select Import Existing Installation.

    Below the green Pivotal logo is the text 'Welcome to Ops Manager'. Next is the text 'Select an Authentication System', below which are two rectangular blue buttons. The top button is labeled 'Use an Identity Provider' in white text; the bottom button is labeled 'Internal Authentication' in white text. Below these buttons is a horizontal line break. Below the line break is the text 'Upgrading Ops Manager?', below which is a rectangular blue button labeled 'Import Existing Installation' in white text.

  6. When prompted, enter the Decryption Passphrase for this Ops Manager installation. You set this passphrase during your initial installation of Ops Manager.

    Note: If lost, the Decryption Passphrase cannot be recovered.

  7. Click Choose File and browse to the installation ZIP file exported in the installation export step of your upgrade preparation. For more information, see the Export Your Installation section of the Upgrade Preparation Checklist for Pivotal Platform v2.7 topic.

    Below the green Pivotal logo is a field labeled 'Decryption Passphrase' containing five hidden characters. Below this field is the text 'Enter file', below which is a small, rectangular gray button labeled 'Choose File'. To the right of the 'Choose File' button is the filename 'installation (4).zip'. Below this button and filename is a rectangular blue button labeled 'Import' in white text.

  8. Click Import.

    Note: Some browsers do not provide feedback on the status of the import process, and might appear to hang.

  9. A Successfully imported installation message appears upon completion.

    The top half of the pop-up message contains a dark green background, a rectangular green logo with a capital P in white, and the text 'Pivotal Ops Manager' in white. The bottom half of the pop-up message contains a lighter green background, a round, dark green icon containing a light green check, and the text 'Successfully imported installation.' in dark green text.

Import New PAS and Product Tiles

After upgrading to Ops Manager v2.7, you must upgrade your product versions.

To upgrade your product versions:

  1. Import the product file to your Ops Manager Installation Dashboard.

  2. Hover over the product name in Available Products and click Add.

  3. Click the newly-added tile to review any configurable options.

  4. (Optional) If you use other service tiles, you can upgrade them following the same procedure. For more information, see Upgrading PAS and Other Pivotal Platform Products.

Perform Your Upgrade

Warning: If the installation fails or returns errors, contact Support. Do not attempt to roll back the upgrade by restarting the previous version’s Ops Manager VM.

To perform your upgrade to Ops Manager v2.7:

  1. Navigate to the Ops Manager Installation Dashboard.

  2. Click Review Pending Changes, then Apply Changes. This immediately imports and applies upgrades to all tiles in a single transaction.

  3. Click each service tile, select the Status tab, and confirm that all VMs appear and are in good health.

  4. After confirming that the new installation functions correctly, remove the previous version’s Ops Manager VM.

(Optional) Task 3: Monitor Upgrade

The following sections describe how to monitor your Pivotal Platform foundation during the upgrade and troubleshoot issues:

Check Status and Performance

You can monitor the progress of the upgrade by checking the status of the foundation at various locations.

Pivotal recommends live-monitoring your upgrade with Pivotal Platform Healthwatch, which monitors and alerts on the current health, performance, and capacity of Pivotal Platform. Healthwatch captures, calculates, stores, visualizes, and alerts on Pivotal Platform platform metrics, including:

For more information, see the Pivotal Platform Healthwatch documentation.

If you are not using Pivotal Platform Healthwatch, you can do some or all of the following to monitor upgrade progress:

  • Use the BOSH CLI to check the status of a task, VM, or instance. For more information, see Check Status Using BOSH CLI.

  • Check app availability.

  • Run cf CLI commands.

  • Check the availability of the Ops Manager UI.

  • If using a network-attached storage (NAS) server, check the server’s performance.

  • If on vSphere, check vSphere performance.

Check Status Using BOSH CLI

To check the status of a task:

  1. Run:

    bosh -e ALIAS task TASK-NUMBER


    • ALIAS is your BOSH alias.
    • TASK-NUMBER is the number of the upgrade task you want to check.

To check the status of a VM:

  1. Run:

    bosh -e ALIAS vms --vitals

    Where ALIAS is your BOSH alias.

To check the status of an instance:

  1. Run:

    bosh -e ALIAS instances --ps

    Where ALIAS is your BOSH alias.

Check Diego State

You can use the CF Diego Operator Toolkit (cfdot) to check Diego component instance count by current state. For more information, see the cfdot repository on GitHub.

Take Snapshots of Storage Metrics

You can periodically take snapshots of storage metrics. Pivotal recommends this if you have a large foundation and have experienced storage issues in the past.

Collect Logs

If you encounter problems during upgrade:

  1. Collect the following information:
    • All job logs
    • Task debug logs for VM upgrade tasks
    • The installation log from Ops Manager

This information helps determine the cause of upgrade issues.

Task 4: After Upgrade

The following sections describe how to prepare for use of your new environment, check its health status, and clean up after upgrading your Pivotal Platform deployment:

Re-Create BOSH Alias

To log in to BOSH after upgrading Pivotal Platform, you must re-create your alias.

To re-create your alias using BOSH:

  1. Run:

    bosh alias-env ALIAS -e DIRECTOR-IP


    • ALIAS is the BOSH alias you are re-creating.
    • DIRECTOR-IP is the IP address of your BOSH Director VM.

Install New cf CLI

To install the version of the Cloud Foundry Command Line Interface (cf CLI) packaged with the PAS tile on Pivotal Network:

  1. Go to the Pivotal Application Service download page on Pivotal Network.

  2. Click the CF CLI download button.

  3. Unzip the cf CLI ZIP file containing compressed binaries for the cf CLI.

  4. Follow the procedure in the Install the cf CLI Using a Compressed Binary section of the Installing the cf CLI topic.

Check the Health of Your Deployment

Check the health of your Pivotal Platform deployment to ensure that all jobs and processes are running as expected.

To check the health of your deployment:

  1. Check your system status by running:

    bosh -e ALIAS -d DEPLOYMENT-NAME instances --ps
    bosh -e ALIAS vms --vitals
    bosh -e ALIAS -d DEPLOYMENT-NAME cck --report


    • ALIAS is your BOSH alias.
    • DEPLOYMENT-NAME is the name of your Pivotal Platform deployment.
  2. Push and horizontally scale a test app to test PAS performance.

  3. If you are running PAS MySQL as a cluster, run the mysql-diag tool to validate health of the cluster. For more information, see the BOSH CLI v2 instructions in Running mysql-diag.

Check Resource Settings

If you added custom VM Type or Persistent Disk Type options, you must ensure that these values are correctly set and were not overwritten.

To check your custom resource settings:

  1. Go to the Ops Manager Installation Dashboard and click the Ops Manager tile.

  2. Select Resource Config.

  3. Ensure that the values for VM Type and Persistent Disk Type are correct.

Run BOSH Clean-Up

To clean up old stemcells, releases, orphaned disks, and other unused resources:

  1. Run:

    bosh -e ALIAS clean-up --all

    Where ALIAS is the BOSH alias you are re-creating.

Restage Apps

VMware recommends telling developers to restage any apps that use buildpacks that were updated as a part of this upgrade.

For more information about how developers can restage apps, see Restage Your App.