Step 1: Backup Your Current Installation
The page APIMGMNT:API Management Backup and Restore was not found -- Please check/update the page name used in the MultiExcerpt-Include macro
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.
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:
# KEYCLOAK_ADMIN_USERNAME=username
# KEYCLOAK_ADMIN_PASSWORD=password
- 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.
- 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
MultiExcerpt named load_docker_images was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macroUpgrade 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
- MultiExcerpt named start_all_containers was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
- 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 API Management Administration > Export/Import Data. 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.