Updating API Management

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.

Migration Notes

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

Step 1: Backup Your Current Installation

Backup your API Management data as described on API Management Backup and Restore, section Data Export.
Shut down your API Management.
To do this, run the following command:
CODE
```
docker-compose down
```

The docker-compose.yml can be found in the following folder:

api-mgmt\single-host-setup\
api-mgmt\

Backup the MySQL database and Elasticsearch. To do this, use the following commands:

CODE

docker-compose run --no-deps --rm -v $(pwd):/backup --entrypoint 'tar cvf /backup/mysql_data.tar /var/lib/mysql' mysql

CODE

docker-compose run -uroot --no-deps --rm -v $(pwd):/backup --entrypoint 'tar cvf /backup/es_data.tar /usr/share/elasticsearch/data' elasticsearch

Move the backup files to a safe location.

Rename folder api-mgmt your API Management installation resides in to e.g. api-mgmt _backup. This backups your current installation that will otherwise be overwritten by the update.

Step 2: Download and Extract the Software

Download the new API Management software.
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.

.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 Release Notes), 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=...

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

Load the new software with

CODE

docker image load -i api-mgmt-gateway-<VERSION>.tar

CODE

docker image load -i api-mgmt-ui-<VERSION>.tar

CODE

docker image load -i api-mgmt-keycloak-<VERSION>.tar

CODE

docker image load -i api-mgmt-devportal-<VERSION>.tar

Upgrade the MySQL database using the following commands:

CODE

docker-compose up -d mysql

CODE

docker exec -it mysql bash

CODE

mysql_upgrade --password

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

CODE

exit

CODE

docker-compose stop

Step 5: Start all Services and Finalize the Update

Go to folder api-mgmt/single-host-setup (folder that contains the file docker-compose.yml).
Start all containers by running the following command:
CODE
```
docker-compose up
```

To run the containers in the background, use:

CODE

docker-compose up -d

Upload new configurations.
If the new API Management software comes with new configurations (e.g. new policies, see API Management Release Notes), you need to import them to your installation. Import the file(s) as described on Restoring API Management Data.
After a successful update you may want to remove the old images to free up some disk space. In this case, just run
CODE
```
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.

Related Pages:

Troubleshooting the API Management Installation