Upgrading RapidDeploy from v4 or v5

To upgrade RapidDeploy from an earlier version of 4.0, 4.1, 4.2 or 5.0, perform the following steps:

Manual Upgrade

  • Stop RapidDeploy as follows, which will write the in-memory database to file:
    ${MV_HOME}/bin/stop-web-app.sh
  • Check that the following file is present:
    ${MV_HOME}/users/<RD-USER>/mv-data.rds

    Where RD-USER is the OS user you used to install/start RapidDeploy.

  • Back up the following directories:
    ${MV_HOME}/logs
    ${MV_HOME}/projects
    ${MV_HOME}/buildstore
    ${MV_HOME}/promotionstore 
    ${MV_HOME}/resources
    ${MV_HOME}/users
    ${MV_HOME}/snapshots
    ${MV_HOME}/libraries
    ${MV_HOME}/proj-lib
  • Install the new version of RapidDeploy
  • Restore the directories you backed up to the same locations
  • If you have made changes to the $MV_HOME/bin/rapiddeploy.properties file, re-apply these changes to the new file (perform a diff if necessary).
  • Start the new instance of RapidDeploy as follows:
    ${MV_HOME}/bin/start-web-app.sh

Using the provided script (recommended for Linux and Mac users)

  • Prior to upgrading, run the following script with the 'backup' argument, which copies the required files to the /tmp directory on your server into a new folder with the current date stamp:
    cd ${MV_HOME}/bin
    ./upgrade.sh backup
  • Move the $MV_HOME folder to another backup location
    cd ../..
    mv midvision midvision-backup-1
  • Unzip the new RapidDeploy assembly (shown for Mac, amend for your platform)
    unzip rapiddeploy-web-app-macosx.zip
  • Rerun the upgrade script with the 'restore' argument:
    cd ${MV_HOME}/bin
    ./upgrade.sh restore
  • You will be prompted to amend the new rapiddeploy.properties file with any differences detected between the two versions.
    vi ${MV_HOME}/bin/rapiddeploy.properties

Do not upgrade by unzipping over an existing installation

Both procedures above replace $MV_HOME with a freshly unzipped installation and restore only your data directories, so the new release's libraries are the only ones present. That is deliberate, and it is the only supported way to upgrade.

Unzipping a new release on top of an existing $MV_HOME is not supported. Doing so leaves libraries from the previous release behind in $MV_HOME/ext-lib alongside the new ones: RapidDeploy adds the libraries a release needs, but it does not delete libraries a previous release needed and this one does not. Where a library has been renamed or replaced between releases, both copies then sit on the runtime classpath and which one is used is not predictable, so a deployment can behave differently from one machine to the next.

If you have previously upgraded this way and want to be sure the installation is clean, the reliable fix is to redo the upgrade using one of the supported procedures above. If that is not practical, compare $MV_HOME/ext-lib against the ext-lib directory of a freshly unzipped copy of the same release and delete anything present only in your installation.

The same applies to a downloadable agent installation and its $MV_AGENT_HOME/lib directory: replace it rather than unzipping over it.

Upgrading from RapidDeploy v3.5

  • In RapidDeploy v3.5, export all of your project to your desktop from the 'Menu' -> 'Projects' -> 'Upload Project'
  • In your new RapidDeploy v5, import all of the previously exported projects from the same panel.