Upgrading

The AnyCAGateway REST is compatible with Keyfactor Command version 11 and above. Previous Keyfactor AnyCAGateway DCOM versions 20.7 and above can be upgraded to the AnyCAGateway REST.

Note:  If you’re upgrading from an instance of the AnyCAGateway DCOM, the upgrade of the database must be run on the existing Anygateway server, or a server that is domain-joined with the existing Anygateway server. However, once the database is upgraded, the new AnyCAGateway REST can be installed anywhere.
Note:  During an upgrade, the Extensions folder is preserved. All existing extensions and files in the destination Extensions folder remain in place unless a file or folder with the same name exists in the source Extensions folder, in which case the source version overwrites the destination version.

By default, Extensions folders for previous versions are located at:

C:\Program Files\Keyfactor\Keyfactor AnyCA Gateway\AnyGatewayREST\net6.0\Extensions
C:\Program Files\Keyfactor\Keyfactor AnyCA Gateway\AnyGatewayREST\net8.0\Extensions

This behavior is especially useful when upgrading extensions that include a manifest.json file. If the source extension includes a newer manifest.json, it will overwrite the existing file in the destination, ensuring that outdated manifests from earlier versions are removed and preventing unintended behavior.

This allows extensions to be upgraded without manually deleting or modifying files in the installation directory.

Note:  Migrations from installations on Windows to installations in containers under Kubernetes with an upgrade are only supported from an existing AnyCAGateway REST implementation. If you’re starting with an instance of the AnyCAGateway DCOM, upgraded to an instance of the AnyCAGateway REST on Windows before migrating to a container implementation.
AnyCA Gateway Upgrade Compatibility Matrix

There are two formats of the AnyCA Gateway—DCOM and REST. While the DCOM format is planned for eventual deprecation, both versions are currently supported and released. This impacts the upgrade process by requiring verification that a gateway installation is compatible with the intended destination version.

The rules as to what upgrades are allowed are as follows:

  • DCOM to DCOM:

    Upgrading from an older DCOM gateway to a newer DCOM gateway is supported.

  • REST to REST:

    Upgrading from an older REST gateway to a newer REST gateway is supported.

  • DCOM to REST:

    Converting a DCOM gateway to a REST gateway is supported only when the source and destination versions are the same (for example, upgrading from 24.1 DCOM directly to 24.1 REST). Cross-version conversions are not supported.

  • REST to DCOM:

    Converting a REST gateway to a DCOM gateway is not supported.

See Table 1223: AnyCA Gateway Upgrade Compatibility Matrix for upgrade compatibility between AnyCA Gateway formats.

Table 1223: AnyCA Gateway Upgrade Compatibility Matrix

Source Version → From

Target Version ↓ To

 DCOM v23.3 DCOM v23.4 DCOM v24.1 DCOM v24.2 DCOM v24.3 DCOM v25.1 REST v24.1 REST v24.2 REST v24.4 REST v25.1 REST v25.2 REST v25.3 REST v25.4 REST v25.5
DCOM v23.3  
DCOM v23.4  
DCOM v24.1  
DCOM v24.2  
DCOM v24.3  
DCOM v25.1  
REST v24.1 † †  
REST v24.2 † † †  
REST v24.4

†

†

†

†

 
REST v25.1 † † † † †  
REST v25.2 † † † † † †  
REST v25.3 † † † † † †  
REST v25.4 † † † † † †  
REST v25.5 † † † † † †  

Table 1224: Legend: AnyCA Gateway Upgrade Compatibility Matrix

Symbol Meaning
Supported

Not supported
†

Indirect upgrade required

Direct upgrade is not supported. Upgrade first to a DCOM version that has a matching REST release, then convert to REST and continue upgrading.

Example: DCOM 23.3 → DCOM 25.1 → REST 25.1 → REST 25.5
  Same Version