wslph/mule repository overview

⁠wslph/mule⁠

• Introduction⁠
  • Changelog⁠
• Contributing⁠
• Issues⁠
• Announcements⁠
• Prerequisites⁠
• Installation⁠
  • Installing Mule Enterprise License⁠
• Configuration⁠
  • Available Configuration Parameters⁠
• Create a custom image based from this image⁠
• References⁠
• About⁠

⁠Introduction

Docker Mule ESB Runtime⁠ container image for Community and Enterprise Edition.

⁠Contributing

If you find this image useful here's how you can help:

• Send a Merge Request with your awesome new features and bug fixes at https://git.whiteskylabs.com/mulesoft/docker-mule⁠
• Be a part of the community and help resolve Issues⁠

⁠Issues

Docker is a relatively new project and is active being developed and tested by a thriving community of developers and testers, and every release includes many enhancements and bugfixes.

Given the nature of the development and release cycle it is very important that you have the latest version of Docker installed because any issue that you encounter might have already been fixed with a newer Docker release.

Install the most recent version of the Docker Engine for your platform using the official Docker releases⁠, which can also be installed using:

wget -qO- https://get.docker.com/ | sh

Fedora and RHEL/CentOS users should try disabling selinux with setenforce 0 and check if resolves the issue. If it does than there is not much that I can help you with. You can either stick with selinux disabled (not recommended by redhat) or switch to using ubuntu.

If you want to try this on your local development machine, you can try Docker for Mac⁠, and Docker for Windows⁠.

If you find any issues with this release, please file an issue request on the issues⁠ page.

In your issue report please make sure you provide the following information:

• The host distribution and release version.
• Output of the docker version command
• Output of the docker info command
• The docker run command you used to run the image (mask out the sensitive bits).

⁠Prerequisites

Your docker host needs to have at least 2GB (or more) of available RAM to run Mule ESB Server Runtime. Please refer to the Mule ESB hardware requirements⁠ documentation for additional information.

⁠Installation

Automated builds of the image are available on Dockerhub⁠ and is the recommended method of installation.

To pull the latest build for 3.9.0-ee

docker pull wslph/mule:3.9.0-ee

To pull the container built on 2018-02-02 (YYYY-MM-DD).

docker pull wslph/mule:3.9.0-ee-2018-02-02

Example 1 : Launching Mule ESB Server runtime container for Community Edition

docker run --restart=always --name mule-ce -d \
    --publish 7777:7777 \
    wslph/mule:3.9.0-ce && docker logs -f mule-ce

Example 2 : Launching Mule ESB Server runtime container for Enterprise Edition

docker run --restart=always --name mule-ee -d \
    --publish 7777:7777 \
    wslph/mule:3.9.0-ee && docker logs -f mule-ee

Example 3 : Attaching container to host network

docker run --restart=always --name mule-ee -d \
    --net=host \
    wslph/mule:3.9.0-ee && docker logs -f mule-ee

Example 4: Mule 4 with ARM_AUTH_TOKEN and additional env variables to automate registration with existing environment, server group, and enablement of anypoint monitoring agent.

docker run --restart=always --name mule -d \
    --publish 8081:8081\
    --env 'ARM_AUTH_TOKEN=<auth-token>' \
    --env 'ANYPOINT_ENV_ID=<env-id-hash-code>' \
    --env 'ANYPOINT_ORG_ID=<org-id-hash-code>' \
    --env 'MULE_ESB_NAME=NODE-1' \
    --env 'MULE_SERVER_GROUP=BILLING-SERVICES' \
    --env 'MULE_ENVIRONMENT=DEVELOPMENT' \
    --env 'MULE_ARM_MONITORING_ENABLED=true' \
    --volume ~/mule/apps:/opt/mule/apps \
    --volume ~/mule/domains:/opt/mule/domains \
    --volume ~/mule/conf:/opt/mule/conf \
    --volume ~/mule/logs:/opt/mule/logs \
    --volume ~/mule/patches:/opt/mule/patches \
    --volume ~/mule/.mule:/opt/mule/.mule \
    --volume ~/mule/plugins:/opt/mule/plugins \
    --volume ~/mule/server-plugins:/opt/mule/server-plugins \
    --volume ~/mule/policies:/opt/mule/policies \
    wslph/mule:4.3.0-20210304-ee-2021-10-23 && docker logs -f mule

