You can build a new repository for an Ansible Collection using this template by following Creating a repository from a template. This README.md contains recommended headings for your collection README.md, with comments describing what each section should contain. Once you have created your collection repository, delete this paragraph and the title above it from your README.md.
We follow the Ansible Code of Conduct in all our 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.
We announce important development changes and releases through Ansible's The Bullhorn newsletter. If you are a collection developer, be sure you are subscribed.
Join us on:
- The Ansible forum:
- Matrix chat rooms:
- #users:ansible.com: general use questions and support
- #community:ansible.com: community and collection development questions
- #social:ansible.com: to say "Good morning, community!"
We take part in the global 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.
The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.
We are actively accepting new contributors and all types of contributions are very welcome.
Don't know how to start? Refer to the Ansible community guide!
Want to submit code changes? Take a look at the Quick-start development guide.
We also use the following guidelines:
The current maintainers 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
Watchbutton ->All Activityin the upper right corner of the repository's homepage). - The news-for-maintainers repository.
They also should be subscribed to Ansible's The Bullhorn newsletter.
The process of decision making in this collection is based on discussing and finding consensus among participants.
Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!
Before using this collection, you need to install it with the Ansible Galaxy command-line tool:
ansible-galaxy collection install NAMESPACE.COLLECTION_NAMEYou can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:
---
collections:
- name: NAMESPACE.COLLECTION_NAMENote that if you install the collection from Ansible Galaxy, 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 NAMESPACE.COLLECTION_NAME --upgradeYou 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 to install version 0.1.0:
ansible-galaxy collection install NAMESPACE.COLLECTION_NAME:==0.1.0See using Ansible collections for more details.
See the changelog.
- Ansible user guide
- Ansible developer guide
- Ansible collections requirements
- Ansible community Code of Conduct
- The Bullhorn (the Ansible contributor newsletter)
- Important announcements for maintainers
GNU General Public License v3.0 or later.
See LICENSE to see the full text.