Applies to: Kyvos Enterprise Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Important Points

For enforcing free disk space for the required partition, see the Verifying free disk space for partition section.
For Azure, before upgrading, it is recommended that you remove the previously installed Jar files from Databricks to prevent overwriting or corruption of Jar files.
For AWS, the restoration process for the external repository RDS has been automated, eliminating the need for manual intervention.
For AWS, if Kyvos is using an external repository RDS as its repository, before initiating a Kyvos rollback, ensure that the 'UsedBy' tag with a value of 'Kyvos' is added to the RDS subnet/security group used for creating the database instance, if it has not already been added.
In case of a Rollback, the previous state of Kyvos is restored. In case you made any entity-specific modifications like changes to the semantic model design, registered files, users, etc., Kyvos recommends the designers/Admins create a cab as a backup before rollback and import the cab file to the rolled-back version.
Process operations cannot be persisted.
If you roll back to a Kyvos Manager process that supports Derby as its repository, any operations, such as audits, events, or other activities (like users add, import, delete, and update) performed using Kyvos Manager build 2023.1 and onwards will NOT be available when you rollback to a Kyvos Manager release previous to 2023.1.
The rollback operation will take some time to initiate.
Kyvos rollback to earlier releases not supporting Flexible server:
- Post Kyvos rollback, configure the single server in Kyvos through the switch repository of Kyvos Manager. The application automatically handles the single server being configured. It must have the same compatible state of the database with the Kyvos release to which rollback is performed.
- A change in the user name will be required while configuring a single server in the system as it requires appending the server name to the username.

Single-Click Rollback through Kyvos Manager

You can roll back patches or upgrade deployments to previously installed versions from the Kyvos Manager portal. To do this, simply select the required version from the Kyvos Manager to easily revert both the Kyvos and Kyvos Manager applications to an previous version.

The following steps are applicable to all cloud environments (AWS, Azure, GCP). This also applies to on-premises environment.

To roll back the application to a previous version, perform the following steps.

Create a manual backup of your existing cluster using the steps explained in the Upgrading Kyvos Manager and Kyvos section.
On the navigation pane, click Application Update > Rollback.
The Rollback page is displayed.
To roll back the application to a previous version, select one of the following from the Rollback list:
- To rollback Kyvos Manager and Kyvos, click All Components. This is selected by default.
- To rollback only Kyvos, click Kyvos from the list.
Click the Select rollback state link and the dialog box is displayed.
Use the dialog box to choose the state to which you want to roll back. You can use the search box to Search for a specific version, or view operation details by clicking the View Details link. The selected rollback version is displayed. You can change the rollback at any point in time by clicking the Change rollback state link.
The Kyvos Manager version compatible with the selected Kyvos rollback is displayed. You can also select the None option to modify the rollback state by providing the Kyvos Manager Bundle Path available on the Kyvos Manager node.

Note

If you select the Kyvos from the Rollback list, this will rollback only Kyvos.

The Backup Path path shows the path used for creating/restoring a backup of Kyvos states in case of Deploy Upgrade and Deploy Patch/Rollback operations. The backup path should be consistent across all the available systems. You can edit this path using the Change Backup Path option from the three-dots menu. Any backup created prior to changing the path remains unaffected and will continue to be available at the same location.
Click the Rollback Now button from the top-right of the page.
On the displayed confirmation message box, select the Start Kyvos Service checkbox to start the service automatically after rollback.
Enter your Kyvos Manager Password to confirm the rollback. Kyvos takes you to the Operations page followed by the Rollback Logs details page.

Warning

If you are using an external repository for Kyvos, then after the Kyvos version rollback, you need to change to the previous version of the repository using the Switch repository feature.
In the case of AWS, for an external repository instance, once you have restored the Kyvos external repository RDS from the backup state of the corresponding release, you will have the option to either delete or stop the Kyvos external repository instance. If you select the Delete option, the in-use external repository will be deleted. However, if you choose the Stop option, this action will incur charges in the future.

Info

After you have performed the Kyvos rollback operation, downgrade the Kyvos Manager to a compatible version of Kyvos.
Before starting the compatible version of Kyvos Manager, ensure that the Kyvos Manager repo folder specific to that version is being pointed.
For example, if you performed roll back from Kyvos Manager version 2022.1 (using repo folder) to version 2021.3 (which was renamed as repo_2021.3 at the time of upgrade), then you must ensure that the report folder from the 2021.3 version is being used.

Kyvos Rollback

