Merge pull request #36 from raspbeguy/rbd-volume-pool

RBD volume pool support

Author: markgoddard

README.md

@@ -15,7 +15,7 @@ Role Variables
 `libvirt_host_pools` is a list of pools to define and start. Each item
 should be a dict containing the following items:
 - `name` The name of the pool.
-- `type` The type of the pool, currently only `dir` and `logical` are
+- `type` The type of the pool, currently only `dir`, `logical` and `rbd` are
   supported. `lvm2` is supported as an alias for `logical`, but this alias is
   deprecated and will be removed in a future release.
 - `capacity`  The capacity, in bytes, of the pool. (optional)
@@ -24,9 +24,13 @@ should be a dict containing the following items:
   integer **without** a leading zero; for example: `mode: 755`. (only `dir`)
 - `owner` The owner of the pool. (only `dir`)
 - `group` The group of the pool. (only `dir`)
-- `source` The name of the volume group. (only when type is `logical`)
+- `source` The name of the volume group (when type is `logical`) or RBD pool
+  (when type is `rbd`).
 - `pvs` A list of physical volumes the volume group consists of. (only when
+- `hosts` The list of the Ceph monitors IPs or hostnames. (only `rbd`)
   type is `logical`)
+- `username` The username used for RADOS authentification. (only `rbd`)
+- `passphrase` The passphrase used for RADOS authentification. (only `rbd`)
 
 `libvirt_host_networks` is a list of networks to define and start. Each item
 should be a dict containing the following items:
@@ -108,6 +112,16 @@ Example Playbook
               target: /dev/vg1
               pvs:
                 - /dev/sda3
+	    - name: rbd-pool
+              type: rbd
+              source: rbd
+              hosts:
+                - 192.168.42.200
+                - 192.168.42.204
+                - 192.168.42.208
+              username: admin
+              passphrase: xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
           libvirt_host_networks:
             - name: br-example
               mode: bridge

tasks/install.yml

@@ -38,7 +38,7 @@
   package:
     name: "{{ package }}"
     state: present
-  with_items: "{{ libvirt_host_qemu_emulators }}"
+  loop: "{{ libvirt_host_qemu_emulators | flatten(levels=1) }}"
   # NOTE(mgoddard): CentOS 8 does not provide separate packages per-emulator.
   when: ansible_os_family != "RedHat" or ansible_distribution_major_version | int == 7
   register: result

tasks/networks.yml

@@ -8,18 +8,18 @@
   with_items: "{{ libvirt_host_networks }}"
   become: True
 
-- name: Ensure libvirt networks are active
+- name: Ensure libvirt networks are started on boot
   virt_net:
     name: "{{ item.name }}"
-    state: active
+    autostart: yes
     uri: "{{ libvirt_host_uri | default(omit, true) }}"
   with_items: "{{ libvirt_host_networks }}"
   become: True
 
-- name: Ensure libvirt networks are started on boot
+- name: Ensure libvirt networks are active
   virt_net:
     name: "{{ item.name }}"
-    autostart: yes
+    state: active
     uri: "{{ libvirt_host_uri | default(omit, true) }}"
   with_items: "{{ libvirt_host_networks }}"
   become: True

tasks/pools.yml

@@ -7,38 +7,45 @@
     mode: "{{ item.mode|int(base=8) }}"
     state: directory
   when: item.type == "dir"
-  with_items: "{{ libvirt_host_pools }}"
+  loop: "{{ libvirt_host_pools | flatten(levels=1) }}"
   become: True
 
 - name: Ensure libvirt LVM storage pool directories exist
   lvg:
     vg: "{{ item.source }}"
     pvs: "{{ item.pvs }}"
   when: item.type in ["lvm2", "logical"]
-  with_items: "{{ libvirt_host_pools }}"
+  loop: "{{ libvirt_host_pools | flatten(levels=1) }}"
   become: True
 
+- include_tasks:
+    file: rbd.yml
+    apply:
+      become: True
+  when: item.type == "rbd"
+  loop: "{{ libvirt_host_pools | flatten(levels=1) }}"
+
 - name: Ensure libvirt storage pools are defined
   virt_pool:
     name: "{{ item.name }}"
     command: define
     xml: "{{ item.xml | default(lookup('template', 'pool.xml.j2')) }}"
     uri: "{{ libvirt_host_uri | default(omit, true) }}"
