Upgrading IBM Cloud Private Cloud Foundry

Complete the following steps to download and upgrade IBM® Cloud Private Cloud Foundry.

The upgrade process requires approximately 2 - 4 hours. This estimate doesn't include time that it takes to download the installation files.

Before you begin: Ensure that all the virtual machines for all your deployments are running and in a healthy state. On the inception container, perform the following checks:

Check all BOSH deployed virtual machines. Ensure that all of the virtual machines are running.
```
bosh -e IBMCloudPrivate vms
```
Check monit processes on all BOSH deployed virtual machines. Ensure that all of the processes are running.
```
bosh -e IBMCloudPrivate instances --ps
```
Use BOSH to check for deployment issues. Ensure that zero problems are reported.
```
bosh -e IBMCloudPrivate -d Bluemix cck
```

Note: Migration from version 2.1.0.3 or earlier of IBM Cloud Private Cloud Foundry is not supported. A new installation is required.

The upgrade process consists of three parts. You can complete parts 1 and 2 concurrently. Complete part 3 after you complete parts 1 and 2.

Part 1: Prepare the new installation media
Part 2: Check the existing installation for upgrade
Part 3: Upgrade to the new version

Before you begin: Note the data directory for your existing installation. This directory is the directory that you originally specified for the -c argument to the launch.sh script. You need this directory in parts 2 and 3. Substitute it where you see <installation_configuration_directory> in the example commands.

Also, inspect the uiconfig.yml file in the <previous_installation_directory> to verify that developer_mode: false is set . Migration is not supported for developer mode. If you're using developer mode, create a new deployment.

Part 1: Prepare the new installation media

Download the full installation file from Passport Advantage (8.1 GB).
To upgrade IBM Cloud Private Cloud Foundry, copy the installation file to a server that has access to the Docker CE and the IaaS environment.
If Docker Community Edition (CE) is not already installed, install Docker CE. For more information, see Install Docker .
Create a directory to use for the upgrade, referred to as <installation_directory> later in the instructions.
Extract the full installation file into the directory.
Change to the directory.
Import the Docker images from the directory.
```
import_images.sh
```

Part 2: Check the existing installation for upgrade

Change to the previous version installation directory, referred to as <previous_installation_directory> in the commands.

Make a copy of the configuration for your previous installation that you'll modify for the upgrade process:

cp <installation_configuration_directory>/uiconfig.yml <previous_installation_directory>/uiconfig_upgrade.yml

Inspect the uiconfig_upgrade.yml file and verify that developer_mode: false is set. If developer_mode: true is set, do not continue migration. You must create a new deployment.

Part 3: Upgrade to the new version

Change to the directory of the new version, referred to as <installation_directory>.
Run the launch.sh script to start the installer container. Replace <environment-name> with the same name you used for the container in part 2. <installation_configuration_directory> is the original data directory from the previous install.
```
./launch.sh -n <environment_name> -c <installation_configuration_directory> -e LICENSE=accept
```
Make a copy of the new version of the uiconfig template. The uiconfig template file is available after you run the launch.sh command. Check the <installation_configuration_directory>/extensions/embedded/cfp-bosh-templates/uiconfig_<environment_type>_template.yml file where <environment_type> depends on your IaaS infrastructure (vmware/openstack/aws).

For example, if you use vSphere:
```
cp <installation_configuration_directory>/extensions/embedded/cfp-bosh-templates/uiconfig_vmware_template.yml <installation_directory>/uiconfig_upgrade.yml
```
Find the keys and values that are specified in the contents of the previous version configuration file, <previous_installation_directory>/uiconfig_upgrade.yml, that need to be filled out in the latest version and copy them into the <installation_directory>/uiconfig_upgrade.yml file. Complete the value for any new keys that are required by 3.1.1. See Installing IBM Cloud Private Cloud Foundry for more information about the configuration parameters.
- Custom YAML changes Since there are configuration changes between IBM Cloud Private Cloud Foundry cf-release and cf-deployment, any custom YAML sections that are listed in the uiconfig_upgrade.yml file might need to be modified. For example, cloud_config_custom, cf_custom, and director_custom.
Upgrade to the new version.
```
./cm engine reset
./launch_deployment.sh -c uiconfig_upgrade.yml
```
This command activates all deployment steps and starts the IBM Cloud Private Cloud Foundry upgrade. If you experience issues, see Troubleshooting IBM Cloud Private Cloud Foundry.
Clean-up (optional): On the inception container, run the following command to remove any stemcells, releases, or orphaned disks that you are no longer using:
```
bosh -e IBMCloudPrivate clean-up --all
```