Creating Kubernetes Exporter

Create a Kubernetes Exporter if you want to deploy your integration solutions in a Kubernetes environment.

The Kubernetes Exporter allows you to package multiple integration modules into a single Docker image. Also, a file named integration_cr.yaml is generated, which can be used to carry out Kubernetes deployments based on the API K8s Operator.

Creating the Kubernetes project

Follow the steps given below.

  1. Create a new integration project and create a Kubernetes Exporter project by doing one of the following.

    1. As part of creating an integration project, you can select the Kubernetes Exporter check box.

    2. You can right click on an existing integration project and select New -> Kubernetes Exporter.

  2. In the New Kubernetes Exporter dialog box that opens, enter a name for the Kubernetes exporter and other parameters as shown below.

    Enter the following information:

    Parameter Description
    Kubernetes Exporter Name Required. Give a name for the Kubernetes project.
    Generate K8s Artifacts for Specify the method that should be used for deploying the Micro Integrator on Kubernetes.
    • K8s Operator: The Kubernetes resources required by the Operator are generated.
    • Pure K8s Artifacts: The Kubernetes resources required for setting up a deployment without using the K8s Operator are generated.
    Integration Name Required. This name will be used to identify the integration solution in the kubernetes custom resource. The custom resource file (integration_cr.yaml) for this solution will be generated along with the other artifacts.
    Number of Replicas Required. Specify the number of pods that should be created in the kubernetes cluster.
    Base Image Repository Required. Select the base Micro Integrator Docker image for your solution. Use one of the following options:
    • wso2/wso2mi: This is the community version of the Micro Integrator Docker image, which is stored in the public WSO2 Docker registry. This is selected by default.
    • This is the Micro Integrator Docker image that includes product updates. This image is stored in the private WSO2 Docker registry. Note that you need a valid WSO2 subscription to use the Docker image with updates.
    • You can also use a custom Docker image from a custom repository.
    If you specify a Docker image from a private repository, note that you need to log in to your repository from a terminal before you build and push the image (as explained below).
    Base Image Tag Required. Specify the tag of the base image that you are using.
    Target Image Repository Required. The Docker repository to which you will later push this Docker image.
    • If your repository is in Docker Hub, use the docker_user_name/repository_name format.
    • If you are using any other repository, use the repository_url/repository_user_name/repository_name forrmat.
    If required, you can update this information later when you build and push the Docker image to the relevant repository.
    Target Image Tag Required. Give a tag name for the Docker image.
    Automatically deploy configurations This check box indicates that you are using the Micro Integrator as the base image. It is recommended to leave this check box selected when you use the Micro Integrator.
    Environment Variables You can enter multiple environment variables as key-value pairs.

  3. Optionally, click Next and configure Maven details for the Kubernetes exporter.

  4. Click Finish. The Kubernetes exporter is created in the project explorer.

  5. This step is only required if you already have a Docker image (in your local Docker repository) with the same name as the base image specified above.


    In this scenario, WSO2 Integration Studio will first check if there is a difference in the two images before pulling the image specified in the Base Image Repository field. If the given base image is more updated, the existing image will be overwritten by this new image. Therefore, if you are currently using an older version, or if you have custom changes in your existing image, they will be replaced.

    To avoid your existing custom/older images from being replaced, add the following property under dockerfile-maven-plugin -> executions -> execution -> configurations in the pom.xml file of your Kubernetes Exporter project. This configuration will ensure that the base image will not be pulled when a Docker image already exists with the same name.


The Kubernetes Exporter directory

Expand the Kubernetes Exporter in the project explorer. See that the following folders and files are created:

Directory Description
Libs Directory to store libraries. During the build time, the libraries inside this folder will be copied to the image.
Resources This folder stores additional files and resources that should be copied to the Docker image. During the build time, the resources inside this directory will be copied to the image.
deployment.toml The product configuration file.
Dockerfile The Dockerfile containing the build details.
integration_cr.yaml Kubernetes configuration file generated based on the user inputs.
pom.xml The file for selecting the relevant composite applications that should be included in the Docker image. This information is also used when you later build and push Docker images to the Docker registries.

Build and Push Docker images

Before you begin:

  • Create your integration artifacts in an ESB Config sub project and package the artifacts in a Composite Exporter. For example, see the HelloWorld sample given below.

    Integration artifacts for Docker

  • Be sure to start your Docker instance before building the image. If Docker is not started, the build process will fail.

  • If you are using a Micro Integrator Docker image from a private registry as your base image:

    1. Open a terminal and use the following command to log in to Docker:
      docker login -u username -p password 
    2. In the next step, specify the name of the private Docker registry.

To build and push the Docker image:


As an alternative, you can skip the steps given below and manually build and push the Docker images using maven. Open a terminal, navigate to the Docker exporter and execute the following command:

mvn clean install -Dmaven.test.skip=true -Ddockerfile.username={username} -Ddockerfile.password={password} 

However, note that you need Maven 3.5.2 or a later version when you build the Docker image manually (without using WSO2 Integration Studio).

  1. Open the pom.xml file inside the Kubernetes exporter and click Refresh on the top-right. Your composite application project with integration artifacts will be listed under Dependencies as follows:

    Kubernetes pom view

  2. Select the composite applications that should be packed inside the Docker image (under Dependencies).

  3. If required, you can update the Target Repository to which the image should be pushed and the Target Tag.
  4. Save the file and click Build & Push on the top-right to start the Docker image build-and-push process. The Enter Docker Registry Credentials wizard opens.

    Docker Registry Auth Details

  5. Enter the following details in the wizard:

    Parameter Description
    Registry URL Type The Docker image registry to which the image will be pushed: Docker Hub or Other.
    Username Username of the target registry repository.
    Password Password of the target registry repository.

  6. Once you enter the above details, click Push Image.

  7. First, it will build the Docker image based on the Dockerfile and the Target details. When the image is created, you will see the following message.

    Docker Build Success

  8. Finally, it will start to push the image to the given registry. Once the process is completed, you will see the following message.

    Docker Push Success