Note:

<auth-token> is generated by curl -X POST -H "Content-Type: application/json" -d '{"username":"'<username>'", "password":"'<password>'"}' https://anypoint.mulesoft.com/accounts/login | jq -r .access_token

Please refer to Available Configuration Parameters⁠ to understand these options

NOTE: Please allow a couple of minutes for the Mule ESB Server runtime to start.

In any of these examples, you should now have Mule ESB Server up and ready for testing. If you want to use this image in production then please read on.

⁠Installing Mule Enterprise License

By default, enterprise edition of Mule ESB Server will run in trial mode. If you want to install an enterprise license⁠ which is either named as license.lic or mule-ee-license.lic, just drop it in your <mule-home>/conf, and then restart your mule container, it will detect and install it. Just do the same process, whenever you need to renew your mule license.

⁠Configuration

Data Store

Mule ESB Server is an application hosting software and as such you don't want to lose your code when the docker container is stopped/deleted. To avoid losing any data, you should mount a volume at,

• /opt/mule/apps
• /opt/mule/domains
• /opt/mule/conf
• /opt/mule/logs
• /opt/mule/patches
• /opt/mule/.mule

Volumes can be mounted in docker by specifying the --volume option in the docker run command.

docker run --restart=always --name mule-ee -d \
    --publish 7777:7777 --publish 1098:1098 --publish 25000:5000 --publish 8081:8081\
    --env 'MULE_ESB_NAME=My-ESB-Server-01' \
    --env 'MULE_MMC_AGENT_PORT=7777' \
    --env 'MULE_MMC_URL=http://my-server.example.com/mmc-console' \
    --env 'MULE_MMC_USERNAME=admin' \
    --env 'MULE_MMC_PASSWORD=admin' \
    --env 'MULE_MMC_AGENT_HOST=123.455.234.110' \
    --volume ~/mule/apps:/opt/mule/apps \
    --volume ~/mule/domains:/opt/mule/domains \
    --volume ~/mule/conf:/opt/mule/conf \
    --volume ~/mule/logs:/opt/mule/logs \
    --volume ~/mule/patches:/opt/mule/patches \
    --volume ~/mule/.mule:/opt/mule/.mule \
    wslph/mule:3.9.0-ee && docker logs -f mule-ee

Applying runtime patch

The /opt/mule/patches volume sole purpose is to copy (before the mule runtime is started) its content to /opt/mule/lib/user and applies to specific version of mule runtime (e.g., 3.6.2-ee requires applying SE-3341-3.6.2.jar that fixes the mule application filename issue). This allows maintenance of patch to an existing Mule runtime, requiring only a docker restart <mule-container>

Registering to Anypoint Runtime Manager

If you want to register your Mule ESB container to Anypoint Platform / Anypoint Runtime Manager, here's an example:

docker run --restart=always --name mule-ee -d \
    --publish 1098:1098 --publish 25000:5000 --publish 8081:8081\
    --env 'MULE_ESB_NAME=My-ESB-Server-01' \
    --env 'MULE_ARM_TOKEN=aaabbbcccdddeeefff...' \
    --volume ~/mule/apps:/opt/mule/apps \
    --volume ~/mule/domains:/opt/mule/domains \
    --volume ~/mule/conf:/opt/mule/conf \
    --volume ~/mule/logs:/opt/mule/logs \
    --volume ~/mule/patches:/opt/mule/patches \
    --volume ~/mule/.mule:/opt/mule/.mule \
    --volume ~/mule/plugins:/opt/mule/plugins \
    --volume ~/mule/server-plugins:/opt/mule/server-plugins \
    --volume ~/mule/policies:/opt/mule/policies \
    wslph/mule:3.9.0-ee && docker logs -f mule-ee

Registering to Mule Management Console

If you want to register your Mule ESB container to a MMC server.

You need to specify the following environment variables:

• MULE_ESB_NAME
• MULE_MMC_AGENT_HOST
• MULE_MMC_AGENT_PORT
• MULE_MMC_URL
• MULE_MMC_USERNAME and MULE_MMC_PASSWORD OR MULE_MMC_HEADER_AUTH

For further explanation of each environment variable, please take a look at Available Configuration Parameters section.

Here's an example:

