gluster.gluster.gluster_volume module – Manage GlusterFS volumes
Note
This module is part of the gluster.gluster collection (version 1.0.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install gluster.gluster
.
To use it in a playbook, specify: gluster.gluster.gluster_volume
.
Synopsis
Create, remove, start, stop and tune GlusterFS volumes
Parameters
Parameter |
Comments |
---|---|
Arbiter count for volume. |
|
Brick paths on servers. Multiple brick paths can be separated by commas. |
|
List of hosts to use for probing and brick setup. |
|
Directory for limit-usage. |
|
Disperse count for volume. |
|
If brick is being created in the root partition, module will fail. Set force to true to override this behaviour. Choices:
|
|
Override local hostname (for peer probing purposes). |
|
The volume name. |
|
A dictionary/hash with options/settings for the volume. |
|
Quota value for limit-usage (be sure to use 10.0MB instead of 10MB, see quota list). |
|
Controls whether the cluster is rebalanced after changes. Choices:
|
|
Redundancy count for volume. |
|
Replica count for volume. |
|
Controls whether the volume is started after creation or not. Choices:
|
|
Use present/absent ensure if a volume exists or not. Use started/stopped to control its availability. Choices:
|
|
Stripe count for volume. |
|
Transport type for volume. Choices:
|
Notes
Note
Requires cli tools for GlusterFS on servers.
Will add new bricks, but not remove them.
Examples
- name: create gluster volume
gluster.gluster.gluster_volume:
state: present
name: test1
bricks: /bricks/brick1/g1
rebalance: yes
cluster:
- 192.0.2.10
- 192.0.2.11
run_once: true
- name: tune
gluster.gluster.gluster_volume:
state: present
name: test1
options:
performance.cache-size: 256MB
- name: Set multiple options on GlusterFS volume
gluster.gluster.gluster_volume:
state: present
name: test1
options:
{ performance.cache-size: 128MB,
write-behind: 'off',
quick-read: 'on'
}
- name: start gluster volume
gluster.gluster.gluster_volume:
state: started
name: test1
- name: limit usage
gluster.gluster.gluster_volume:
state: present
name: test1
directory: /foo
quota: 20.0MB
- name: stop gluster volume
gluster.gluster.gluster_volume:
state: stopped
name: test1
- name: remove gluster volume
gluster.gluster.gluster_volume:
state: absent
name: test1
- name: create gluster volume with multiple bricks
gluster.gluster.gluster_volume:
state: present
name: test2
bricks: /bricks/brick1/g2,/bricks/brick2/g2
cluster:
- 192.0.2.10
- 192.0.2.11
run_once: true
- name: Remove the bricks from gluster volume
gluster.gluster.gluster_volume:
state: present
name: testvol
bricks: /bricks/brick1/b1,/bricks/brick2/b2
cluster:
- 10.70.42.85
force: true
run_once: true
- name: Reduce cluster configuration
gluster.gluster.gluster_volume:
state: present
name: testvol
bricks: /bricks/brick3/b1,/bricks/brick4/b2
replicas: 2
cluster:
- 10.70.42.85
force: true
run_once: true