Upgrade procedure

This section describes how to upgrade an existing installation of an on-premises OpenText™ Software Delivery Management server.

In this topic:

Upgrade paths

You can choose between two upgrade paths:

• Short-term path (STP). Upgrade to each new service pack (for example, from 25.3 to 26.1). If you choose this path, you need to go through all the interim service packs to upgrade to the following release.

• Long-term path (LTP). Upgrade directly from one LTP release to the next (for example, from 25.1 directly to 26.1), without having to upgrade to each of the interim service packs.

This version is an LTP release. You can upgrade to this version directly from 24.3 (the previous LTP release).

Back to top

Prepare for upgrade

Before upgrading, review the following:

1. Check that all spaces are up to date, first in Settings > Site > Spaces, and then in Settings > Site > POST UPGRADE JOBS. Delete any spaces that you do not want to upgrade to prevent problems in future upgrades.

2. Verify that your server machine, and if relevant, all cluster nodes, meet all prerequisites.

   This includes checking the supported versions for all third party tools such as Elasticsearch, and upgrading accordingly. For details, see Prerequisites.

3. Stop the octane service on the server and on all cluster nodes, if relevant.

4. Create backups of:

   • The repository

     OS	Path
     Linux	/opt/octane/repo (default)
     Windows	C:\Program Files\Octane\repo (default)

   • Existing configuration files, including octane.conf

   • Your database

   • Elasticsearch

5. Take note of any special aspects of your configuration. 

   Special configuration	Recommendation
   Linux: Did you use a different user, other than the octane user, to install? (Linux)	If you did, the user is set in the OCTANE_USER environment variable. Use this user to upgrade.
   Did you install to a location other than the default?	Linux default: /opt/octane Windows default: C:\Program Files\Octane Refer to the actual location that you used while upgrading.
   Did your organization's DBA make changes to database schemas, such as adding tables or columns?	Define an exception file. The exception file instructs OpenText Software Delivery Management to ignore manual changes to the database schemas during installation. For details, see Using exception files for manual database changes.
   Linux: What sudoer user did you use to install?	Use the same sudoer user that was used for installation to upgrade.

6. Before upgrading, remove all patches or hotfixes at WEB-INF/lib and WEB-INF/classes.

   Example of full paths:

   OS	Example
   Linux	/opt/octane/webapps/root/WEB-INF/classes /opt/octane/webapps/root/WEB-INF/lib
   Windows	C:\Program Files\Octane\webapps\root\WEB-INF\classes C:\Octane\webapps\root\WEB-INF\lib

Back to top

Step 1: Deploy the new version and start the server

1. Download the OpenText Software Delivery Management package

   https://sld.microfocus.com/mysoftware/download/downloadCenter

2. Download and deploy the new version

   OS	Command
   Linux	rpm -Uvh --prefix <install-path><name of new rpm file> If the rpm command fails on Java version, see https://softwaresupport.softwaregrp.com/doc/KM000023838.
   Windows	setup.exe

3. Update the configuration files: If any manual changes were made to the configuration files, follow the steps below to ensure that they are preserved during the upgrade process:

   Files	Details
   osp-config folder	If any of the files in the <repository folder>/conf/osp-config folder were manually changed, do the following steps: Copy the changes into the corresponding files in the osp-config.new folder. Rename osp-config to osp-config.old. Rename osp-config.new to osp-config.
   Other configuration files	If any of the configuration files in the <repository folder>/conf/ folder were manually changed, do the following steps. These include any files with .conf extension and also files that have counterparts with the .new extension. Copy the changes into the corresponding .conf.new or .new files. Rename all configuration files to .conf.old or .old. Remove the .new extension from all the configuration files.

4. Start the server:

   OS	Command
   Linux	Run systemctl start octane
   Windows	On the server machine, go to: Start > OpenText Software Delivery Management > Start OpenText Software Delivery Management

5. Check the log file

   Verify the wrapper.log file:

   OS	Path
   Linux	/opt/octane/log/wrapper.log
   Windows	C:\Program Files\octane\log\wrapper.log

   • If you do not see the message Server is ready!, correct the errors shown in the log.

   • If you encounter a recoverable error in wrapper.log or upgrade.log, fix the problem and restart the server to resume the upgrade.

   • If your Java truststore (<java_home>/jre/lib/security/cacerts) uses a non-default password, enter this password in octane.conf under the parameter:

     java-default-trust-store-password

Back to top

Step 2: Upgrade cluster nodes

Back to top

Step 3: Upgrade spaces

After upgrading, log in as the site admin to upgrade each space.

To upgrade spaces:

1. In a browser, go to <ServerURL>:<port>/ui/?site.

2. Log in with the user name and password defined in the octane.conf file.

   To upgrade all spaces at once, log in as the site admin.

3. Click Site and then click the Spaces tab.

4. Select one or more spaces and click Upgrade.

   Upgrade is available only if the space needs to be upgraded.

5. Individual workspaces are upgraded in the background.

   Note: Some data might be unavailable in trend graphs and other Elasticsearch-related features until all of the post-upgrade jobs have completed.

Back to top

Step 4: Verify that spaces upgraded successfully

In addition, check that all post-upgrade jobs were completed in Settings > Site > POST UPGRADE JOBS.

Back to top