Layer7 API Management

 View Only

CA APIM Solution   - Gateway Migration Guide (for v7.1 to v8x series 

Aug 20, 2015 05:27 PM

Upgrading v7.1 gateway to v8.0

This part of the document will describe the steps involved in migrating operational v7.1 gateway to newly stood up v8.0 gateway.

 

Pr-Requisite

  • An operational version 7.1 virtual appliance
  • A version 8.0 virtual appliance as delivered by Layer 7, with networking
    configured. (No database should be configured.)
  • The vm-migration.sh file, which can be downloaded from the Layer 7 Technical Support download site.

Prepare for Upgrade

For this upgrade you need to copy over the upgrade script and stop the Gateway services. 

  • To prepare for the upgrade:
    1. Log in as ssgconfig on the Gateway virtual appliance running v7.1 and open a
      privileged command shell from the Gateway configuration menu.
    2. Copy the vm-migration.sh file to the virtual appliance (any directory).
    3. Change to that directory and change the permissions with this command: chmod a+x vm-migration.sh
    4. If the Enterprise Service Manager is installed, stop it with this command:
      # service ssem stop

Backup the source gateway (v7.1)

For this PoC, we are using "Default back up", we also have another type of back up called "Custom Back up"

 

    1. Navigate to the directory containing the vm-migration.sh file Run the following command:
      # ./vm-migration.sh --verbose --backup
      This backs up the database and OS-level files from the source Gateway to a file named migration-package.tgz in the current directory.

Tip: You can specify your own backup package name and path by adding the “- -file” parameter:
--file /tmp/<backupName>.tar.gz

2. Copy both the backup and the script files to the target Gateway running v8.0:
migration-package.tgz vm-migration.sh

 

Restore to the Target Gateway
When a backup is restored on a target Gateway, all files in the manifest (either default or customized) are restored. Note: Any errors or warnings generated during the backup may reduce the number of files being restored.
  • To restore to the target Gateway:
  1. Ensure the backup and the script files have been copied to the target Gateway.
  2. In the directory containing the copied files, update the permissions as follows:
          # chmod a+x vm-migration.sh
  3. Restore the backed-up files with this command:
    # ./vm-migration.sh --verbose --restore
    This command will look for a backup package named migration-package.tgz in the current directory and use it to restore the v7.1 database plus all OS-level files in the default manifest.
  4. Reboot the server.

 

Post Upgrade

  • Perform the following tasks after upgrade is complete:
  1. Connect to the v8.0 Gateway using the Layer 7 Policy Manager and install the new license file. Tip: Be sure to use the new v8.0 license file provided; your old v7.1 license will no longer work.
  2. Any custom assertions present in v7.1 will need to be reinstalled and reregistered after upgrading to version 8.0. For more information, see the Layer 7 Custom Assertions Installation Manual.
  3. Assertion files that were not included by default in your v7.1 system will need to be copied back to the following directory on the v8.0 Gateway:
    runtime/modules/assertions
    An example of non-default files are the .AAR files for modular assertions.
  4. Similarly, .JAR files will need to be copied over again to the following directories for some features to work (for example, JDBC or JMS):
    /runtime/lib/ext /runtime/lib

 

Post Upgrade Verification

To verify that the upgrade to version 8.0 (either standalone or clustered) is successful, you can perform the following checks:

  • Check #1
    1. In MySQL, enter the following command:
      1. mysql> select * from ssg_version;
      2. This should match the output of this command:
        1. # rpm -qa | grep ssg
  • Check #2
    In MySQL, enter the following command:

MySQL>show tables; or SELECT COUNT(*) FROM information_schema.tables WHERE table_schema = 'ssg1';

This should return 93 tables.

 

Upgrading v8.0 gateway to v8.4

This section of the document will describe the steps involved in upgrading v8.0 gateway to v8.4

Pre -Requisite

Please download following Platform and Application  patches for this PoC

 

Source Version

Target Version

Platform Updates

  1. 8.0.0
  2. 8.4.00

Trust Store Update

  1. 8.1.0
  2. 8.2.00
  3. 8.3.00
  4. 8.4.00

 

Source Version

Target Version

Application Update

  1. 8.0.0
  2. 8.4.00
  3. 8.4.00

 

Upgrade Process for v8.0 to v8.4

Background

The CA API Gateway is architected around two major components:

  • The Platform Patch
  • The Application is the Java component of the API Gateway. It is made up by the Oracle Java JDK as well as the Java programs that comprise the API Management 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.

 

Steps Involved
Using FileZilla or SCP, upload the patch file one at a time in the sequence as  given below to /home/ssgconfig folder of the gateway.

  1. Layer7_UpdateTrustStore_8.0.0.L7P              Platform
  2. Layer7_PlatformUpdate_64bit_v8.1.0.L7P      Platform
  3. Layer7_PlatformUpdate_64bit_v8.2.00.L7P    Platform
  4. Layer7_PlatformUpdate_64bit_v8.3.00.L7P    Platform
  5. Layer7_PlatformUpdate_64bit_v8.4.00.L7P    Platform
  6. Layer7_v8.4.00.L7P                                         Application

    Note:
  1. 1. First Install Trust Store followed by Platform and finally Application patch (don’t change the order)
  2. 2. Depending on the version being upgrade, use relevant application patch also only apply those relevant platform patches.
    1. a.     Example: if upgrading to v8.3, then apply all platform patches until v8.3 and then followed by v8.3 application patch.

 

Change the ownership and permission using the following scripts for those patch files.

  1. Ensure that the Gateway service is running by executing the following command: service ssg start
  2. Set the necessary ownership of all update files: chown layer7. /home/ssgconfig/*.L7P
  3. Set the necessary permissions on all update files: chmod 644 /home/ssgconfig/*.L7P

 

Upload and Install

  1. Login into gateway using ssgconfig user id and in the main menu, please select menu # 8 Patach management
  2. In Patch Management Menu, select menu # 1 for Upload the patch, upon successful upload exit the menu
  3. In Patch Management Menu, select menu # 2 Install the patch, upon successful Install, exit the menu
  4. Return to main menu and do a reboot by selecting "R" in main menu
    NoteRepeat 2nd and 3rd Step above for all the patch files listed in 1st line item in the same order.

    Database upgrade
  1. Upon completing the installation of Application patch, please log back into gateway using ssgconfig credentials
  2. Select menu # 2 Display Layer7 Gateway Configuration Menu
  3. In the configuration Menu, select menu # 1 Upgrade Layer 7 Gateway Database
  4. Verify the version upgrade and confirm the upgrade by entering "YES"
  5. Click Enter for Root user
  6. Enter the password for Root user
  7. Upon successful upgrade exit the configuration menu and select R for rebooting the gateway in main menu.

Post Upgrade
Perform the following tasks after upgrade is complete:

  1. Connect to the v8.4 Gateway using the Layer 7 Policy Manager and install the new license file. Tip: Be sure to use the new v8.4 license file provided; your old v7.1 license will no longer work.
  2. Any custom assertions present in v7.1 will need to be reinstalled and reregistered after upgrading to version 8.0. For more information, see the Layer 7 Custom Assertions Installation Manual.
  3. Assertion files that were not included by default in your v7.1 system will need to be copied back to the following directory on the v8.0 Gateway: runtime/modules/assertions
    An example of non-default files are the .AAR files for modular assertions.
  4. Similarly, .JAR files will need to be copied over again to the following directories for some features to work (for example, JDBC or JMS):  /runtime/lib/ext /runtime/lib

 

Reference Materials:

  • V7x to v8.0 VirtualApplianceUpgrader.zip, contains vm-migrtaion.sh & Layer 7 Gateway v7.1 to 8.0 Upgrade Guide.pdf

Statistics
0 Favorited
7 Views
1 Files
0 Shares
0 Downloads
Attachment(s)
zip file
VirtualApplianceUpgrader.zip   250 KB   1 version
Uploaded - May 29, 2019

Tags and Keywords

Related Entries and Links

No Related Resource entered.