Installing the Micro Gateway for the Professional and Enterprise offering

Install the Micro Gateway and add it to the Catalog.

Before you begin

Important: IBM® API Connect Micro Gateway is deprecated in IBM API Connect Version 5.0.8 in favor of DataPower® Gateway. From 1 April 2020, Micro Gateway, and associated toolkit CLI commands, will no longer be supported. Existing users can migrate their API definitions to IBM DataPower Gateways. For information on supported API policies, see Built-in policies.

This instruction applies to IBM API Connect Professional and Enterprise offerings. For instructions to install the Micro Gateway for IBM API Connect Essentials, see Installing the Micro Gateway for the Essentials offering.

This task assumes that you installed API Connect collective and registered the Member host with the collective, and that you added the API Connect collective to the Cloud Manager; for details, see Installing API Connect collective.

As a prerequisite to installing the Micro Gateway, you must ensure that a supported version of Node.js is installed.

For details of supported Node.js versions, follow the link on the IBM API Connect Version 5.0 requirements page to the IBM API Connect Software Product Compatibility Report for the API Connect offering you are using, then click the Prerequisites tab.

Node.js is available as part of the IBM SDK for Node.js.

About this task

Create and publish the Micro Gateway.

Procedure

  1. Add the Micro Gateway as an application:
    1. Start the IBM API Connect API Manager user interface.
      https://<API_manager_hostname>/apim
      Note: To be able to log in to the Management server to use the API Manager user interface, you must either be the owner of a provider organization or have been added to a provider organization; for more information, see Creating a provider organization account and Adding users and assigning roles.
    2. If you have not previously pinned the UI navigation pane, click the Navigate to icon The Navigate to icon.
      The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon The Pin menu icon..
    3. On the Dashboard page, click Add > App.
    4. Enter a display name and name for the application (microgateway for example), select the collective that you want to publish the Micro Gateway to, then click Add .
    5. Click the Show app identifier icon Show app identifier and copy the command string from the App Identifier window.

    For more information about Apps in the API Manager user interface, see Working with Apps.

  2. Set the environment for the deployment by using the developer toolkit CLI.
    For details on installing and using the developer toolkit CLI, see Working with the toolkit.
    1. Open a command window.
    2. Paste and run the command that you copied in step 1.e; the command has the following form:
    apic config:set app=apic-app://API_manager_hostname/orgs/org_name/apps/app_name
    For example:
    apic config:set app=apic-app://myhost.com/orgs/myorg/apps/microgateway
  3. Change to the directory that contains API Connect and create the Micro Gateway by entering the command.
    apic microgateway
  4. When prompted, enter an application project name for the Micro Gateway; for example, microgw-app.
  5. When prompted, enter a folder name to be created for the Micro Gateway application project; for example, microgw-app.
  6. Create the public and private keys and copy them into the Micro Gateway application project folder. The following commands use OpenSSL, an open source implementation of the SSL and TLS protocols.
    1. Create the RSA private key.
      openssl genrsa -out id_rsa 4096
    2. Create the public key.
      openssl rsa -in id_rsa -outform PEM -pubout -out id_rsa.pub
    3. Copy the key files to the Micro Gateway application project folder.
  7. Optional: Configure any user-defined policies; for more information, see Packaging and importing your policies into IBM API Connect.
  8. Publish the Micro Gateway.
    1. Log in to your IBM API Connect Management server.
      apic login

      Specify the host name and login details for your IBM API Connect Management server. If you do not know the host name of your Management server, contact your IBM API Connect cloud administrator. To be able to log in to the Management server, you must either be the owner of a provider organization or have been added to a provider organization; for more information, see Creating a provider organization account and Adding users and assigning roles.

    2. Ensure that you are in the Micro Gateway application project folder.
    3. Publish the gateway.
      apic apps:publish

What to do next

Add the Micro Gateway to a Catalog.

For further information about the Micro Gateway, see the following subtopics: