Allow pool type to be 'logical', deprecate 'lvm2'

The correct type in libvirt is logical, and we should use the same name.

Author: markgoddard

README.md

@@ -15,15 +15,18 @@ 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 `lvm2` are supported.
+- `type` The type of the pool, currently only `dir` and `logical` 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)
 - `path` The absolute path to the pool's backing directory.
 - `mode` The access mode of the pool. N.B.: This should be specified as an
   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 `lvm2`)
-- `pvs` A list of physical volumes the volume group consists of. (only `lvm2`)
+- `source` The name of the volume group. (only when type is `logical`)
+- `pvs` A list of physical volumes the volume group consists of. (only when
+  type is `logical`)
 
 `libvirt_host_networks` is a list of networks to define and start. Each item
 should be a dict containing the following items:
@@ -100,7 +103,7 @@ Example Playbook
               owner: my-user
               group: my-group
             - name: lvm_pool
-              type: lvm2
+              type: logical
               source: vg1
               target: /dev/vg1
               pvs:

defaults/main.yml

@@ -2,7 +2,9 @@
 # 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', 'lvm2' or 'zfs' are supported.
+# type: The type of the pool, currently only 'dir', 'logical' or 'zfs' 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.
 # path: The absolute path to the pool's backing directory.
 # mode: The access mode of the pool.

tasks/pools.yml

@@ -10,11 +10,11 @@
   with_items: "{{ libvirt_host_pools }}"
   become: True
 
-- name: Ensure libvirt lvm2 storage pool directories exist
+- name: Ensure libvirt LVM storage pool directories exist
   lvg:
     vg: "{{ item.source }}"
     pvs: "{{ item.pvs }}"
-  when: item.type == "lvm2"
+  when: item.type in ["lvm2", "logical"]
   with_items: "{{ libvirt_host_pools }}"
   become: True
 
@@ -41,4 +41,4 @@
     autostart: yes
     uri: "{{ libvirt_host_uri | default(omit, true) }}"
   with_items: "{{ libvirt_host_pools }}"
-  become: True
+  become: True

templates/pool.xml.j2

@@ -7,10 +7,10 @@
   {% if 'capacity' in item %}
   <capacity>{{ item.capacity }}</capacity>
   {% endif %}
-  {% if item.type == 'lvm2' or item.type == 'zfs' %}
+  {% if item.type in ['logical', 'lvm2', 'zfs'] %}
   <source>
     <name>{{ item.source }}</name>
-    {% if item.type == 'lvm2' %}
+    {% if item.type in ['logical', 'lvm2'] %}
     <format type='lvm2'/>
     {% endif %}
   </source>