community.rabbitmq Collection

This repository hosts the community.rabbitmq Ansible Collection.

The collection includes the rabbitmq modules and plugins supported by Ansible rabbitmq community to help the management of rabbitmq infrastructure.

This collection is a part of the Ansible package.

Community standards

This project follows:

• The Ansible Code of Conduct in all interactions within this project. If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.
• The Ansible Community Policy for AI-Assisted Contributions.

Communication

• Join the Ansible forum:

  • Get Help: get help or help others. Please add appropriate tags if you start new discussions, for example the rabbitmq tag.
  • Posts tagged with 'rabbitmq': subscribe to participate in collection-related conversations.
  • Social Spaces: gather and interact with fellow enthusiasts.
  • News & Announcements: track project-wide announcements including social events.

• The Ansible Bullhorn newsletter: used to announce releases and important changes.

For more information about communication, see the Ansible communication guide.

Tested with Ansible

• 2.16
• 2.17
• 2.18
• 2.19
• 2.20
• 2.21
• devel

External requirements

• python >= 2.7

Some plugins require additional python libraries:

• rabbitmq: Requires pika

Some modules require additional system tools:

• rabbitmq_binding: Requires requests
• rabbitmq_exchange: Requires requests
• rabbitmq_policy: Requires requests
• rabbitmq_publish: Requires pika
• rabbitmq_queue: Requires requests
• rabbitmq_user: Requires requests
• rabbitmq_vhost: Requires requests

Included content

• Modules:

  • rabbitmq_binding: Manage rabbitMQ bindings.
  • rabbitmq_exchange: Manage rabbitMQ exchanges.
  • rabbitmq_feature_flag: Enables feature flag.
  • rabbitmq_global_parameter: Manage RabbitMQ global parameters.
  • rabbitmq_parameter: Manage RabbitMQ parameters.
  • rabbitmq_plugin: Manage RabbitMQ plugins.
  • rabbitmq_policy: Manage the state of policies in RabbitMQ.
  • rabbitmq_publish: Publish a message to a RabbitMQ queue.
  • rabbitmq_queue: Manage rabbitMQ queues.
  • rabbitmq_upgrade: Execute rabbitmq-upgrade commands.
  • rabbitmq_user_limits: Manage RabbitMQ user limits.
  • rabbitmq_user: Manage RabbitMQ users.
  • rabbitmq_vhost_limits: Manage the state of virtual host limits in RabbitMQ.
  • rabbitmq_vhost: Manage the state of a virtual host in RabbitMQ.

• Lookup:

  • rabbitmq: Retrieve messages from an AMQP/AMQPS RabbitMQ queue.

Using this collection

Installing the Collection from Ansible Galaxy

Before using the collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install community.rabbitmq

You can include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: community.rabbitmq

You can also download the tarball from Ansible Galaxy and install the collection manually wherever you need.

Note that if you install the collection from Ansible Galaxy with the command-line tool or tarball, it will not be upgraded automatically when you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install community.rabbitmq --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax:

ansible-galaxy collection install community.rabbitmq:==X.Y.Z

See Ansible Using collections for more details.

Contributing to this collection

The content of this collection is made by people just like you, a community of individuals collaborating on making the world better through developing automation software.

We are actively accepting new contributors.

All types of contributions are very welcome.

You don't know how to start? Refer to our contribution guide!

The aspiration is to follow the following general guidelines:

• Changes should include tests and documentation where appropriate.
• Changes will be lint tested using standard python lint tests.
• No changes which do not pass CI testing will be approved/merged.
• The collection plugins must provide the same coverage of python support as the versions of Ansible supported.
• The versions of Ansible supported by the collection must be the same as those in developed, or those maintained, as shown in the Ansible Release and Maintenance documentation.

We use the following guidelines:

• CONTRIBUTING.md
• Ansible Community Guide
• Ansible Development Guide
• Ansible Collection Development Guide

Local Testing

• Requirements

  • Python 3.5+
  • pip
  • virtualenv or pipenv if you prefer.
  • git
  • docker

• Useful Links

  • Pip & Virtual Environments
  • Ansible Integration Tests

Local testing is done with the ansible-test tool which requires a specific directory hierarchy to function correctly so please follow carefully.

# These base directory environment variables can be adjusted to suit personal preferences
SRC_BASE_DIR="~/code"
VENV_BASE_DIR="~/.venvs"

# These should not be altered
COLL_DIR="${SRC_BASE_DIR}/ansible/ansible_collections/community/rabbitmq"
VENV_DIR="${VENV_BASE_DIR}/ansible"

# Create the required directory structure
mkdir -p $(basename ${COLL_DIR})

# Clone the collection repository
git clone https://github.com/ansible-collections/community.rabbitmq.git ${COLL_DIR}

# Create and activate a virtual environment.
virtualenv ${VENV_DIR}
source ${VENV_DIR}/bin/activate

# Install the devel branch of ansible-base
pip install https://github.com/ansible/ansible/archive/devel.tar.gz --disable-pip-version-check

# Switch into the collection directory
cd ${COLL_DIR}

# Run the integration tests
ansible-test integration --docker default -v --color --python 3.13

# Run the unit tests
ansible-test units --docker default -v --color --python 3.13

Collection maintenance

The current maintainers (contributors with write or higher access) are listed in the MAINTAINERS file. If you have questions or need help, feel free to mention them in the proposals.

To learn how to maintain / become a maintainer of this collection, refer to the Maintainer guidelines.

It is necessary for maintainers of this collection to be subscribed to:

• The collection itself (the Watch button -> All Activity in the upper right corner of the repository's homepage).
• The "Changes Impacting Collection Contributors and Maintainers" issue.

They also should be subscribed to Ansible's The Bullhorn newsletter.

Publishing New Version

See the Releasing guidelines.

Supported connections

TBD

More Information

Reference

• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

License

GNU General Public License v3.0 or later.

See LICENCE to see the full text.