After you upgrade from 7.3.x or 7.4.x

This topic includes post-upgrade steps that you might need to perform after running sysupgrade to upgrade from API Gateway 7.3.x or 7.4.x to 7.5.3. It contains the following topics:

Upgrade API Gateway projects

Each API Gateway group has a configuration that is typically deployed as a .fed file. When you upgrade from an earlier version of API Gateway, configuration for all API Gateway groups is automatically upgraded during sysupgrade. However, you might have configuration files that were originally created in Policy Studio in a development environment that also need to be upgraded. You can upgrade the configuration in your development environment in one of the following ways:

  • In Policy Studio:
    • Choose the From an API Gateway instance option to create a new project from the configuration in an already upgraded API Gateway.
    • Choose the From existing configuration option to create a new project from an old configuration. The configuration is upgraded to version 7.5.3 automatically.
  • For more information on creating projects in Policy Studio, see the API Gateway Policy Developer Guide.
  • If you upgraded from version 7.4.1 or earlier, you can use the upgradeconfig script that is available in your API Gateway installation directory (for example, /opt/Axway-7.5.3/apigateway/Win32/bin). For more information on running the upgradeconfig script, enter upgradeconfig --help at the command prompt.
Caution   If your .fed file contains API Manager configuration, you cannot upgrade it using upgradeconfig or Policy Studio. You must use sysupgrade.

Update Salesforce connector license

If you upgraded from API Gateway 7.4.1, the API Gateway trace log might show a deployment error indicating that the Salesforce connector does not have a valid license.

The Salesforce connector was added in API Gateway 7.4.1 and was installed together with API Manager. It can be used to import back-end APIs from Salesforce. In 7.5.3, the Salesforce connector is a licensed feature.

You have two options to resolve this issue:

  1. If you intend to use the Salesforce connector in the new API Gateway installation, you must acquire a valid license from Axway Support.
  2. If you do not intend to use the Salesforce connector in the new API Gateway installation, you can remove it using Policy Studio. This will eliminate the deployment error.
  3. For more information on what to remove in Policy Studio, see the Salesforce API connectors section of the API Manager User Guide. After removing the connector, you must deploy the updated configuration to all groups in the topology.

Upgrade services

If you were running the API Gateway and Node Manager processes as services in your old installation, you must update the service scripts manually after the upgrade completes. Service scripts are not updated by sysupgrade.

Note   If you have set up Cassandra to run as a service on the same machine as the API Gateway services, you must ensure that the Cassandra service starts up before the API Gateway services.

Upgrade services on UNIX/Linux

Complete the following steps after running sysupgrade apply:

  1. Switch user to root to enable you to modify files in /etc/init.d. Typically, Axway services file names start with vshell-.
  2. Edit the Node Manager script and update the VDISTDIR variable to point to the apigateway folder in the new installation.
  3. For example, on a machine called XUbuntu02, edit the file /etc/init.d/vshell-Node-Manager-on-XUbuntu02.
    • Update the VDISTDIR variable (for example, change VDISTDIR="/opt/Axway-7.2.2/apigateway to VDISTDIR="/opt/Axway-7.5.3/apigateway).
  4. Edit each of the relevant API Gateway scripts, and update the VDISTDIR and the VINSTDIR variables to point to the apigateway folder in the new installation.
  5. For example, on a machine called XUbuntu02 with one API Gateway called Gateway1 that is a member of a group called Default Group, edit the file /etc/init.d/vshell-Default-Group-Gateway1.
    • Update the VDISTDIR variable (for example, change VDISTDIR="/opt/Axway-7.2.2/apigateway to VDISTDIR="/opt/Axway-7.5.3/apigateway).
    • Update the VINSTDIR variable (for example, change VINSTDIR="/opt/Axway-7.2.2/apigateway/groups/group-2/instance-1 to VINSTDIR="/opt/Axway-7.5.3/apigateway/groups/group-2/instance-1).
  6. Save the changes to the files and restart the machine. When the machine restarts the new services are started.
Tip   Alternatively, your UNIX/Linux administrator can remove the old services using the preferred UNIX/Linux utility and delete the old init.d service files, and you can use managedomain to recreate the services after running sysupgrade.

Upgrade services on Windows

To upgrade services on Windows, you can use the managedomain utility to remove and recreate the services. You also need to use some Windows utilities to modify the services.

Note   The managedomain utility is located in INSTALL_DIR\apigateway\Win32\bin. The Admin Node Manager must be running to use managedomain.

