This documentation is for WSO2 Enterprise Integrator version 6.5.0 . View documentation for the latest release in the 6.x.x family and the latest release in the 7.x.x family.

All docs This doc
Skip to end of metadata
Go to start of metadata

WSO2 Micro Integrator is a cloud-native ESB that can easily be run on a containerized environment, or on a VM. See the topics given below for information on how to run WSO2 Micro Integrator on different platforms and environments.

Running the Micro Integrator on containers

To run your Micro Integrator solutions on Docker or Kubernetes, you need to first create an immutable docker image with the required synapse artifacts, configurations, and third-party dependencies by using the base Docker image of WSO2 Micro Integrator. You can then deploy and run the immutable images on Docker or Kubernetes. One advantage of having an immutable docker image is that you can easily implement a CI/CD pipeline to systematically test the solution before deploying in production.

  • The Micro Integrator Docker image (with the latest products) is available in the WSO2 Docker Registry. Note that you need a valid WSO2 subscription to use the Docker image with updates. Therefore, you need to provide your log in credentials when downloading the Docker image. If you do not already have a subscription, you can get a free trial subscription.

    Micro Integrator Docker image (with updates)
    Log in to WSO2 Docker Registry
    docker login
  • The community version of Micro Integrator's base Docker image is available on DockerHub.

    Base Docker Image and Tag (community version)

Micro Integrator with Docker

Given below are the basic steps you need to follow to run the Micro Integrator on Docker:

  1. Export the integration artifacts into a CAR file.

  2. Create the Dockerfile as shown below. This file contains instructions to download the base Docker image of WSO2 Micro Integrator from DockerHub (community version) or the WSO2 Docker Registry (includes updates), and to copy the integration artifacts to the Micro Integrator.

    FROM <docker_image_name>:1.0.0
    COPY <directoy_path>/<capp_name> /home/wso2carbon/wso2mi/repository/deployment/server/carbonapps
     About the Dockerfile

    The information specified in the Docker file is as follows:


    The 'FROM' tag in the docker file specifies the WSO2 Micro Integrator version that should be downloaded. You can use the updated Docker image or the community version as shown below. The version is 1.0.0 of the WSO2 Micro Integrator. If required, you can use an earlier version by replacing 'latest' with the version number.

    Example 1: Docker image with updates
    Example 2: Docker image without updates (community version)
    FROM wso2/micro-integrator:1.0.0

    The 'COPY' tag in the docker file specifies the directory path to your composite application, followed by the location in your Docker instance to which the composite application should be copied.

    Example 1
    COPY carbonapps /home/wso2carbon/wso2mi/repository/deployment/server/carbonapps

    If you have multiple composite application that you want to deploy in Docker using a single Docker image, add another entry to the Dockerfile. For example:

    Example 2
    COPY carbonapps /home/wso2carbon/wso2mi/repository/deployment/server/carbonapps
    COPY <sample_carbon_app> /home/wso2carbon/wso2mi/repository/deployment/server/carbonapps
  3. Create an immutable Docker image for your integration artifacts on WSO2 Micro Integrator by executing the following command from the location of your Dockerfile.

    docker build -t sample_docker_image .
  4. Start a Docker container by running the Docker image as shown below.

    docker run -d -p 8290:8290 sample_docker_image

Follow the Quick Start Guide to run a simple use case on a Docker container.

Micro Integrator with Kubernetes

Kubernetes is an open source container orchestration system for automating, scaling, and managing your application deployments. To run your Micro Integrator solutions on Kubernetes, you need to first create an immutable docker image with the required synapse artifacts, configurations, and third-party dependencies by using the base Docker image of WSO2 Micro Integrator as explained above. You can then use the immutable Docker image to create pods and to configure the kubernetes deployments according to your requirements.

Follow the Quick Start Guide to run a simple use case on a Kubernetes cluster.

Running the Micro Integrator on a VM

Follow the steps given below to install and run the Micro Integrator on a VM.

Installing the WSO2 Micro Integrator

Follow the steps below:

  1. Go to the WSO2 Micro Integrator product page and download.

    Note that there are several options for installing the product in various environments. Use the available links for more information on each option.

  2. If you used the installer, double-click to open the installation wizard, which will guide you through the installation. When you finish, the product will be installed and ready for use. 

Accessing the HOME directory

Let's call the installation location of your product the <MI_HOME> directory.

If you used the installer to install the product, this is located in a place specific to your OS as shown below:

OSHome directory
Mac OS/Library/WSO2/MicroIntegrator/1.0.0
WindowsC:\Program Files\WSO2\MicroIntegrator\1.0.0

Uninstalling the product

If you used the installer to install the product, you can uninstall by following the steps given below:

Mac OS

Open a terminal and run the following command as the root user:

sudo bash /Library/WSO2/MicroIntegrator/1.0.0/
WindowsGo to the  Start Menu -> Programs -> WSO2 -> Uninstall Micro Integrator 1.0.0  or search  Uninstall Micro Integrator 1.0.0  and click the shortcut icon. This will uninstall the product from your computer.

Open a terminal and run the following command:

sudo apt-get purge wso2mi-1.0.0

Open a terminal and run the following command:

sudo yum remove wso2ei-1.0.0-x86_64

Deploying the integration artifacts

Package your integration artifacts (developed using WSO2 Integration Studio), and add the CAR file to the <MI_HOME>/repository/deployment/server/carbonapps directory. Note that WSO2 Micro Integrator does not support hot deployment. Therefore, you need to restart the Micro Integrator after copying the artifacts, in order to get them deployed.

Testing your integration artifacts?

If you are testing the integration artifacts in your development environment, you can deploy and build your integration solution in the embedded Micro Integrator instance of WSO2 Integration Studio. See Developing Cloud Native Integration for details.

Running the Micro Integrator

Start the WSO2 Micro Integrator by following the instructions given below.

Using the installer

Open a terminal and execute the command given below.

sudo wso2mi-1.0.0

The operation log keeps running until the profile starts, which usually takes several seconds. Wait until the profile fully boots up and displays a message similar to "WSO2 Carbon started in n seconds."

Go to Start Menu -> Programs -> WSO2 -> Micro Integrator. This will open a terminal and start the relevant profile.

Using the binary distribution
  1. Before you execute the product startup script, be sure to set the JAVA HOME in your machine. Use a JDK that is compatible with WSO2 Micro Integrator.
  2. Open a terminal and navigate to the <MI_HOME>/bin/ directory, where <MI_HOME> is the home directory of your product distribution.
  3. Execute the relevant command.


    Note: If you have installed the product using the installer, and you want to manually run the product startup script from the /bin directory, you need to use the 'sudo launcher_micro-integrator' command. This script automatically assigns the JAVA HOME of your VM to the root user of your Micro Integrator instance.


By default, the HTTP listener port is 8290 and the default HTTPS listener port is 8253.

Stopping the Micro Integrator

To stop the Micro Integrator runtime, press Ctrl+C in the command window.

  • No labels