community.rabbitmq Collection

This repo 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.

Tested with Ansible

TBD

External requirements

TBD

Supported connections

TBD

Included content

TBD

Using this collection

Before using the rabbitmq community collection, you need to install the collection with the ansible-galaxy CLI:

ansible-galaxy collection install community.rabbitmq

Alternatively, you can also 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

For more information regarding using collections with Ansible, see the Ansible user guide.

Contributing to this collection

While this community is still developing its guidelines, 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.

As a fallback, the Ansible Community Guide remains our community reference set of guidelines.

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.6

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

Publishing New Version

Basic instructions without release branches:

1. Create changelogs/fragments/<version>.yml with release_summary: section (which must be a string, not a list).
2. Run antsibull-changelog release --collection-flatmap yes
3. Make sure CHANGELOG.rst and changelogs/changelog.yaml are added to git, and the deleted fragments have been removed.
4. Tag the commit with <version>. Push changes and tag to the main repository.
5. Monitor the release job on the Zuul Status Dashboard.
6. Verify that the new version is available on Ansible Galaxy.

More Information

Communication

This is a small collection with a small number of contributors. As such, there is no formal Ansible Working Group. To communicate with the maintainers, please make contact via one of the following methods:

• IRC on irc.libera.chat in the #ansible-community channel
• Issues on Github

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.