- Overview
- Docker Hub
- Preparing your Docker host
- Build
- Usage
- Troubleshooting
- Issues and contributions
- License
Run IBM® MQ in a Docker container. By default, the supplied Dockerfile runs IBM MQ for Developers, but also works for IBM MQ. The source can be found on the ibm-messaging GitHub. There's also a short demo video available.
The image is available on Docker Hub as ibmcom/mq with the following tags:
cd,9-cd,9,latest(Dockerfile)lts,9-lts(Dockerfile)8(Dockerfile)
You need to make sure that you either have a Linux kernel version of V3.16, or else you need to add the --ipc host option when you run an MQ container. The reason for this is that IBM MQ uses shared memory, and on Linux kernels prior to V3.16, containers are usually limited to 32 MB of shared memory. In a change to Linux kernel V3.16, the hard-coded limit is greatly increased. This kernel version is available in Ubuntu 14.04.2 onwards, Fedora V20 onwards, and boot2docker V1.2 onwards. If you are using a host with an older kernel version, but Docker version 1.4 or newer, then you can still run MQ, but you have to give it access to the host's IPC namespace using the --ipc host option on docker run. Note that this reduces the security isolation of your container. Using the host's IPC namespace is a temporary workaround, and you should not attempt shared-memory connections to queue managers from outside the container.
After extracting the code from this repository, you can build an image with the latest version of MQ using the following command:
sudo docker build --tag mq .
In order to use the image, it is necessary to accept the terms of the IBM MQ license. This is achieved by specifying the environment variable LICENSE equal to accept when running the image. You can also view the license terms by setting this variable to view. Failure to set the variable will result in the termination of the container with a usage statement. You can view the license in a different language by also setting the LANG environment variable.
This image is primarily intended to be used as an example base image for your own MQ images.
You can run a queue manager with the default configuration and a listener on port 1414 using the following command. Note that the default configuration is locked-down from a security perspective, so you will need to customize the configuration in order to effectively use the queue manager. For example, the following command creates and starts a queue manager called QM1, and maps port 1414 on the host to the MQ listener on port 1414 inside the container, as well as port 9443 on the host to the web console on port 9443 inside the container:
sudo docker run \
--env LICENSE=accept \
--env MQ_QMGR_NAME=QM1 \
--volume /var/example:/mnt/mqm \
--publish 1414:1414 \
--publish 9443:9443 \
--detach \
mq
Note that in this example, the name "mq" is the image tag you used in the previous build step.
Also note that the filesystem for the mounted volume directory (/var/example in the above example) must be supported.
If you wish to run a queue manager with default configuration and a listener on port 1414, but using an IBM Bluemix volume to store your data you will need to mount the volume in a different directory than /var/mqm. When using a volume in Bluemix, special actions need to be taken in order to mount the IBM MQ data directory with the correct permissions on the volume. These actions are performed in the setup-var-mqm.sh script. The script is configured to look for a directory called /mnt/mqm, if it finds this then it will perform the special actions to create the IBM MQ data directory. When using mounting a volume to a Bluemix container you should mount the volume to the /mnt/mqm directory:
bx ic run \
--env LICENSE=accept \
--env MQ_QMGR_NAME=QM1 \
--volume /var/example:/mnt/mqm \
mq
You can customize the configuration in several ways:
- By creating your own image and adding your own MQSC file into the
/etc/mqmdirectory on the image. This file will be run when your queue manager is created. - By using remote MQ administration. Note that this will require additional configuration as remote administration is not enabled by default.
Note that a listener is always created on port 1414 inside the container. This port can be mapped to any port on the Docker host.
The following is an example Dockerfile for creating your own pre-configured image, which adds a custom config.mqsc and an administrative user alice. Note that it is not normally recommended to include passwords in this way:
FROM mq
RUN useradd alice -G mqm && \
echo alice:passw0rd | chpasswd
COPY 20-config.mqsc /etc/mqm/Here is an example corresponding 20-config.mqsc script from the mqdev blog, which allows users with passwords to connect on the PASSWORD.SVRCONN channel:
DEFINE CHANNEL(PASSWORD.SVRCONN) CHLTYPE(SVRCONN) REPLACE
SET CHLAUTH(PASSWORD.SVRCONN) TYPE(BLOCKUSER) USERLIST('nobody') DESCR('Allow privileged users on this channel')
SET CHLAUTH('*') TYPE(ADDRESSMAP) ADDRESS('*') USERSRC(NOACCESS) DESCR('BackStop rule')
SET CHLAUTH(PASSWORD.SVRCONN) TYPE(ADDRESSMAP) ADDRESS('*') USERSRC(CHANNEL) CHCKCLNT(REQUIRED)
ALTER AUTHINFO(SYSTEM.DEFAULT.AUTHINFO.IDPWOS) AUTHTYPE(IDPWOS) ADOPTCTX(YES)
REFRESH SECURITY TYPE(CONNAUTH)
It is recommended that you configure MQ in your own custom image. However, you may need to run MQ commands directly inside the process space of the container. To run a command against a running queue manager, you can use docker exec, for example:
sudo docker exec \
--tty \
--interactive \
${CONTAINER_ID} \
dspmq
Using this technique, you can have full control over all aspects of the MQ installation. Note that if you use this technique to make changes to the filesystem, then those changes would be lost if you re-created your container unless you make those changes in volumes.
This image includes the core MQ server, Java, language packs, and GSKit. Other features (except the client) are not currently supported running in Docker. See the MQ documentation for details of which RPMs to choose.
This image includes the MQ Developer defaults scripts which are automatically ran during Queue Manager startup. This configures your Queue Manager with a set of default objects that you can use to quickly get started developing with IBM MQ. If you do not want the default objects to be created you can set the MQ_DEV environment variable to false.
Userid: admin Groups: mqm Password: passw0rd
Userid: app Groups: mqclient Password:
- DEV.QUEUE.1
- DEV.QUEUE.2
- DEV.QUEUE.3
- DEV.DEAD.LETTER.QUEUE - Set as the Queue Manager's Dead Letter Queue.
- DEV.ADMIN.SVRCONN - Set to only allow the
adminuser to connect into it and a Userid + Password must be supplied. - DEV.APP.SVRCONN - Does not allow Administrator users to connect.
- DEV.LISTENER.TCP - Listening on Port 1414.
DEV.BASE.TOPIC - With a topic string of dev/.
- DEV.AUTHINFO - Set to use OS as the user repository and adopt supplied users for authorization checks
- Users in
mqclientgroup have been given access connect to all Queues and topics starting withDEV.**and haveputgetpubandsubpermissions.
The MQ Developer Defaults supports some customization options, these are all controlled using environment variables:
- MQ_DEV - Set this to
falseto stop the Default objects being created. - MQ_ADMIN_PASSWORD - Changes the password of the
adminuser. Must be at least 8 characters long. - MQ_APP_PASSWORD - Changes the password of the app user. If set, this will cause the
DEV.APP.SVRCONNchannel to become secured and only allow connections that supply a valid userid and password. Must be at least 8 characters long. - MQ_TLS_KEYSTORE - Allows you to supply the location of a PKCS#12 keystore containing a single certificate which you want to use in both the web console and the queue manager. Requires
MQ_TLS_PASSPHRASE. When enabled the channels created will be secured using theTLS_RSA_WITH_AES_256_GCM_SHA384CipherSpec. Note: you will need to make the keystore available inside your container, this can be done by mounting a volume to your container. - MQ_TLS_PASSPHRASE - Passphrase for the keystore referenced in
MQ_TLS_KEYSTORE.
By default the image will start the IBM MQ Web Console that allows you to administer your Queue Manager running on your container. When the web console has been started, you can access it by opening a web browser and navigating to https://:9443/ibmmq/console. Where is replaced by the IP address of your running container.
When you navigate to this page you may be presented with a security exception warning. This happens because, by default, the web console creates a self-signed certificate to use for the HTTPS operations. This certificate is not trusted by your browser and has an incorrect distinguished name.
If you chose to accept the security warning, you will be presented with the login menu for the IBM MQ Web Console. The default login for the console is:
- User: admin
- Password: passw0rd
If you wish to change the password for the admin user, this can be done using the MQ_ADMIN_PASSWORD environment variable. If you supply a PKCS#12 keystore using the MQ_TLS_KEYSTORE environment variable, then the web console will be configured to use the certificate inside the keystore for HTTPS operations.
If you do not wish the web console to run, you can disable it by setting the environment variable MQ_DISABLE_WEB_CONSOLE to true.
- LICENSE - Set this to
acceptto agree to the MQ Advanced for Developers license. If you wish to see the license you can set this toview. - LANG - Set this to the language you would like the license to be printed in.
- MQ_QMGR_NAME - Set this to the name you want your Queue Manager to be created with.
- MQ_QMGR_CMDLEVEL - Set this to the
CMDLEVELyou wish your Queue Manager to be started with. - MQ_DEV - Set this to
falseto stop the Default objects being created. - MQ_ADMIN_PASSWORD - Changes the password of the
adminuser. Must be at least 8 characters long. - MQ_APP_PASSWORD - Changes the password of the app user. If set, this will cause the
DEV.APP.SVRCONNchannel to become secured and only allow connections that supply a valid userid and password. Must be at least 8 characters long. - MQ_TLS_KEYSTORE - Allows you to supply the location of a PKCS#12 keystore containing a single certificate which you want to use in both the web console and the queue manager. Requires
MQ_TLS_PASSPHRASE. When enabled the channels created will be secured using theTLS_RSA_WITH_AES_256_GCM_SHA384CipherSpec. Note: you will need to make the keystore available inside your container, this can be done by mounting a volume to your container. - MQ_TLS_PASSPHRASE - Passphrase for the keystore referenced in
MQ_TLS_KEYSTORE. - MQ_DISABLE_WEB_CONSOLE - Set this to
trueif you want to disable the Web Console from being started.
This message also appears as "System error: no such file or directory" in some versions of Docker. This can happen using Docker Toolbox on Windows, and is related to line-ending characters. When you clone the Git repository on Windows, Git is often configured to convert any UNIX-style LF line-endings to Windows-style CRLF line-endings. Files with these line-endings end up in the built Docker image, and cause the container to fail at start-up. One solution to this problem is to stop Git from converting the line-ending characters, with the following command:
git config --global core.autocrlf input
If you see this message in the container logs, it means that the directory being used for the container's volume doesn't use a filesystem supported by IBM MQ. This often happens when using Docker Toolbox or boot2docker, which use tmpfs for the /var directory. To solve this, you need to make sure the container's /var/mqm volume is put on a supported filesystem. For example, with Docker Toolbox try using a directory under /mnt/sda1. You can list filesystem types using the command df -T
For issues relating specifically to this Docker image, please use the GitHub issue tracker. For more general issues relating to IBM MQ or to discuss the Docker technical preview, please use the messaging community. If you do submit a Pull Request related to this Docker image, please indicate in the Pull Request that you accept and agree to be bound by the terms of the IBM Contributor License Agreement.
The Dockerfile and associated scripts are licensed under the Apache License 2.0. IBM MQ Advanced for Developers is licensed under the IBM International License Agreement for Non-Warranted Programs. This license may be viewed from the image using the LICENSE=view environment variable as described above or may be found online. Note that this license does not permit further distribution.