Performing helm roll backs to DevOps Plan

You can roll back DevOps Plan to the previous release using the helm rollback command.

Before you begin

Before you perform the upgrade, you must first do the following:
  • Use Helm to install the DevOps Plan solution chart as described in Step 5 of Getting started with DevOps Plan Helm chart.
  • Use Helm to upgrade the DevOps Plan chart to the new DevOps Plan release as described in Performing rolling upgrades to DevOps Plan Helm chart.
  • Note: When using DevOps Control, it is possible that a DevOps Control release includes an upgraded database schema. Performing a Helm rollback to an installation that includes a mismatch in database schema is not supported and the Helm rollback will fail. When using DevOps Control, it is recommended that you use backup and restore functionality with Velero. For more information, see Backup and Restore instructions for DevOps Plan. Performing Velero based rollback will lead to loss of newer data that is generated after upgrading.
DevOps Plan 3.0.7 includes upgraded OpenSearch and OpenSearch Dashboards. OpenSearch created and migrates internal indexes using a newer format that is not backwards compatible with earlier OpenSearch versions. As a result, rolling back from version 3.0.7 to an earlier version of DevOps Plan is not supported. Attempting to rollback from version 3.0.7 to an earlier version may cause OpenSearch to fail to start.

Before upgrading to DevOps Plan version 3.0.7, it is recommended to use Velero to create a backup. If you downgrade to a previous release, you must restore the cluster state from a backup that was taken before the upgrade happened.

The recommended downgrade workflow is:
  1. Use Velero to create a backup of the DevOps Plan environment before performing an upgrade.
  2. Upgrade to DevOps Plan version 3.0.7.
  3. If you need to revert to a previous release, roll back the application version and restore the cluster resources and persistent volumes from the Velero backup that you created in step 1.

About this task

Rolling back utilizes the helm rollback command. For more information, see Helm Rollback in the Helm documentation.

Procedure

  1. Run the helm history command to see revision numbers of your DevOps Plan helm chart release.
    You should have a minimum of two revision numbers: revision 1 for installation and revision 2 that you used to upgrade to. The following example illustrates a helm chart release named hcl-devopsplan with revision 1 installed hcl-devopsplan3.0.5 for the DevOps Plan 3.0.6 release and revision 2 upgraded the helm chart hcl-devopsplan3.0.7 to the DevOps Plan 3.0.7 release.
    $ helm history hcl-devopsplan --namespace dev
REVISION        UPDATED                         STATUS          CHART             APP VERSION              DESCRIPTION
1               Thu Jan 20 21:58:13 2022        superseded      hcl-devopsplan1-3.0.6          Install complete
2               Thu Jan 20 22:13:56 2022        deployed        hcl-devopsplan2-3.0.7          Upgrade complete
  2. Roll back the DevOps Plan helm chart using the helm rollback command.
    The following example will roll back the DevOps Plan helm chart release hcl-devopsplan from revision 2 to revision 1.
    $ helm rollback hcl-devopsplan --namespace dev
Rollback was a success! Happy Helming!
  3. Run the helm history RELEASE command to see that the new revision 3 has been created after roll back, and that it rolled back to revision 1 in the DevOps Plan helm chart release hcl-devopsplan1. 
    $ helm history hcl-devopsplan --namespace dev
REVISION        UPDATED                         STATUS          CHART             APP VERSION              DESCRIPTION
1               Thu Jan 20 21:58:13 2022        superseded      hcl-devopsplan1-3.0.6           Install complete
2               Thu Jan 20 22:13:56 2022        deployed        hcl-devopsplan2-3.0.7           Upgrade complete
3               Thu Jan 20 22:30:32 2022        deployed        hcl-devopsplan1-3.0.6           Rollback to 1