Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WINSTALLATION and version 4

...

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.

Info

Please also have a look at the API Management concerning necessary migrations before starting with the procedure.

Step 1: Backup Your Current Installation

...

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 of your installation (the one you have backup-ed in step 4)  with the new one coming with from 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. 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.

...