Upgrading the server in interactive mode#

To upgrade the server, stop the server and run the new installation program.

Depending on the version of UrbanCode Deploy you are upgrading, be sure to address these build-specific considerations.

Affected Build Consideration
6.1 and later If the server is using an HCL® JRE, upgrade the JRE to a version that is shipped with version 6.2 or later.
6.1 - UrbanCode Deploy servers and relays must be upgraded at the same time. Agents that connect through relays may not connect successfully until both server and relay are upgraded.
6.2.2 and later Urban Code Deploy server and agent relays require a Java™ Runtime Environment (JRE) or Java Development Kit (JDK) version 8.After upgrading, these changes apply to the agent relays.

Users might notice that some agent relays are no longer listed in the user interface even though they were able to view relays before the upgrade. The new version includes updated security controls. The agent relays are still available to the users. However, System Team administrators can assign agent relays to teams and set the View Agent Relays permission for roles so that appropriate users can see the agent relays in the user interface. Users can install and use agent relays. However, the relays are not listed in the user interface for the user until a System Team administrator assigns the agent relay to teams and sets the View Agent Relays permission.| |6.1 -|Ensure that all secure property values are obscured, the values of all properties in the history for existing deployments are obscured. In the deployment history for deployments that you run after you upgrade, only secure properties are obscured in the logs.| |6.1 -|New security features erase old component version import logs to hide secure information. If you want to keep the logs, in the installed.properties file, set the property com.urbancode.ds.cleanup.sourceConfig.fullCleanupSkip to True.|

This task applies to upgrades of versions 6.1 or later. Contact UrbanCode Deploy support for all other versions.

Note: During the upgrade of UrbanCode Deploy, the contents of the appdata/patches directory (including all .jar files) will be appended with .off, preventing the existing test fixes from being loaded once the UCD Server is started post-installation. All UI test fixes applied to the Tomcat directory will be wiped by the upgrade and will not be recoverable.

If a text fix received for a reported defect is not fixed in the upgraded version, you may need to open a Support Case to request a new build.

Note: Setting com.urbancode.ds.cleanup.sourceConfig.fullCleanupSkip to True is only effective upon upgrade. After upgrading, component version import logs are automatically cleaned up after 24 hours by default. Refer to Component Versions.

  1. If you have added custom keystores, certificates, or any other files to the server_install/opt/tomcat directory, back up those files before you upgrade. If you do not back up files that you have added to the server_install/opt/tomcat directory, those files are removed when the upgrade process runs.

  2. Download and extract the installation files for HCL™ Launch. These files are available for download from the HCL Passport Advantage® website. See the HCL UrbanCode Deploy download document.

  3. Ensure that no application and generic processes are running.

    Open the Dashboard and confirm that no processes are running. If processes are running, you can wait for them to complete or by clicking Cancel in the same row as each process, cancel them.

  4. Stop the server.

    Warning: If you are upgrading a high-availability installation, stop all of the servers. If any servers are accessing the database when the upgrade happens, the upgrade will cause errors. See Upgrading high-availability installations.

  5. Ensure that the server is stopped:

    1. Check to ensure that there is no file server.pid in the server_install/var folder.

    2. Check for running system processes.

      For example, on Linux™, you can use the netstat or ps commands. For example, if the server is running on port 8443, use the command netstat -nap | grep 8443. You can also run ps -ef | grep server and look for the server system process in the results.

    3. If any server processes are still running, stop them.

    If a server process is still running, when you install the new version, you see an error that says "A previously installed version of HCL Launch is running. Please shutdown the running HCL Launch and start the installation again."

  6. Back up the database.

  7. If you are upgrading from a version prior to version 6.2.2 to version 6.2.2 or later, upgrade the version of Java on the server to version 8 or later.

    See Changing or updating the JRE of servers.

  8. From the command line, run the server installer program.

    • On Windows™, run the install-server.bat file.
    • On Linux, run ./install-server.sh.
    • To install a FIPS-compliant server, add the switch -fips to the command, such as install-server.sh -fips.

      Note: If you install a FIPS-compliant server, cloud provisioning is not available. Your JVM connects to only FIPS 140-2 certified HCL providers.

    Depending on your system settings, you might need to run this file as an administrator.

  9. Read the license agreements for the software package. Press Enter to show one page at a time, or press F and then press Enter to show the entire license at once.

  10. If you agree to the terms of all of the license agreements, press Y and then press Enter.

  11. At the prompt that says Enter the directory where the HCL Launch server should be installed., specify the folder of the existing installation and press Enter.

  12. At the prompt that says A previous version exists in the specified directory. Do you want to upgrade the currently installed version? press Y and then press Enter.

  13. Verify that the server is stopped and then press Enter to start the upgrade process.

  14. Start the server and verify that the server has been migrated.

  15. Ensure that licensing is set up for the server.

    See License management.

  16. If you are upgrading the server from version or earlier to a version later than version, upgrade the encryption key strength.

    See Upgrading encryption key strength.

  17. Upgrade the agents.

    See Upgrading agents. If you are upgrading from a version before to version or later, you must upgrade agents that use Java plug-ins, including most source configuration plug-ins. If you do not upgrade the agents, they will throw an IllegalCharsetNameException exception that refers to the variable DS_SYSTEM_ENCODING.

If you are upgrading from version to or later, upgrade all agent relays to the current version. Agents that connect through relays may not connect successfully until both server and relay are upgraded.

Parent topic: Upgrading the server