Upgrade from Release 8 to Release 8 EHP 1

These documentation is splitted into 3 parts. Part 1 and 2 describes the actual update of the conainers, Part 1 is relevant if you use our recommended docker compose setup. Part two describes the same in a generic way.

Part 3 describes steps which have to be done independently of the container orchestration mode.

Part 1: Update using default docker compose

Step 1 – Shutdown Simplifier Instance

Go to the directory where you placed the docker-compose file. Switch into that folder:

cd docker-compose

To stop Simplifier, run

docker compose-f simplifier-standalone.yml down

Step 2 – Get Simplifier setup files

Prerequisite: simplifier-standalone.yml is not changed, only .env file has manual entries. If this is not the case, make a backup of simplifier-standalone.yml and add your changes to the new version. You could use git stash and git stash pop for this. To make a copy and revert your changes:

git stash
git restore simplifier-standalone.yml

Update the content and switch to the new release branch:

git pull
git checkout --track origin/release/8.1

The filename simplifier-standalone.yml was changed to docker-compose.yml to comply to the docker standards. You now can omit the -f <filename> parameter to execute docker compose commands.

Step 3 – Updating .env

With the 8 EHP 1 template, we introduced 3 new environment variables:

# new variables with 8.1 template
INSTANCE_PREFIX=dev # # only use letters!
PUBLIC_PORT_HTTP=80
PUBLIC_PORT_HTTPS=443

Usually, PUBLIC_PORT_HTTP and PUBLIC_PORT_HTTPS do not need to be changed.

With INSTANCE_PREFIX, you can define for which environment this Simplifier is used. Typical values for this are dev, qa, prod, test. Please always set a value here and do not leave it empty. This naming only reflects to the container names and is independent of the host name the instance is listenting to.

Step 4: renaming data folder

Up to release 7, there was only one storage folder called data. With Release 7 EHP 1 und Relese 8, new container images were added with their own persistant storage. Out of historic reason, the folder for simplifier was still called data in our default setup, but the other folders were named accoring to the names of the containers. To have a consistent naming, our default setup now uses simplifier as folder name for the simplifier container. To match this, you should rename the existing folder. If you used the recommended folder structure, you need to do:

mv /var/lib/simplifier/data /var/lib/simplifier/simplifier

Part 2: Generic upgrade instructions

Infrastructure-wise, there aren’t any changes within this release. Just replace the 8.0 tags of the container image names with 8.1 in what any configuration management you use. Make sure you change this for all containers. A mix of 8.0 and 8.1 containers is not supported.

Part 3: Doings after upgrade

Step 1: recreate keystores (optional)

Recreating keystores is only necessary, if you are using a custom keystore in your current setup. If you did not implement this, you can skip this step.

With Simplifier Release 8 EHP 1, the JVM version changed. Because of this, the keystore format changed, as well as the correct location for the keystore.

To edit the keystore, please always use keytool from within the container. The path to keytool is

/usr/lib/jvm/graalvm-community-openjdk-20.0.1+9.1/bin/keytool

The path of the cacerts file is

/usr/lib/jvm/graalvm-community-openjdk-20.0.1+9.1/lib/security/cacerts

Step 2: update Standard Content

Download the latest standard content from https://community.simplifier.io/marketplace/ and import it to your Simplifier Instance. Make sure you activated the Override switch.