Upgrade API Gateway on the appliance

This topic describes how to upgrade the API Gateway software on your appliance from version 7.4.x to version 7.5.3.

Tip   This topic applies to API Gateway Appliances only. For more information on upgrading an API Gateway software installation, see the API Gateway Upgrade Guide.

Prerequisites

The following prerequisites apply when upgrading API Gateway on the appliance:

  • You must backup the old API Gateway installation before proceeding with this upgrade.
  • Before you can upgrade API Gateway on the appliance, you must first upgrade your Appliance Platform to version 7.1.2. For more details, see Upgrade the Axway Appliance Platform.
  • Before you proceed with an upgrade of API Gateway on the appliance, you should familiarize yourself with the API Gateway software upgrade process as detailed in the API Gateway Upgrade Guide. Depending on the version of API Gateway you are upgrading from, and whether you are upgrading a single-node or multi-node domain, you should also review the relevant sections on single-node and multi-node upgrades, and on the tasks you might need to perform before the upgrade and after the upgrade. See the following sections:
  • Before you start API Gateway on the appliance, ensure that you have the correct licenses. For more information, see License keys.
  • If you intend to upgrade Apache Cassandra to version 2.2.8, we recommend that you upgrade API Gateway before upgrading your Cassandra version.
  • Upgrading API Gateway on your appliance will result in service interruption and you should plan the upgrade appropriately and take any necessary steps before proceeding with the upgrade.

Upgrade summary

To upgrade API Gateway on your appliance you must complete both of the following steps:

  1. Download and install the API Gateway 7.5.3 software.
  2. Run sysupgrade to upgrade your system.

The API Gateway 7.5.3 software is downloaded and installed in a different directory to your old API Gateway installation, which means that you can keep your old installation running during the upgrade.

The API Gateway 7.5.3 package is downloaded and installed in the following location:

 /opt/Axway-7.5.3/apigateway

During the sysupgrade process this installation is referred to as the new installation.

Earlier versions of API Gateway are installed in the following location:

 /opt/Axway/apigateway

During the sysupgrade process this installation is referred to as the old installation.

Note   Performing an upgrade changes the path of the API Gateway installation. You must update any start scripts, monitoring, audit archiving, or other settings that use the API Gateway installation paths after the upgrade completes.

Upgrade steps

To upgrade the API Gateway software on your appliance, follow these steps:

  1. Install the new API Gateway software package using the Web Administration Interface, zypper, or rpm.
  2. For example, to install using zypper, enter the following commands:
# sudo zypper --non-interactive --no-gpg-checks --gpg-auto-import-keys install -l -y --download-only 
-r APIGATEWAY AxwayAPIGateway-appliance 
# sudo rpm -i /var/cache/zypp/packages/APIGATEWAY/AxwayAPIGateway-appliance-7.5.3-8.x86_64.rpm
  1. To install using the Web Administration Interface:
    1. Select Software Update Management in the menu on the left, and select API Gateway Updates.
    2. Click the Check Updates button. The latest available API Gateway package displays (for example, AxwayAPIGateway-appliance-7.5.3).
    3. Check for API Gateway updates
    4. Click the Update Software button to install the API Gateway package.
    5. Perform the update
  2. The API Gateway 7.5.3 package is downloaded and installed in the following location:
 /opt/Axway-7.5.3/apigateway
  1. Change to the following directory in the new installation:
# cd /opt/Axway-7.5.3/apigateway/upgrade/bin
  1. Run the sysupgrade export command. For example:
# ./sysupgrade export --old_install_dir /opt/Axway/apigateway/
  1. Run the sysupgrade upgrade command. For example:
# ./sysupgrade upgrade
  1. Stop the API Gateway processes in the old installation. (Do not stop Apache Cassandra 2.2.5.)
  2. Perform the following steps:
    1. Move /etc/ld.so.conf.d/gateway-libs.conf (file associated with the old API Gateway) to a secure location.
    2. Move /opt/Axway-7.5.3/apigateway/conf/gateway-libs-7.5.3.conf to /etc/ld.so.conf.d.
    3. Run the /sbin/ldconfig command.
    4. Run the setcap 'cap_net_bind_service=+ep cap_sys_rawio+ep' /opt/Axway-7.5.3/apigateway/platform/bin/vshell command.
  3. Run the sysupgrade apply command. For example:
# ./sysupgrade apply
  1. (Optional) If you are using Apache Cassandra, you can now upgrade to Apache Cassandra version 2.2.8. For more information, see Upgrade to Apache Cassandra 2.2.8 on the appliance. Alternatively, you can continue using your existing Apache Cassandra version 2.2.5.

