1. Documentation
2. 2024.1 (Latest) 2024.0 10.3 10.2 10.1 10.0 9.10 9.9 9.8 9.7 9.6 9.5 9.4 9.3 9.2 9.1 9.0 8.2 8.1 8.0 7.6
3. Server
4. Administration
5. Upgrading
6. Upgrade RapidMiner Server 8.x

Upgrade RapidMiner Server 8.x

This section describes updating RapidMiner Server from 8.x to the latest version using the full upgrade. It also describes the process for rolling back the upgrade.

Performing a full upgrade

A full upgrade means installing RapidMiner Server into an empty directory while pointing the database to the existing one.

Stop the old RapidMiner Server 8 and perform a backup

1. Stop all connected Job Agents and take a note where you can find them. 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. Back up your RapidMiner extensions. If you are unsure of the directory location, check the setting on the Administration > System Settings page. The location is the value defined for the property com.rapidanalytics.plugindir.

3. Stop the old RapidMiner Server 8. If running Windows, verify that all RapidMiner-related services have stopped.

4. Back up your RapidMiner Server operations database.

5. Back up the workDir/ in the RapidMiner Server base directory.

6. Back up the execution.properties file from your RapidMiner Server configuration folder standalone/configuration/.

7. (Optional) Back up the job-agent/ directory if the agent-bundled Job Agent is used.

Install latest RapidMiner Server 8

1. Download the latest version of the full server package.

2. Change to the bin/ directory, within the installation directory, to locate (and then run) the start script (or batch file) for installing the new version of RapidMiner Server software.

Restore previous configuration

1. Copy the workDir/ of the old RapidMiner Server 8 to the new RapidMiner Server 8 installation folder.

   For example: cp -r rm-server-8.0.1/workdir/ rm-server-8.1.0/workdir/

2. If the agent-bundled Job Agent is used:

   1. Copy the following folders from the old to the new job-agent/ directory:

      • data/
      • jobs/
      • logs/

      For example: cp -r rm-server-8.0.1/job-agent/data/ rm-server-8.1.0/job-agent/data/

   2. Restore installed extensions and re-apply custom configuration of old agent-bundled Job Agent.

3. Do not forget to re-apply the configuration changes you made to the previous version of RapidMiner Server. For example if you modified standalone.xml then manually re-apply the pieces you changed to the new version too. Do not copy the whole files as it may change from version to version.

Start the new RapidMiner Server 8 and perform migration steps

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

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

3. Check location of installed extensions:

   1. Update the com.rapidanalytics.plugindir property in the system settings in regard to your new installation folder.

   2. Restore installed extensions from the old location.

      Note: If you are using Radoop, make sure you go through the specific installation steps described in the Radoop documentation.

   3. Restart RapidMiner Server if location has changed.

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 job-agent-QueueName.zip -d rapidminer-jobagent-8.1.0/

   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 following folders from the old to the new Job Agent:

   • data/
   • jobs/
   • logs/

   For example: cp -r rapidminer-jobagent-8.0.1/rapidminer-jobagent/data/ rapidminer-jobagent-8.1.0/rapidminer-jobagent/data/

4. Restore installed extensions and re-apply custom configuration of the old Job Agent.

5. 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 config/config.properties file.

Rolling back a full upgrade

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 old RapidMiner Server and Job Agent files from backups.

5. Start the old RapidMiner Server and the corresponding Job Agents.