Git Product home page Git Product logo

community.rabbitmq's Introduction

community.rabbitmq Collection

Build Status

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.

Code of Conduct

We follow the Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior violating the Ansible Code of Conduct, please refer to the policy violations section of the Code of Conduct for information on how to raise a complaint.

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:

Local Testing

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

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.

Tested with Ansible

TBD

External requirements

TBD

Supported connections

TBD

More Information

Communication

To communicate, we use:

We announce important development changes and releases through Ansible's The Bullhorn newsletter. If you are a collection developer, be sure you are subscribed.

We take part in the global quarterly Ansible Contributor Summit virtually or in-person. Track The Bullhorn newsletter and join us.

For more information about communication, refer to the Ansible Communication guide.

Reference

License

GNU General Public License v3.0 or later.

See LICENCE to see the full text.

community.rabbitmq's People

Contributors

abompard avatar aitorpazos avatar akasurde avatar andersson007 avatar chandlerswift avatar cognifloyd avatar csmart avatar damiandabrowski5 avatar duttaani avatar flora-five avatar gotmax23 avatar gundalow avatar mjrider avatar nazunalika avatar odyssey4me avatar rolt avatar samdoran avatar shadow6363 avatar tchernomax avatar thetrompf avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.