Rollback

This section describes how to roll back after upgrading an on-premises OpenText Software Delivery Management server. This may be necessary if for some reason the upgrade fails or performance is slow.

Depending on when you want to roll back, there are different steps to perform.

Note: To roll back you need the pre-upgrade backups of all configuration files including octane.conf from each node.

After the upgrade's setup validation phase

You can roll back after the upgrade's setup validation phase, whether it passed or failed.

If the upgrade reached setup validation, the following have been modified: 

  • Previously-deployed files

  • Configuration files, including octane.conf

To roll back the deployed files, including octane.conf:

  1. Revert to the previous version:

    OS Steps
    Linux Run: rpm -Uvh --oldpackage <filename>
    Windows

    1. Uninstall the new OpenText Software Delivery Management version using Windows Add/Remove Programs.

    2. Install the previous version, as described in the OpenText Software Delivery Management Help Center > Installation Guide for Windows (for the previous version).

  2. Revert to backups of configuration files, including octane.conf.

  3. If necessary, copy back the folder in which you stored the repository, such as C:\Program Files\Octane\repo.

  4. Start the server

    OS Command
    Linux Run systemctl start octane
    Windows Start the OpenText Software Delivery Management service.

Back to top

After a site schema has been upgraded

You can roll back after the site schema has been upgraded.

If the upgrade upgraded the site schema, the following have been modified:

  • Previously-deployed files

  • The site schema (database)

  • Elasticsearch indexes

  • Configuration files, including octane.conf

To roll back the site schema:

  1. Stop the server:

    OS Steps
    Linux Run systemctl stop octane
    Windows Stop the OpenText Software Delivery Management service.

  2. Revert to a backup of the site schema.

  3. Revert to a backup of Elasticsearch indexes.

  4. Revert to the previous version:

    OS Steps
    Linux Run: rpm -Uvh --oldpackage <filename>
    Windows

    1. Uninstall the new OpenText Software Delivery Management version using Windows Add/Remove Programs.

    2. Install the previous version, as described in the OpenText Software Delivery Management Help Center > Installation Guide for Windows (for the previous version).

  5. If necessary, copy back the folder in which you stored the repository, such as C:\Program Files\Octane\repo.

  6. Revert to backups of configuration files, including octane.conf.

  7. Start the server:

    OS Command
    Linux Run systemctl start octane
    Windows Start the OpenText Software Delivery Management service.

Back to top

After space schema has been upgraded

If the upgrade upgraded the space schema, the following have been modified:

  • Previously-deployed files

  • Elasticsearch indexes

  • Configuration files, including octane.conf

  • The site schema

  • The space schema

Rolling back a single space is relevant after upgrade of a space failed. In this case, fixes are required depending on the cause of the failure, as seen in the logs and in the UI.

Note: This is only relevant if the space upgrade failed with CORRUPTED status. If it ended in SUSPENDED status, implement the fixes as instructed in the logs and in the UI, and then resume upgrade. No rollback actions are required.

To roll back changes to the space schema:

  1. Revert to the backup of the space schema.

  2. Revert to the backups of Elasticsearch indexes related to the specific space.

    Space-specific indexes can be identified by the space logical name embedded in their name, using the pattern mqm_{space logical name}_*.

    Note: There are multiple Elasticsearch indexes for each space. Make sure to roll back all of them.

  3. Revert to the repository backup of this specific space.

  4. Fix what caused the upgrade to fail.

  5. Run the following API to repair the space:

    POST {octane server}/admin/shared_spaces/repair?ids={space_id}

    Tip: To repair multiple spaces, provide the space_ids separated by commas.

  6. Upgrade again.

Back to top

After upgrade completed

If the upgrade completed successfully, the following have been modified:

  • Previously-deployed files

  • Configuration files, including octane.conf

  • The site schema

  • The space schema(s)

  • Elasticsearch indexes

  • Repository files

To roll back the entire upgrade:

  1. Follow the procedure To roll back the site schema:.

  2. Revert to backups of all space schemas.

  3. Revert to backups of all Elasticsearch indexes.

  4. Revert to backup of the previous repository.

Back to top

After upgrading cluster nodes

If you upgraded additional cluster nodes, the following have been modified on the cluster nodes: 

  • Previously-deployed files

  • Configuration files, including octane.conf

To roll back cluster nodes:

  1. Revert to the previous version on each cluster node

    OS Steps
    Linux Run: rpm -Uvh --oldpackage <filename>
    Windows

    1. Uninstall the new OpenText Software Delivery Management version using Windows Add/Remove Programs.

    2. Install the previous version on each cluster node as described in the Installation Guide for the previous version.

  2. Revert to backups of configuration files, including octane.conf, on each cluster node.

  3. Start the server on each cluster node:

    OS Command
    Linux Run systemctl start octane
    Windows Start the OpenText Software Delivery Management service on each cluster node.

Back to top