For more details on running the sysupgrade commands for a single-node domain see:

For more details on running the sysupgrade commands for a multi-node domain see:

Upgrade to Apache Cassandra 2.2.8 on the appliance

You can upgrade Apache Cassandra from version 2.2.5 to version 2.2.8 after you upgrade API Gateway on the appliance.

Upgrade Cassandra if it is running as a process

If Apache Cassandra is running as a process, follow these steps to upgrade Apache Cassandra from version 2.2.5 to version 2.2.8 on your appliance:

  1. Download the Cassandra 2.2.8 package (for example, APIGateway_7.5.3_Package_Cassandra_2.2.8_linux-x86-64_BN<n>.zip) from Axway Support at https://support.axway.com and upload it to your appliance.
  2. Log in to the appliance using the default administrator account (user name admin ) and use su - to switch to the root user after logging in. You can log in locally or using SSH. For more information, see Connect to consoles and user interfaces.
  3. Change to the directory where you uploaded the Cassandra package.
  4. Unzip the file. For example:
unzip APIGateway_7.5.3_Package_Cassandra_2.2.8_linux-x86-64_BN<n>.zip
  1. Stop the Cassandra 2.2.5 process. For example:
$ ps –ef | grep cassandra
$ sudo kill -9 <cassandra_pid>
  1. Enter the following command to upgrade Cassandra:
rpm --upgrade cassandra-appliance-2.2.8-<n>.x86_64.rpm
  1. Start Cassandra 2.2.8. For example:
$ cd /opt/apache-cassandra-2.2.8/bin
$ ./cassandra

Upgrade Cassandra if it is running as a service

If Apache Cassandra is running as a service, follow these steps to upgrade Apache Cassandra from version 2.2.5 to version 2.2.8 on your appliance:

  1. Download the Cassandra 2.2.8 package (for example, APIGateway_7.5.3_Package_Cassandra_2.2.8_linux-x86-64_BN<n>.zip) from Axway Support at https://support.axway.com and upload it to your appliance.
  2. Log in to the appliance using the default administrator account (user name admin ) and use su - to switch to the root user after logging in. You can log in locally or using SSH. For more information, see Connect to consoles and user interfaces.
  3. Change to the directory where you uploaded the Cassandra package.
  4. Unzip the file. For example:
unzip APIGateway_7.5.3_Package_Cassandra_2.2.8_linux-x86-64_BN<n>.zip
  1. Enter the following command to upgrade Cassandra:
rpm --upgrade cassandra-appliance-2.2.8-<n>.x86_64.rpm
  1. The Cassandra 2.2.5 service is stopped by the upgrade.
  2. Start Cassandra 2.2.8. For example:
# service cassandra-appliance start

Roll back to Apache Cassandra 2.2.5

When you upgrade to Apache Cassandra 2.2.8 a backup of your Cassandra 2.2.5 installation is created in /opt/backups/cassandra-appliance/cassandra-appliance_<YYYYMMDD>. For more details, see the /tmp/cass_log log file generated during Cassandra upgrade.

To roll back to Apache Cassandra version 2.2.5, follow these steps:

  1. Log in to the appliance using the default administrator account (user name admin ) and use su - to switch to the root user after logging in. You can log in locally or using SSH. For more information, see Connect to consoles and user interfaces.
  2. Enter the following command to uninstall Cassandra 2.2.8:
rpm -e cassandra-appliance-2.2.8-<n>
  1. Download the Cassandra 2.2.5 package (for example, APIGateway_7.5.3_Package_cassandra_2.2.5_linux-x86-64_BN<n>.rpm) from Axway Support at https://support.axway.com and upload it to your appliance.
  2. Change to the directory where you uploaded the Cassandra 2.2.5 package.
  3. Enter the following command to install Cassandra 2.2.5:
rpm -ivh APIGateway_7.5.3_Package_cassandra_2.2.5_linux-x86-64_BN<n>.rpm
  1. Replace the data and conf folders in the Cassandra 2.2.5 installation with the data and conf folders from the Cassandra 2.2.5 backup. For example:
    • Replace /opt/apache-cassandra-2.2.5/data with opt/backups/cassandra-appliance/cassandra-appliance_<YYYYMMDD>/data
    • Replace /opt/apache-cassandra-2.2.5/conf with opt/backups/cassandra-appliance/cassandra-appliance_<YYYYMMDD>/conf
  1. Start Cassandra 2.2.5. For example:
# service cassandra-appliance start

Related Links