Upgrade XL Release 7.5.x and higher to current

This topic describes the prerequisites, process and considerations for upgrading XL Release version 7.5.x and higher to a current version.

Prerequisites

Beginning with version 7.5.0, XL Release uses a new SQL relational database backend which replaced the JackRabbit (JCR) repository used in previous releases. This procedure assumes that you have successfully upgraded to version 7.5.x or higher and are no longer using a JCR repository.

To prepare for the upgrade:

  • Create a backup of your repository before you upgrade to a new version of XL Release. For more information, see backup XL Release.
  • Ensure that the external database servers used to store XL Release data are supported. For a list of supported databases and versions, see Supported databases.
  • Carefully read the release manual for your destination version and note any changes that may apply to your situation.
  • Check if there are any hotfixes installed in the hotfix directory. If hotfixes are installed, contact the XebiaLabs support team before upgrading.

Upgrade procedure

To upgrade from XL Release version 7.5.x or higher to a current version:

  1. Go to the XebiaLabs software distribution site and obtain a new version of the XL Release software and, if necessary, a new license. Customer log in is required to access this URL.

  2. Ensure that there are no active tasks, then shut down XL Release:

    Operating system Shortcut
    Microsoft Windows Ctrl + c
    Unix-based systems Ctrl + c

    Note: In a hot-standby configuration, all nodes must be stopped.

  3. If you have implemented any custom plugins, copy them from the plugins directory of the source XL Release installation to the plugins directory of the target installation.

  4. If you are using an external database for your repository, copy your database driver to the new installation. Typically, the database driver is stored in your lib directory as described in Configure the SQL repository.

  5. Copy the content of the ext directory from the source installation to the ext directory of the target installation.

  6. Copy the content of the conf directory from the source installation to the conf directory of the target installation.

    Important: When upgrading XL Release, do not overwrite the script.policy file. You must use the new version of the file.

  7. If you changed the XL Release server startup script(s) in the bin directory of the source installation, do not copy the changed script(s) to the target installation. Manually reapply the changes to the files that were provided in the new version of XL Release.

  8. Start the new version of XL Release interactively so that automatic upgraders can run. Open a command prompt or terminal, point to the XL_RELEASE_SERVER_HOME/bin directory, and depending on your system, execute on of the following commands:

    Operating system Command
    Microsoft Windows run.cmd
    Unix-based systems run.sh
  9. Shut down XL Release:

    Operating system Shortcut
    Microsoft Windows Ctrl + c
    Unix-based systems Ctrl + c
  10. Start XL Release by opening a command prompt or terminal, pointing to the XL_RELEASE_SERVER_HOME/bin directory, and executing the appropriate command:

    Operating system Command
    Microsoft Windows run.cmd
    Unix-based systems run.sh