Pivotal Cloud Foundry v1.7

Upgrading Pivotal Cloud Foundry

Page last updated:

Note: Pivotal Cloud Foundry (PCF) for vCloud Air and vCloud Director is deprecated and availability is restricted to existing customers. Contact Support for more information.

This topic describes upgrading Pivotal Cloud Foundry to version 1.7. The upgrade procedures below describe upgrading Ops Manager, Elastic Runtime, and product tiles.

If you have already upgraded your Ops Manager to version 1.7 and want to upgrade individual products such as PCF Elastic Runtime, Pivotal MySQL, or RabbitMQ® in your PCF deployment, see the Upgrading Products in a PCF Deployment topic.

WARNING: Before you upgrade to Pivotal Cloud Foundry 1.7, you must migrate all apps that are currently running on DEA architecture to run on Diego architecture. All apps that do not already run on Diego will terminate during an upgrade from 1.6 to 1.7.

Note: 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.

Important: Read the Known Issues section of the Pivotal Cloud Foundry (PCF) Release Notes before getting started.

Before You Upgrade

This section contains important guidelines that you must follow before beginning an upgrade to PCF 1.7. Failure to follow these instructions may jeopardize your existing deployment data or cause your upgrade to fail.

The tasks you need to complete before upgrade fall into three categories:

Choose Single-AZ or Multi-AZ

For AWS and OpenStack, Ops Manager 1.7 ships with a new multi-AZ functionality that results in multiple networks.

Note: The multi-AZ functionality ships with PCF 1.6 and later for vSphere.

When you upgrade to PCF 1.7 from a previous version instead of performing a new full install, you have a single-AZ deployment. If you want to use PCF 1.7 with multi-AZ functionality, choose one of the following procedures:

  • Upgrade and then apply multi-AZ:

    1. Follow the upgrade instructions on this page to upgrade to PCF 1.7.
    2. Follow the instructions in this Knowledge Base article to enable advanced mode in Ops Manager.
    3. Follow the instructions in this Knowledge Base article to apply the multi-AZ feature to your deployment.
  • Perform a new installation of PCF 1.7.

Prepare Your Environment for Upgrade

  1. Install the releases from your currently deployed version to the target version in sequential order. For example, if your deployment uses Ops Manager release 1.5 and you are upgrading to 1.7, you must sequentially install 1.6 and 1.7.

  2. Ensure that you are using Elastic Runtime (ERT) v. 1.6.9 or higher. For information about how to upgrade product tiles, see the Upgrading Elastic Runtime and Other Pivotal Cloud Foundry Products topic.

  3. Ensure that every product tile on the Installation Dashboard is compatible with the new version of Ops Manager. For specific compatibility information, refer to the full Product Version Matrix. If a product does not meet this requirement, you must upgrade the product or remove the tile before upgrading Ops Manager.

  4. For each product tile you have installed, review the upgrade documentation that is specific to the tile. For example, if you have RabbitMQ, you need to increase the number of HAproxy instances from one to two. See RabbitMQ for Pivotal Cloud Foundry Upgrades.

  5. Confirm that you have adequate disk space for your upgrades. From your Installation Dashboard, select the Ops Manager Director tile. Select Status. If you need more space to handle your upgrades, select Settings > Resource Config. Increase your persistent disk space to 100 GB, or enough to handle the size of the resources.

  6. If you have disabled lifecycle errands for any installed product in order to reduce deployment time, Pivotal recommends that you re-enable these errands before upgrading. See Adding and Deleting Products for more information.

  7. Ensure that the VM resurrector is turned off:

    1. From your Installation Dashboard, select the Ops Manager Director tile.
    2. Click Director Config.
    3. Clear the Enable VM resurrector plugin checkbox.
    4. Click Save.
    5. Return to the Installation Dashboard, and click Apply Changes.
  8. If you are upgrading a vSphere environment, ensure that you have the following information about your existing environment before starting the upgrade:

    • Note these IP addresses, which can be found in the vSphere web client, Manage > Settings > vApp Options. This is the same information you entered at the end of deploying Ops Manager on vSphere.
      • IP Address of the Ops Manager
      • Netmask
      • Default Gateway
      • DNS Servers
      • NTP Servers
    • Note this VM hardware information so you can set up the new VM with similar settings. You can find this in the vSphere web client, Manage > Settings > VM Hardware.
      • CPU
      • Memory
      • Hard Disk 1
      • Network Adapter 1 - When you set up the new VM, ensure your network adapters are configured properly and are on the same network.

Prepare Databases and Apps for Upgrade

  1. Back up all critical data prior to upgrading to PCF 1.7. For example, to backup a 1.6 environment, follow these instructions Backing Up Pivotal Cloud Foundry.

  2. Before you upgrade to Pivotal Cloud Foundry 1.7, you must migrate all apps that are currently running on DEA architecture to run on Diego architecture. Pivotal does not support DEA architecture in Pivotal Cloud Foundry 1.7. See the Migrating Apps to Diego topic for information.

Check System Health Before Upgrade

  1. Run bosh cloudcheck to confirm that the VMs are healthy. See the BOSH Cloudcheck topic.

  2. Check the system health of installed products. In the Installation Dashboard, select the Status tab for each service tile. Confirm that all jobs are healthy.

  3. (Optional) Check the logs for errors before proceeding with the upgrade. See the Viewing Logs in the Command Line Interface topic.

  4. There should be no outstanding changes in Ops Manager or any other tile. All tiles should be green. Click Apply Changes if necessary.

  5. After applying changes, click Recent Install Logs to confirm that the changes completed cleanly: Cleanup complete {"type": "step\_finished", "id": "clean\_up\\_up"} Exited with 0.

Upgrading with Installed Products

Follow the steps below to upgrade Ops Manager and keep all installed products.

Note: Ops Manager 1.7 uses the User Account and Authentication (UAA), instead of only local user account authentication. When you import your pre-1.7 file to Ops Manager, your user name changes to admin and your password remains the same. It also prompts you to create a shared passphrase, which is distinct from your password. Your passphrase on a new import will be the same as your password. However, you must change the passphrase for security purposes.

  1. From the Product Dashboard, select Actions > Export installation settings.

    Upgrade to 1.7

    This exports the current PCF installation with all of its assets. When you export an installation, the export contains the base VM images and necessary packages, and references to the installation IP addresses. As a result, an exported file can be very large, as much as 5 GB or more.

    • The export time depends on the size of the exported file.
    • Some browsers do not provide feedback on the status of the export process, and may appear to hang.

    Note: Some operating systems may automatically unzip the exported installation. If this occurs, create a zip file of the unzipped export. Do not start compressing at the “installation” folder level. Instead, start compressing at the level containing the config.yml file:


  2. Download the latest Ops Manager VM Template from the Pivotal Network site.

  3. Record the IP address of the existing Ops Manager VM.

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

  5. Deploy the new Ops Manager VM:

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


  7. When prompted, enter the following:

    • Decryption Passphrase, which is the same as your password.
    • Click Choose File and browse to the installation zip file exported in Step 3 above.

    Decryption passphrase

  8. Click Import.

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

  9. Before you see the new PCF 1.7 Installation Dashboard, a Security Features alert appears. Take note of your new username. Ensure you change your decryption passphrase before sharing it with other users. Click Continue.

    Security features

  10. A “Successfully imported installation” message appears upon completion.


  11. Click Apply Changes. This immediately imports and applies upgrades to all tiles in a single transaction.

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

  13. Remove the original Ops Manager VM from your IaaS if the new installation functions correctly.

After the Upgrade

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