Upgrade from Simplifier 10 to Simplifier 11

Introduction

This documentation is divided into 2 parts:

Part 1 describes the actual update of the containers and comes in two options
- Option 1 in case you use our recommended docker compose setup.
- Option 2 in case you have a custom setup. It describes the relevant changes that come with Simplifier 11 in a generic way.
Part 2 describes steps which have to be done independently of the container orchestration mode.

Make sure you read our Release Notes and Migration Notes for Simplifier 11 before you start upgrading your instance.

Part 1: Upgrading Simplifier

Option 1: Upgrade 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

Hint: If you have changed docker-compose.yml, make a backup of docker-compose.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 docker-compose.yml

Update the content and switch to the new release branch:

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

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 Update .env

Make a copy of your .env file

cp .env .env.10

Copy the template as new .env

cp .env.template .env

Edit the new .env file

nano .env

You must adjust the first 4 entries to your needs:

# these 4 variables need to be changed
SIMPLIFIER_HOSTNAME=example.simplifier.cloud
INITIAL_ADMIN_PASSWORD=MyAdminSecret12
DB_PASSWORD=MySecret123
DB_ROOT_PASSWORD=MySuperSecret

We recommend setting these values to the ones you used in your previous .env file. DB passwords are not automatically changed if you change them here.

Optional: Adjust other .env variables

Refer to docker image configuration for a complete list of variables, required by the individual containers. Change the .env values as needed:

SIMPLIFIER_HOSTNAME	Simplifier Hostname, FQDN, without protocoll. To access Simplifer, https://${SIMPLIFIER_HOSTNAME} needs to be used
DB_PASSWORD	MySQL Database Password
DB_ROOT_PASSWORD	Password for the MySQL root user
DB_NAME	Database name for the Simplifier database. Used as prefix for all plugin/module databases.
SIMPLIFIER_VERSION	Version of Simplifier you want to install. You should not change this. If you want to have another Simplifier version, please check out the appropriate branch instead
HOST_DATA_PATH	Path were all data is stored in the host.
PLUGINLIST	List of all plugins which should be started. Technically, the Workflow Engine is not a plugin, so it is not mentioned here
SIMPLIFIER_JVM_HEAP_GB	How much heap space for Simplier App Server in GB
TZ	Timezone. Only used in Workflow Context
WF_RT_JVM_HEAP_GB	How much heap space for Workflow Runtime in GB
WF_ARCHIVE_ENABLED	For archive related settings, please refer to this documentation.
WF_ARCHIVE_INTERVAL
WF_ARCHIVE_MAX_AGE_COMPLETED
WF_ARCHIVE_TIME
WF_DT_JVM_HEAP_GB	How much heap space for Workflow Designtime in GB
LAUNCHPAD_JVM_HEAP_GB	How much heap space for Launchpad in GB
PDFPLUGIN_SECURITY_ALLOW_JAVASCRIPT	Should Javascript execution be allowed in PDF templates? (Read more)
TRACKING_BEHAVIOR	Default: consent – each user is asked for consent. on – tracking is activated without asking for consent. off – tracking is disabled

Step 4

Pull new images

docker compose pull

Start Simplifier

docker compose up -d

Option 2: Generic upgrade instructions, if you are not using our default docker compose setup

Step 1 – Upgrade MySQL to 8.4

Make sure you use MySQL 8.4, if you haven’t before

Step 2 – Update exiting container

To upgrade to Simplifier MAKERS CHOICE 26-09, shut down Simplifier and change the container image name from

simplifierag/simplifier:10
simplifierag/launchpad:10
simplifierag/workflow-designtime:10
simplifierag/workflow-runtime:10

simplifierag/simplifier:11
simplifierag/launchpad:11
simplifierag/workflow-designtime:11
simplifierag/workflow-runtime:11

You need to add a new environment variable to the Simplifier container simplifierag/simplifier:

PI_AGENT_CONTAINER_ADDRESS=ws://business-agent-broker:3000

business-agent-broker stands for the DNS name of the newly added container (see next step)

Step 3 – Add new container

With this release, an additional container is needed:

simplifierag/pi-agent-broker:11

This new container needs to have network access to the simplifier container and, depending on your use cases for your Business Agents, to you AI Model Provider and the general Internet.

This container has one mandatory configuration via invironment variable:

SIMPLIFIER_URL=http://simplifier:8080

The value represent the simplifier container, always with the port 8080. The name depends on your setup.

Part 2: Doings after upgrade

Step 1: Update Simplifier Standard Content

Download the latest Standard Content from Marketplace and import it to your Simplifier Instance. Make sure using import scenarios ‘Overwrite all’ or ‘Skip unchanged’ (recommended).