APIIDA API Gateway Manager
Release Notes
Summary of enhancements, fixes, and known issues.
Supported Versions
Releases of APIIDA’s API Gateway Manager are under active support for six months. Security related updates are shipped for another three month. After this date there will be no fixes whatsoever.
Releases are currently scheduled every three month, however we might opt to skip one release.
Version | End of Support | End of Security Patches |
|---|---|---|
All versions prior 2022.3 | - | - |
2022.3 | April 2023 | July 2023 |
2023.1 | October 2023 | January 2024 |
2023.2 | January 2024 | April 2024 |
2024.1 | June 2024 | September 2024 |
2024.2 | September 2024 | December 2024 |
Versioning Scheme And Regular Security Updates
See the following table for an example of the versioning scheme we are using:
Release | Tag in Docker-Hub |
|---|---|
Latest release of AAGM | latest |
First release of 2023 | 2023.1 |
Second release of 2023 | 2023.2 |
Update #1 for 2023.1 | 2023.1.1 |
Update #2 for 2023.1 | 2023.1.2 |
Depending on your preferences you can pin your installation to a specific release or go for the latest tags to always pull the newest builds. The update releases contain bug fixes of the API Gateway Manager itself. Updated builds of said releases (containing new versions of the base images / installed packages) are created in a monthly rhythm and are released under the existing tags. Only the latest update version of a release gets new builds though. In the above example the tags “latest” and “2023.1.2” will receive updated images monthly. The monthly builds are issued mid-month.
Upgrade from previous Version
The instructions below work with the Virtual Appliance, as well as with the Docker installation.
If you always want to stay on the most current version of APIIDA API Gateway Manager you can set your docker files to use the ‘latest’ tag. For a full list of all available tags see the listing on Docker Hub. https://hub.docker.com/r/apiida/aagm/tags
To Upgrade the APIIDA API Gateway Manager please execute the following steps:
Check whether there is a update guide and read it.
Optional: Backup your data (see section below).
Change the version in docker-compose.yml to whatever version you are upgrading to for the image apiida/aagm.
Restart the Docker containers
docker compose up --detach --pull=always
Updating the APIIDA Solution Kit
If you are using the APIIDA Solution Kit for Monitoring, please additionally do the following steps to upgrade the solution kit:
Follow this instruction: https://apiida.atlassian.net/wiki/spaces/AAGM/pages/7760740363
Instead of installing a new solution kit, please select the previous version and click on [Upgrade].
Please restart all gateway instances in the cluster
Backing up your data
All persistent data is stored in the folder /opt/aagm within the image. If you use our default docker-compose file this directory is mapped to a value with the name “aagm-vol”. See the Docker documentation on how to backup a volume.