IriusRisk upgrade guide

Note: As of 26/12/2022 version 3 support is now deprecated, this article is directly related to version 4. 

Note to upgrade to version 4: To deploy version 4 you need to change the image on your docker-compose file, if you are using docker, continuumsecurity/iriusrisk-prod:tomcat-4.

And please check first the Rules Migration Guide from version 3 to version 4 before proceeding with the version 4 upgrade, also please ensure to create the Elliptic key and mount it in the deployment if upgrading to 4.8 or later.

We strongly encourage testing on a pre-production instance first.

Perform a backup of your database

Regardless of your installation type, you should always have a backup of your IriusRisk database, especially before performing an upgrade to newer versions.

This step is mandatory if you want to be able to do a rollback later.

Please ensure you take note of the version you are currently on so that you can rollback to that version should you run into any issues.

If you're using PostgreSQL we recommend performing a backup with pg_dump tool. The steps are as follows:

sudo su
cd docker
cat docker-compose.yml | grep db
pg_dump -U iriusprod -h your.database.endpoint iriusprod > /tmp/DATABASE.dump

Upgrade your IriusRisk

Docker based installations:

First of all you need to stop your running docker containers by opening a command prompt and changing to the folder that contains IriusRisk files along with docker-compose.yml and execute:

docker-compose down

Then you need to take a look at your docker-compose.yml. There is a section where you specify the image for tomcat container. Check that it points at a generic version 4 for the latest updates:

image: continuumsecurity/iriusrisk-prod:tomcat-4

"continuumsecurity/iriusrisk-prod:tomcat-4" will always contain the latest 4.X version.

Then ensure that you have the latest docker images with:

docker-compose pull

Start up your new installation:

docker-compose up -d

On the first run of the new IriusRisk release there will be upgrades and migrations performed on the database. This process can take more than 30 minutes depending on your database size and the type of migrations. You can check the progress of this by viewing the container console with:

docker logs -f iriusrisk-tomcat

The system is up and running and available for use once you see this message:

INFO [main] org.apache.catalina.startup.Catalina.start Server startup in xxxxxx ms 

Roll back a failed backup

In case you want to roll back to a certain previous version of IriusRisk you will need a database backup of your data in the desired version.

Restore the database

Before making any changes we encourage you to make a final backup.

If you're using PostgreSQL we recommend performing a backup with pg_dump tool. The command is as follows:

pg_dump -U iriusprod -h your.database.endpoint iriusprod -Fc -f DATABASE_FINAL.dump

We start by deleting the current database and create a clean one:

dropdb -U iriusprod -h your.database.endpoint iriusprod
createdb -U iriusprod -h your.database.endpoint -O iriusprod iriusprod

Now we can load the backup in the desired version:

pg_restore -U iriusprod -h your.database.endpoint -Fc -c -d iriusprod DATABASE_VERSION_X.dump

This procedure may throw some warnings trying to delete in-existent tables. Ignore them.

Restore the application

Once the database is ready it's time to download and run the application.

If you are using containers, just change the image to pull to the desired version. There is a section in your docker-compose.yml where you specify the image for tomcat container. Set the image to the desired version. For example, to get the 4.10.2 version put:

image: continuumsecurity/iriusrisk-prod:tomcat-4.10.2