wso2/wso2ei-broker 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/broker/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 Message Broker profile of WSO2 Enterprise Integrator

WSO2 Enterprise Integrator is shipped with a separate runtime for message brokering (Message Broker profile). This Message Broker profile is an instance of the WSO2 Message Broker product; thereby, it contains all the functionality that was available with WSO2 Message Broker. When you use WSO2 Enterprise Integrator for integration, you can easily configure the Message Broker runtime along with the ESB runtime to achieve guaranteed delivery and reliable messaging. Further, you can also run the Message Broker profile in WSO2 Enterprise Integrator to facilitate message brokering using Topics and Queues.

⁠How to use this image.

⁠Start a Message Broker profile instance

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

$ docker run -it -p 9446:9446 --name broker wso2/wso2ei-broker:6.4.0

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

⁠Accessing management console

To access the management console, use the Docker host IP and port 9446 as follows:

https://{DOCKER_HOST}:9446/carbon

⁠Container shell access and viewing server logs

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

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

$ docker logs broker

• 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 broker bash

⁠Pass arguments during server startup

⁠Running in debug mode

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

$ docker run -it -p 9446:9446 -p 5005:5005 --name another-broker wso2/wso2ei-broker:6.4.0 -debug 5005

⁠JMX port monitoring

WSO2 Carbon platform uses TCP ports to monitor a running Carbon instance using a JMX client such as JConsole. JMX is enabled in WSO2 products by default. Thus, JMX server is started automatically in a particular product.

The default JMX ports RMIRegistryPort and the RMIServerPort are started on ports 10002 and 11114, respectively.

Hence, assuming the default ports are not changed, start a Docker container instance of Message Broker profile using the following command.

$ docker run -it -p 9446:9446 -p 10002:10002 -p 11114:11114 --name jmx-broker wso2/wso2ei-broker:6.4.0

Obtain the JMX Service URL as described in the WSO2 official documentation⁠ from the server startup log.

⁠List server logs:

docker logs jmx-broker

⁠Server log line to capture:

INFO {org.wso2.carbon.core.init.JMXServerManager} - JMX Service URL : service:jmx:rmi://localhost:11114/jndi/rmi://localhost:10002/jmxrmi

Follow the steps provided under Monitoring a WSO2 product with JConsole⁠.

Please see the WSO2 official documentation⁠ for advanced details on JMX monitoring.

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.xml is as follows:

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

In the Message Broker profile product distribution, carbon.xml configuration file can be found at {DISTRIBUTION_HOME}/wso2/broker/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.xml.

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

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

$ docker run -p 9447:9447 --volume {SOURCE_CONFIGS}/carbon.xml:{TARGET_CONFIGS}/carbon.xml wso2/wso2ei-broker:6.4.0

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

⁠Image Variants

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

⁠wso2ei-broker:{version}

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

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

⁠wso2ei-broker:{version}-alpine

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

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

⁠wso2ei-broker:{version}-centos

CentOS 7 based Docker image⁠ has been used. AdoptOpenJDK 8 and Message Broker 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.