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. Reinstall Joomla! components
  3. Post-upgrade steps
Note   Upgrade to API Portal 7.5.5 is supported from v7.5.3 and v7.5.4. If you have an earlier API Portal version, you must first upgrade to v 7.5.3.

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

  1. Download the API Portal upgrade package from the Axway Support at https://support.axway.com
  2. Go to the the directory where you saved the upgrade package and extract it:
  3. # tar xpvzf <package>.tgz
  4. Log in to the Joomla! Admin Interface (JAI) (https://<API Portal host>/administrator).
  5. Click Components > Joomla! Update, and go to the Upload & Update tab.
  6. Browse to the extracted API Portal upgrade package, and select the included Joomla upgrade package file (for example, joomla-update-package-3.8.0-package.zip).
  7. Click Upload & Install, and follow the displayed instructions.
  8. If you have a virtual appliance installation, log in to your appliance (locally or using SSH) using the default administrator account (user name admin ), use su - to switch to the root user after logging in, upload the rest of the upgrade package to the appliance, and change to the directory where you uploaded the upgrade package.
  9. Enter the following to run the upgrade script:
  10. # ./apiportal_upgrade.sh
Note   In case Joomla! Update is not visible in the Components menu, connect to your user database and execute the following query for API Portal database:
update s8f7h_menu set menutype='main' where title like 'com_joomlaupdate'

Post-upgrade steps

After the upgrade, perform the following tasks.

Note   When you create a new menu from JAI, there might be an issue with the menu path (the menu path is broken and some additional paths are added as part of the URL). To fix this issue you have to rebuild the menu paths. Navigate to JAI > Menus > Main Menu and click the Rebuild button. This should be performed only once after installation.

Reinstall Joomla! components

After upgrade, you must reinstall Easyblog and EasyDiscuss in JAI to update the component version and fix compatibility issues. The API Portal data related to the components (posts, attachements) is not affected.

  1. Log in to the JAI.
  2. Click Components > EasyBlog, and follow the instructions in the EasyBlog installer.
  3. If prompted to select the installation method, select Installation via Directory, select the available package from the drop-down list, and follow the instructions in the installer to the finish.
  4. 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.
  5. Click Components > EasyDiscuss, and repeat the component installation as described for EasyBlog.

Check for updates

Before you start configuring your API Portal, 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.5, 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.5

Enable SDK download

In version 7.5.3 the option to enable application developers to generate and download an SDK for an API exposed in the API Catalog is available under Other settings on the API Portal configuration page. This setting has been moved, and is now available on the API Catalog tab of the APIs menu page. This setting is disabled by default.

If you are upgrading from 7.5.3 and you had enabled this option in your old installation, you must manually re-enable it after upgrading to 7.5.5. For more details, see Enable SDK generator in the API Portal Administrator Guide

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.

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

Related Links