summaryrefslogtreecommitdiffstats
path: root/ansible_collections/ngine_io/exoscale/README.md
blob: 824f6b779d90f591b9b7228a9655d6ad8a33a4c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
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.