Before you upgrade from 7.5.x

This topic describes the steps that you must perform before you upgrade from API Gateway 7.5.x. It includes checks for your old API Gateway installation and for your new API Gateway 7.5.3 installation. It includes the following sections:

Checklist for the old API Gateway installation

You must perform the following in your old API Gateway installation:

Back up the old API Gateway installation

Back up the old API Gateway installation on each node. At a minimum:

  • Back up the apigateway directory.
  • Back up any databases used by API Gateway, including external databases used for OAuth or KPS, and your metrics database if you are using API Gateway Analytics.

For more details on what you should back up, see API Gateway backup and disaster recovery in the API Gateway Administrator Guide.

Check that old API Gateway groups are consistent

Before you upgrade, ensure that all API Gateway groups in the old installation are consistent, meaning that all API Gateways in a group have the same configuration deployed. Upgrade is not supported for inconsistent groups.

You can use Policy Studio or API Gateway Manager to deploy configuration to API Gateway groups. For more details, see the API Gateway Administrator Guide.

Do not update the old API Gateway installation

Do not make any changes to the old API Gateway installation after the upgrade process has begun. For example, if you have run any sysupgrade commands, do not perform any of the following on the old installation:

  • Do not make any topology changes (for example, add new API Gateway instances)
  • Do not deploy any configuration
  • Do not update the API Gateway admin user store
  • Do not update API Manager configuration (for example, add new APIs, organizations, or applications)

See also What happens if you change the old API Gateway installation after running export?

Check that ext/lib customizations in the old installation are compatible

If you have customizations (for example, third-party JAR files) in the ext/lib directory of your old API Gateway installation, the sysupgrade command copies any third-party JARs to the new installation. However, you must verify that all third-party JARs are compatible with API Gateway 7.5.3.

Before you upgrade, you should confirm that any third-party JARs are not already present in the new installation under directory apigateway/system/lib. You should also test any custom JARs to ensure that they work correctly in API Gateway 7.5.3.

For more details, see the API Gateway Developer Guide.

Upgrade API Gateway Analytics version 7.4.0 or later

If you are using API Gateway Analytics version 7.4.0 or later, you can upgrade API Gateway Analytics before you run the sysupgrade command. For more information, see Upgrade API Gateway Analytics.

Identify components and configuration requiring manual upgrade steps

Not all components and configuration from earlier API Gateway versions can be upgraded automatically with the sysupgrade command. However, you can upgrade these items manually.

Check your old installation and identify if you are using any of the following:

  • Redaction files – For more information on migrating redaction files, contact Axway Support.
  • Customizations to OAuth sample .md files – For more information on upgrading these files, contact Axway Support.
  • API firewalling – For more information on upgrading API firewalling, contact Axway Support.
  • QuickStart tutorial – For more information on migrating the QuickStart tutorial, see Migrate the QuickStart tutorial.
  • API Gateway services – If you are running API Gateway processes as services on UNIX/Linux or Windows, you must upgrade these manually. See Upgrade services.

Checklist for the new API Gateway 7.5.3 installation

Perform the following in your new API Gateway 7.5.3 installation:

Install the latest service pack

Install the latest available service pack to your new installation. Service packs are available from Axway Support at https://support.axway.com.

Do not start any Node Managers or API Gateways in the new installation

Do not create or start any Node Managers, groups, or API Gateways in the new installation. These are started automatically by the sysupgrade process.

Open the new Apache Cassandra client port in the firewall

API Gateway version 7.5.3 includes the Datastax Cassandra client, which uses a default port of 9042 to communicate with Cassandra over the native protocol. Earlier API Gateway versions included the Hector Cassandra client, which used a default port of 9160 to communicate with Cassandra over the Apache Thrift protocol.

When upgrading from 7.5.1 or later to API Gateway 7.5.3 all Cassandra hosts are updated to use port 9042 for client communication. You must open the port 9042 on your firewall to enable API Gateway to communicate with Apache Cassandra.

Alternatively, to continue to use the same port as you used in your old installation, you can perform some manual steps after the upgrade completes. For more information, see Configure a different Apache Cassandra client port.

Move third-party JDBC JARs to the new installation

If your old API Gateway installation uses external third-party databases for OAuth and KPS, you must copy the JDBC JAR files to the following location in your new 7.5.3 installation:

/apigateway/upgrade/lib

For example, if your new installation is at /opt/Axway/7.5.3, copy the JDBC drivers to /opt/Axway/7.5.3/apigateway/upgrade/lib.

This enables the sysupgrade apply step to upgrade the databases.

Related Links