Upgrade XL Deploy 8.0.x and higher to current

This topic describes the tasks and considerations for upgrading XL Deploy from version 8.0 or higher to the current version.

Upgrading XL Deploy includes the following tasks:

  1. Obtain a new version of the XL Deploy software and, if necessary, a new license from XebiaLabs.
  2. Read the release manual so you are aware of the new functionality and possible upgrade considerations.
  3. Stop the current version of XL Deploy if it is running and ensure that there are no active tasks.
  4. Extract the new XL Deploy release into a directory for the new version of XL Deploy (so the old version will still be available in case of problems).
  5. Copy data from the old installation directory to the new installation directory.
  6. Redo custom changes that you made to configuration files and startup scripts.
  7. Start the new version of XL Deploy so that automatic upgraders can run.

You can find release notes for each version here: Release notes.

About upgrading

Upgrading from a version earlier than 8.0.x

If you are upgrading from a version of prior to XL Deploy 8.0.x, the data stored in XL Deploy must be converted from the JackRabbit (JCR) format to SQL format. In this scenario, upgrade using the procedure described in Migrate XL Deploy data storage to an SQL database.

Masters, workers and satellite

You can use the procedures in this topic to upgrade XL Deploy masters, workers and satellites that exist in a typical production environment. Make sure that all masters, workers and satellites are upgraded to share the same version.

Upgrading and downgrading

After you upgrade to a new version of XL Deploy, you cannot downgrade to an older version. If you upgrade to a release candidate (RC), alpha, or beta version, you cannot upgrade to a newer version or downgrade to an older version. Ensure that you always create a backup of your repository before you upgrade to a new version of XL Deploy.

Skipping versions

When upgrading, you can skip XL Deploy versions. XL Deploy will sequentially apply upgrades for the intermediate versions. However, you may be required to take manual actions for the intermediate versions; you can find these in the release manual.

Upgrading the repository

If a repository upgrade is required, XL Deploy will detect that it is running against an old repository and will automatically execute an upgrade when it is first started. The server log will contain extensive logging of the repository upgrade process. Save this log for future reference.

Important: New functionality in XL Deploy or plugins may require database schema changes. As a result, the application requires additional privileges to perform the changes to the schema. These privileges include:

  • ALTER, CREATE, and DROP privileges for tables, views, indexes, and triggers
  • REFERENCES privilege (if applicable)
  • INSERT, SELECT, UPDATE, and DELETE privileges (like in a normal operation)

Upgrading plugins

A plugin version is related to the version of XL Deploy with which it is compatible. For example, the Kubernetes plugin version 9.0.0 requires XL Deploy 9.0.0 or later, unless otherwise specified in the release manual.

The new version of XL Deploy may not be compatible with the current version of your plugins. If this is the case, you must download and install updated versions of the plugins. Upgrading to a new plugin version may require you to take manual actions; you can find these in the release manual.

XL Deploy will not prevent you from downgrading a plugin to an older version, but doing so is not recommended.

Deprecations

Each new version may deprecate some functionality or features in favor of newer ways of working. If functionality is marked as deprecated for a specific version, the old functionality is still available (so you can still upgrade hassle-free), but it will be removed in the next version.

The release manual may include information about how to migrate to the new way of working. This gives you the time and opportunity to migrate to the new situation before upgrading to a still newer version that will no longer have the old functionality. Be sure to read the deprecation information for each release you’re upgrading to, so you know what will change in upcoming versions.

Before you upgrade

Before you upgrade:

  • Carefully read the release manual and note any changes that may apply to your situation.
  • Review any files that you have customized, such as conf/deployit-security.xml or conf/logback.xml. You will need to redo these changes in the new files.
  • Check whether there are any hotfixes installed in the hotfix directory. If hotfixes are installed, contact the XebiaLabs support team before upgrading.

Upgrade the server

To upgrade an XL Deploy server installation:

  1. Extract the server archive. It creates an installation directory called, for example, xl-deploy-9.0.0-server.

  2. Log in to XL Deploy as an administrator, click Explorer, expand Monitoring, double click Deployment tasks, and select All Tasks.

    • If there are any tasks with a state of Failing or Failed, cancel them.
    • If there are any tasks with a state of Executing, wait for them to complete or cancel them.
    • To open a task from Monitoring, double-click it.
    • Ensure that no new tasks are started by enabling maintenance mode.
  3. Shut down the XL Deploy server.

    Note: If you are running the XL Deploy server as a service and you want to use it after the upgrade, you must uninstall the existing XL Deploy service. You must re-install the XL Deploy as a service from the new location after the upgrade.

  4. Copy the repository directory from the old installation directory to the new installation directory.

  5. Copy the contents of the importablePackages directory from the old installation directory to the new installation directory.

  6. Copy the contents of the plugins directory from the old installation directory to the new installation directory (unless new versions of your plugins were provided with the new XL Deploy version).

    Tip: Check the release manual for information about plugin incompatibility.

  7. Copy the contents of the ext directory from the old installation directory to the new installation directory.

  8. If you added libraries to XL Deploy’s lib directory (such as database drivers), copy the additional libraries from the old installation directory to the new installation directory.

  9. Verify that libraries in the lib directory do not also appear in the plugins directory, even if their versions are different.

    For example, if lib contains guava-27.1.jar, then the plugins directory should not contain any guava-x.x.jar file (such as guava-20.0.jar). In this case, you must remove the library from the plugins directory.

  10. Copy the conf/deployit-license.lic file from the old installation directory to the new installation directory.

  11. Copy the following files from existing conf directory to the new installation’s conf directory:

    • deployit.conf
    • deployit-defaults.properties
    • repository-keystore.jceks file (if it exists) from the old installation directory to the new installation directory.
  12. If you have changed other files in the conf directory, such as xl-deploy.conf, deployit-security.xml or logback.xml, do not copy the changed files to the new installation directory. Instead, manually reapply the changes to the files that were provided in the new version of XL Deploy.

  13. If you have changed the XL Deploy server startup script(s) in the bin directory, do not copy the changed script(s) to the new installation directory. Instead, manually reapply the changes to the files that were provided in the new version of XL Deploy. Note: There are also install-service.sh and install-service.cmd scripts for running XL Deploy as a service. If you customized the run or install-service scripts in the old installation, you must redo these changes in the install-service script in the new installation.

  14. Start the XL Deploy server interactively (instead of starting as a background process or service) to allow automatic repository upgraders to run.

  15. If you normally run the XL Deploy server as a service, shut it down and restart it as you normally do.

Upgrade the XL Deploy CLI

To upgrade an XL Deploy command-line interface (CLI) installation:

  1. Create a directory for the new XL Deploy CLI installation, including the new XL Deploy CLI version number in the directory name.

  2. Extract the CLI archive in this directory.

  3. Copy the contents of the plugins directory from the previous installation to the new installation directory (unless new versions of your plugins were provided with the new XL Deploy version).

  4. Copy the contents of the ext directory from the previous installation to the new installation directory.

    Note: Do not copy the content of the hotfix directory unless instructed to do so (because hotfixes are version-specific).

  5. If you have made any changes to the XL Deploy CLI startup scripts (cli.sh or cli.cmd), copy these from the bin directory in the previous installation to the new installation directory.