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.

Note

Before proceeding with the Kyvos upgrade, Upgrade the Kyvos Manager to a compatible version.

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

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

Kyvos rollback

You can roll back patches or upgrade deployments to previously installed versions through the Kyvos Manager portal.

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.

To roll back the cluster deployment to a previous version, perform the following steps.

Create a manual backup of your existing cluster using the steps explained in the Upgrading Kyvos Manager and Kyvos section.
On the navigation pane, click Application Update > Rollback.
The Rollback page is displayed.
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.
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.
On the displayed confirmation message box, select the Start Kyvos Service checkbox to start the service automatically after rollback.
Enter your Kyvos Manager Password to confirm the rollback. Kyvos takes you to the Operations page followed by the Rollback Logs details page.

Warning

If you are using an external repository for Kyvos, then after the Kyvos version rollback - you need to change to the previous version of the repository using the Switch repository feature.
In the case of AWS, for an external repository instance, once you have restored the Kyvos external repository RDS from the backup state of the corresponding release, you will have the option to either delete or stop the Kyvos external repository instance. If you select the Delete option, the in-use external repository will be deleted. However, if you choose the Stop option, this action will incur charges in the future.

Info

After you have performed the Kyvos rollback operation, downgrade the Kyvos Manager to a compatible version of Kyvos.
Before starting the compatible version of Kyvos Manager, ensure that the Kyvos Manager repo folder specific to that version is being pointed.
For example, if you performed roll back from Kyvos Manager version 2022.1 (using repo folder) to version 2021.3 (which was renamed as repo_2021.3 at the time of upgrade), then you must ensure that the report folder from the 2021.3 version is being used.

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.

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:

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

Upgrading Kyvos