-  with_items: "{{ libvirt_host_pools }}"
+  loop: "{{ libvirt_host_pools | flatten(levels=1) }}"
   become: True
 
 - name: Ensure libvirt storage pools are active
   virt_pool:
     name: "{{ item.name }}"
     state: active
     uri: "{{ libvirt_host_uri | default(omit, true) }}"
-  with_items: "{{ libvirt_host_pools }}"
+  loop: "{{ libvirt_host_pools | flatten(levels=1) }}"
   become: True
 
 - name: Ensure libvirt storage pools are started on boot
   virt_pool:
     name: "{{ item.name }}"
     autostart: yes
     uri: "{{ libvirt_host_uri | default(omit, true) }}"
-  with_items: "{{ libvirt_host_pools }}"
+  loop: "{{ libvirt_host_pools | flatten(levels=1) }}"
   become: True

tasks/rbd.yml

@@ -0,0 +1,34 @@
+---
+
+- name: Install additional packages for rbd support
+  package:
+    name: "{{ libvirt_host_packages_rbd_volume_pool | flatten(levels=1) }}"
+    state: present
+  notify: restart libvirt
+
+- name: Create temporary file for Ceph secret
+  tempfile:
+    state: file
+    suffix: .xml
+  register: secret_tempfile
+
+- name: Send Ceph secret
+  template:
+    src: ceph_secret.xml.j2
+    dest: "{{ secret_tempfile.path }}"
+
+- name: Define Ceph secret
+  command: "virsh secret-define {{ secret_tempfile.path }}"
+
+- name: Set Ceph secret value
+  command: "virsh secret-set-value {{ item.name | to_uuid }} {{ item.passphrase }}"
+
+- name: Delete temporary file
+  file:
+    path: "{{ secret_tempfile.path }}"
+    state: absent
+
+- name: Flush handlers
+  meta: flush_handlers
+
+

templates/ceph_secret.xml.j2

@@ -0,0 +1,7 @@
+<secret ephemeral='no' private='yes'>
+  <uuid>{{ item.name | to_uuid }}</uuid>
+  <description>{{ item.name }} pool secret</description>
+  <usage type='ceph'>
+    <name>{{ item.name }}</name>
+  </usage>
+</secret>

templates/pool.xml.j2

@@ -7,12 +7,20 @@
   {% if 'capacity' in item %}
   <capacity>{{ item.capacity }}</capacity>
   {% endif %}
-  {% if item.type in ['logical', 'lvm2', 'zfs'] %}
+  {% if item.type in ['logical', 'lvm2', 'zfs', 'rbd'] %}
   <source>
     <name>{{ item.source }}</name>
     {% if item.type in ['logical', 'lvm2'] %}
     <format type='lvm2'/>
     {% endif %}
+    {% if item.type == 'rbd' %}
+    {% for host in item.hosts %}
+    <host name='{{ host }}' />
+    {% endfor %}
+    <auth type='ceph' username='{{ item.username }}'>
+      <secret usage='{{ item.name }}'/>
+    </auth>
+    {% endif %}
   </source>
   {% endif %}
   {% if item.type != 'zfs' %}

vars/Archlinux.yml

@@ -18,5 +18,10 @@ libvirt_host_libvirt_packages: >
      (libvirt_host_packages_efi if libvirt_host_enable_efi_support else []) | unique
   }}
 
+# Packages for RBD volume pool support
+libvirt_host_packages_rbd_volume_pool:
+  - libvirt-storage-rbd
+  - qemu-block-rbd
+
 # These are passed to the lineinfile module to customize configuration files
 libvirt_host_lineinfile_extra_rules: []

vars/Debian.yml

@@ -26,5 +26,10 @@ libvirt_host_libvirt_packages: >
      (libvirt_host_packages_efi if libvirt_host_enable_efi_support else []) | unique
   }}
 
+# Packages for RBD volume pool support
+libvirt_host_packages_rbd_volume_pool:
+  - libvirt-daemon-driver-storage-rbd
+  - qemu-block-extra
+
 # These are passed to the lineinfile module to customize configuration files
 libvirt_host_lineinfile_extra_rules: []

vars/RedHat.yml

@@ -18,6 +18,11 @@ libvirt_host_libvirt_packages: >
      (libvirt_host_packages_efi if libvirt_host_enable_efi_support else []) | unique
   }}
 
+# Packages for RBD volume pool support
+libvirt_host_packages_rbd_volume_pool:
+  - libvirt-daemon-driver-storage-rbd
+  - qemu-kvm-block-rbd
+
 libvirt_host_custom_yum_repos_efi:
   # Add custom repository as OVMF package seems to be broken
   - name: qemu-firmware-jenkins