wso2/wso2ei-msf4j repository overview

⁠About WSO2 Product Docker Images

WSO2 product Docker images available at DockerHub⁠ package General Availability (GA) versions of WSO2 products with no WSO2 Updates⁠.

For a production grade deployment of the desired WSO2 product-version, it is highly recommended to use the relevant Docker image which packages WSO2 Updates, available at WSO2 Private Docker Registry⁠.

⁠Supported tags and respective Dockerfile links

• 6.5.0 (Dockerfile)⁠
• 6.5.0-alpine (Dockerfile)⁠
• 6.5.0-centos (Dockerfile)⁠
• 6.4.0, latest (Dockerfile)⁠
• 6.4.0-alpine (Dockerfile)⁠
• 6.4.0-centos (Dockerfile)⁠

•   [`6.3.0` (*Dockerfile*)](https://github.com/wso2/docker-ei/blob/v6.3.0.1/dockerfiles/msf4j/Dockerfile)
  

  Copy

⁠Quick reference

• Where to get help:
  Docker Community Forums⁠, Docker Community Slack⁠, Stack Overflow⁠ or mail to WSO2 Developer mailing list⁠

• Where to file issues:
  Product specific issues at WSO2 Enterprise Integrator product repository⁠ and Docker resource usage issues at product Docker resource repository⁠

• Maintained by:
  WSO2 Inc.⁠

• Supported Docker versions:
  Docker v17.09.0 or above

⁠About MSF4J profile of WSO2 Enterprise Integrator

With its lightweight, fast runtime and annotation-based programming model, WSO2 Microservices Framework for Java (WSO2 MSF4J) offers the best option to create microservices in Java with container-based deployment in mind. Microservices developed using WSO2 MSF4J can boot in just a few milliseconds in a Docker container and can easily be added to a Docker image definition.

⁠How to use this image.

⁠Start a MSF4J profile instance

The following command starts a Linux Ubuntu-based MSF4J profile Docker image.

$ docker run -it -p 9090:9090 --name msf4j wso2/wso2ei-msf4j:6.4.0

Here, port 9090 has been mapped to the corresponding Docker host (host machine on top of which containers are spawned) ports.

⁠Container shell access and viewing server logs

Assuming you have started a Docker container instance of MSF4J profile as instructed in the previous section Start a MSF4J profile instance,

• The MSF4J server log is available through Docker's container log:

$ docker logs msf4j

• The Docker exec command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside the container you created:

$ docker exec -it msf4j bash

⁠Pass arguments during server startup

⁠Running in debug mode

To start a Docker container instance of the MSF4J profile in debug mode (assuming 5005 to be the remote debugging port), use the following command:

$ docker run -it -p 9090:9090 -p 5005:5005 --name another-msf4j wso2/wso2ei-msf4j:6.4.0 -debug 5005

Note: Passing arguments during server startup is not supported in Docker image with tag 6.3.0.

⁠How to update configurations

Configurations would lie on the Docker host machine and they can be volume mounted to the container. As an example, the steps required to change the port offset using carbon.yml is as follows:

• Stop the MSF4J profile container if it's already running.

In the MSF4J profile product distribution, carbon.yml configuration file can be found at {DISTRIBUTION_HOME}/wso2/msf4j/conf. Copy the file to a suitable location of the host machine, referred to as {SOURCE_CONFIGS}/carbon.xml and increase the offset value under ports by 1.

• Grant read permission to other users for {SOURCE_CONFIGS}/carbon.yml.

$ chmod o+r {SOURCE_CONFIGS}/carbon.yml

• Run the image by mounting the file to the container as follows:

$ docker run -p 9090:9090 --volume {SOURCE_CONFIGS}/carbon.yml:{TARGET_CONFIGS}/carbon.yml wso2/wso2ei-msf4j:6.4.0

Here, {TARGET_CONFIGS} refers to /home/wso2carbon/wso2ei-6.4.0/wso2/msf4j/conf folder of the container.

⁠Image Variants

Multiple product profile Docker images based on different base operating systems are available.

⁠wso2ei-msf4j:{version}

Ubuntu 18.04 LTS based Docker image with AdoptOpenJDK 8 pre-installed has been used as the base Docker image⁠.

MSF4J profile of WSO2 Enterprise Integrator has been installed on top of this Docker image.

⁠wso2ei-msf4j:{version}-alpine

Alpine based Docker image with AdoptOpenJDK 8 pre-installed has been used as the base Docker image⁠.

MSF4J profile of WSO2 Enterprise Integrator has been installed on top of this Docker image.

⁠wso2ei-msf4j:{version}-centos

CentOS 7 based Docker image⁠ has been used. AdoptOpenJDK 8 and MSF4J profile of WSO2 Enterprise Integrator have been installed on top of this Docker image.

⁠License

View license information⁠ for the software contained in this image.

As with all Docker images, these are likely to contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.