Chapter 1. Before you begin

Prior to proceeding with the upgrade, you must consider these points:

Supported configurations

  • 3scale supports upgrade paths from 2.5 to 2.6 with templates only, on OpenShift 3.11.

Previous 3scale versions

  • Assuming 3scale 2.5 was deployed with the amp.yml standard scenario template, download the new 3scale 2.6 amp.yml template and then deploy it to create the new OpenShift elements.

  • For multi-version upgrades from earlier versions than 2.4, confirm the existence of the system-environment ConfigMap: 

    $ oc get configmap system-environment
    • If you get NotFound error message, refer to the 2.4 Upgrade Guide, under Creating ConfigMaps.

Tooling

  • Perform a backup of the databases. The procedure of the backup is specific to each database type and setup.
  • Ensure your OpenShift CLI tool is configured in the same project where 3scale is deployed.
  • Run the commands below in the bash shell.

  • For this upgrade, download and get the patch files by following these steps:

    1. Click templates-migration-2.5-to-2.6.
    2. Download and extract the files.

You will see some file references throughout the document that are relative to the contents of the compressed file you have downloaded. For example, $(cat db-imagestream-patches/backend-redis-json.patch).