Post upgrade steps for Kyvos

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

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

This section outlines the steps to be taken after completing the upgrade process.

Post-upgrade steps

Post upgrade steps for upgrading to 2023.2 from 2023.1.x

Deploying Zookeeper

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

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

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.

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

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

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

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.

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

Post-upgrade steps to manually configure Heap memory

Note

From Kyvos 2023.5 onwards, Heap, Off-heap, and other required memory on Query Engines are automatically configured if memory mode is set to Auto mode.

For a manual memory mode, you must perform the following post-deployment steps.

Open the Kyvos Java options page in Kyvos Manager and Navigate to the Query Engine section.
If Configure Heap memory for Query Engine is set as Auto, no need is required.
If Configure Heap memory for Query Engine is set as Manual, reduce Off-Heap memory by 10 GB.
For Example, Suppose the total machine memory is 128 GB, whereas 45 GB is assigned to Heap, and 66 GB is assigned to Off-Heap. In that case, you need to set Heap as 45 GB and Off-Heap as 56 GB so Kyvos can use the remaining 10 GB internally for the new data store-based architecture.

Post-upgrade steps for Azure

Azure Functions

Note

Applicable ONLY when you have upgraded Azure Cloud-based cluster where functions were deployed for supporting scheduling feature.

In releases before 2021.3, Azure was deployed with three separate function apps, each having a single function (KyvosClusterStatusFunction, KyvosClusterStartFunction, and KyvosOlapFunction) in it. With the 2021.3 release, the three functions are merged into a single function app (KyvosFunction). Therefore, in case of an upgrade through the Kyvos Manager application, the functions cannot be upgraded, and require a manual update.

If the functions were created in a previous release before Kyvos 2021.3

On the Azure portal, create the Azure function using azure_functions.json template file available at kyvosmanager_war/kyvosmanager/cloud/azure/templates. You can also download the file from the Azure Installation folder.
On the Kyvos Manager portal, navigate to the Properties page. In the kyvosclient.properties file, update the CLUSTER_STARTUP_URL and SERVER_STATUS_CHECK_URL properties with the URL provided in the Azure deployment function output.
Logon to your Azure portal, and navigate to <Container> / user / <work directory> / setup / cloud_conf. Download the cluster.properties file, update the FUNCTION_NAME property to provide the created Azure function name, and the upload the updated file.
Restart the BI Server.

Warning

DO NOT delete the existing function app, as you may need them in case of a rollback.

Azure Rollback steps

In case you have to roll back from Kyvos version 2021.3 to any previous version, you need to perform the following steps to ensure the correct working of the Azure functions.

On the Kyvos Manager portal, navigate to the Properties page. In the kyvosclient.properties file, update the CLUSTER_STARTUP_URL and SERVER_STATUS_CHECK_URL properties with URL available in old functions created before the upgrade.
Logon to your Azure portal, and navigate to <Container> / user / <work directory> / setup / cloud_conf. Download the cluster.properties file, update the FUNCTION_NAME property to provide the previous function name that was created before the upgrade, and upload the updated file.
Restart the BI Server.

Migrating Storage account TLS version from 1.0 to TLS 1.2

From Kyvos 2024.1 onwards, for fresh deployments on Azure, the minimum TLS version value must be 1.2. For existing environments, you need to perform the following post-deployment steps to migrate from TLS 1.0 and 1.1 to TLS 1.2.

Note

As of November 1, 2024, Azure Storage will no longer support TLS 1.0 and 1.1. It is essential to migrate to TLS 1.2 before this date.

Go to your Azure Storage account.
On the Home page, click Overview, and then click the Properties tab.
In the Security section, click Minimum TLS version and update it to 1.2 and then click Save.