docker run --restart=always --name mule-ee -d \
    --publish 7777:7777 --publish 1098:1098 --publish 25000:5000 --publish 8081:8081\
    --env 'MULE_ESB_NAME=My-ESB-Server-01' \
    --env 'MULE_MMC_AGENT_HOST=123.455.234.110' \
    --env 'MULE_MMC_AGENT_PORT=7777' \
    --env 'MULE_MMC_URL=http://my-server.example.com/mmc-console' \
    --env 'MULE_MMC_USERNAME=admin' \
    --env 'MULE_MMC_PASSWORD=admin' \
    --volume ~/mule/apps:/opt/mule/apps \
    --volume ~/mule/domains:/opt/mule/domains \
    --volume ~/mule/conf:/opt/mule/conf \
    --volume ~/mule/logs:/opt/mule/logs \
    --volume ~/mule/patches:/opt/mule/patches \
    --volume ~/mule/.mule:/opt/mule/.mule \
    --volume ~/mule/plugins:/opt/mule/plugins \
    --volume ~/mule/server-plugins:/opt/mule/server-plugins \
    --volume ~/mule/policies:/opt/mule/policies \
    wslph/mule:3.9.0-ee && docker logs -f mule-ee

OR

docker run --restart=always --name mule-ee -d \
    --publish 7777:7777 --publish 1098:1098 --publish 25000:5000 --publish 8081:8081\
    --env 'MULE_ESB_NAME=My-ESB-Server-01' \
    --env 'MULE_MMC_AGENT_HOST=123.455.234.110' \
    --env 'MULE_MMC_AGENT_PORT=7777' \
    --env 'MULE_MMC_URL=http://my-server.example.com/mmc-console' \
    --env 'MULE_MMC_HEADER_AUTH=Authorization:Basic YWRtaW46YWRtaW4=' \
    --volume ~/mule/apps:/opt/mule/apps \
    --volume ~/mule/domains:/opt/mule/domains \
    --volume ~/mule/conf:/opt/mule/conf \
    --volume ~/mule/logs:/opt/mule/logs \
    --volume ~/mule/patches:/opt/mule/patches \
    --volume ~/mule/.mule:/opt/mule/.mule \
    --volume ~/mule/plugins:/opt/mule/plugins \
    --volume ~/mule/server-plugins:/opt/mule/server-plugins \
    --volume ~/mule/policies:/opt/mule/policies \
    wslph/mule:3.9.0-ee && docker logs -f mule-ee

IMPORTANT:

In order to execute the registration script to MMC server, you need to do the following:

docker exec <container-name> mmc_setup

and it will provide a JSON response, which indicates wether registration is successful or not.

Developer's Note:

• At the moment, this is the only way to register to MMC server. If you have a better way of doing this inside the container, I'd be happy to implement it and credit it to you. Thanks!

Available Configuration Parameters

Please refer the docker run command options for the --env-file flag where you can specify all required environment variables in a single file. This will save you from writing a potentially long docker run command.

Below is the complete list of available options that can be used to customize your Mule ESB Server container installation.

⁠Maintenance

Shell Access

For debugging and maintenance purposes you may want access the container's shell. If you are using docker version 1.3.0 or higher you can access a running container's shell using docker exec command.

docker exec -it mule-ee bash

⁠Create a custom image based from this image

Note: If you want to use this image to build your own docker image, you will need to setup CMD[] command as shown below:

CMD [ "/opt/mule/bin/mule-start.sh" ]

This is required, as the bash script executes the necessary checks and configurations at the start.

Here's an example:

FROM wslph/mule:4.2.0-ee
COPY ./helloworld/target/helloworld-1.0.0-SNAPSHOT-mule-application.jar /opt/mule/apps/
CMD ["/opt/mule/bin/mule-start.sh"]

⁠References

• For available server runtime version please see tags⁠
• Mule ESB User Guide⁠
• Container is based from wslph/ubuntu:jammy-latest⁠
• Mule ESB Runtime v4 documentation⁠
• MMC and AMC setup are not supported for Mule ESB Community Edition.

⁠About

Developed and maintained by Reynold Lariza⁠ of WhiteSky Labs⁠, a Premier Partner of MuleSoft®⁠ with the mission to be the #1 Certified Partner to deliver specialized API integration services.