Versions Compared

Old Version 2

changes.mady.by.user Sarabjeet Kaur

Saved on

compared with

New Version 3

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) Kyvos AWS Marketplace

...

Post upgrade steps for upgrading to 2023.2 from 2023.1.x

...

Redeploying Zookeeper

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFFAE6

Important

  • To upgrade to the latest version of Zookeeper, switching to managed Zookeeper is mandatory.

  • After redeploying Managed Zookeeper, you must restart Kyvos services.

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

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

When upgrading to a release across which the Managed Zookeeper supported version is changing, post-upgrade, the activity of Managed Zookeeper undeploy/deploy will be required.

...

This is a one-time activity that is required only when upgrading from a prior release using older Managed ZooKeeper version to a Kyvos release which is using the newer version of Managed Zookeeper. For example, if you upgrade from release prior to Kyvos 2023.2 to a release up to Kyvos 2024.1.2 (i.e., when Zookeeper version 3.6.1 was in use and now 3.7.1 is supported).

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 deployments (AWS, GCP, and Azure) and on-prem deployments to remove the previous version of Zookeeper.

Upgrading Zookeeper version

  1. Log onto the Kyvos Manager and navigate to Kyvos and Ecosystem > Zookeeper.

  2. Here, select the External option and click the Save It will undeploy Zookeeper.

  3. Once Zookeeper undeployment is complete, select the Managed by Kyvos option and click the Save This will trigger the deploy Zookeeper operation.  

  4. Once Zookeeper deployment is complete, restart all Kyvos services from the Dashboard.

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 Kyvos, perform the following post-upgrade steps. 

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFFAE6

Important

  • From Kyvos 2023.2 onwards, for AWS, the restoration process for the external repository RDS has been automated, eliminating the need for manual intervention.

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

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

...

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.

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Info

If you restore a previous version of Kyvos Manager or Kyvos, any data that was added or performed in Kyvos Manager after switching to Postgres (starting with Kyvos 2023.1) - such as audits, operations, users, and alerts - will be lost.


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.

...