Page History

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.

...

...

1. If there are new configuration variables coming with the new software release (see API MANAGEMENT Release NotesManagement), 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.

   Info
   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

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

...

1. Multiexcerpt include
   MultiExcerptName start_all_containers PageWithExcerpt INTERNAL:_api_excerpts

2. Upload new configurations.
   If the new API Management software comes with new configurations (e.g. new policies, see API MANAGEMENT Release NotesManagement), you need to import them to your installation. Import the file(s) as described on API Management Administration > Export/Import 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

   Code Block
   docker image rm api-mgmt/NAME-VERSION

   For more clean up instructions refer to the docker documentation.

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