IBM API Connect v5.0.8.x: Migrate the Developer Portal to Ubuntu 18
The Developer Portal is a core subsystem of the IBM API Connect product that is the industry-leading API management platform. It provides a self-service, branded portal across multiple API provider lines of business that allows organizations to socialize/monetize APIs, engage consumers, and drive adoption.
Developer Portal releases prior to v5.0.8.11 release of Developer Portal (OVA form factor) run on Ubuntu v16.04. Support for Ubuntu v16.04 will be withdrawn in March 2021. To mitigate this, IBM recommends customers migrate their Developer Portals to Ubuntu v18.04.
In this APIC Field Note we document a field-proven procedure used to migrate a single-node API Connect Developer Portal from v5.0.8.10-iFix-20201109 (Ubuntu 16) to v5.0.8.10-iFix-20210223 (Ubuntu 18).
Requirements
- An Ubuntu v16.04 Developer Portal server at version 5.0.8.8 or later
- The latest Developer Portal OVA file (v5.0.5.10-iFix-20210223, as of this writing)
Step 1: Confirm system health.
Run the command status.
All services should be in the Up state with no errors reported. Ignore the certificate warning message if you are using self-signed certificates.
Step 2: Confirm all sites are in INSTALL state.
Step 3: Confirm all sites are up and healthy.
Run the command check_site -a.
Step 4: Backup the entire Developer Portal configuration.
Step 5: Copy the backup file to a remote server.
You will need this file in a later step to restore the Developer Portal onto the new Ubuntu v18.04 virtual machine.
Step 6: Retrieve the fully-qualified domain name of the Developer Portal.
Run the command hostname -a.
Step 7: Shutdown all legacy Ubuntu v16.04 virtual machines.
Deploy the Ubuntu v18.04 OVA in vCenter and provide the network properties such as IP address, network mask, gateway, domain search, DNS, and NTP servers.
Step 8: Power on the Ubuntu v18.04 virtual machine.
Log with user admin and default password !n0r1t5@C. Verify the deployed Ubuntu version.
Step 9: Update the virtual machine’s network configuration.
Edit the file /etc/netplan/00-installer-config.yaml.
After saving the file, run the command netplan apply to apply configuration updates to the network.
Exit the root shell by running the logout command.
Step 10: Set the hostname.
This is typically the same hostname as defined in the legacy Ubuntu v16.04 virtual machine.
Verify the hostname.
Step 11: Restore the Developer Portal from Ubuntu v16.04.
Copy the file from Step 5 above to the Ubuntu v18.04 virtual machine.
To restore your Developer Portal run the following command:
restore_devportal -c -s developerPortalBackupfile.tgz
Depending on the number of sites and availability of compute resources, this command could take several minutes to over an hour to complete. Here is sample output generated at the end:
Enabling site cleanup code as there were 1 returned
Found new NGINX vhost file for odc-v5portal.rtp.raleigh.ibm.com/sila/sb with DB silasbodcv5po
Added/Updated localhost loopback for site 5fa46c0ae4b0353e760382a6.5fa46c0ae4b0353e760382b2 => odc-v5portal.rtp.raleigh.ibm.com url odc-v5portal.rtp.raleigh.ibm.com/sila/sb db silasbodcv5po
Reloading nginx configuration as a site has been added/removed
Site odc-v5portal.rtp.raleigh.ibm.com/sila/sb restored from backup /var/aegir/backups/sila.sb.odc-v5portal.rtp.raleigh.ibm.com-20210317.191537.tar.gz
Restore site completed.
Step 12: Verify status of migrated Developer Portal.
Run list_sites -p to ensure all Portal sites from Ubuntu v16.04 are deployed and in INSTALLED state.
Run status to verify Developer Portal status.
This concludes Developer Portal migration.
Reference
[1] IBM API Connect v5 Knowledge Center — https://www.ibm.com/support/knowledgecenter/SSMNED_5.0.0/com.ibm.apic.install.doc/tapim_portal_production_migrate_ubuntu18.html
