If you plan to upgrade your Akamas instance, please verify the upgrade path with the Akamas support team. To ensure rollback in case of upgrade failure, it is suggested to back up your studies (see section User data backup).
The following guide uses the same chart repository and helm release names. Before starting the upgrade, you may find it helpful to look at the section Useful Commands.
Start by updating the local chart repository:
Ensure your kubectl configuration points to the namespace where Akamas is installed or specify it with the --namespace parameter. To start the upgrade to the latest version:
You can specify an older chart version using the --version parameter. Refer to Listing Akamas chart versions for discovering the published chart versions.
If you need to specify a different Values file from the latest installation, start from the last one used. If you do not have it stored, it can be retrieved as specified in Retrieving the Values file.
Before starting the upgrade, check Configure the registry to add new docker images.
If you can not reach helm.akamas.io from the machine where the installation will be run, run the following commands from another client (see the installation guide for a full explanation).
Then, you can start the upgrade in the same way as for the Online version. If you are using the downloaded chart package, transfer the package and replace akamas/akamas with the downloaded tgz archive.
Akamas' versions can be listed by running the following command:
It is always suggested to install and upgrade to the latest chart version. The App Version field refers to the Akamas version. To ease the release process multiple chart versions may refer to the same App Version.
In case you do not have access to the Values file used during the last installation/upgrade, you can still get it by running:
Such a command is useful only if you need to change some of the parameters during the upgrade, otherwise the old Values file is kept by Helm.
The following sections describe the procedure to upgrade your Akamas instance.
If you plan to upgrade your Akamas instance, please verify the upgrade path with the Akamas support team. To ensure rollback in case of upgrade failure, it is suggested to backup your studies (see section User data backup).
If you plan to upgrade your Akamas instance, please verify the upgrade path with the Akamas support team. To ensure rollback in case of upgrade failure, it is suggested to backup your studies (see section User data backup).
To start with the upgrade, on the Akamas server navigate to the same folder where the docker-compose.yml and .env file are stored (see section Get Akamas Docker artifacts). Now you can download the latest version compose file:
You can point to a specific version. As an example to download the artifact for version 3.2.2:
If the old docker-compose has been changed and it is still needed in the newer Akamas version, make sure to migrate such changes from docker-compose.yml.bak to the docker-compose.yml .
Ensure your .env file is up to date with the required variables, by comparing your version with the one at Configure Akamas environment variables.
Then log in to AWS with the following command:
If the login succeeds, then you can start the upgrade by running:
Wait for a few minutes and check the Akamas services are running the command:
The expected output should be like the following (repeat the command after a minute or two if the last line is not "OK" as expected):