Upgrade Kyvos Manager

Upgrade Kyvos Manager

This section explains how to upgrade Kyvos Manager to a newer version.

Select the Kyvos Manager option from the Upgrade list. For the next on-screen options, refer to Single-click Kyvos Manager and Kyvos section.

image-20241120-102706.png

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.

  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. 

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://docs.support.kyvos.io/wiki/spaces/KD202410/pages/238857907 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.

Copyright Kyvos, Inc. 2025. All rights reserved.