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

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

...

Rollback Kyvos Manager and Kyvos

...

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

Panel
panelIconId atlassian-info panelIcon :info: bgColor #FFFAE6
Important For enforcing free disk space for 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. If you roll back the 2023.2 Kyvos Manager build to a version prior to 2023.2, a warning message will display, indicating that the spark distribution update has failed. The spark distribution bundle is only available in the Kyvos 2023.2 release and cannot be accessed in any previous versions. 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.

...

1. Create a manual backup of your existing cluster using the steps explained in the Upgrading Kyvos Manager and Kyvos section.

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

   

3. Click the Select rollback state link. From the displayed dialog box, 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 link.

4. 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 Backup Path option from the three-dots menu. A ny 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.
   

   

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

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

...

Panel
panelIconId atlassian-note panelIcon :note: bgColor #DEEBFF
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.

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. 

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.

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

...

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.

...

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.

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.

...

...

On the Kyvos Manager, click Application Update > Patch.

...

1. .

...

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.

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.

...