Upgrading the server in interactive mode

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

Before you begin

If you are upgrading from version 4.8.5 or later but before 6.0, migrate the security before you upgrade the server. See Migrating security settings.

If you are upgrading from a version prior to 6.2 to version 6.2 or later, and the server is using an IBM JRE, upgrade the JRE to a version that is shipped with version 6.2 or later.
Important: If you are upgrading from version 6.2.3.0 and earlier, 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.
Important: Beginning in version 6.2.2, the IBM UrbanCode Deploy server and agent relays require Java™ Runtime Environment (JRE) or Java Development Kit (JDK) version 8.
Important: After you upgrade to IBM UrbanCode Deploy version 6.2.2 or later, note these changes to 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.

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.

Important: The artifact format changed in version 6.1. If you are upgrading from a version before 6.1 to 6.1 or later, the amount of disk space that is used during the upgrade is temporarily increased. Typically, the amount of space that is used is double the amount that is normally used by artifacts. After the upgrade is complete, older artifact versions are removed and the amount of storage is usually equivalent to the amount used before the upgrade. This disk space requirement affects only upgrades of versions before 6.1 to 6.1 or later. See Automatic upgrades of files stored in the server CodeStation.
Important: If you are upgrading to version 6.2.1.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.
Important: If you are upgrading from versions before 6.2.1.1, to 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.

About this task

You can upgrade the server to version 6.0 or later from versions 4.8.5 or 5.0. If you use a version before 4.8.5, you must upgrade to 5.0 first.
Note: To upgrade high-availability installations, see Upgrading high-availability installations.

Procedure

  1. Download and extract the installation files for IBM UrbanCode Deploy. These files are available for download from the IBM Passport Advantage® website. See the IBM UrbanCode Deploy download document.
  2. 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.
  3. 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.
  4. 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 IBM UrbanCode Deploy is running. Please shutdown the running IBM UrbanCode Deploy and start the installation again."
  5. Back up the database.
  6. 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.
  7. 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 IBM providers.
    Depending on your system settings, you might need to run this file as an administrator.
  8. 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.
  9. If you agree to the terms of all of the license agreements, press Y and then press Enter.
  10. At the prompt that says Enter the directory where the IBM UrbanCode Deploy server should be installed., specify the folder of the existing installation and press Enter.
  11. 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.
  12. Verify that the server is stopped and then press Enter to start the upgrade process.
  13. Start the server and verify that the server has been migrated.
  14. Ensure that licensing is set up for the server. See License management.
  15. Optional: If you are upgrading the server from version 6.0.1.1 or earlier to a version later than version 6.0.1.1, upgrade the encryption key strength. See Upgrading encryption key strength.
  16. Optional: Upgrade the agents. See Upgrading agents. If you are upgrading from a version before 6.1.0.4 to version 6.1.0.4 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.

What to do next

If you are upgrading from version 6.2.3.0 to 6.2.3.1 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.

Feedback