› KCM Installation Guide › KCM upgrade › Upgrading KCM

Upgrading KCM

The following is a description of the Upgrade.exe tool that you need to run for upgrading your KCM installation.

Overview

Upgrade.exe is a command-line tool designed to upgrade an existing KCM installation to version 5.8.0. Upgrade is supported for KCM 5.7.0, 5.6.0, 5.5.0.

The tool works as follows:

  1. It upgrades all KCM components on a local server to KCM 5.8.0.
  2. Configuration of the existing KCM instances is preserved, except for the following:
    • For each KCM instance, a new database is used for the KCM Repository. However, the content of the old database is transferred automatically to the new one.
    • For each KCM instance, the license is configured anew.
  3. The Contract Manager configuration is set as follows:
    • Authentication and LDAP flags of the Contract Manager are configured anew, along with their configuration files.
    • The upgrade preserves the contracts with which the instances were associated on the Contract Manager.
  4. KCM Control Center configuration is set as follows:
    • OAuth2 authentication is configured anew.
  5. B&OM upgrade. For more information, refer to the following topic: Upgrading B&OM.
  6. After the upgrade, KCM 5.8.0 installation will be fully set up and started automatically.
    KCM 5.5.0 instances that were not running before the upgrade will not be started.

  7. (Optional) If an upgrade fails, an automatic rollback to the previous installation is attempted.

Execution steps

To upgrade KCM, you must execute the following steps:

  1. Open the command line interface (CLI). It could be PowerShell or Command Prompt.

  2. In the CLI, navigate to the InstallServer folder of the new KCM installation package.

  3. Call the Upgrade.exe file and provide the necessary parameters. The order of parameters is irrelevant.

    To simplify input, you can create a script with the required parameter values and then use it to run Upgrade.exe.

    If everything is correct, the upgrade will run without errors. You will be able to follow the installation process by reading the CLI output.

Troubleshooting

If the start operation fails during upgrade, we recommend that you follow the steps below:

  1. Open the corresponding log file located in the <root folder>\KCM\Work\5.8\Management\Logs folder.

  2. Start the component using the parameters and values specified in the log file.