diff options
Diffstat (limited to 'collections-debian-merged/ansible_collections/ngine_io/vultr/README.md')
| -rw-r--r-- | collections-debian-merged/ansible_collections/ngine_io/vultr/README.md | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/collections-debian-merged/ansible_collections/ngine_io/vultr/README.md b/collections-debian-merged/ansible_collections/ngine_io/vultr/README.md new file mode 100644 index 00000000..be2e84b4 --- /dev/null +++ b/collections-debian-merged/ansible_collections/ngine_io/vultr/README.md @@ -0,0 +1,80 @@ + + [](https://codecov.io/gh/ngine-io/ansible-collection-vultr) +[](LICENSE) + +# Ansible Collection for Vultr Cloud + +This collection provides a series of Ansible modules and plugins for interacting with the [Vultr](https://www.vultr.com) Cloud. + +## Requirements + +- ansible version >= 2.9 + +## Installation + +To install the collection hosted in Galaxy: + +```bash +ansible-galaxy collection install ngine_io.vultr +``` + +To upgrade to the latest version of the collection: + +```bash +ansible-galaxy collection install ngine_io.vultr --force +``` + +## Usage + +### Playbooks + +To use a module from Vultr collection, please reference the full namespace, collection name, and modules name that you want to use: + +```yaml +--- +- name: Using Vultr collection + hosts: localhost + tasks: + - ngine_io.vultr.vultr_server: + ... +``` + +Or you can add full namepsace and collecton name in the `collections` element: + +```yaml +--- +- name: Using Vultr collection + hosts: localhost + collections: + - ngine_io.vultr + tasks: + - vultr_server: + ... +``` + +### Roles + +For existing Ansible roles, please also reference the full namespace, collection name, and modules name which used in tasks instead of just modules name. + +### Plugins + +To use a pluign, please reference the full namespace, collection name, and plugins name that you want to use: + +```yaml +plugin: ngine_io.vultr.vultr +``` + +## Contributing + +There are many ways in which you can participate in the project, for example: + +- Submit bugs and feature requests, and help us verify as they are checked in +- Review source code changes +- Review the documentation and make pull requests for anything from typos to new content +- If you are interested in fixing issues and contributing directly to the code base, please see the [CONTRIBUTING](CONTRIBUTING.md) document. + +## License + +GNU General Public License v3.0 + +See [COPYING](COPYING) to see the full text. |