How to add initial users when starting a RabbitMQ

Question

Currently i am starting RabbitMQ Docker container using the default RabbitMQ image from DockerHub. Using the following commands.

docker run --restart=always \
-d \
-e RABBITMQ_NODENAME=rabbitmq \
-v /opt/docker/rabbitmq/data:/var/lib/rabbitmq/mnesia/rabbitmq \
-p 5672:5672 \
-p 15672:15672 \
--name rabbitmq rabbitmq:3-management

I have a need where i want to provide defaults users / and virtual-hosts when the image is first started. For example to create a default 'test-user'.

Currently i have to do that manually by using the management plugin and adding the users / virtual-hosts via the web ui. Is there a way i can provide default settings when starting the RabbitMQ image?

Answer 1

Came up with a solution that suits my needs, leaving it here in case anybody else needs it.

Summary

The idea is to take a standard rabbitmq container with management plugin enabled and use it to create the required configuration, then export and use it to start new containers. The below solution creates a derived docker image but it also works to just mount the two files at runtime (e.g. using docker compose).

References

• the info I started from
• complete rabbitmq.config example

Components

• official rabbitmq image, management plugin version (rabbitmq:management)

• custom image based on the original one, with this Dockerfile (using version 3.6.6):

  FROM rabbitmq:3.6.6-management
  ADD rabbitmq.config /etc/rabbitmq/
  ADD definitions.json /etc/rabbitmq/
  RUN chown rabbitmq:rabbitmq /etc/rabbitmq/rabbitmq.config /etc/rabbitmq/definitions.json
  CMD ["rabbitmq-server"]
  

• rabbitmq.config just tells rabbitmq to load definitions from the json file
• definitions.json contains the users, vhosts, etc. and can be generated by the export function of the management web interface

rabbitmq.config example:

[
  {rabbit, [
    {loopback_users, []}
  ]},
  {rabbitmq_management, [
    {load_definitions, "/etc/rabbitmq/definitions.json"}
  ]}
].

definitions.json example:

{
 "rabbit_version": "3.6.6",
 "users": [
  {
   "name": "user1",
   "password_hash": "pass1",
   "hashing_algorithm": "rabbit_password_hashing_sha256",
   "tags": ""
  },
  {
   "name": "adminuser",
   "password_hash": "adminpass",
   "hashing_algorithm": "rabbit_password_hashing_sha256",
   "tags": "administrator"
  }
 ],
 "vhosts": [
  {
   "name": "\/vhost1"
  },
  {
   "name": "\/vhost2"
  }
 ],
 "permissions": [
  {
   "user": "user1",
   "vhost": "\/vhost1",
   "configure": ".*",
   "write": ".*",
   "read": ".*"
  }
 ],
 "parameters": [],
 "policies": [],
 "queues": [],
 "exchanges": [],
 "bindings": []
}

Alternave version

Deriving a new docker image is just one solution and works best when portability is key, since it avoids including host-based file management in the picture.

In some situations using the official image and providing configuration files from storage local to the host might be preferred.

The rabbitmq.config and definitions.json files are produced the same way, then mounted at runtime.

Notes:

• I'm assuming they have been placed in /etc/so/ for the sake of these examples
• files need to either be world readable or owned by the rabbitmq user or group (numerical id inside the docker container is 999), this needs to be handled by the host's sysadmin

docker run example:

    docker run --rm -it \
        -v /etc/so/rabbitmq.config:/etc/rabbitmq/rabbitmq.config:ro \
        -v /etc/so/definitions.json:/etc/rabbitmq/definitions.json:ro \
        rabbitmq:3.6-management

docker compose example:

    version: '2.1'
    services:
        rabbitmq:
            image: "rabbitmq:3.6-management"
            ports:
                - 5672:5672
                - 15672:15672
            volumes:
                - /etc/so/rabbitmq.config:/etc/rabbitmq/rabbitmq.config:ro
                - /etc/so/definitions.json:/etc/rabbitmq/definitions.json:ro

Answer 2

In my case sleep 5 solution above did not work because RabbitMQ startup time was much longer and not predictable. Posting solution which waits until RabbitMQ is up and running:

• Dockerfile

  FROM rabbitmq:3-management
  ADD init.sh /
  ADD config_rabbit.sh /
  RUN chmod +x /init.sh /config_rabbit.sh
  ENTRYPOINT ["/init.sh"]
  

• init.sh

  #!/bin/bash
  
  # Launch config script in background
  # Note there is no RabbitMQ Docker image support for executing commands after server (PID 1) is running (something like "ADD schema.sql /docker-entrypoint-initdb.d" in MySql image), so we are using this trick
  /config_rabbit.sh &
  
  # Launch
  /docker-entrypoint.sh rabbitmq-server
  

• config_rabbit.sh

  #!/bin/bash
  
  # This script needs to be executed just once
  if [ -f /$0.completed ] ; then
    echo "$0 `date` /$0.completed found, skipping run"
    exit 0
  fi
  
  # Wait for RabbitMQ startup
  for (( ; ; )) ; do
    sleep 5
    rabbitmqctl -q node_health_check > /dev/null 2>&1
    if [ $? -eq 0 ] ; then
      echo "$0 `date` rabbitmq is now running"
      break
    else
      echo "$0 `date` waiting for rabbitmq startup"
    fi
  done
  
  # Execute RabbitMQ config commands here
  
  # Create user
  rabbitmqctl add_user USER PASSWORD
  rabbitmqctl set_permissions -p / USER ".*" ".*" ".*"
  echo "$0 `date` user USER created"
  
  # Create queue
  rabbitmqadmin declare queue name=QUEUE durable=true
  echo "$0 `date` queues created"
  
  # Create mark so script is not ran again
  touch /$0.completed