Installing Platform Patches for the CA API Management Product Suite

Document ID : KB000009868
Last Modified Date : 14/02/2018
Show Technical Document Details
Introduction:

The CA API Management product suite maintains two separate lines of upgrades for different parts of the products: application and platform. This article is specific to the platform.

The application consists of the Java-based application running on the appliance. This includes applications such as the API Gateway itself, the API Developer Portal, and the Mobile API Gateway.

The platform consists of the Red Hat Enterprise Linux (RHEL) host operating system that runs the Java-based application. These platform updates are OS-level updates that address potential security concerns in order to ensure the operating system remains secure. Platform updates can be applied without modifying the version of the application running on the appliance. This allows administrators or operators to maintain a certain functional level while being able to address security vulnerabilities within the host operating system. Note that the platform updates can also be referred to as security patches. Platform updates should be applied as soon as possible to keep the API Gateway appliance patched against any OS-level security vulnerabilities.

 

It is strongly recommended that an administrator take a full API Gateway backup or snapshot of a virtual machine prior to applying platform updates. This will ensure that data is retained in case of a catastrophic failure. Instructions for taking an API Gateway backup are documented within the Installation and Maintenance Manual (Appliance Edition). Instructions for capturing snapshots of virtual machines should be documented by the vendor of the applicable virtualisation platform.

It is important that the administrator be prepared to restart the API Gateway if the patch requires it. We highly recommend performing the update during a designated maintenance period.

 

Environment:
This article applies to all CA API Management products built on top of the CA API Gateway ("Gateway"). This includes products such as the CA API Developer Portal ("Portal") and CA Enterprise Service Manager ("ESM").
Instructions:

Installing platform updates can be broken down into three specific steps:

  1. Determining the most recently installed platform update.
  2. Determining the platform update(s) to install.
  3. Troubleshooting common issues if they arise.

Determining the most recently installed platform patch

  1. Log on to the node as the ssgconfig user.
  2. Select the 8) Display Patch Management menu option in the main ssgconfig menu.
  3. Select the 4) List the patches uploaded to the Gatewayoption in the menu after number two above.
  4. Review the patches listed to determine the platform version of the node.
    • Note the versionstatusand last modified date of the most recently applied patch. An example is illustrated below:
      Patch ID Layer7_PlatformUpdate_64bit_v8.1.0 [..] is INSTALLED, last modified on 2014-04-29T04:30:47-0700

Determining the platform patch to install

These platform patches should only be applied on appliance-based form factors such as the hardware appliance or virtual appliance. These patches are not supported for use in the software-based API Gateway application on customized Enterprise Linux or Solaris systems. An administrator or operator should contact CA Support if it is not clear whether an API Gateway deployment is a hardware or virtual appliance, or if it is a software install.

Please note that platform updates must always be installed prior to an application update if an application update is also being applied.

Assuming the above requirements are met: The version number noted in the previous procedure should be used as a base for installing platform updates. Consult the Product Documentation in order to determine what additional platform updates should be installed. Installing the applicable platform patches using the ssgconfig menu is described in the product documentation.

Troubleshooting common issues

CA Support has documented common pitfalls and errors that may occur during the installation of platform updates. They are listed below for easy reference:

  1. Uploading or installing patches fails due to "Could not write attachments"
  2. Platform update fails to install with Layer7_UpdateTrustStore.L7P patch installed ('Liquibase' error reported)
  3. Platform updates installation fails due to duplicate MySQL PID
  4. Unable to install 8.1.02 Platform Update: failed to update operating system RPMs
  5. Unable to install patches against API Gateway version 8.0.0: Certificate is not trusted for signing patches
  6. Replication fails after applying a Gateway Platform Update: You cannot 'ALTER' a log table

 

 

Additional Information:

A list of platform updates can be found on the Solutions & Patches page. There is a related community document on this topic too.