Document toolboxDocument toolbox

Upgrade and Rollback for Marketplace Deployments

Owned by Sarabjeet Kaur
Sep 06, 2024
6 min read

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

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

Azure Marketplace Deployments

This section provides information on how to upgrade Kyvos and Kyvos Manager and roll back patches for Azure marketplace deployments.

Upgrading Kyvos and Kyvos Manager

You can easily upgrade both Kyvos and Kyvos Manager applications to a newer version by simply selecting the required version from the Kyvos Manager portal.

To upgrade Kyvos and Kyvos Manager, perform the following steps. 

  1. On the navigation bar, click Application Update > Upgrade. 

  2. The Upgrade page is displayed with the current version details of Kyvos and Kyvos Manager. 

  3. Select the required  Version  from the Upgrade To list to which you want to upgrade.  
    NOTE: In the Upgrade To list, all future versions available for upgrading will be displayed.

  4. To view upgrade options, click the  Show Upgrade Options  link, and configure the following options as needed.

Parameter/Field

Description

Parameter/Field

Description

Overwrite

Select this option to override the existing templates in your Kyvos environment.
NOTE: 

  • If the option is selected, a template will be generated.

  • If the option is not selected, t he old template will be copied with _backup as a suffix.

Backup 

  • Semantic Model:  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.

  • Log:  Select this option to create a backup of the existing logs of your Kyvos environment. 

  1. Click the Upgrade Now button on the top-right of the page.

     

Note

If the upgrade operation fails, you can resume it by clicking the Click to resume option. The upgrade will resume from the point where it last failed. Additionally, you can view the details of the failed operation by clicking the Click to view details option.

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

  2. Enter your Kyvos Manager Password to confirm upgrade deployment.

Note

You need to manually restore the files uploaded from the Configuration Files page (if any), after upgrading Kyvos.
Before the upgrade, a backup will be created and saved at /data/kyvos/app/ location automatically.
Before applying the Kyvos upgrade, ensure that the Service account attached to the Kyvos Manager node has the permission required for updating Functions.

  1. To see upgrade history, click the Actions menu (...) and select the View History option.

Rollback 

You can easily roll back both Kyvos and Kyvos Manager applications by simply selecting the required version from the Kyvos Manager portal.

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  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. The rollback state is selected. You can also change the rollback state using the Change rollback state link. 

  4. Select the required rollback version. 

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

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

     

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

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

Note

If the Kyvos Manager rollback operation fails, followed by Kyvos rollback, you can resume it by clicking the  Click to resume  option. The Kyvos Manager rollback operation will resume from the point where it last failed. Additionally, you can view the details of the failed operation by clicking the  Click to view details  option.


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.

Deploy a Patch 

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

  1. On the navigation pane, click Application Update > Patch. 

  2. The Patch page displays the details of the current Kyvos version.

  3. Select the required patch version from the Select Patch list that you want to deploy. 

  4. To configure the Patch Options, do the following: 

Parameter/Field

Description

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.

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

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

Note

  • You need to manually restore the files uploaded from the Configuration Files page (if any), after upgrading Kyvos.

  • Before applying the Kyvos patch ensure that the Managed Identity attached to the Kyvos Manager node has permission required for updating Functions.

  • You must create a folder structure for patch deployment. Create a folder named "patches" in the current release. Then, create a folder within the "patches" directory with the same name as the patch.
    For example, if the patch name is 'Kyvos2023.2_Patch_134.039.tar.gz', then the folder name should be '2023.2_Patch_134.039'.

 

Deleting Kyvos upgrade and patch bundles 

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

Copyright Kyvos, Inc. All rights reserved.