API Gateway: Working with API Gateway .L7P Patch Files

Products

• CA API Gateway

Issue/Introduction

You will occasionally need to apply a patch to your CA API Gateway Appliance. These patches come in the form of .L7P files. This document provides supplementary information to the formal product documentation on the subject of patching which can be seen here:

(Please use the Version Selector to select your Gateway version)

https://techdocs.broadcom.com/us/en/ca-enterprise-software/layer7-api-management/api-gateway/10-0/install-configure-upgrade/upgrade-the-gateway/understand-gateway-patches.html

Environment

This document Applies to the patching of CA API Gateway 9.x and 10.x Appliances 

Cause

If you have need to apply a .L7P patch file to your Gateway Appliance this document can help guide you

Resolution

Working with .L7P Files
*** .L7P files are the file format used for Layer 7 / CA API Gateway Patching ***
PLEASE NOTE: The .L7P files are first copied to the /home/ssgconfig directory as a staging area. THIS DIRECTORY IS ONLY 2 GB in size so please only copy one at a time, then apply it, and then delete it to make space for the next patch in the upgrade sequence

STEP 1 (COPY THE FILE TO THE GATEWAY): Copy the .L7P to your Gateway Appliance /home/ssgconfig directory. You can use a program like WinSCP to drag and drop it or the SCP command from a Windows Command Prompt

You can also use the SCP command from your preferred workstation

scp command example from a Windows Command Prompt: scp -p CA_API_PlatformUpdate_64bit_vKernel-2018-10-05.L7P ssgconfig@<Gateway_HOST>:/home/ssgconfig

STEP 2 (SET 755 PERMISSIONS ON FILE): After the file has been copied log into your Gateway Appliance and choose Option 3 to drop into the Root Shell

When you are at the Root shell cd to /home/ssgconfig/ where you should now see the file you copied over (see it by typing ls -l)

Now change the permission on the file to 755 with the following command chmod 755 CA_API_PlatformUpdate_64bit_vKernel-2018-10-05.L7P

STEP 3: (stop the Gateway Service and DB Replication) Now type exit and go back into the main Gateway Menu. From the main menu choose option 2) Display Layer 7 Gateway configuration menu and then option 7) Manager Layer 7 Gateway status and stop the Gateway service



Type X to exit this Menu and Give the Gateway a few minutes to finish stopping. Verify that the service has stopped with option 2) Display Layer 7 Gateway configuration menu and 7) Manager Layer 7 Gateway status

If you are running a Standalone Gateway (Non clustered) then you can proceed to Step 4

If you are running your Gateway in a Clustered Environment with Master / Master MySQL Database Replication Enabled then perform the following steps to stop Replication before applying any patches

To stop Database Replication run the following commands on BOTH Clustered Gateway Nodes. mysql and then stop slave;

Verify that your MySQL Replication is stopped by running the show slave status\G; on both nodes

Step 4: Upload and Apply the Patch - There are two main steps to applying an .L7P patch. First it gets "uploaded" or "registered" from the /home/ssgconfig directory and then it gets applied to the system

Type exit to get back to the root command prompt and then exit again to access the Gateway Main Menu and then choose option 8) Display Patch Management Menu

Choose Option 1) Upload a patch to the Gateway. This step will register the file that you copied to /home/ssgconfig



You will see the patch that was loaded into the /home/ssgconfig directory in listed as an option, as show below



Enter 1 or the relevant number for the patch you're installing and let the system perform the patch "upload"



Press Enter

Now the patch has been uploaded to the system and is ready for installation.

Press Enter and then Exit back to the main Patching Menu by pressing X

Choose Option 2) Install a patch onto the Gateway

Note the Patch that was uploaded is now available for Installation



Choose the number for the patch that you have uploaded and apply the patch



Ensure that you recieve a patch operation completed successfully message



Verify that the patch has been installed by accessing Option 4) List Gateway patch history



Note the patch is now listed as an applied patch



Reboot your Gateway after applying any patches

After rebooting the system will come back and the Gateway Service will be restarted.

If you are applying a sequence of multiple patches always re-stop your SSG service and DB Replication as necessary to apply the next patch