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

Upgrade RapidMiner Server 9.1

This section describes updating RapidMiner Server from 9.1 to the latest version. It also describes the process for rolling back the upgrade.

Performing a full upgrade

This upgrade process does not perform an in-place upgrade, but instead installs the new version of RapidMiner Server into a new installation directory. The new instance uses your existing 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

  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 RapidMiner Server. If running Windows, verify that all RapidMiner-related services have 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 your RapidMiner Server home directory.

Install RapidMiner Server

  1. Download version 9.1 of the full server package.

  2. Unzip the installer

  3. Change to the bin/ directory within the installer directory and run the start script.

  4. Follow the prompts to upgrade RapidMiner Server.

    • At the Locations step, select a fresh installation directory and your existing home directory.
    • At the Server Settings step, configure the existing external database
  5. Run the installation

Restore custom configurations

The <home directory>/configuration/ folder is a new folder created by the installation process. The old configuration folder has been backed up and is located right next to the newly created folder.

Re-apply the configuration changes you made to the previous version of RapidMiner Server (e.g. custom modifications to the standalone.xml or files). Do not copy the whole files as they may change from version to version.

If the bundled Job Agent is used, copy the old Job Agent home directory to the new one:

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

Start RapidMiner Server

  1. From the new installation folder, start RapidMiner Server.

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

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.1/

    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 RapidMiner Server. 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 the old RapidMiner Server and the corresponding Job Agents.