If you have a running Scheer PAS API Management installation and want to update, please do the following steps:
Shut down your API Management.
To do this, run the following command:
docker-compose down |
The docker-compose.yml can be found in the following folder:
|
Backup your API Management data as described on API Management Administration > Export/Import Data.
Also backup the MySQL database and Elasticsearch. To do this, use the following commands:
docker-compose run --no-deps --rm -v $(pwd):/backup --entrypoint 'tar cvf /backup/mysql_data.tar /var/lib/mysql' mysql |
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.
Unzip the downloaded software from api-mgmt-<version>.zip. This creates a new folder api-mgmt containing the new version of API Management.
If there are new configuration variables coming with the new software release (see API MANAGEMENT Release Notes), you need to merge the .env file of your installation (the one you have backup-ed in step 4) with the new one coming with 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:
|
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.
Load the new software with
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 |
exit |
docker-compose stop |
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. |