Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The topics in this section walk you through the steps to quickly configure and test the following:

  • A single node Microgateway deployment.
  • A high availability deployment scenario where you have two Microgateway instances fronted by a load balancer.
Tip

If you want to run the Microgateway on Docker, see Deploying the Microgateway as a Docker Container. 

Table of Contents
maxLevel3
minLevel3

...

Excerpt
  • Ensure that you have the Java SE Development Kit (JDK) installed. You can install either OpenJDK 8 or Oracle JDK 1.8.*.

    Note
    titleImportant!

    WSO2 recommends installing JDK 8u161 or later.

  • Be sure that you meet the following system requirements:

    Physical
    • 3 GHz Dual-core Xeon/Opteron (or latest)
    • 4 GB RAM (2 GB for JVM and 2 GB for the operating system)
    • 10 GB free disk space
    • ~ Recommended minimum - 2 Cores.
    Tip

    For high concurrencies and better performance you can use 4 Cores.

    Disk space is based on the expected storage requirement calculated by considering file uploads and backup policies.

    Virtual Machine (VM)
    • 2 compute units minimum (each unit having 1.0-1.2 GHz Opteron/Xeon processor)
    • 4 GB RAM
    • 10 GB free disk space
    • One CPU unit for the operating system and one for JVM.

    ~ 512 MB heap size. This is generally sufficient to process typical SOAP messages but the requirements vary with larger message sizes and the number of messages processed concurrently.

    EC2
    • One c5.large instance to run one Microgateway instance.

...

Configure the Microgateway deployment

Depending on your requirement you can either quickly try out the basic single node Microgateway deployment for testing purposes, or you can try out a production level high availability deployment.
Expand
titleClick here for instructions on how to configure a single node On-Prem Gateway deployment:
Tip
titleTip

Let’s refer to the Microgateway download location as <MICROGATEWAY_HOME> throughout this section.

  1. Navigate to <MICROGATEWAY_HOME>/bin, and execute the following command to start configuring the Microgateway:
    On Windows: cloud-init.bat --run
    On Linux/Mac OS: sh cloud-init.sh
    This allows you to configures the downloaded Microateway with the settings required to integrate with API Cloud.
  2. Provide your email address, organization key, and password.
    Your organization key will be displayed as shown below.

    The status of the Microgateway will be displayed on completion.
  3. Navigate to <MICROGATEWAY_HOME>/bin, and execute the following command to run the start up script:
    On Windows: wso2server.bat --run
    On Linux/Mac OS: sh wso2server.sh
    The Microgateway status will be updated when it starts.

Now you have configured a single Microgateway instance. Next let's test the deployment.

...