You are viewing the RapidMiner Server documentation for version 9.5 - Check here for latest version

Upgrade guide

In this guide we'll run you through upgrading RapidMiner Server as a High Availability cluster in a Linux environment from version 9.1 and above.

Performing a cluster upgrade

The upgrade process installs the new version of RapidMiner Server into a new installation directory for every node. The new instance uses the existing shared RapidMiner Server home directory and existing database.

If necessary, rolling back an upgrade can only be performed by restoring a backup of both the RapidMiner Server home directory and the RapidMiner Server database – rolling back requires a consistent home directory and database. You can then reinstall the previous version of the application to the installation directory. Read the Rollback section below for more details.

Stop the application cluster

  1. Stop all connected Job Agents. Verify that you stopped every Job Agent by navigating to the Queues page and check the connected agents per queue. There should always be the message No Job Agents connected.

  2. Stop all RapidMiner Server nodes. If running Windows, verify that all RapidMiner-related services have been stopped.

Back up your data

We strongly recommended that you perform a backup of RapidMiner Server data before making changes to the software version:

  1. Back up your external database and confirm the backup was created properly. You can use the database native tools to create the backup.

  2. Back up the shared RapidMiner Server High Availability home directory.

Upgrade first RapidMiner Server node

Start the upgrade process by upgrading the first RapidMiner Server node. Do not upgrade the other RapidMiner Server nodes before the first one has been upgraded and the migration step have been completed.

  1. Upgrade first RapidMiner Server node. Follow the upgrade guide for a standalone RapidMiner Server node.

  2. From the new installation folder, start the first RapidMiner Server node.

  3. Log on to RapidMiner Server as admin and perform necessary migration steps.

Upgrade remaining RapidMiner Server nodes

After the first RapidMiner Server node has been upgraded and the migration steps have been completed, perform the upgrade procedure for all other RapidMiner Server nodes as well.

Upgrade external Job Agents

For every external Job Agent:

  1. Download a new Job Agent archive for the corresponding Queue.

  2. Unzip the new Job Agent archive and place the extracted folder near the Job Agent you would like to update.

    For example:

    unzip -d rapidminer-jobagent-9.x/

    Note: The Job Agent folder in the archive is always called rapidminer-jobagent so do not unzip it in the same folder as the old one as it will overwrite the old contents.

  3. Copy the old Job Agent home directory to the new one:

    cp -r {old-job-agent-directory}/home/ {new-job-agent-directory}/home/

  4. Start the new Job Agent and make sure it is visible on the Queues page. The name of the new Job Agent can be found in the home/config/ file.


To roll back an upgrade:

  1. Stop all connected Job Agents.

  2. Stop all RapidMiner Server nodes. If running Windows, verify that all RapidMiner-related services have stopped.

  3. Restore your RapidMiner Server database from backup. If unsure how to do so, try searching Google for the appropriate commands for your database type.

  4. Restore your RapidMiner Server home folder from backup.

  5. Start all RapidMiner Server nodes and the corresponding Job Agents.