Page Comparison

Post upgrade steps for upgrading to 2023.2 from 2023.1.x

Deploying Zookeeper

...

Redeploying Zookeeper with the newer version

You must redeploy the Zookeeper using the Zookeeper configuration page in Kyvos Manager to switch to the latest version of Zookeeper.  This  This is necessary for cloud deployments (AWS, GCP, and Azure) and on-prem deployments to remove the previous version of Zookeeper.

...

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.

Upgrade Graviton JRE for AWS cluster 

To upgrade Kyvos, perform the following post-upgrade steps. 

...

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

...

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

...

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

...

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

...

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

...

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:

   Code Block
   { "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.

   Code Block
   "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.

   Code Block
   { "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.

...

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": "*"
}

...

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" }, 

...

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": "*"
}

...

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

...

Remove the following existing policy for a condition.

 {
                  "Sid": "Ec2StartStopKyvos",
                  "Effect": "Allow",
                  "Action": [
                    "ec2:StopInstances",
                    "ec2:StartInstances",
                    "ec2:DescribeInstanceStatus"
                  ],
                  "Resource": "*",
                "Condition": {
                    "StringEqualsIgnoreCase": {
                      "ec2:ResourceTag/aws:cloudformation:stack-name": {
                        "Fn::Sub": "${AWS::StackName}"
                      }
                    }
                  }
                },

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

...

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

Upgrading Zookeeper with the latest supported version

1. Navigate to Kyvos and Ecosystem > Zookeeper.

2. Here, select the External option and click Save. It will undeploy the Zookeeper. The in-use Zookeeper version tar bundle will be deleted from Kyvos Manager Repository.

3. Once Zookeeper undeployment is complete, select the Managed by Kyvos option and click Save This will deploy the Zookeeper with the latest supported version.  

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

Switching to the earlier-used version of Zookeeper

To access the earlier-used version of the Zookeeper, perform the following steps. 

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

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

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 earlier-used version.
   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”]
   Sample zookeeper.json file

   Image Added

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.