First steps for deploying in a VMware environment

The first steps in deploying in a VMware environment are to obtain the API Connect distribution files and to create a project directory.

Before you begin

About this task

In these First Steps, you will use Install Assist (apicup) to create a project directory that contains the configuration file apiconnect-up.yml. When you configure the first subsystem, such as the Management Service, the subsystem configuration settings are placed in the file.

When you want to configure a second subsystem, it is important that you reuse the same project directory. This means that you only need to download Install Assist once, and create a project directory once. The configuration settings for the second subsystem are added to the existing apiconnect-up.yml. In this way, the second subsystem, such as Developer Portal, can access the configuration information needed to interact with the first subsystem.

After completing these First Steps, follow the links to instructions for configuring your subsystem. You will specify configuration settings, create an ISO of the subsystem configuration, and then use VMware to deploy the distribution file (.ova file) for the subsystem with your ISO. Note that you create a separate ISO for each subsystem.

Installation and configuration of DataPower® Gateway on an appliance (physical or virtual) is completed after you install the API Connect subsystems. For the gateway service in a VMware environment, use the instructions in Deploying DataPower Gateway.

Note: When maintaining API Connect, do not use kubectl exec commands to access API Connect pods unless advised by IBM.

Do not make any changes on the deployed VMs unless documented here or otherwise advised by IBM. Attempting to manually update packages, adding new users, or installing new software will likely cause problems. Operating system updates are handled by API Connect fix packs.

Procedure

  1. Download the latest IBM API Connect® package from IBM Fix Central.
    Package IBM API Connect subsystem file
    IBM API Connect Management for VMWare apiconnect-management.ova and the Developer Toolkit
    IBM API Connect Analytics for VMware apiconnect-analytics.ova
    IBM API Connect Developer Portal for VMware apiconnect-portal.ova

    Note that the IBM Passport Advantage® site contains the API Connect LTS release, 2018.4.1.0, but not any packages that contain later Fix Packs. The Fix Pack distributions, such as 2018.4.1.5, contain the entire product. For a new installation, you do not need to first install the LTS version, 2018.4.1.0, or any of the fix packs (2018.4.1.x) prior to the latest one. For example, if you want to install 2018.4.1.5 as a new installation, you do not need to first install 2018.4.1.0, 2018.4.1.1, 2018.4.1.2, 2018.4.1.3 or 2018.4.1.4.

    Note also that the Fix Pack page contains two copies of the files for each subsystem. One copy is for new installations and one is for upgrades of existing installations. For new installations, do not use files with names with the prefix upgrade-. Use the file names specified in the previous table. In addition, be aware that during upgrades, there are prerequisites to meet when moving between specific versions. For upgrades, do not use the procedures on this page. See Upgrading in a VMware environment.

  2. Select one of the following actions:
    • If you are configuring your first subsystem, go to step 3.
    • If you have already configured a subsystem, go to step 7.
  3. Download the IBM API Connect Install Assist package for your operating system from IBM Fix Central. It contains the apicup file, which simplifies installation of the API Connect components.
  4. OSX and Linux® only: Make the apicup file an executable file by entering the following command: 
    chmod +x apicup
  5. Set your path to the location of your apicup file.
    • For the OSX and Linux operating systems:
      export PATH=$PATH:/Users/your_path/
    • For the Windows operating system:
      set PATH=c:\your_path;%PATH%
  6. Create a project called myProject and optionally copy the apicup executable into the project directory:
    1. Create a project:
      apicup init myProject
    2. Read and accept the license agreement.
    3. Optionally, copy the apicup executable into the myProject directory or folder created by the apicup init command.
    Important:

    Use a single APICUP project for all subsystems, even those in a different cluster. Multiple projects will result in multiple certificate chains which will not match.

    The original project directory created with APICUP during the initial product installation (for example, myProject) is required to both restore the database and to upgrade your deployment. You cannot restore the database or perform an upgrade without the initial project directory because it contains pertinent information about the cluster. Note that the endpoints and certificates cannot change; the same endpoints and certificates will be used in the restored or upgraded system. A good practice is to back up the original project directory to a location from where it can always be retrieved.

    The apiconnect-up.yml file is created in that directory.

    Important: The apiconnect-up.yml file must be in a secure and permanent location. The file contains password information and other information that is exposed in text format. Ensure that the project directory is secure.
  7. Continue with the configuration steps for your subsystem: