Document toolboxDocument toolbox

Upgrade Protocol Gateway

This article describes how to upgrade Protocol Gateway.

Protocol Gateway has support for changing the directory where Protocol Gateway puts the cm-gateway directory containing configuration and logs using the cm-gateway.base parameter.

Prerequisites

The following prerequisites apply: 

1. Stop the Tomcat service

2. Back up Protocol Gateway folder

Back up the Protocol Gateway folder: 

  1. Navigate to the Tomcat /webapps folder.

  2. Make a backup of the existing /pgwy folder for reference and delete the original.

3. Upgrade from a specific version

Sequential upgrade process

To upgrade from older versions to newer versions, you must upgrade each version step-by-step. 

Example: Starting from 8.5.0, you must upgrade to 8.6.x and thereafter to 8.7.1.  

The following configurations are done in configuration files in <configroot>. 

From 7.18 to 8.0

The numbering of the handlers has been changed in the file <configroot>/api.properties:

  1. If the file is unmodified, remove this file and it will be recreated with new defaults when restarting Protocol Gateway.

  2. If the file has been modified, then do the following:

    1. Open the file <configroot>/api.properties for editing. 

    2. Change the numbers on all configured handlers and their related configuration so that the number corresponds to the following numbering scheme:

      Example: api.properties

      handler.0.filter = certificates handler.10.filter = certificates/revoke handler.11.filter = certificates/reinstate handler.20.filter = certificates/[a-z0-9A-Z]+/details handler.21.filter = certificates/[a-z0-9A-Z]+/download handler.30.filter = certificates/pkcs10 handler.50.filter = procedures
    3. Add the following lines at an appropriate place in the file:

      Example: api.properties

      # Process PKCS10 request -> PKCS12 response handler.31.filter = certificates/pkcs10-to-pkcs12 handler.31.format = api/certificates-pkcs10-to-pkcs12 handler.31.tokenprocedure = Token Procedure Name - must be configured
    4. Save the file.

The settings in c2x.properties have changed:

  • If this file exists in your environment, remove it. A new version with default values will appear when restarting Protocol Gateway.

From 8.0 to 8.1

Protocol Gateway has gained the ability to send metrics to InfluxDB.

To use this feature, do the following:

  1. Open the file <configroot>/cm-gateway.properties for editing. 

  2. Add the following lines after the setting for cmhost:

    Example: cm-gateway.properties

    # CM-Connections is the maximum amount of concurrent officer connections to CF # to allocate to the officer pool. cmconnections = 20
  3. Add the following lines at the end of the file:

    Example: cm-gateway.properties

  4. Save the file. 

The REST API configuration has been extended with additional endpoints.

To use these features, do the following:

  1. Open the file <configroot>/api.properties for editing. 

  2. Add the following lines at the end of the file:

    Example: api.properties

  3. Save the file.

The EST configuration has been extended with additional options.

To use these features, do the following:

  1. Open the file <configroot>/est.properties for editing. 

  2. Replace the description of the parameters to the following:

    Example: est.properties

  3. Save the file.

From 8.1 to 8.2

From 8.2 to 8.3

From 8.3 to 8.4.x

From 8.4.x to 8.5.x

From 8.5.x to 8.6.x

From 8.6.x to 8.7.1

From 8.7.0 to 8.7.1

Certificate Manager v8.7.0

Certificate Manager version 8.7.0 is no longer available on Nexus support portal. 

From 8.7.x to 8.8.x

From 8.8.x to 8.9.x

From 8.9.x to 8.10.x

From 8.10.x to 8.11.0

4. Replace .war file

5. Restart the Tomcat service

Copyright 2024 Technology Nexus Secured Business Solutions AB. All rights reserved.
Contact Nexus | https://www.nexusgroup.com | Disclaimer | Terms & Conditions