Page Comparison

1. On the navigation bar, click Application Update > Upgrade. The Upgrade page is displayed with the current version details of Kyvos and Kyvos Manager. 

2. In the Upgrade list, select one of the following as per requirement: 

   1. All components Kyvos and Kyvos Manager 

   2. Kyvos 

   3. Kyvos Manager 

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

   1. Path:  Provide the Kyvos bundle path on the node where Kyvos Manager is running. Ensure that the bundle for the Kyvos version to which you want to upgrade is available on the Kyvos Manager node.

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

   3. Version:Enter the Access Key and Client Secret Key to access the bundle, and then click the Fetch Versions button.
      NOTE: For Marketplace and Managed Services, access and secret keys are not required. Therefore, these inputs will not appear on the page.

   4. Select the required version from the Version list to which you want to upgrade. 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.

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

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

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

   

If Kyvos is using an external repository RDS during the upgrade, and the backup process fails, the Kyvos services will not start after the upgrade is completed. When returning to the Kyvos Manager dashboard, the following message will prompt you to provide the snapshot name of the manually taken backup of the external repository RDS.

In this case, you need to create a Kyvos external repository RDS snapshot from your Cloud console and provide the snapshot name to continue using Kyvos Manager. 

In the dialog box, enter the external repository Snapshot Name and click Continue.

Panel
panelIconId atlassian-note panelIcon :note: bgColor #DEEBFF
Note If a snapshot is taken manually, you must update the 'UsedBy' tag with the value 'Kyvos'. If the snapshot ID is invalid, it could fall into one of the following cases:  'Not valid' indicates that it does not exist. The snapshot is not from the original database instance that is currently in use. The provided snapshot may not be ready yet.

Aura tab
summary Azure params JTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMiU3RA==

Tip
Tip Before upgrading, it is recommended that you remove the previously installed Jar files from Databricks to prevent overwriting or corruption of Jar files.

1. On the navigation bar, click Application Update > Upgrade. The Upgrade page is displayed with the current version details of Kyvos and Kyvos Manager. 

2. In the Upgrade list, select one of the following as per requirement: 

   1. All components Kyvos and Kyvos Manager 

   2. Kyvos 

   3. Kyvos Manager 

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

4. Path:  Provide the Kyvos bundle path on the node where Kyvos Manager is running. Ensure that the bundle for the Kyvos version to which you want to upgrade is available on the Kyvos Manager node.

   

Panel
panelIconId atlassian-warning panelIcon :warning: bgColor #FFEBE6
Warning DO NOT provide the path for a lower version of Kyvos Manager here. You cannot Rollback to an older version from here. The Kyvos Manager would stop working in this case.

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

   

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

   

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

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, the old template will be copied with _backup as a suffix.
Backup Path	Shows the backup path. NOTE 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.
Backup	Semantic model data: 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.

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.

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

Enter your Kyvos Manager Password to confirm upgrade deployment.

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

Aura tab
summary GCP params JTdCJTIydGl0bGUlMjIlM0ElMjJHQ1AlMjIlN0Q=

1. On the navigation bar, click Application Update > Upgrade. The Upgrade page is displayed with the current version details of Kyvos and Kyvos Manager. 

2. In the Upgrade list, select one of the following as per requirement: 

   1. All components Kyvos and Kyvos Manager 

   2. Kyvos 

   3. Kyvos Manager 

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

   1. Path:  Provide the Kyvos bundle path on the node where Kyvos Manager is running. Ensure that the bundle for the Kyvos version to which you want to upgrade is available on the Kyvos Manager node.

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

   3. Version:Enter the Access Key and Client Secret Key to access the bundle, and then click the Fetch Versions button.

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

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 Path	Shows the backup path. NOTE 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.
Backup	semantic model data: 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.

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

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

Enter your Kyvos Manager Password to confirm upgrade deployment.

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 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 Cloudfunctions.functions.update permission required for updating Functions.

Aura tab
summary On-Prem params JTdCJTIydGl0bGUlMjIlM0ElMjJPbi1QcmVtJTIyJTdE

On the navigation bar, click Application Update > Upgrade. 

The Upgrade page is displayed with the current version details of Kyvos and Kyvos Manager. By default, the Kyvos option is selected for the Upgrade field. 

To upgrade Kyvos, do the following: 

Click the Select Bundle link to choose the Kyvos bundle from a list of compatible versions. Or, click the Upload New Bundle link to provide your bundle.

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

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 Path	Shows the backup path. NOTE 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.
Backup	Semantic model data: 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.

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

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

Enter your Kyvos Manager Password to confirm upgrade deployment.

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 the upgrade, a backup will be automatically created and saved at /data/hdisk1/app/ location.