Upgrade existing API Portal installation

If you have an existing API Portal installation, you can upgrade that installation to a newer version without having to repeat the initial setup. The upgrade package and the process are the same for both virtual appliance and software installation:

  1. Upgrade API Portal
  2. Update Joomla! database structure
  3. Post-upgrade steps

This guide does not describe how to upgrade API Gateway. For information on upgrading API Gateway, see API Gateway Upgrade Guide.

Prerequisites

Before you the upgrade, complete the following prerequisites.

Prerequisites for all installations

  • If you intend to use the EasyBlog and EasyDiscuss plugins, before you start the upgrade you must have installed them. For more details, see Install API Portal and the instructions for your installation (virtual appliance or software installation). If you do not plan to use EasyBlog or EasyDiscuss, you do not have to do this.
  • Stop and back up the existing API Portal files and database. There is no option to roll back once you start the upgrade.
    • To backup API Portal virtual appliance installation, do a snapshot of the virtual machine (VM). If you have configured an external database that is run on a machine different than the API Portal VMs, you need to backup your database manually, for example, by using the mysql_dump.
    • To backup API Portal software installation, do a file system backup and export the database.

Prerequisites for virtual appliance installations

On virtual appliance installations, you must also do the following:

Upgrade the appliance platform

Ensure your appliance platform version is 7.1.2, and upgrade it if needed. For more details, see Upgrade the Axway Appliance Platform in the API Gateway Appliance Installation and Administration Guide.

Note   After the upgrade, you must ensure that the API Portal ports on the appliance are open.

Upgrade API Portal

The same upgrade package can be used to upgrade both virtual appliance and software installation. The upgrade package automatically upgrades all API Portal components to v7.5.4.

Upgrade API Portal on virtual appliance

  1. Download the API Portal upgrade package from the Axway Support at https://support.axway.com, and upload it to your appliance.
  2. Log in to the appliance using the default administrator account (user name admin ) and use su - to switch to the root user after logging in. You can log in locally or using SSH. For more details, see Connect to consoles and user interfaces in the API Gateway Appliance Installation and Administration Guide.
  3. Change to the directory where you uploaded the upgrade package, and extract the upgrade package:
  4. # tar xpvzf <package>.tgz
  5. Enter the following to run the upgrade script:
  6. # ./apiportal_upgrade.sh

Upgrade API Portal on software installation

  1. Download the API Portal upgrade package from the Axway Support at https://support.axway.com to your API Portal host.
  2. Go to the directory where you saved the upgrade package, and extract it:
  3. # tar xpvzf <package>.tgz
  4. Enter the following to run the upgrade script:
  5. # ./apiportal_upgrade.sh

Update Joomla! database structure

To update the database structure and fix the database problems, do the following:

  1. Log in to the Joomla! Admin Interface (JAI) (https://<API Portal host>/administrator).
  2. Click Extensions > Manage > Database, and select Fix.
  3. Click Components > EasyBlog, and follow the instructions in the EasyBlog installer.
  4. Select Installation via Directory, select com_easyblog_5.0.40_component_pro.zip from the Select Package drop-down list, and follow the instructions in the installer to the finish.
  5. Note   Do not install any of the modules and plugins unless you plan to use them. To prevent installing any modules, click Modules and deselect Select All, then repeat the same for Plugins.
  6. Click Components > EasyDiscuss, and repeat the component installation as described for EasyBlog. In Select Package, select com_easydiscuss_4.0.1_component_pro.zip from the drop-down list.
  7. Note   Do not install any of the modules and plugins unless you plan to use them. To prevent installing any modules, click Modules and deselect Select All, then repeat the same for Plugins.

Post-upgrade steps

After the upgrade, perform the following tasks.

Check for updates

Check if there are any updates available for your installation and install them. For more details, see Update API Portal.

Change the version number

After the upgrade, the API Portal version number visible in the portal is still the old version. To change the version number to 7.5.4, you must edit the value in API Portal properties file.

  1. Open the following file in a text editor:
  2. /etc/platform.conf
  3. Change the API Portal version property to the current release:
  4. PRODUCT_VERSION=7.5.4

Restore your theme (optional)

After the upgrade, the portal theme is changed to the default Axway theme. To revert to your own theme, do the following:

  1. Log in to JAI.
  2. Click Extensions > Templates.
  3. Locate your custom theme, and click the star button to make it the default theme.

Upgrading API Portal also reverts the logo image to the default Axway logo. For more details, see Customize your logo in the API Portal Administrator Guide.

Hide blog from the API Portal landing page (optional)

After the upgrade, the blog is visible and accessible on the main menu on the API Portal landing page, because the EasyBlog plugin overrides permissions. If you want to hide your blog on the landing page, do the following:

  1. Log in to JAI.
  2. Click Menus > Main Menu, and select Blog.
  3. On the Details tab, set Access to Registered, and click Save.
  4. Refresh the API Portal landing page. Blog is no longer visible in the main menu before signing in.

Consolidate vhosts and .htaccess files (optional)

During upgrade, the original vhost file is backed up to the following locations:

  • Virtual appliance installation: /etc/apache2/vhosts.d/apiportal.conf.old
  • Software installation: /etc/httpd/conf.d/apiportal.conf.old

A new vhost file is deployed at the same location.

In addition, the original .htaccess file is backed up to the following locations:

  • Virtual appliance installation: /opt/axway/apiportal/htdoc/.htaccess.old
  • Software installation: /opt/axway/apiportal/htdoc/.htaccess.old

A new .htaccess file is deployed at the same location.

If the you had any customizations in your vhost or .htaccess files and you want to preserve them, you must merge the old and new files together manually.

Related Links