summaryrefslogtreecommitdiffstats
path: root/ansible_collections/ngine_io/exoscale/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:04:41 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:04:41 +0000
commit975f66f2eebe9dadba04f275774d4ab83f74cf25 (patch)
tree89bd26a93aaae6a25749145b7e4bca4a1e75b2be /ansible_collections/ngine_io/exoscale/README.md
parentInitial commit. (diff)
downloadansible-975f66f2eebe9dadba04f275774d4ab83f74cf25.tar.xz
ansible-975f66f2eebe9dadba04f275774d4ab83f74cf25.zip
Adding upstream version 7.7.0+dfsg.upstream/7.7.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/ngine_io/exoscale/README.md')
-rw-r--r--ansible_collections/ngine_io/exoscale/README.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/ansible_collections/ngine_io/exoscale/README.md b/ansible_collections/ngine_io/exoscale/README.md
new file mode 100644
index 000000000..824f6b779
--- /dev/null
+++ b/ansible_collections/ngine_io/exoscale/README.md
@@ -0,0 +1,72 @@
+![Collection integration](https://github.com/ngine-io/ansible-collection-exoscale/workflows/Collection%20integration/badge.svg)
+ [![Codecov](https://img.shields.io/codecov/c/github/ngine-io/ansible-collection-exoscale)](https://codecov.io/gh/ngine-io/ansible-collection-exoscale)
+[![License](https://img.shields.io/badge/license-GPL%20v3.0-brightgreen.svg)](LICENSE)
+
+# Ansible Collection for exoscale Cloud
+
+This collection provides a series of Ansible modules and plugins for interacting with the [exoscale](https://www.exoscale.com) Cloud.
+
+## Requirements
+
+- ansible version >= 2.9
+
+## Installation
+
+To install the collection hosted in Galaxy:
+
+```bash
+ansible-galaxy collection install ngine_io.exoscale
+```
+
+To upgrade to the latest version of the collection:
+
+```bash
+ansible-galaxy collection install ngine_io.exoscale --force
+```
+
+## Usage
+
+### Playbooks
+
+To use a module from exoscale collection, please reference the full namespace, collection name, and modules name that you want to use:
+
+```yaml
+---
+- name: Using exoscale collection
+ hosts: localhost
+ tasks:
+ - ngine_io.exoscale.<module>:
+ ...
+```
+
+Or you can add full namepsace and collecton name in the `collections` element:
+
+```yaml
+---
+- name: Using exoscale collection
+ hosts: localhost
+ collections:
+ - ngine_io.exoscale
+ tasks:
+ - <module>:
+ ...
+```
+
+### 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.
+
+## 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.