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 provides information to upgrade and rollback Kyvos Manager. 

• Pre-upgrade verification

• Creating backup

• Upgrade Kyvos Manager and Kyvos

• Manually upgrading Kyvos Manager

• Kyvos Manager Tomcat Server logs 

• Upgrade Kyvos Manager in Azure

• Performing skip upgrade of Kyvos Manager

Pre-upgrade verification  

Important for RHEL 8.6 and TLS

Please make sure you have moved or renamed the openssl.cnf file placed at /etc/pki/tls/ location only on Kyvos Manager and the node where Postgres Service is running to another location.

Creating backup

To upgrade the Kyvos Manager to a newer version, you must first create a backup of your existing Kyvos Manager environment.

To create a backup for the Kyvos Manager data, perform the following steps.

1. Log in to Kyvos Manager machine through the terminal.

2. Navigate to the Kyvos Manager installation path.

3. Stop the Kyvos Manager process using the command:
   ./kyvosmanager/bin/stop-km.sh 

4. Identify the location for the used kyvosmanagerdata  folder. For this, check the value of KM_DATA_DIR in the set env.sh  file in the bin folder.
   This folder contains the Kyvos Manager data including the repository.

5. Go to parent folder of the kyvosmanagerdata  folder and run the command.
   tar -zcvf file_name.tar.gz kyvosmanagerdata
   Here  file_name  is the user backup file name for the Kyvos Manager.

6. Copy the backup file to the local machine.

7. Rename your current  repo  folder at the  kyvosmanagerdata/server location, such as repo_<oldversion number>. For example, you can name it repo_2020.5.

Upgrade Kyvos Manager and Kyvos

You can easily upgrade both Kyvos and Kyvos Manager applications to a newer version by simply selecting the required version from the Kyvos Manager portal.

From Kyvos 2024.3 onwards, this is applicable to all environments.

Int he table below:

MP = Marketplace | MS = Managed Services | SNS = Single Node Standard | Ent = Enterprise

1. On the navigation pane, click Application Update > Upgrade.

2. On the Upgrade Kyvos Manager page, provide the information as:

3. To see upgrade history, click the Actions menu (...) and select the View History option.

Manually upgrading Kyvos Manager

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

1. If not stopped already, stop Kyvos Manager from the terminal using the following command.

   ./kyvosmanager/bin/stop-km.sh 

2. Copy the new Kyvos Manager setup on the machine parallel to the older version of Kyvos Manager is installed.
   For this: 

   1. Log in to the machine using the credentials of the user, which were used for installing the previous version.

   2. Download the setup from the FTP site to the location where you need to install it. For example, /data/kyvosXXXX.YY/

   3. For the older version of Kyvos Manager, we assume:

      1. Installation directory is located at /data/kyvos

      2. Kyvos Manager home directory is located at /data/kyvos/kyvosmanager

      3. Data directory is located at /data/kyvos/kyvosmanagerdata

3. Extract the Kyvos Manager bundle using the following command:
   tar -xvf KyvosManager<version>_ux64.tar.gz
   You will get a folder named kyvosmanager_war.

4. Make the following configurations in the setenv.sh file located at $KM_HOME/kyvosmanager_war/kyvosmanager/bin/

   1. Set absolute paths for the following variables, as shown in the examples.

      1. KM_BASE_DIR: Should point to the kyvosmanager_war folder.

      2. KM_DATA_DIR: Should point to kyvosmanagerdata folder of the older installation.
         Example: KM_DATA_DIR=/data/kyvosmanager_war/kyvosmanagerdata/

      3. JRE_HOME: Should point to the JRE folder in the kayvosmanager_war folder.
         Example: /data/kyvosmanager_war/jre/

5. Copy all the contents of the kyvosmanager_war/kyvosmanagerdata/server/repo/ folder to the KM_DATA_DIR/server/ location.

   Ensure that you copy ALL the contents of the repo folder i.e., the Kyvos bundle and the metadata.Kyvos folder.

6. Merge the contents of your existing conf/kyvosanager.properties file to the conf/kyvosanager.properties of the new version.

7. Copy the contents of the kyvosmanager_war/kyvosmanagerdata/server/repo/ folder to the KM_DATA_DIR/server/ location.

8. Start Kyvos Manager from the terminal using the command:

   cd      

   ^{kyvosmanager_war/kyvosmanager/bin}

   ^{./start-km.sh}

9. Login to Kyvos Manager and check the version from the About page to verify a successful upgrade.

10. The Kyvos Manager cluster dashboard displays a warning message, prompting you to upgrade your Kyvos version. Click Upgrade. Now you can upgrade Kyvos .

Kyvos Manager Tomcat Server logs 

From Kyvos 2023.3 onwards, logs of Kyvos Manager Tomcat Server will be located in the kyvosmanagerdata/server/tomcatLogs path. 

Upgrade Kyvos Manager in Azure

Post-upgrade steps

Redeploying Zookeeper

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.

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 the Graviton JRE version, perform the following post-upgrade steps. 

1. Create a fresh automated Graviton-based AWS cluster on the Kyvos 2023.1.1 release that contains Kyvos Manager JRE version as  Corretto-8.362.08.1

2. Upgrade Kyvos Manager to Kyvos 2023.2, which contains Kyvos Manager JRE version as  Corretto-17.0.7.7.1. 

3. Execute the following command to download the  JRE 17.0.7.7.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

4. Delete the JRE that is already existing in the following path: 
   For example, /data/kyvos/installs/kyvosmanager_releases/KyvosManager2023.2War_ux64/kyvosmanager_war/jre/

5. Untar the downloaded tar file and place it on the following path of the Kyvos Manager node:   
   For example,  /data/kyvos/installs/kyvosmanager_releases/KyvosManager2023.2War_ux64/kyvosmanager_war/jre/

6. Start the Kyvos Manager services from the following path.
   For example,  /data/kyvos/installs/kyvosmanager_releases/KyvosManager2023.2War_ux64/kyvosmanager_war/kyvosmanager/bin

7. After completing the steps, the Kyvos Manager application will be up and running. 

Performing skip upgrade of Kyvos Manager

From Kyvos 2024.1 onwards, there are manual steps required when performing skip upgrade of Kyvos Manager. This is only necessary when upgrading Kyvos Manager from a release earlier than 2023.1 (i.e. when the Kyvos Manager build uses Derby as the repository) to any release 2024.1 or later.

To perform skip upgrade of Kyvos Manager for the previous releases, perform the following steps.

1. After the Kyvos Manager upgrade (from release earlier to 2023.1) to any release 2024.1 or onwards, a new version of Kyvos Manager will not start.

2. Stop the new version of Kyvos Manager from its current home path using bin/stop-km.sh.

3. Copy the existing Derby jar from the earlier running version of Kyvos Manager from path kyvosmanager/webapps/kyvosmanager/WEB-INF/lib/ to the latest running version of Kyvos Manager at the same path.

4. Start the latest Kyvos Manager using the start-km.sh command.

5. After logging in, you will be redirected to the Kyvos Manager repository database migration to perform the Kyvos Manager database migration from Derby to Postgres.

6. Once the database migration is completed, ensure that Kyvos Manager is restarted.