Versions Compared

Key

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

...

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.

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

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

...

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.

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

    Code Block
     {
                      "Sid": "Ec2StartStopKyvos",
                      "Effect": "Allow",
                      "Action": [
                        "ec2:StopInstances",
                        "ec2:StartInstances",
                        "ec2:DescribeInstanceStatus"
                      ],
                      "Resource": "*",
                    "Condition": {
                        "StringEqualsIgnoreCase": {
                          "ec2:ResourceTag/aws:cloudformation:stack-name": {
                            "Fn::Sub": "${AWS::StackName}"
                          }
                        }
                      }
                    },
  6. After removing the policy mentioned in step-5 (as mentioned above) for a condition, update the following policy.

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

...

to manually configure Heap memory
Anchor
HeapMemory
HeapMemory

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

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.  

...

  • 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
Anchor
Azure
Azure

Azure Functions

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

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

...

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

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

  3. Restart the BI Server.

Migrating Storage account TLS version from 1.0 to TLS 1.2
Anchor
Migrate
Migrate

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.

...