Upgrading subsystems from 10.0.1.1-eus to the latest 10.0.1.x-eus on VMware

Install the latest API Connect 10.0.1.x-eus and recover the data from your original 10.0.1.1-eus deployment.

Procedure

  1. Obtain the API Connect files:
    1. Go to the What's New in the latest version information page.
    2. Locate the Note: You can access the latest files from <URL link>. Select the <URL link> to go directly to the Announce page on Fix Central, where you can download files for the latest version of API Connect.
    Note: When upgrading on VMware from 10.0.1.1-eus to the latest 10.0.1.x-eus version, you will use the same Fix Central files as are used for a new API Connect installation. Do not use the upgrade files.

    The following files are used for upgrade of 10.0.1.1-eus on VMware:

    IBM® API Connect <version> Management for VMware
    Management subsystem files
    IBM® API Connect <version> Developer Portal for VMware
    Developer Portal subsystem files
    IBM® API Connect <version> Analytics for VMware
    Analytics subsystem files
    IBM® API Connect <version> Install Assist for <operating_system_type>
    The apicup installation utility. Required for all installations on VMware.
    IBM® API Connect <version> script and assets required for version 10-to-<lastest_v10_version> side-by-side upgrades
    The package contains a script to run on 10.0.1.1-eus prior to upgrade and two scripts to run after upgrade.
    IBM® API Connect <version> Toolkit for <operating_system_type>
    Toolkit command line utility. Packaged standalone, or with API Designer or Loopback:
    • IBM® API Connect <version> Toolkit for <operating_system_type>
    • IBM® API Connect <version> Toolkit with Loopback for <operating_system_type>
    • IBM® API Connect <version> Toolkit Designer with Loopback for <operating_system_type>

    Not required during initial installation. After installation, you can download directly from the Cloud Manager UI and API Manager UI. See Installing the toolkit.

    IBM® API Connect <version> Local Test Environment
    Optional test environment. See Testing an API with the Local Test Environment
    IBM® API Connect <version> Security Signature Bundle File
    Checksum files that you can use to verify the integrity of your downloads.
  2. Install the installation utility.
    1. Locate the Install Assist (apicup) installation utility file for your operating system.
    2. Rename the file for your OS type to apicup. Note that the instructions in this documentation refer to apicup.
    3. Make apicup available on your operating system:
      Operating system Configuration
      Ubuntu, Debian, OSX
      1. Make the apicup file an executable file: chmod +x apicup
      2. Set your path to the location of your apicup file:
        export PATH=$PATH:/Users/your_path/
      Windows, RedHat: Set your path to the location of your apicup file:
      set PATH=c:\your_path;%PATH%
  3. Use the following links to upgrade the subsystems, in the specified order:
    1. Upgrading management subsystem from 10.0.1.1-eus to the latest 10.0.1.x-eus
    2. Upgrading Developer Portal subsystem from 10.0.1.1-eus to the latest 10.0.1.x-eus
    3. Upgrading Analytics subsystem from 10.0.1.1-eus to the latest 10.0.1.x-eus
  4. Upgrade your DataPower Gateway. See Upgrading DataPower Gateway Service.
  5. Optionally, install new versions of other API Connect packages:

    For each of the following distribution packages there is no upgrade process. You replace the existing tools or binaries with the new versions for the latest version of version 10.

    IBM® API Connect <version> Toolkit for <operating_system_type>
    Toolkit command line utility. Packaged standalone, or with API Designer or Loopback:
    • IBM® API Connect <version> Toolkit for <operating_system_type>
    • IBM® API Connect <version> Toolkit with Loopback for <operating_system_type>
    • IBM® API Connect <version> Toolkit Designer with Loopback for <operating_system_type>

    Not required during initial installation. After installation, you can download directly from the Cloud Manager UI and API Manager UI. See Installing the toolkit.

    IBM® API Connect <version> Local Test Environment
    Optional test environment. See Testing an API with the Local Test Environment
    IBM® API Connect <version> Security Signature Bundle File
    Checksum files that you can use to verify the integrity of your downloads.
  6. After confirming the latest 10.0.1.x-eus deployment is fully restored and running as expected, you can delete the VMs of the previous deployment.

    If the latest 10.0.1.x-eus deployment has not restored as expected, or you need to revert to your previous installation for any reason, shutdown the new VMs and power-on those of your original deployment. You must also restore the project directory. Use the VM images, and saved project directory, that you created in Prepare 10.0.1.1-eus for upgrade to the latest 10.0.1.x-eus.

  7. Optional: If the latest 10.0.1.x-eus deployment is fully restored, take a Virtual Machine (VM) snapshot of all your VMs; see Using VM snapshots for infrastructure backup and disaster recovery for details. This action does require a brief outage while all of the VMs in the subsystem cluster are shut down - do not take snapshots of running VMs, as they might not restore successfully. VM snapshots can offer a faster recovery when compared to redeploying OVAs and restoring from normal backups.
    Important: VM snapshots are not an alternative to the standard API Connect backups, which are required to use the API Connect restore feature.