Versions Compared

Old Version 1

changes.mady.by.user Kirstin Seidel-Gebert

Saved on

compared with

New Version Current

changes.mady.by.user Annegret Bernhardt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WINSTALLATION and version 24.0
Div
Classe2e-refDiv
Rde

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 from folder api-mgmt\single-host-setup\.

Code Block
docker-compose down

...

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:

Code Block
docker-compose run --no-deps --rm -v $(pwd):/backup --entrypoint 'tar cvf /backup/mysql_data.tar /var/lib/mysql' mysql
Code Block
docker-compose run -uroot --no-deps --rm -v $(pwd):/backup --entrypoint 'tar cvf /backup/es_data.tar /usr/share/elasticsearch/data' elasticsearch

...

Unzip the downloaded software to the folder your API Management installation resides in.
This will overwrite your current API Management installation.

Note

As this will also overwrite your Docker configuration file, make sure that you have renamed it as explained in step 4.

Note

This will also overwrite the docker-compose.yml of your installation. This is no problem, if you have stuck to the standard installation. However, if you have changed something, you need to backup this file, too, and merge your changes to the new file that is coming with the update.

...

. If you experience problems during the update, refer to Troubleshooting the API Management Installation.

Note
titleMigration Notes

Please also have a look at the API Management migration notes before starting with the update procedure.

Children Display

Step 1: Backup Your Current Installation

Multiexcerpt include
SpaceWithExcerptAPIMGMNT2311
MultiExcerptNamebackup
PageWithExcerptAPIMGMNT2311:API Management Backup and Restore

Step 2: Download and Extract the Software

  1. Download the new API Management software.

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

Anchor
installation_settings
installation_settings

Step 3: Configure the Installation Settings

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

...

  1. Management), you need to merge the previous .env file

...

  1. with the new one

...

  1. 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=

...

  1. ...
    # KEYCLOAK_ADMIN_PASSWORD=

...

  1. ...

  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.

Step 4: Update the Software

  1. Load the new software with

    Multiexcerpt include
    MultiExcerptNameload_docker_images_api
    PageWithExcerptINTERNAL:_

...

  1. installation_excerpts

  2. Upgrade the MySQL database using the following commands:

    Code Block
    docker-compose up -d mysql
    Code Block
    docker exec -it mysql bash
    Code Block
    mysql_upgrade --password
    Info

    If you are asked for a password, use the password you specified in the .env file for MYSQL_ROOT_PASSWORD.

    Code Block
    exit
    Code Block
    docker-compose stop

Step 5: Start all Services and Finalize the Update

  1. Go to folder api-mgmt/single-host-setup (folder that contains the file docker-compose.yml).
    Multiexcerpt include
    MultiExcerptNamestart_all_containers_docker
    PageWithExcerptINTERNAL:_

...

  1. installation_excerpts
  2. Upload new configurations.
    If the new API Management software comes with new configurations (e.g. new policies, see API

...

  1. Management), you need to import them to your installation. Import the file(s) as described on Restoring API Management

...

  1. Data.

  2. 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.
Panel
titleOn this Page:

Table of Contents

Panel
titleRelated Pages:
Panel
titleRelated Documentation: