Versions Compared

Old Version 6

changes.mady.by.user Sarabjeet Kaur

Saved on

compared with

New Version Current

changes.mady.by.user Sarabjeet Kaur

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

...

This section provides information to upgrade and rollback Kyvos Manager. 

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

  • From the Kyvos 2023.1 release onwards, the Derby repository will no longer be supported for Kyvos Manager. The only supported repository will be Postgres (either bundled or external).

  • In a fresh deployment using the Kyvos 2023.1 release, Postgres will be used as the default repository for Kyvos Manager. However, in cases where older releases were used to deploy the cluster, an upgrade will be mandatory to migrate from Derby to Postgres as the repository for Kyvos Manager.

  • If your environment has enhanced security, the managed identity must be granted 'joinViaServiceEndpoint/action' permission with the scope set to the virtual network in which Kyvos is running.

...

Upgrade Kyvos Manager from the portal
Anchor
Upgrade_KM
Upgrade_KM

...

On the navigation pane, click Application Update > Upgrade.

...

KM

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

  2. On the Upgrade Kyvos Manager page, provide the information as:

Aura tab collection
paramsJTdCJTIyZ2VuZXJhbCUyMiUzQSU3QiUyMnRhYlNwYWNpbmclMjIlM0EwJTJDJTIydGFiV2lkdGglMjIlM0ExMDAlMkMlMjJ0YWJIZWlnaHQlMjIlM0E1MCUyQyUyMmRpcmVjdGlvbiUyMiUzQSUyMmhvcml6b250YWwlMjIlN0QlMkMlMjJjb250ZW50JTIyJTNBJTdCJTIyYmFja2dyb3VuZENvbG9yJTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjNmZmYlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0ExJTJDJTIydG9wJTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmNvbG9yJTIyJTNBJTdCJTIybGlnaHQlMjIlM0ElMjIlMjNjY2NlY2YlMjIlN0QlN0QlMkMlMjJwYWRkaW5nJTIyJTNBJTdCJTIydG9wJTIyJTNBMTAlMkMlMjJyaWdodCUyMiUzQTEwJTJDJTIyYm90dG9tJTIyJTNBMTAlMkMlMjJsZWZ0JTIyJTNBMTAlN0QlN0QlMkMlMjJhY3RpdmUlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzZjU4MjI3JTIyJTdEJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSU3QiUyMmxpZ2h0JTIyJTNBJTIyJTIzMDAwMDAwJTIyJTdEJTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTdEJTdEJTJDJTIyaG92ZXIlMjIlM0ElN0IlMjJiYWNrZ3JvdW5kQ29sb3IlMjIlM0ElN0IlMjJjb2xvciUyMiUzQSUyMiUyM2RmZTFlNiUyMiU3RCUyQyUyMnRleHQlMjIlM0ElN0IlMjJmb250U2l6ZSUyMiUzQTE4JTJDJTIyY29sb3IlMjIlM0ElMjIlMjM1ZTZjODQlMjIlMkMlMjJ0ZXh0QWxpZ24lMjIlM0ElMjJsZWZ0JTIyJTJDJTIyZm9udFdlaWdodCUyMiUzQSUyMmxpZ2h0ZXIlMjIlN0QlN0QlMkMlMjJpbmFjdGl2ZSUyMiUzQSU3QiUyMmJhY2tncm91bmRDb2xvciUyMiUzQSU3QiUyMmNvbG9yJTIyJTNBJTIyJTIzZjRmNWY3JTIyJTdEJTJDJTIydGV4dCUyMiUzQSU3QiUyMmZvbnRTaXplJTIyJTNBMTYlMkMlMjJjb2xvciUyMiUzQSUyMiUyMzVlNmM4NCUyMiUyQyUyMnRleHRBbGlnbiUyMiUzQSUyMmxlZnQlMjIlMkMlMjJmb250V2VpZ2h0JTIyJTNBJTIybGlnaHRlciUyMiU3RCUyQyUyMmJvcmRlciUyMiUzQSU3QiUyMnRvcCUyMiUzQXRydWUlMkMlMjJsZWZ0JTIyJTNBdHJ1ZSUyQyUyMnJpZ2h0JTIyJTNBdHJ1ZSUyQyUyMmJvdHRvbSUyMiUzQXRydWUlMkMlMjJ3aWR0aCUyMiUzQTElMkMlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyY29sb3IlMjIlM0ElN0IlMjJsaWdodCUyMiUzQSUyMiUyM2NjY2VjZiUyMiU3RCU3RCU3RCU3RA==
Aura tab
summaryAWS
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJBV1MlMjIlN0Q=

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

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

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

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

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

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

    Pictures12.pngImage Added

Panel
panelIconIdatlassian-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 IAM role attached to the Kyvos Manager node has the lambda:UpdateFunctionCode permission required for updating Lambda.

After upgrading Kyvos and Kyvos Manager, you must perform post-upgrade steps to upgrade the Graviton JRE version. See the Post upgrade steps for the AWS section for more details. 

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.

Pictures13.pngImage Added

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

Pictures11.pngImage Added
Aura tab
summaryAzure
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJBenVyZSUyMiU3RA==

  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 

      1. Kyvos 

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

    image-20240625-174212.pngImage Added
Panel
panelIconIdatlassian-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.

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

    image-20240625-174330.pngImage Added

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

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

    image-20240625-174444.pngImage Added

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

image-20240625-174608.pngImage Added

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.

image-20240625-174722.pngImage Added
Panel
panelIconIdatlassian-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
summaryGCP
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJHQ1AlMjIlN0Q=

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.

image-20240625-174820.pngImage Added

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.

image-20240625-174936.pngImage Added
Panel
panelIconIdatlassian-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
summaryOn-Prem
paramsJTdCJTIydGl0bGUlMjIlM0ElMjJPbi1QcmVtJTIyJTdE

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.

image-20240625-175108.pngImage Added

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.

image-20240625-175148.pngImage Added
Panel
panelIconIdatlassian-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.

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

Manually upgrading Kyvos Manager

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

Kyvos Manager Tomcat Server logs will be generated in the kyvosmanagerdata/server/tomcatLogs location even after upgrading the Kyvos Manager version.

Upgrade Kyvos Manager in Azure

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

If you have upgraded to Kyvos 2023.2, you must redeploy the Zookeeper using the Zookeeper configuration page in Kyvos Manager to switch to the latest version of Zookeeper. This is necessary for cloud and on-prem deployments to remove the previous version of Zookeeper.

If you're currently using the default Zookeeper on the Kyvos Manager node, you'll need to redeploy the ZooKeeper. This applies to any cluster deployed before the managed Zookeeper implementation and still uses the default Zookeeper on the Kyvos Manager node.

  • For Kyvos Manager: If you are upgrading only Kyvos Manager, it is necessary to redeploy Zookeeper immediately after the upgrade.

  • For Kyvos: If you are upgrading both Kyvos Manager and Kyvos using either the single click upgrade or the All components upgrade, you must redeploy Zookeeper after upgrading Kyvos Manager.

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

You must restart Kyvos services once the redeployment of Zookeeper has been completed.

Upgrading Zookeeper for Kyvos 2023.2

...

Switching to the previous version of Zookeeper

To access the previous version of the Zookeeper, perform the following steps. 

  1. Add the previous Zookeeper version bundle to the Kyvos Manager repository at  kyvosmanagerdata/server/repo/ .

  2. Take a backup of the new version 3.7.1 bundle of Zookeeper at a different location outside the Kyvos Manager repo. This bundle will be necessary for switching to the new version 3.7.1 of Zookeeper.

  3. Update the previous version bundle name in the supportedBundles present in the kyvosmanagerdata/server/repo/metadata.Kyvos/zookeeper.json file by deleting the new zookeeper version bundle name and then redeploy the Zookeeper to restore managed Zookeeper to version 3.6.1.
    For example, to switch to Zookeeper version 3.6.1, before uninstalling the Zookeeper, a key having a value like supportedBundles : [zookeeper-3.7.1.tar.gz] must be updated with supportedBundles : [zookeeper-3.6.1.tar.gz]

Switching to the default non-managed version of Zookeeper

To restore the default non-managed version of Zookeeper on the Kyvos Manager node, which was removed during the uninstallation of Managed Zookeeper, you will need to manually install Zookeeper on the Kyvos Manager node.

Upgrade Graviton JRE for AWS cluster 

To upgrade the Graviton JRE version, perform the following post-upgrade steps. 

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#FFFAE6

Important

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

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note
You don't need to manually remove the Derby derby jar from the latest kyvosmanager/webapps/kyvosmanager/WEB-INF/lib/ folder. This is because it's automatically migrated deleted after the database migration. Moreover, the Derby jar has vulnerabilities, therefore Kyvos Manager will delete it from the lib folder.