You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Related Documentation:
If you have a running Scheer PAS API Management installation and want to update, please do the following steps:

  1. Download the new API Management software.

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

    • API Managment 7.3.0 api-mgmt\single-host-setup\

    • API Managment before 7.3.0 api-mgmt\

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

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

  5. Unzip the downloaded software from api-mgmt-<version>.zip. This creates a new folder api-mgmt containing the new version of API Management.

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

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

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

    exit

    docker-compose stop
  9. MultiExcerpt named start_all_containers was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
  10. 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.

  11. 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.
  • No labels