Create a manual backup of your existing cluster using the steps explained in the Upgrading Kyvos Manager and Kyvos section.
On the navigation pane, click Application Update > Rollback.
The Rollback page is displayed.
To roll back the cluster deployment to a previous version, select Kyvos from the list.
Click the Select rollback state link and the dialog box is displayed.
Use the dialog box to choose the state to which you want to roll back. You can use the search box to Search for a specific version, or view operation details by clicking the View Details link. The selected rollback version is displayed. You can change the rollback at any point in time by clicking the Change rollback state link.
The Backup Path path shows the path used for creating/restoring a backup of Kyvos states in case of Deploy Upgrade and Deploy Patch/Rollback operations. The backup path should be consistent across all the available systems. You can edit this path using the Change Backup Path option from the three-dots menu. Any backup created prior to changing the path remains unaffected and will continue to be available at the same location.
Click the Rollback Now button from the top-right of the page.
On the displayed confirmation message box, select the Start Kyvos Service checkbox to start the service automatically after rollback.
Enter your Kyvos Manager Password to confirm the rollback. Kyvos takes you to the Operations page followed by the Rollback Logs details page.

Kyvos Manager Rollback through Terminal

Important points to know

From Kyvos 2024.2 onwards, If Kyvos Reporting Service is deployed and you want to roll back the Kyvos Manager release earlier to 2024.2, then before performing Kyvos Manager rollback, you must remove Kyvos Reporting Service.
Logs of Kyvos Manager Tomcat Server will be generated in the kyvosmanagerdata/server/tomcatLogs path. If you rollback Kyvos Manager to an older version, logs will be generated inside the kyvosmanager_war/kyvosmanager/logs/ folder of the Kyvos Manager on which the rollback was performed.
In case of a Rollback, the previous state of Kyvos Manager is restored. In case you made any changes that you need in the previous state, you need to perform them again.

To roll back to a previous version, perform the following steps.

Create a backup for the Kyvos Manager data, perform the following steps.
Log in to the Kyvos Manager machine through the terminal.
Navigate to the Kyvos Manager installation path.
Stop the Kyvos Manager process using the command:
./kyvosmanager_war/kyvosmanager/bin/stop-km.sh
Identify the location for the used kyvosmanagerdata folder. For this, check the value of KM_DATA_DIR in the set env.sh file in the bin folder.
This folder contains the Kyvos Manager data, including the repository.
Go to the parent folder of the kyvosmanagerdata folder and run the command.
tar -zcvf file_name.tar.gz kyvosmanagerdata
Here file_name is the user backup file name for the Kyvos Manager.
Copy the backup file to the local machine.
Rename your current repo folder at the kyvosmanagerdata/server location, such as repo_<current version number>. For example, you can rename it repo_2022.1
Locate the version to which you want to roll back (for example, 2021.1), and rename its repo folder (such as repo_2021.1) to repo.
Locate the build folder of the Kyvos Manager version to which you want to roll back (for example, 2021.1), and verify the correct value of KM_DATA_DIR in the set env.sh file in the bin folder.
Start the required version of Kyvos Manager using the command:
./kyvosmanager_war/kyvosmanager/bin/start-km.sh

Note

If your cluster node password was updated or the encryption algorithm changed using Kyvos Manager 2021.2 onwards, then on rollback of Kyvos Manager to any build previous to version 2021.2, you need to reconfigure the c luster node password.

Kyvos Manager Rollback to previous releases not supporting Flexible Server

Kyvos Manager rollback to earlier releases (prior to the Kyvos 2023.5 releases that are not supporting Flexible server) when Kyvos Manager using external repository.

It could be:
- Kyvos Manager rollback to a release supporting Bundled Postgres: To migrate from external repository to bundled Postgres, see the https://docs.support.kyvos.io/wiki/spaces/KD202410/pages/238863788/Configuring+jdbc.properties+for+Kyvos+Manager#External-Repository-to-Bundles-Postgres section.
- Kyvos Manager rollback to a release supporting Azure Single Server: To migrate from Flexible Server to Single Server, see the https://docs.support.kyvos.io/wiki/spaces/KD202410/pages/238863788/Configuring+jdbc.properties+for+Kyvos+Manager#Flexible-Server-to-Single-Server section.

Deleting Kyvos upgrade and patch bundles

During Kyvos upgrade and patch processes, the oldest backup bundle will be deleted automatically to retain the newest bundles within the specified limit. Suppose you choose to preserve 6 bundles out of 10 available. In this case, only the 6 most recent bundles will be saved, and the remaining 4 bundles will be deleted. The oldest of these 4 bundles, based on the date they were created, will be deleted first.

To delete a previous state of rollback, use the Manage Backup Bundles option from the three-dots menu.

In the Preserve Backup Bundles list, set the count to retain the bundles.

Points to know

If the number of bundles present exceeds the preserved count, the remaining bundle will be automatically selected, indicating that it will be deleted.
If the number of bundles equals the retention count, no bundles will be deleted.
Bundles can only be deleted by changing the preserve count. Selecting them for deletion is disabled and unsupported.
If the latest backup bundle is a Patch, then the most recent Kyvos bundle will also be preserved.
The backup bundles which are created for failed Kyvos upgrade or failed Patch operations will also be there in the list to delete.

Restoring to Derby State of Kyvos Manager or Kyvos

You can restore the Derby-compatible version of Kyvos, or the Kyvos Manager process that is prior to Kyvos 2023.1.