library: add ec_profile module

This commit adds a new module `ceph_ec_profile` to manage erasure code
profiles.

Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>

library/ceph_ec_profile.py

@@ -0,0 +1,246 @@
+# Copyright 2020, Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+from ansible.module_utils.basic import AnsibleModule
+try:
+    from ansible.module_utils.ca_common import is_containerized, \
+                                               generate_ceph_cmd, \
+                                               exec_command, \
+                                               exit_module
+except ImportError:
+    from module_utils.ca_common import is_containerized, \
+                                            generate_ceph_cmd, \
+                                            exec_command, \
+                                            exit_module
+import datetime
+import json
+
+
+ANSIBLE_METADATA = {
+    'metadata_version': '1.1',
+    'status': ['preview'],
+    'supported_by': 'community'
+}
+
+DOCUMENTATION = '''
+---
+module: ceph_ec_profile
+
+short_description: Manage Ceph Erasure Code profile
+
+version_added: "2.8"
+
+description:
+    - Manage Ceph Erasure Code profile
+options:
+    cluster:
+        description:
+            - The ceph cluster name.
+        required: false
+        default: ceph
+    name:
+        description:
+            - name of the profile.
+        required: true
+    state:
+        description:
+            If 'present' is used, the module creates a profile.
+            If 'absent' is used, the module will delete the profile.
+        required: false
+        choices: ['present', 'absent', 'info']
+        default: present
+    stripe_unit:
+        description:
+            - The amount of data in a data chunk, per stripe.
+        required: false
+    k:
+        description:
+            - Number of data-chunks the object will be split in
+        required: true
+    m:
+        description:
+            - Compute coding chunks for each object and store them on different
+              OSDs.
+        required: true
+    crush_root:
+        description:
+            - The name of the crush bucket used for the first step of the CRUSH
+              rule.
+        required: false
+    crush_device_class:
+        description:
+            - Restrict placement to devices of a specific class (hdd/ssd)
+        required: false
+
+author:
+    - Guillaume Abrioux <gabrioux@redhat.com>
+'''
+
+EXAMPLES = '''
+- name: create an erasure code profile
+  ceph_ec_profile:
+    name: foo
+    k: 4
+    m: 2
+
+- name: delete an erassure code profile
+  ceph_ec_profile:
+    name: foo
+    state: absent
+'''
+
+RETURN = '''#  '''
+
+
+def get_profile(module, name, cluster='ceph', container_image=None):
+    '''
+    Get existing profile
+    '''
+
+    args = ['get', name, '--format=json']
+
+    cmd = generate_ceph_cmd(cluster=cluster,
+                            sub_cmd=['osd', 'erasure-code-profile'],
+                            args=args,
+                            container_image=container_image)
+
+    return cmd
+
+
+def create_profile(module, name, k, m, stripe_unit, cluster='ceph', force=False, container_image=None):
+    '''
+    Create a profile
+    '''
+
+    args = ['set', name, 'k={}'.format(k), 'm={}'.format(m)]
+    if stripe_unit:
+        args.append('stripe_unit={}'.format(stripe_unit))
+    if force:
+        args.append('--force')
+
+    cmd = generate_ceph_cmd(cluster=cluster,
+                            sub_cmd=['osd', 'erasure-code-profile'],
+                            args=args,
+                            container_image=container_image)
+
+    return cmd
+
+
+def delete_profile(module, name, cluster='ceph', container_image=None):
+    '''
+    Delete a profile
+    '''
+
+    args = ['rm', name]
+
+    cmd = generate_ceph_cmd(cluster=cluster,
+                            sub_cmd=['osd', 'erasure-code-profile'],
+                            args=args,
+                            container_image=container_image)
+
+    return cmd
+
+
+def run_module():
+    module_args = dict(
+        cluster=dict(type='str', required=False, default='ceph'),
+        name=dict(type='str', required=True),
+        state=dict(type='str', required=False,
+                   choices=['present', 'absent'], default='present'),
+        stripe_unit=dict(type='str', required=False),
+        k=dict(type='str', required=False),
+        m=dict(type='str', required=False),
+    )
+
+    module = AnsibleModule(
+        argument_spec=module_args,
+        supports_check_mode=True,
+        required_if=[['state', 'present', ['k', 'm']]],
+    )
+
+    # Gather module parameters in variables
+    name = module.params.get('name')
+    cluster = module.params.get('cluster')
+    state = module.params.get('state')
+    stripe_unit = module.params.get('stripe_unit')
+    k = module.params.get('k')
+    m = module.params.get('m')
+
+    if module.check_mode:
+        module.exit_json(
+            changed=False,
+            stdout='',
+            stderr='',
+            rc=0,
+            start='',
+            end='',
+            delta='',
+        )
+
+    startd = datetime.datetime.now()
+    changed = False
+
+    # will return either the image name or None
+    container_image = is_containerized()
+
+    if state == "present":
+        rc, cmd, out, err = exec_command(module, get_profile(module, name, cluster, container_image=container_image))
+        if rc == 0:
+            # the profile already exists, let's check whether we have to update it
+            current_profile = json.loads(out)
+            if current_profile['k'] != k or \
+               current_profile['m'] != m or \
+               current_profile.get('stripe_unit', stripe_unit) != stripe_unit:
+                rc, cmd, out, err = exec_command(module,
+                                                 create_profile(module,
+                                                                name,
+                                                                k,
+                                                                m,
+                                                                stripe_unit,
+                                                                cluster,
+                                                                force=True, container_image=container_image))
+                changed = True
+        else:
+            # the profile doesn't exist, it has to be created
+            rc, cmd, out, err = exec_command(module, create_profile(module,
+                                                                    name,
+                                                                    k,
+                                                                    m,
+                                                                    stripe_unit,
+                                                                    cluster,
+                                                                    container_image=container_image))
+            if rc == 0:
+                changed = True
+
+    elif state == "absent":
+        rc, cmd, out, err = exec_command(module, delete_profile(module, name, cluster, container_image=container_image))
+        if not err:
+            out = 'Profile {} removed.'.format(name)
+            changed = True
+        else:
+            rc = 0
+            out = "Skipping, the profile {} doesn't exist".format(name)
+
+    exit_module(module=module, out=out, rc=rc, cmd=cmd, err=err, startd=startd, changed=changed)
+
+
+def main():
+    run_module()
+
+
+if __name__ == '__main__':
+    main()

tests/library/ca_test_common.py

@@ -0,0 +1,29 @@
+from ansible.module_utils import basic
+from ansible.module_utils._text import to_bytes
+import json
+
+
+def set_module_args(args):
+    if '_ansible_remote_tmp' not in args:
+        args['_ansible_remote_tmp'] = '/tmp'
+    if '_ansible_keep_remote_files' not in args:
+        args['_ansible_keep_remote_files'] = False
+
+    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
+    basic._ANSIBLE_ARGS = to_bytes(args)
+
+
+class AnsibleExitJson(Exception):
+    pass
+
+
+class AnsibleFailJson(Exception):
+    pass
+
+
+def exit_json(*args, **kwargs):
+    raise AnsibleExitJson(kwargs)
+
+
+def fail_json(*args, **kwargs):
+    raise AnsibleFailJson(kwargs)