gluster.gluster.gluster_volume – Manage GlusterFS volumes

Note

This plugin 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	Choices/Defaults	Comments
arbiters integer		Arbiter count for volume.
bricks string		Brick paths on servers. Multiple brick paths can be separated by commas. aliases: brick
cluster list / elements=string		List of hosts to use for probing and brick setup.
directory string		Directory for limit-usage.
disperses integer		Disperse count for volume.
force boolean	Choices: no yes	If brick is being created in the root partition, module will fail. Set force to true to override this behaviour.
host string		Override local hostname (for peer probing purposes).
name string / required		The volume name. aliases: volume
options dictionary		A dictionary/hash with options/settings for the volume.
quota string		Quota value for limit-usage (be sure to use 10.0MB instead of 10MB, see quota list).
rebalance boolean	Choices: no ← yes	Controls whether the cluster is rebalanced after changes.
redundancies integer		Redundancy count for volume.
replicas integer		Replica count for volume.
start_on_create boolean	Choices: no yes ←	Controls whether the volume is started after creation or not.
state string / required	Choices: absent present started stopped	Use present/absent ensure if a volume exists or not. Use started/stopped to control its availability.
stripes integer		Stripe count for volume.
transport string	Choices: tcp ← rdma tcp,rdma	Transport type for volume.

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

Authors

Taneli Leppä (@rosmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/gluster/gluster/gluster_volume_module.html

Docs

Docs4dev

Title here