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

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

To upgrade Kyvos to a new version, perform the following steps.

To upgrade your Kyvos version from the current version to a newer version using the Kyvos Manager portal, perform the following steps.

Post-upgrade steps

Post upgrade steps for upgrading to 2023.2 from 2023.1.x

Redeploying Zookeeper

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. 

1. Navigate to the following Kyvos path: 
   /data/kyvos/installs/kyvosmanager_war/kyvosmanagerdata/server/repo

2. Execute the following command to download JRE 8.372.07.1 
   curl -o manual_node_creation_graviton_prereq.tar.gz https://s3.amazonaws.com/us-east-1.kyvos/2023.2/latest/prereq/manual_node_creation_graviton_prereq.tar.gz

3. Untar the  Kyvos2023.2_Build000x_ux64.tar.gz  tar file at the above location. The  kyvos  folder is extracted. 

4. Navigate to the  kyvos  folder and delete the existing  jre  folder, and copy the downloaded JRE (refer to step 2). 

5. Rename the  Kyvos2023.2_Build000x_ux64.tar.gz  tar file to  Kyvos2023.2_Build000x_ux64_old.tar.gz

6. Create a new tar in the  kyvos  folder by executing the following command: 
   tar -cvzf Kyvos2023.2_Build000x_ux64.tar.gz kyvos/

7. Go to Kyvos Manager, navigate to the Upgrade page, and then upgrade Kyvos.

Post upgrade IAM policies to use resource scaling

Case 1
To upgrade from Kyvos 2023.1.1 to Kyvos 2023.5, perform the following steps.

1. To increase or decrease BI Server or Query Engine nodes, following permissions need to be added in IAM roles:

   { "Sid": "LaunchTemplateAndTerminateInstances", "Effect": "Allow", "Action": [ "ec2:GetLaunchTemplateData", "ec2:TerminateInstances" ], "Resource": "*", "Condition": { "StringEqualsIgnoreCase": { "ec2:ResourceTag/UsedBy": "Kyvos" } } }, { "Sid": "CreateLaunchTemplate", "Effect": "Allow", "Action": [ "ec2:RunInstances", "ec2:CreateLaunchTemplate", "ec2:DeleteLaunchTemplate" ], "Resource": "*" }

2. The ‘CreateTags’ permission needs to be removed. Hence, to create a separate policy for creating tags. Replace the following existing policy.

   "Condition": { "StringEqualsIgnoreCase": { "ec2:ResourceTag/UsedBy": "Kyvos" } }, "Action": [ "ec2:DeleteTags", "ec2:CreateTags", "ec2:DescribeInstanceStatus" ], "Resource": "*", "Effect": "Allow", "Sid": "Ec2tagsPermissionKM" },

3. After replacing the policy mentioned in Step-2, update the following policy.

   { "Sid": "Ec2tagsPermissionKM", "Effect": "Allow", "Action": [ "ec2:DeleteTags", "ec2:DescribeInstanceStatus" ], "Resource": "*", "Condition": { "StringEqualsIgnoreCase": { "ec2:ResourceTag/UsedBy": "Kyvos" } } }, { "Sid": "Ec2tagsPermissionKM2", "Effect": "Allow", "Action": [ "ec2:CreateTags" ], "Resource": "*" }

Case 2

In case of upgrade from Kyvos 2023.2, 2023.3, 2023.4 to Kyvos 2023.5, perform the following steps.

1. To increase or decrease BI Server or Query Engine nodes, following permissions need to be added in IAM roles:

2. The ‘CreateTags’ permission needs to be removed. Hence, to create a separate policy for creating tags. Replace the following existing policy.

3. After replacing the policy mentioned in Step-2, update the following policy.

4. Add a tag on all Query Engine and BI Server as cloudformation:stack-name and its value must be the stack name you provide.

5. Remove the following existing policy for a condition.

6. After removing the policy mentioned in step-5 (as mentioned above) for a condition, update the following policy.

Kyvos rollback

You can roll back patches or upgrade deployments to previously installed versions through 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. 

   Open

   

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.
   
   

   Open

   

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.
   
   

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.

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.