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

• Kyvos Rollback

You can roll back patches or upgrade deployments to previously installed versions through the Kyvos Manager portal. 

...

...

• Kyvos Manager Rollback through Terminal

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.

Kyvos Rollback

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 a newer version.

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

1. Create a manual backup of your existing cluster using the steps explained in the Upgrading Kyvos Manager and Kyvos /wiki/spaces/KD202411/pages/268642028 section.

2. On the navigation pane, click Application Update > Rollback.
   The Rollback page is displayed. 

   Image RemovedImage Added

3. To roll back the cluster deployment to a previous version, select Kyvos from the Rollback list.

4. Click the Select rollback state link . From the displayed dialog box, and the dialog box is displayed.

   Image Added

5. 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 using the corresponding 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.

   Image Added

6. 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 Modify Change Backup Path option from the three-dots menu. A ny Any backup created prior to changing the path remains unaffected and will continue to be available at the same location.

   Image Added

7. Click the Rollback Now button from the top-right of the page.

   Image RemovedImage Added

8. On the displayed confirmation message box, select the Start Kyvos Service checkbox to start the service automatically after rollback.

9. Enter your Kyvos Manager Password to confirm the rollback. Kyvos takes you to the  Operations page  followed by the  Rollback Logs  details page.

Deleting Kyvos upgrade and patch bundles 

From Kyvos 2023.3 onwards, during Kyvos 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. 

You must perform the following manual steps to perform a Kyvos, or Kyvos Manager process rollback: 

1. Change the JDBC URL in the jdbc.properties to a Derby-specific URL. To do this, you must rename the existing jdbc.properties (using Postgres as a repository) to the jdbc.properties.postgres and then rename the existing jdbc.properties.derby to jdbc. properties.
   NOTE: The files are located at:  kyvosmanagerdata/server/db/

2. In addition, if the bundled Postgres is used as the Kyvos Manager repository, it is necessary to move the Postgres folder inside Kyvos on each node of the cluster from its current location parallel to Kyvos.

3. To switch back to the old Derby-compatible version of Kyvos Manager, first stop the current Postgres, which is supported as the Kyvos Manager process repository.

4. If a Kyvos rollback is also required, then perform it using the Derby-compatible Kyvos Manager only. Also, ensure that you perform Step 3.

Deploy Patch

To deploy a patch on an existing Kyvos version, perform the following steps.

...

...

On the Kyvos Manager, click Application Update > Patch.

...

The Patch page is displayed with the current version details of Kyvos.

In the Locate Bundle By, select any of the following options, and provide the corresponding details.

...

File: Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to upload the package to be used for the upgrade.

...

Select the required version from the Version list to which you want to upgrade. All future versions available for upgrading will be displayed.

...

Click the required Select Patch from a list of compatible versions.

...

To view patch options, click the Patch Options link, and configure the following options as needed.

...

Parameter/Field

...

Description

...

Create backup

...

Select this option to create a backup of the existing Kyvos environment before deploying the patch.

Selecting this option will speed up patch deployment as no data backup will be performed. However, the currently deployed version can not be
restored using rollback

...

Create semantic model data backup

...

Select this option to create a backup of the existing semantic model data in your Kyvos environment. This may slow down the deployment for taking the backup of semantic model data.

...

Create logs backup

...

Select this option to create a backup of the existing logs of your Kyvos environment

...

Backup Path

...

Shows the backup path.

The backup path should be consistent across all the available systems. To edit the path, use the Modify Backup Path option from the use three-dots menu.

...

Click the Deploy Now button on the top-right of the 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. 

1. Create a backup for the Kyvos Manager data, perform the following steps.

2. Log in to the Kyvos Manager machine through the terminal.

3. Navigate to the Kyvos Manager installation path.

4. Stop the Kyvos Manager process using the command:
   ./kyvosmanager_war/kyvosmanager/bin/stop-km.sh 

5. 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.

6. 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.

7. Copy the backup file to the local machine.

8. 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

9. 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.

10. 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.

11. Start the required version of Kyvos Manager using the command:
    ./kyvosmanager_war/kyvosmanager/bin/start-km.sh

5. Click the Deploy Now button on the top-right of the page.

6. On the displayed confirmation message box, enter your Kyvos Manager Password to confirm upgrade deployment.

Image Removed

Panel
panelIconId atlassian-note panelIcon :note: bgColor #DEEBFF
Note You need to manually restore the files uploaded from the Configuration Files page (if any), after upgrading Kyvos. Before applying the Kyvos upgrade ensure that the IAM role attached to the Kyvos Manager node has the lambda:UpdateFunctionCode permission required for updating Lambda. Image Removed Aura tab summary Azure params JTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMiU3RA== On the Kyvos Manager, click Application Update > Patch. The Patch page is displayed with the current version details of Kyvos. In the Locate Bundle By, select any of the following options, and provide the corresponding details. File: Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to upload the package to be used for the upgrade. Version:Select therequired Patch from the list. Click the required Patch from a list of compatible versions. To view patch options, click the Patch Options link, and configure the following options as needed.
Parameter/Field	Description
Create backup	Select this option to create a backup of the existing Kyvos environment before deploying the patch. Selecting this option will speed up patch deployment as no data backup will be performed. However, the currently deployed version can not be restored using rollback
Create semantic model data backup	Select this option to create a backup of the existing semantic model data in your Kyvos environment. This may slow down the deployment for taking the backup of semantic model data.
Create logs backup	Select this option to create a backup of the existing logs of your Kyvos environment
Backup Path	Shows the backup path. The backup path should be consistent across all the available systems. To edit the path, use the Modify Backup Path option from the use three-dots menu.

In the Locate Bundle By, select any of the following options, and provide the corresponding details.

Parameter/Field

Description

Create backup

Select this option to create a backup of the existing Kyvos environment before deploying the patch.

Selecting this option will speed up patch deployment as no data backup will be performed. However, the currently deployed version can not be
restored using rollback

Create semantic model data backup

Select this option to create a backup of the existing semantic model data in your Kyvos environment. This may slow down the deployment for taking the backup of semantic model data.

Create logs backup

Select this option to create a backup of the existing logs of your Kyvos environment

Backup Path

Shows the backup path.

The backup path should be consistent across all the available systems. To edit the path, use the Modify Backup Path option from the use three-dots menu.

5. Click the Deploy Now button on the top-right of the page.

6. On the displayed confirmation message box, enter your Kyvos Manager Password to confirm upgrade deployment.

Image Removed

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://kyvosdocumentation.atlassian.net/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://kyvosdocumentation.atlassian.net/wiki/spaces/KD202410/pages/238863788/Configuring+jdbc.properties+for+Kyvos+Manager#Flexible-Server-to-Single-Server section.

Post-rollback steps

If you have rolled back from 2022.1 or above, and you updated the password or encryption algorithm (feature introduced in version 2022.1), then you need to reconfigure the c luster node password on to the previous Kyvos Manager release.