If you have a running Scheer PAS API Management installation and want to update, please do the following steps. If you experience problems during the update, refer to Troubleshooting the API Management Installation.

Please also have a look at the API Management migration notes before starting with the update procedure.

Step 1: Backup Your Current Installation

Step 2: Download and Extract the Software

  1. Download the new API Management software.

  2. Unzip the downloaded software from api-mgmt-<version>.zip. This creates a new folder api-mgmt containing the new version of API Management.

Step 3: Configure the Installation Settings

Rework the configuration files.

  1. .env File
    Copy the .env file from your API Management backup api-mgmt_backup/single-host-setup (see step 1/4) to your updated API Management installation.
    If there are new configuration variables coming with the new software release (see API Management), you need to merge the previous .env file with the new one from the update.

    As you have already an administrator account for your API Management installation, you can comment out the following lines in your .env file:

    # KEYCLOAK_ADMIN_USERNAME=...
    # KEYCLOAK_ADMIN_PASSWORD=...

  2. docker-compose.yml
    If you did not stick to the standard installation and have made changes to the docker-compose.yml, you need to merge those changes into the new docker-compose.yml.
  3. Certificates and Keystores
    Copy all certificates and keystores from the backup folder of your old installation (api-mgmt _backup/configs) to your updated installation (api-mgmt/configs). Overwrite the existing files from the target folder - they are example files only.

Step 4: Update the Software

  1. Load the new software with

  2. Upgrade the MySQL database using the following commands:

    docker-compose up -d mysql

    docker exec -it mysql bash

    mysql_upgrade --password

    If you are asked for a password, use the password you specified in the .env file for MYSQL_ROOT_PASSWORD.

    exit

    docker-compose stop

Step 5: Start all Services and Finalize the Update

  1. Go to folder api-mgmt/single-host-setup (folder that contains the file docker-compose.yml).
  2. Upload new configurations.
    If the new API Management software comes with new configurations (e.g. new policies, see API Management), you need to import them to your installation. Import the file(s) as described on Restoring API Management Data.

  3. After a successful update you may want to remove the old images to free up some disk space. In this case, just run

    docker image rm api-mgmt/NAME-VERSION

    For more clean up instructions refer to the docker documentation.

    Also consider removing the backup files from step 3 as they consume a considerable amount of disk space.