Applies to: 
Kyvos Enterprise Kyvos Cloud (SaaS on AWS) 
Kyvos AWS Marketplace
Kyvos Azure Marketplace Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)
Single-click Upgrade for 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.
This is applicable to all environments.
In the table below:
MP = Marketplace | MS = Managed Services | SNS = Single Node Standard | Ent = Enterprise
| AWS | AWS MP | AWS MP SNS | Azure MP | Azure MP SNS | GCP MP | GCP MP SNS | AWS Ent | Azure Ent | GCP Ent | On-Premise |
Single Click Upgrade | |
|
| | | |
| |
|
|
|
Single Click Rollback | | | | | | | | |
|
|
|
Independent Kyvos Patch (Version Dropdown / text input based) |
| |
|
|
| | |
|
|
|
|
Independent Kyvos Patch |
|
|
|
|
|
|
|
|
|
|
|
Independent Kyvos Upgrade (upload / list) |
|
|
|
|
|
|
|
|
|
|
|
Independent Kyvos Rollback |
|
|
|
|
|
|
|
|
|
|
|
Independent KM Upgrade (upload / list) |
|
|
|
|
|
|
|
|
|
|
|
Independent KM Rollback |
|
|
|
|
|
|
|
|
|
|
|
On the navigation pane, click Application Update > Upgrade.
On the Upgrade page, provide the information as:
To see upgrade history, click the Actions menu (...) and select the View History option.
Upgrade Kyvos
You can also upgrade individual components such as Kyvos or Kyvos Manager.
To upgrade only Kyvos, select the Kyvos option from the Upgrade list. For the next on-screen options, refer to Single-click Kyvos Manager and Kyvos section.
Upgrade Kyvos Manager
You can also upgrade individual components such as Kyvos or Kyvos Manager.
To upgrade only Kyvos, select the Kyvos Manager option from the Upgrade list. For the next on-screen options, refer to Single-click Kyvos Manager and Kyvos section.
Manually upgrading Kyvos Manager
To upgrade Kyvos to a new version, perform the following steps.
If not stopped already, stop Kyvos Manager from the terminal using the following command.
./kyvosmanager/bin/stop-km.sh
Copy the new Kyvos Manager setup on the machine parallel to the older version of Kyvos Manager is installed.
For this:Log in to the machine using the credentials of the user, which were used for installing the previous version.
Download the setup from the FTP site to the location where you need to install it. For example, /data/kyvosXXXX.YY/
For the older version of Kyvos Manager, we assume:
Installation directory is located at /data/kyvos
Kyvos Manager home directory is located at /data/kyvos/kyvosmanager
Data directory is located at /data/kyvos/kyvosmanagerdata
Extract the Kyvos Manager bundle using the following command:
tar -xvf KyvosManager<version>_ux64.tar.gz
You will get a folder named kyvosmanager_war.Make the following configurations in the setenv.sh file located at $KM_HOME/kyvosmanager_war/kyvosmanager/bin/
Set absolute paths for the following variables, as shown in the examples.
KM_BASE_DIR: Should point to the kyvosmanager_war folder.
KM_DATA_DIR: Should point to kyvosmanagerdata folder of the older installation.
Example: KM_DATA_DIR=/data/kyvosmanager_war/kyvosmanagerdata/JRE_HOME: Should point to the JRE folder in the kayvosmanager_war folder.
Example: /data/kyvosmanager_war/jre/
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.
Merge the contents of your existing conf/kyvosanager.properties file to the conf/kyvosanager.properties of the new version.
Copy the contents of the kyvosmanager_war/kyvosmanagerdata/server/repo/ folder to the KM_DATA_DIR/server/ location.
Start Kyvos Manager from the terminal using the command:
cd kyvosmanager_war/kyvosmanager/bin ./start-km.sh
Login to Kyvos Manager and check the version from the About page to verify a successful upgrade.
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.
Note
Kyvos Manager Tomcat Server logs will be generated in the kyvosmanagerdata/server/tomcatLogs location even after upgrading the Kyvos Manager version.
Upgrade Kyvos Manager in Azure
Applicable only when current Kyvos Manager is using the Single server.
For Kyvos Manager, ensure that you use ARM template (FlexibleServerKyvosManagerRepository and FlexibleServerKyvosRepository) for the Flexible Server instance creation. You can also refer to the https://kyvosdocumentation.atlassian.net/wiki/spaces/KD202410/pages/238857907/Creating+ARM+Template+for+Automated+Azure+Deployment#FlexibleServer section.
Any user running in Kyvos Manager build before 2023.1 first needs to upgrade to any version, such as 2023.1, lower than 2023.5 so that the Kyvos Manager database Derby first gets migrated to Postgres as the Kyvos Manager repository.
First you need to upgrade both Kyvos Manager and Kyvos. After upgrading them, you need to migrate repository from Single Server to Flexible Server.
Important
Using the same external repository instance is not recommended/certified for Kyvos Manager & Kyvos both. Cluster scheduling with non-shared repo will cause the DB instance to go down; thus, the Kyvos Manager will not work properly.
If the same repository instance is used, then the database for Kyvos Manager and Kyvos must be different.
The default database name for:Kyvos is delverepo.
Kyvos Manager is kmrepo.
If any time the same external repository instance gets configured in Kyvos Manager and Kyvos. In that case, ensure that on the Switch Repository page of Kyvos Manager, the Shared repository is checked and configuration is saved.
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.
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.
Note
The login page will not appear and the following error message will be displayed.
Stop the new version of Kyvos Manager from its current home path using bin/stop-km.sh.
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.
Start the latest Kyvos Manager using the start-km.sh command.
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.
Once the database migration is completed, ensure that Kyvos Manager is restarted.
Note
You don't need to manually remove the Derby jar from the latest kyvosmanager/webapps/kyvosmanager/WEB-INF/lib/ folder. This is because it's automatically migrated after the database migration. Moreover, the Derby jar has vulnerabilities, therefore Kyvos Manager will delete it from the lib folder.