summaryrefslogtreecommitdiff
path: root/README.md
blob: a6ddcc9afcbc4f955756ba48bc333e9ba2a60e0b (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
# Ansible Cloud: Volume role

An Ansible role for managing volumes on the Cloud in an agnostic cloud provider way.

This role is part of the [ansible-cloud](https://github.com/redhat-cip/ansible-cloud) broader effort.

## Pre-requisites

Please refer to [ansible-cloud](https://github.com/redhat-cip/ansible-cloud) [README.md](https://github.com/redhat-cip/ansible-cloud/blob/master/README.md) to see how to configure your system the proper way for the provide you wish to use.


## Role Variables

| Variable name               | Required  | Default | Type   | Description                     |
|-----------------------------|-----------|---------|--------|---------------------------------|
| cloud_volume_name           | True      | N/A     | String | Name of the volume              |
| cloud_volume_size           | True      | N/A     | Int    | Size of the volume              |
| cloud_volume_region         | True      | N/A     | String | Region when the volume is       |
| cloud_volume_state          | False     | present | String | Should the volume be present    |


## Example

```
---
- hosts: localhost
  vars:
    ansible_cloud_provider: openstack
  tasks:
    - name: Create volume
      include_role:
        name: cloud-volume
      vars:
        cloud_volume_name: ansiblecloud-testvolume
        cloud_volume_size: 20
        cloud_volume_region: nova
```


## License

Apache 2.0


## Authors Information

  - Ricardo Carrillo Cruz <ricarril@redhat.com>
  - Yanis Guenane <yguenane@redhat.com>