iktech/rabbitmq-user-setup repository overview

⁠RabbitMQ Configuration Utility

The RabbitMQ configuration utility is designed to help to configure users, virtual hosts and permissions in the controlled way for the RabbitMQ instance. It will apply the full content of the setup file to the designated instance of the RabbitMQ.

⁠Configuration

The configuration file must be in the YAML format, have name setup.yaml (or setup.yml) and be present in one of the following locations:

• /etc/rabbitmq/
• $HOME/.rabbitmq
• . (i.e. current directory)

The structure of the configuration file:

url: <rabbit_management_url> # could be overridden by the URL environment variable, default http://localhost:15672
admin:
  username: <admin_username>
  password: <admin_password>
users:
  - name: <username>
    password: <password>
    virtualHosts:
      - hostname: <virtual_host>
        permissions: <default_permissions>
        configurePermissions: <configure_permissions>
        readPermissions: <read_permissions>
        writePermissions: <write_permissions>
 ...

For each user, name and password are mandatory.

For each virtualHost, if hostname is omitted, we assume that the entry configures '/' root virtual host.

If permissions is defined, it is assumed default permissions for the virtual host in question. This means that if any of the configurePermissions, readPermissions, or writePermissions are omitted then tool uses permissions value to configure missing permission.

If permissions is omitted, then all three items configurePermissions, readPermissions and writePermissions must be present. Otherwise, tool exists with the error.