Skip to content

Latest commit

 

History

History
154 lines (121 loc) · 7.58 KB

README.md

File metadata and controls

154 lines (121 loc) · 7.58 KB
Raw

Ansible Role jm1.cloudy.libvirt_volumes

This role helps with managing libvirt volumes from Ansible variables. For example, it allows to create volume snapshots from existing volumes within the same libvirt storage pool with variable libvirt_volumes. This variable is defined as a list where each list item is a dictionary of parameters that will be passed to module jm1.libvirt.volume or jm1.libvirt.volume_snapshot from collection jm1.libvirt 1. For example, to create a snapshot of an existing Debian cloud image debian-11-genericcloud-amd64.qcow2 in storage pool default of the local libvirt daemon (run by current Ansible user on the Ansible controller), define variable libvirt_volumes in group_vars or host_vars as such:

libvirt_volumes:
- backing_vol: 'debian-11-genericcloud-amd64.qcow2'
  backing_vol_format: 'qcow2'
  capacity: 5G
  format: 'qcow2'
  linked: false
  name: '{{ inventory_hostname }}.qcow2'
  pool: 'default'
  prealloc_metadata: false
  state: present

# libvirt connection uri
# Ref.: https://libvirt.org/uri.html
libvirt_uri: 'qemu:///session'

Use role jm1.cloudy.libvirt_pools to create libvirt storage pool default as shown in the introduction of that role.

Use role jm1.cloudy.libvirt_images to fetch the cloud image of Debian 11 (Bullseye) and add it as a volume debian-11-genericcloud-amd64.qcow2 to storage pool default as shown in the introduction of that role.

Once all previous roles have finished, execute this role jm1.cloudy.libvirt_volumes. It will pass each item of the libvirt_volumes list one after another as parameters to module jm1.libvirt.volume_snapshot from collection jm1.libvirt 1. If a libvirt volume with the same name already exists, it will not be changed.

Tested OS images

Available on Ansible Galaxy in Collection jm1.cloudy.

Requirements

This role uses module(s) from collections community.libvirt and jm1.libvirt. To install these collections you may follow the steps described in README.md using the provided requirements.yml.

Variables

Name Default value Required Description
libvirt_volumes [] false List of parameter dictionaries for module jm1.libvirt.volume or jm1.libvirt.volume_snapshot from collection jm1.libvirt 1
libvirt_uri qemu:///system false libvirt connection uri

Dependencies

None.

Example Playbook

Use role jm1.cloudy.libvirt_pools to create a libvirt storage pool with name default as shown in the introduction of that role.

Use role jm1.cloudy.libvirt_images to fetch the cloud image of Debian 11 (Bullseye) and add it as a volume debian-11-genericcloud-amd64.qcow2 to storage pool default as shown in the introduction of that role.

- hosts: all
  # do not become root because connection is local
  connection: local # Assign libvirt_uri to setup a connection to the libvirt host
  vars:
    # Variables are listed here for convenience and illustration.
    # In a production setup, variables would be defined e.g. in
    # group_vars and/or host_vars of an Ansible inventory.
    # Ref.:
    # https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html
    # https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html

    libvirt_volumes:
    - backing_vol: 'debian-11-genericcloud-amd64.qcow2'
      backing_vol_format: 'qcow2'
      capacity: 5G
      format: 'qcow2'
      linked: false
      name: '{{ inventory_hostname }}.qcow2'
      pool: 'default'
      prealloc_metadata: false
      state: present

    # libvirt connection uri
    # Ref.: https://libvirt.org/uri.html
    libvirt_uri: 'qemu:///session'

  roles:
  - name: Setup libvirt block storage volumes
    role: jm1.cloudy.libvirt_volumes
    tags: ["jm1.cloudy.libvirt_volumes"]

For more examples on how to use this role, refer to variable libvirt_volumes as defined in group_vars/lvrt.yml and host_vars from the provided examples inventory. The top-level README.md describes how the listed hosts can be provisioned with playbook playbooks/site.yml.

For instructions on how to run Ansible playbooks have look at Ansible's Getting Started Guide.

License

GNU General Public License v3.0 or later

See LICENSE.md to see the full text.

Author

Jakob Meng @jm1 (github, galaxy, web)

Footnotes

  1. If key backing_vol is NOT present in a list item, then the item, i.e. its key-value pairs, is passed to module jm1.libvirt.volume else it is passed to module jm1.libvirt.volume_snapshot. If a list item does not contain key uri then it will be initialized from Ansible variables libvirt_uri. ↩ ↩2 ↩3