Upgrade

This chapter details how to update an existing KeySafe 5 install to the latest version.

Upgrade the KeySafe 5 Service Deployment from v1.7.0

Before upgrading, Entrust recommends backing up your data and configurations as described in KeySafe 5 Service Backup.
  1. Perform the following steps for your operating system:

    On Linux:

    1. Run sudo /opt/nfast/keysafe5/server/sbin/install -u to uninstall the existing KeySafe 5 Service.

    2. Download and unpack the KeySafe 5 1.8.0 package and navigate to the keysafe5-service directory.

    3. Run sudo tar -C / -xf /path/to/keysafe5-server-1.8.0-Linux.tar.gz to unpack the KeySafe 5 Service binaries and associated scripts into the /opt/nfast/ directory.

    4. Run sudo /opt/nfast/keysafe5/server/sbin/install to install the KeySafe 5 Service.

    On Windows:

    1. Stop the KeySafe 5 Service using Windows Service Manager.

    2. Open the Control Panel and select Programs and Features.

    3. Select the nShield KeySafe 5 Service package.

    4. Select Uninstall and follow the on-screen instructions.

    5. Download and unpack the KeySafe 5 1.8.0 package and navigate to the keysafe5-service directory.

    6. Double-click keysafe5-server-1.8.0-windows.msi and follow the Installation Wizard.

  2. Open the KeySafe 5 WebUI at https://127.0.0.1:18080 by default, and verify that your existing KeySafe 5 data is available.

  3. Upgrade each KeySafe 5 Agent as described in Agent Upgrade.

Configuration File Changes

The following sections describe the configuration parameters that have been updated or added in this version of the KeySafe 5 Service. The config.yaml.example file included with this version lists these parameters and their default values. To change any of these settings from their default values, copy the relevant parameters into your existing config.yaml file and restart the KeySafe 5 Service. Default values apply to any configuration parameters not explicitly set in config.yaml. For details on configuration items, see KeySafe 5 Service Configuration.

Existing configuration items that have been updated:

Parameter Description Default Value

database.type

Type of database to use. This parameter now supports mongodb in addition to sqlite.

sqlite

database.timeout

Timeout for database requests has increased from 30s to 60s.

60s

The new configuration items are as follows:

Parameter Description Default Value

health.service_startup_timeout

Maximum time to wait for each sub-service to pass its initial health check during startup. Increase this value if sub-services are slow to start in your environment. If a sub-service does not become healthy within this period, the gateway will report a startup failure.

30s

logging.journal.enabled

Set this parameter to true to enable log output to the journal. The default setting (false) does not output to the journal.

false

ui.csp_connect_sources

List of additional domains to add to the Content-Security-Policy connect-src directive applied to the WebUI. Required for Identity Providers, such as Microsoft Entra ID, that serve OIDC endpoints from a different domain to the issuer.

``