IMPORTANT: This document has been retired, in favour of the official product documentation which lists the update files and upgrade paths. Please check the version of your documentation to ensure it's accurate for your upgrade scenario. Here is an example of said documentation with a file listing for Gateway version 9.3: List of Update Files - CA API Gateway - 9.3 - CA Technologies Documentation
Background
The CA API Gateway is designed around two major components: The Platform and the Application. The Platform consists of the server that runs the API Gateway appliance and the dependency applications and tools that are located on it. This includes (but is certainly not limited to) the Linux kernel, OpenSSL, and MySQL. The Application is the Java component of the API Gateway. It is made up by the Oracle Java Development Kit (JDK) as well as the Java programs that comprise the API Management product suite. These two components are designed to be updated separately to allow systems administrators to upgrade the Platform without upgrading the Application. This ensures that the API Gateway remains compliant with security protocols and is protected against common threats.
Fully upgrading an API Gateway appliance involves upgrading both the Platform and the Application. This document will prescribe any patches necessary for upgrading from one specific version to another specific version within the 8-series of the API Management suite. This includes versions 8.0.0, 8.1.0, 8.2.00, and 8.3.00.
The documentation for performing an actual upgrade is contained within the CA Technologies Documentation. Please consult the documentation for installing these updates.
Important: The official product documentation for upgrading to the target version of API Gateway will soon be including the details of what files are needed and which ISO images they are found in, and much more. Once that migration of information is complete, this community document may be retired in favor of the official product documentation. For now, this document will be maintained until it is confirmed that all necessary information exists in the official product documentation.
Prerequisite files
The two tables below reflect lists of files to download for upgrading the API Gateway appliance. Select the existing Source Version and desired Target Version and download the applicable files via the links in the third column. For example: An administrator wishes to upgrade from version 8.0.0 to 8.2.00. This involves downloading the 8.2.00 Application Update as well as three Platform Updates: Trust Store Update, 8.1.0, and 8.2.00.
The patches should be applied in the order specified in the Update column. Additionally, all applicable Platform Updates should be applied before the required Application Update. For example: Patches for an upgrade from 8.0.0 to 8.2.00 should be applied in the following order:
- Trust Store Update
- Platform 8.1.0
- Platform 8.2.00
- Application 8.2.00
Downloading the files
Since the migration to CA Support Online from the Layer 7 Support Portal, the links have changed, there are no longer any direct links to the files in the tables below. The Application Updates and the Platform Updates are all included in the associated ISO file which contains all the relevant files to upgrade from the previous version.
For quick reference, the high-level instructions from the documentation are as follows:
- Log in to CA Support Online.
- Point to Download Center and then choose Download Products.
- On the Download Center page:
- Select My Products and then choose your product from the drop-down list (if not already displayed).
- Select the release number.
- The Gen level is '0000' for base releases and '01' for service pack releases.
- Click Go to see the DVD disk images for the release.
- Review the Release Notes to see a listing of the contents of each disk image.
- Download the appropriate image(s) to your hard drive and open it using a tool capable of extracting ISO images.
- Locate the necessary patch files in the disk image and copy them to a temporary location on your hard drive.
- Copy the patch files to the CA API Gateway appliance using the SCP command. The recommended directory is /home/ssgconfig, but another directory may be used
The instructions above are provided with more details on how to patch an appliance on the product documentation page. Be sure to choose the version of documentation applicable to your target version of the API Gateway. You can change the version of documentation by clicking the versions button on the upper-right side of the page.
Application updates
| Source Version | Target Version | Application Update |
|---|
| 8.0.0 | 8.1.0 | 8.1.0 |
| 8.0.0 | 8.2.00 | 8.2.00 |
| 8.0.0 | 8.3.00 | 8.3.00 |
| 8.0.0 | 8.4.00 | 8.4.00 |
| 8.0.0 | 9.0.00 | 9.0.00 |
| 8.0.0 | 9.1.00 | 9.1.00 |
| 8.1.0 | 8.2.00 | 8.2.00 |
| 8.1.0 | 8.3.00 | 8.3.00 |
| 8.1.0 | 8.4.00 | 8.4.00 |
| 8.1.0 | 9.0.00 | 9.0.00 |
| 8.1.0 | 9.1.0 | 9.1.00 |
| 8.2.00 | 8.3.00 | 8.3.00 |
| 8.2.00 | 8.4.00 | 8.4.00 |
| 8.2.00 | 9.0.00 | 9.0.00 |
| 8.2.00 | 9.1.00 | 9.1.00 |
| 8.3.00 | 8.3.01 | 8.3.01 |
| 8.3.00 | 8.4.00 | 8.4.00 |
| 8.3.00 | 9.0.00 | 9.0.00 |
| 8.3.00 | 9.1.00 | 9.1.00 |
| 8.3.01 | 8.4.01 | 8.4.01 |
| 8.3.01 | 9.1.00 | 9.1.00 |
| 8.4.00 | 8.4.01 | 8.4.01 |
| 8.4.00 | 9.0.00 | 9.0.00 |
| 8.4.00 | 9.1.00 | 9.1.00 |
| 8.4.01 | 9.1.00 | 9.1.00 |
| 9.0.00 | 9.1.00 | 9.1.00 |
Platform Updates
| Source Version | Target Version | Platform Update |
|---|
| 8.0.0 | 8.1.0 | 8.1.0 |
| 8.0.0 | 8.2.00 | Trust Store Update 8.1.0 8.2.00 |
| 8.0.0 | 8.3.00 | Trust Store Update 8.1.0 8.2.00 8.3.00 |
| 8.0.0 | 8.4.00 | Trust Store Update 8.1.0 8.2.00 8.3.00 8.4.00 |
| 8.0.0 | 9.0.00 | Trust Store Update 8.1.0 8.2.00 8.3.00 8.4.00 9.0.00 |
| 8.0.0 | 9.1.00 | Trust Store Update 8.1.0 8.2.00 8.3.00 8.4.00 9.0.00 9.1.00 |
| 8.1.0 | 8.2.00 | 8.2.00 |
| 8.1.0 | 8.3.00 | 8.2.00 8.3.00 |
| 8.1.0 | 8.4.00 | 8.2.00 8.3.00 8.4.00 |
| 8.1.0 | 9.0.00 | 8.2.00 8.3.00 8.4.00 9.0.00 |
| 8.1.0 | 9.1.00 | 8.2.00 8.3.00 8.4.00 9.0.00 9.1.00 |
| 8.2.00 | 8.3.00 | 8.3.00 |
| 8.2.00 | 8.4.00 | 8.3.00 8.4.00 |
| 8.2.00 | 9.0.00 | 8.3.00 8.4.00 9.0.00 |
| 8.2.00 | 9.1.00 | 8.3.00 8.4.00 9.0.00 9.1.00 |
| 8.3.00 | 8.3.01 | 8.3.01 |
| 8.3.00 | 8.4.00 | 8.4.00 |
| 8.3.00 | 9.0.00 | 8.4.00 9.0.00 |
| 8.3.00 | 9.1.00 | 8.4.00 9.0.00 9.1.00 |
| 8.3.01 | 8.4.01 | 8.4.01 |
| 8.3.01 | 9.1.00 | 8.4.01 9.1.00 |
| 8.4.00 | 8.4.01 | 8.4.01 |
| 8.4.00 | 9.0.00 | 9.0.00 |
| 8.4.00 | 9.1.00 | 9.0.00 9.1.00 |
| 8.4.01 | 9.1.00 | 9.1.00 |
| 9.0.00 | 9.1.00 | 9.1.00 |
Note: Versions 8.3.01 and 8.4.01 of the Platform Update must skip 9.0.00, as laid out in the above table.