Upgrade Portal 5.2.2 to 5.4

Products

• CA API Developer Portal

Issue/Introduction

Looking for procedure steps to upgrade portal to 5.4, using the OFFLINE install

Environment

Portal 5.2.2  Debian 11 OVA 

Resolution

The upgrade process 2 step for API Portal:   5.2.2.-> 5.3->5.4

• Step1: Upgrade Debian 11 -> 12 then upgrade Portal 5.2.2 -> 5.3
• Step2: Upgrade Portal 5.3 -> 5.4

Step 1:  Upgrade Debian 11 -> 12 then upgrade Portal 5.2.2 -> 5.3  

VM snapshot of Portal OVA and the two mysql hosting PortalDB’s

Analytics disabled skip related steps

Update environment debian 11 to the latest patch:

Debian image users are advised to reference Patching a Debian Portal Virtual Machine (Platform Updates) using PMS

The latest for Debian 11: Layer7_API_PortalPlatformUpdate_64bit_v11.X-Debian-2024-03-11.zip

Update Debian 11 to Debian 12 then PMS 2.

Platform Debian 11 to Debian 12 docs link

Download the OS upgrade patch file from the API Developer Portal Solutions and Patches page  (i.e., Layer7_API_PlatformUpdate_Debian-12_2024-06-19.L7P)

The latest Debian 12 Monthly Platform patch (NOTE requires PMS 2.0

Debian image users are advised to reference Patching a Debian Portal Virtual Machine (Platform Updates) 5.3.1+ uses PMS v2.0.0 Layer7_API_PMS_Debian_v2.0.0-20240722103829.L7P

Update to the latest Monthly PlatformPatchfor Debian 12

Layer7_API_PortalPlatformUpdate_Debian-12_2025-10-16.zip

Update API Portal

Download OFFLINE API Portal and platform update from My Download Portal page  “API Developer Portal Installer Offline 5.3.tar.gz” & “Layer7_API_PlatformUpdate_Debian-12_2024-06-19.L7P”

Extract:  #  tar –xzf “API Developer Portal Installer Offline 5.3.tar.gz” -C <previousInstallationDirectory> --strip-components=1

Shutdown Portal # sudo docker stack rm portal

Ensure Portal stack is shutdown:  # sudo docker ps

START Portal # sudo ./portal.sh

When portal is started the PortalDBs is upgraded this can take time

Monitor containers waiting for each to be 1/1 

# sudo watch docker service ls 

Once containers are up access/test portal before moving to the next upgrade

Step 2:  Upgrading to Portal 5.4 GA -> Debian 13: Upgrade paths from 5.3.3, 5.3.2, 5.3.1, and 5.3 are supported.

VM snapshot of Portal OVA and the two mysql hosting PortalDB’s

Analytics disabled skip related steps

Update API Portal

Extract:  #  tar –xzf “API Developer Portal Installer Offline 5.4.tar.gz” -C <previousInstallationDirectory> --strip-components=1

Shutdown Portal # sudo docker stack rm portal

Ensure Portal stack is shutdown:  # sudo docker ps

START Portal # sudo ./portal.sh

When portal is started the PortalDBs is upgraded this can take time

Monitor containers waiting for each to be 1/1 

# sudo watch docker service ls 

Once containers are up access portal UI 

Update environment:  

Debian image users are advised to reference Patching a Debian Portal Virtual Machine (Platform Updates) NOTED the latest MPP is updated in step 2

Perform an In-Place OS Upgrade (Debian 12 to Debian13)

First install the PMS v3.0.0 patch (Layer7_API_PMS_Debian_v3.0.0-20251112151340.L7P).

After successfully installing the patch, reboot the Debian OVA.

Second Install Platform update to Debian 13

Layer7_API_PlatformUpdate_Debian-13_2025-12-22.L7P

Download OFFLINE API Portal and platform update from My Download Portal page  “API Developer Portal Installer Offline 5.4.tar.gz” & “Layer7_API_PortalPlatformUpdate_Debian-12_2025-10-16.zip”

Gateway proxy side:

Before bundle update run the script once from one NODE per cluster, effectively it removes PSSG and/or DSSG certification from the proxies: update_pssg_host_cwp.sh

Update integration BUNDLE on one NODE per cluster