To modify Windows services, you must have administrator rights. Always use the Run as administrator option when launching a command prompt to run managedomain or the Windows utilities mentioned in the following steps.

Complete the following steps after running sysupgrade apply:

  1. Use the managedomain utility to remove the old API Gateway services. Ensure that you remove the services for each API Gateway instance. See Use managedomain to remove API Gateway services.
Tip   You can use managedomain --print_topology to show the Node Manager and API Gateway instance names.
  1. Use the managedomain utility to remove the old Node Manager service. See Use managedomain to remove a Node Manager service.
  2. To confirm that the services have been deleted, launch the Windows utility Services.msc, and verify that they are no longer listed.
  3. Use managedomain to recreate the Node Manager service. See Use managedomain to add a service for a Node Manager.
  4. Use managedomain to recreate the API Gateway services. Ensure that you add services for each API Gateway instance. See Use managedomain to add API Gateway services.
  5. Change the startup type of the services to automatic (by default, the services must be started manually). You can use the Windows sc.exe utility to change the startup type.
  6. For example, to change the startup type of the service name QuickStart Server (QuickStart Group), enter the following command:
sc config "QuickStart Server (QuickStart Group)" start= auto
  1. If you are using Cassandra and you have set up Cassandra to run as a Windows service on the same machine as the API Gateway services, you must set a dependency on Cassandra in any API Gateway services.
  2. For example, to add a dependency to the service name QuickStart Server (QuickStart Group), enter the following command :
sc config "QuickStart Server (QuickStart Group)" depend= cassandra

Use managedomain to remove API Gateway services

To remove each API Gateway service, enter the following command:

managedomain.bat --remove_service --name GATEWAY_NAME --group GATEWAY_GROUP

For example, if the API Gateway is called QuickStart Server and it belongs to a group called QuickStart Group, enter the following:

managedomain.bat --remove_service --name "QuickStart Server" --group "QuickStart Group"

Use managedomain to remove a Node Manager service

To remove a Node Manager service, enter the command:

managedomain.bat --edit_host --host HOST_NAME --remove_nm_service

For example, if the host is PC-123.wks.university.edu, enter:

managedomain.bat --edit_host --host "PC-123.wks.university.edu" --remove_nm_service

Use managedomain to add a service for a Node Manager

To add the Node Manager as a Windows service, enter the command:

managedomain.bat --edit_host --host HOST_NAME --add_service

For example, if the host name is PC123.wks.university.edu, enter:

managedomain.bat --edit_host --host "PC123.wks.university.edu" --add_service

Use managedomain to add API Gateway services

To add each API Gateway as a Windows service, enter the command:

managedomain.bat --add_service_only --name GATEWAY_NAME --group GATEWAY_GROUP

For example, if the API Gateway is called QuickStart Server and it belongs to a group called QuickStart Group, enter:

managedomain.bat --add_service_only --name “QuickStart Server” --group “QuickStart Group”

Migrate the QuickStart tutorial

sysupgrade does not migrate the Quickstart tutorial from your old installation. To migrate it, copy the /apigateway/webapps/quickstart directory from your old installation (for example, /opt/Axway/7.4.1/apigateway/webapps/quickstart) to the same location in the new 7.5.3 installation (for example, /opt/Axway/7.5.3/apigateway/webapps/quickstart).

Add nodes to an Apache Cassandra database cluster for HA

Note    
  • This section applies to Apache Cassandra users who are upgrading from API Gateway versions earlier than 7.5.1 only. For example:
    • If you are using API Manager in your old installation, Apache Cassandra is required and this section applies.
    • If you are using Apache Cassandra for custom KPS data, for OAuth client application data, or for API keys in your old installation, this section applies.
  • If you are not using Apache Cassandra, or if you are upgrading from API Gateway 7.5.1 or later you can skip this section.

Before you upgraded, you configured an Apache Cassandra cluster with one Cassandra server as detailed in Configure an Apache Cassandra database cluster in the new installation. You can now add more nodes to this cluster to provide high availability (HA), and configure TLS security.

For more information, see Install Apache Cassandra in the API Gateway Installation Guide.

Upgrade API Gateway Analytics versions earlier than 7.4.0

If you are using an API Gateway Analytics version earlier than 7.4.0, you can upgrade API Gateway Analytics after you run the sysupgrade command. For more information, see Upgrade API Gateway Analytics.

Related Links