Merge pull request #169 from lae/feature/pbs-storage

Add Proxmox Backup Server storage type

Author: lae

README.md

@@ -545,8 +545,8 @@ Refer to `library/proxmox_role.py` [link][user-module] and
 
 You can use this role to manage storage within Proxmox VE (both in
 single server deployments and cluster deployments). For now, the only supported
-types are `dir`, `rbd`, `nfs`, `cephfs`, `lvm`,`lvmthin`, `zfspool` and `btrfs`.
-Here are some examples.
+types are `dir`, `rbd`, `nfs`, `cephfs`, `lvm`,`lvmthin`, `zfspool`, `btrfs`,
+and `pbs`. Here are some examples.
 
 ```
 pve_storages:
@@ -589,6 +589,13 @@ pve_storages:
       - 10.0.0.1
       - 10.0.0.2
       - 10.0.0.3
+  - name: pbs1
+    type: pbs
+    content: [ "backup" ]
+    server: 192.168.122.2
+    username: user@pbs
+    password: PBSPassword1
+    datastore: main
   - name: zfs1
     type: zfspool
     content: [ "images", "rootdir" ]

library/proxmox_storage.py

@@ -159,6 +159,17 @@
       - 10.0.0.1
       - 10.0.0.2
       - 10.0.0.3
+- name: Create a Proxmox Backup Server storage type
+  proxmox_storage:
+    name: pbs1
+    type: pbs
+    content: [ "backup" ]
+    server: 192.168.122.2
+    username: user@pbs
+    password: PBSPassword1
+    datastore: main
+    fingerprint: f2:fb:85:76:d2:2a:c4:96:5c:6e:d8:71:37:36:06:17:09:55:f7:04:e3:74:bb:aa:9e:26:85:92:63:c8:b9:23
+    encryption_key: autogen
 - name: Create a ZFS storage type
   proxmox_storage:
     name: zfs1
@@ -175,16 +186,26 @@
 from ansible.module_utils._text import to_text
 from ansible.module_utils.pvesh import ProxmoxShellError
 import ansible.module_utils.pvesh as pvesh
+import re
+import json
+from json import JSONDecodeError, loads as parse_json
+
 
 class ProxmoxStorage(object):
     def __init__(self, module):
         self.module = module
         self.name = module.params['name']
         self.state = module.params['state']
-        self.type = module.params['type']
+        # Globally applicable PVE API arguments
         self.disable = module.params['disable']
         self.content = module.params['content']
         self.nodes = module.params['nodes']
+        self.type = module.params['type']
+        # Remaining PVE API arguments (depending on type) past this point
+        self.datastore = module.params['datastore']
+        self.encryption_key = module.params['encryption_key']
+        self.fingerprint = module.params['fingerprint']
+        self.password = module.params['password']
         self.path = module.params['path']
         self.pool = module.params['pool']
         self.monhost = module.params['monhost']
@@ -199,6 +220,24 @@ def __init__(self, module):
         self.sparse = module.params['sparse']
         self.is_mountpoint = module.params['is_mountpoint']
 
+        # Validate the parameters given to us
+        fingerprint_re = re.compile('^([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}$')
+        if self.fingerprint is not None and not fingerprint_re.match(self.fingerprint):
+            self.module.fail_json(msg=(f"fingerprint must be of the format, "
+                                       f"{fingerprint_re.pattern}."))
+
+        if self.type == 'pbs':
+            if self.content != ['backup']:
+                self.module.fail_json(msg="PBS storage type only supports the "
+                                          "'backup' content type.")
+            try:
+                if self.encryption_key not in ["autogen", None]:
+                    parse_json(self.encryption_key)
+            except JSONDecodeError:
+                self.module.fail_json(msg=("encryption_key needs to be valid "
+                                           "JSON or set to 'autogen'."))
+
+        # Attempt to retrieve current/live storage definitions
         try:
             self.existing_storages = pvesh.get("storage")
         except ProxmoxShellError as e:
@@ -233,6 +272,16 @@ def prepare_storage_args(self):
             args['nodes'] = ','.join(self.nodes)
         if self.disable is not None:
             args['disable'] = 1 if self.disable else 0
+        if self.datastore is not None:
+            args['datastore'] = self.datastore
+        if self.encryption_key is not None:
+            args['encryption-key'] = self.encryption_key
+        if self.fingerprint is not None:
+            args['fingerprint'] = self.fingerprint
+        if self.master_pubkey is not None:
+            args['master-pubkey'] = self.master_pubkey
+        if self.password is not None:
+            args['password'] = self.password
         if self.path is not None:
             args['path'] = self.path
         if self.pool is not None:
@@ -329,13 +378,20 @@ def main():
     # Refer to https://pve.proxmox.com/pve-docs/api-viewer/index.html
     module_args = dict(
         name=dict(type='str', required=True, aliases=['storage', 'storageid']),
+        state=dict(default='present', choices=['present', 'absent'], type='str'),
+        # Globally applicable PVE API arguments
         content=dict(type='list', required=True, aliases=['storagetype']),
+        disable=dict(required=False, type='bool', default=False),
         nodes=dict(type='list', required=False, default=None),
         type=dict(default=None, type='str', required=True,
                   choices=["dir", "nfs", "rbd", "lvm", "lvmthin", "cephfs",
-                           "zfspool", "btrfs"]),
-        disable=dict(required=False, type='bool', default=False),
-        state=dict(default='present', choices=['present', 'absent'], type='str'),
+                           "zfspool", "btrfs", "pbs"]),
+        # Remaining PVE API arguments (depending on type) past this point
+        datastore=dict(default=None, type='str', required=False),
+        encryption_key=dict(default=None, type='str', required=False),
+        fingerprint=dict(default=None, type='str', required=False),
+        master_pubkey=dict(default=None, type='str', required=False),
+        password=dict(default=None, type='str', required=False),
         path=dict(default=None, required=False, type='str'),
         pool=dict(default=None, type='str', required=False),
         monhost=dict(default=None, type='list', required=False),
@@ -363,7 +419,11 @@ def main():
             ["type", "lvmthin", ["vgname", "thinpool", "content"]],
             ["type", "zfspool", ["pool", "content"]],
             ["type", "btrfs", ["path", "content"]],
-        ]
+            ["type", "pbs", ["server", "username", "password", "datastore"]]
+        ],
+        required_by={
+            "master_pubkey": "encryption_key"
+        }
     )
     storage = ProxmoxStorage(module)
 

tasks/main.yml

@@ -269,17 +269,23 @@
 - name: Configure Proxmox Storage
   proxmox_storage:
     name: "{{ item.name }}"
-    type: "{{ item.type }}"
-    disable: "{{ item.disable | default(False) }}"
-    path: "{{ item.path | default(omit) }}"
+    state: "{{ item.state | default('present') }}"
+    # Globally applicable PVE API arguments
     content: "{{ item.content | default([]) }}"
+    disable: "{{ item.disable | default(False) }}"
     nodes: "{{ item.nodes | default(omit) }}"
+    type: "{{ item.type }}"
+    # Remaining PVE API arguments (depending on type) past this point
+    datastore: "{{ item.datastore | default(omit) }}"
+    encryption_key: "{{ item.encryption_key | default(omit) }}"
+    fingerprint: "{{ item.fingerprint | default(omit) }}"
+    password: "{{ item.password | default(omit) }}"
+    path: "{{ item.path | default(omit) }}"
     username: "{{ item.username | default(omit) }}"
     pool: "{{ item.pool | default(omit) }}"
     monhost: "{{ item.monhost | default(omit) }}"
     maxfiles: "{{ item.maxfiles | default(omit) }}"
     krbd: "{{ item.krbd | default(omit) }}"
-    state: "{{ item.state | default('present') }}"
     server: "{{ item.server | default(omit) }}"
     export: "{{ item.export | default(omit) }}"
     options: "{{ item.options | default(omit) }}"