Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sbesson/idr.openstack


https://github.com/sbesson/idr.openstack

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README 

        
# collection_template

You can build a new repository for an Ansible Collection using this template by following [Creating a repository from a template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/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.



# Foo Collection for Ansible



[![CI](https://github.com/ansible-collections/REPONAMEHERE/workflows/CI/badge.svg?event=push)](https://github.com/ansible-collections/REPONAMEHERE/actions) [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/REPONAMEHERE)](https://codecov.io/gh/ansible-collections/REPONAMEHERE)



## Code of Conduct



We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project.



If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint.



## Communication



We announce releases and important changes through Ansible's [The Bullhorn newsletter](https://github.com/ansible/community/wiki/News#the-bullhorn). Be sure you are [subscribed](https://eepurl.com/gZmiEP).



Join us in the `#ansible` (general use questions and support), `#ansible-community` (community and collection development questions), and other [IRC channels](https://docs.ansible.com/ansible/devel/community/communication.html#irc-channels).



We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://eepurl.com/gZmiEP) and join us.



For more information about communication, refer to the [Ansible Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).



## Contributing to this collection



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.



Any kind of contribution is very welcome.



You don't know how to start? Refer to our [contribution guide](CONTRIBUTING.md)!



We use the following guidelines:



* [CONTRIBUTING.md](CONTRIBUTING.md)

* [REVIEW_CHECKLIST.md](REVIEW_CHECKLIST.md)

* [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html)

* [Ansible Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)

* [Ansible Collection Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections)



## Collection maintenance



The current maintainers are listed in the [MAINTAINERS](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](MAINTAINING.md).



## Governance



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!



## Tested with Ansible



## External requirements



### Supported connections



## Included content



## Using this collection



### Installing the Collection from Ansible Galaxy



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

```bash

ansible-galaxy collection install NAMESPACE.COLLECTION_NAME

```



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

```yaml

---

collections:

  - name: NAMESPACE.COLLECTION_NAME

```



Note 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:

```bash

ansible-galaxy collection install NAMESPACE.COLLECTION_NAME --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 to install version `0.1.0`:



```bash

ansible-galaxy collection install NAMESPACE.COLLECTION_NAME:==0.1.0

```



See [Ansible Using collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details.



## Release notes



See the [changelog](https://github.com/ansible-collections/REPONAMEHERE/tree/main/CHANGELOG.rst).



## Roadmap



## More information



- [Ansible Collection overview](https://github.com/ansible-collections/overview)

- [Ansible User guide](https://docs.ansible.com/ansible/devel/user_guide/index.html)

- [Ansible Developer guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)

- [Ansible Collections Checklist](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst)

- [Ansible Community code of conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html)

- [The Bullhorn (the Ansible Contributor newsletter)](https://us19.campaign-archive.com/home/?u=56d874e027110e35dea0e03c1&id=d6635f5420)

- [News for Maintainers](https://github.com/ansible-collections/news-for-maintainers)



## Licensing



GNU General Public License v3.0 or later.



See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.