ceph_orch_spec: Add ceph orch apply spec feature

Signed-off-by: Teoman ONAY <[email protected]>

infrastructure-playbooks/cephadm-adopt.yml

@@ -931,13 +931,19 @@
         - radosgw_address_block != 'subnet'
 
     - name: Update the placement of radosgw hosts
-      ansible.builtin.command: >
-        {{ cephadm_cmd }} shell -k /etc/ceph/{{ cluster }}.client.admin.keyring --fsid {{ fsid }} --
-        ceph orch apply rgw {{ ansible_facts['hostname'] }}
-        --placement='count-per-host:{{ radosgw_num_instances }} {{ ansible_facts['nodename'] }}'
-        {{ rgw_subnet if rgw_subnet is defined else '' }}
-        --port={{ radosgw_frontend_port }}
-        {{ '--ssl' if radosgw_frontend_ssl_certificate else '' }}
+      ceph_orch_spec:
+        fsid: "{{ fsid }}"
+        spec: >
+          service_type: rgw
+          service_id: "{{ ansible_facts['hostname'] }}"
+          placement: 
+            count-per-host: "{{ radosgw_num_instances }}"
+            hosts: "{{ ansible_facts['nodename'] }}"
+          networks:
+          - {{ rgw_subnet if rgw_subnet is defined else '' }}
+          spec:
+            rgw_frontend_port: "{{ radosgw_frontend_port }}"
+            ssl: "{{ 'true' if radosgw_frontend_ssl_certificate else 'false'}}"
       changed_when: false
       delegate_to: "{{ groups[mon_group_name][0] }}"
       environment:

library/ceph_orch_spec.py

@@ -0,0 +1,186 @@
+#!/usr/bin/python
+
+# Copyright: (c) 2024, Teoman Onay <[email protected]>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+from ansible.module_utils.basic import AnsibleModule
+
+from ansible.module_utils.basic import AnsibleModule
+try:
+    from ansible.module_utils.ca_common import exit_module, generate_cmd, is_containerized  # noqa: E501
+except ImportError:
+    from module_utils.ca_common import exit_module, generate_cmd, is_containerized  # noqa: E501
+
+import datetime
+import yaml
+from typing import Tuple, List
+
+
+ANSIBLE_METADATA = {
+    'metadata_version': '1.0',
+    'status': ['preview'],
+    'supported_by': 'community'
+}
+
+DOCUMENTATION = r'''
+---
+module: ceph_orch_spec
+
+short_description: This is my test module
+
+# If this is part of a collection, you need to use semantic versioning,
+# i.e. the version is of the form "2.5.0" and not "2.4".
+version_added: "1.0.0"
+
+description: This is my longer description explaining my test module.
+
+options:
+    spec:
+        description: This is the message to send to the test module.
+        required: true
+        type: str
+# Specify this value according to your collection
+# in format of namespace.collection.doc_fragment_name
+# extends_documentation_fragment:
+#     - my_namespace.my_collection.my_doc_fragment_name
+
+author:
+    - Teoman ONAY ([email protected])
+'''
+
+EXAMPLES = r'''
+# Pass in a message
+- name: Test with a message
+  my_namespace.my_collection.ceph_orch_spec:
+    spec: >-
+        service_type: rgw
+        service_id: realm.zone
+        placement:
+          hosts:
+            - host1
+            - host2
+            - host3
+        config:
+          param_1: val_1
+          ...
+          param_N: val_N
+        unmanaged: false
+        networks:
+        - 192.169.142.0/24
+
+# pass in a message and have changed true
+- name: Test with a message and changed output
+  my_namespace.my_collection.ceph_orch_spec:
+    name: hello world
+    new: true
+
+# fail the module
+- name: Test failure of the module
+  my_namespace.my_collection.ceph_orch_spec:
+    name: fail me
+'''
+
+RETURN = r'''
+# These are examples of possible return values, and in general should use other names for return values.
+original_message:
+    description: The original name param that was passed in.
+    type: str
+    returned: always
+    sample: 'hello world'
+message:
+    description: The output message that the test module generates.
+    type: str
+    returned: always
+    sample: 'goodbye'
+'''
+
+
+def parse_spec(spec: str) -> yaml:
+    """ parse spec string to yaml """
+    yaml_spec: yaml = yaml.safe_load(spec)
+    return yaml_spec
+
+
+def retrieve_current_spec(module: AnsibleModule, expected_spec: yaml) -> yaml:
+    """ retrieve current config of the service """
+    service: str = expected_spec["service_type"]
+    cmd = build_base_cmd_orch(module)
+    cmd.extend(['ls', service, '--format=yaml'])
+    out = module.run_command(cmd)
+    return yaml.safe_load(out[1])
+
+
+def compare_specs(current: yaml, expected: yaml) -> bool:
+    result: bool = True
+    for key, value in expected.items():
+        if current[key] != value:
+            result = False
+            break
+        else:
+            continue
+    return result
+
+def apply_spec(module: "AnsibleModule", 
+               data: str) -> Tuple[int, List[str], str, str]:
+    cmd = build_base_cmd_orch(module)
+    cmd.extend(['apply', '-i', '-'])
+    rc, out, err = module.run_command(cmd, data=data)
+
+    if rc:
+        raise RuntimeError(err)
+
+    return rc, cmd, out, err
+
+
+def run_module():
+
+    module_args = dict(
+        spec=dict(type='str', required=True),
+        fsid=dict(type='str', required=False),
+    )
+
+    module = AnsibleModule(
+        argument_spec=module_args,
+        supports_check_mode=True
+    )
+
+    startd = datetime.datetime.now()
+    spec = module.params.get('spec')
+
+    if module.check_mode:
+        exit_module(
+            module=module,
+            out='',
+            rc=0,
+            cmd=[],
+            err='',
+            startd=startd,
+            changed=False
+        )
+
+    # Idempotency check
+    expected = parse_spec(module.params.get('spec'))
+    change_required = compare_specs(retrieve_current_spec(module, expected), expected)
+
+    if change_required:
+        rc, cmd, out, err = apply_spec(module, spec)
+        changed = True
+
+    exit_module(
+        module=module,
+        out=out,
+        rc=rc,
+        cmd=cmd,
+        err=err,
+        startd=startd,
+        changed=changed
+    )
+
+
+def main():
+    run_module()
+
+
+if __name__ == '__main__':
+    main()

module_utils/ca_common.py

@@ -1,5 +1,6 @@
 import os
 import datetime
+from typing import TYPE_CHECKING, Any, List, Dict, Callable, Type, TypeVar
 
 
 def generate_cmd(cmd='ceph',
@@ -93,6 +94,36 @@ def exec_command(module, cmd, stdin=None, check_rc=False):
 
     return rc, cmd, out, err
 
+def build_base_cmd(module: "AnsibleModule") -> List[str]:
+    cmd = ['cephadm']
+    docker = module.params.get('docker')
+    image = module.params.get('image')
+
+    if docker:
+        cmd.append('--docker')
+    if image:
+        cmd.extend(['--image', image])
+
+    return cmd
+
+
+def build_base_cmd_shell(module: "AnsibleModule") -> List[str]:
+    cmd = build_base_cmd(module)
+    fsid = module.params.get('fsid')
+
+    cmd.append('shell')
+
+    if fsid:
+        cmd.extend(['--fsid', fsid])
+
+    return cmd
+
+
+def build_base_cmd_orch(module: "AnsibleModule") -> List[str]:
+    cmd = build_base_cmd_shell(module)
+    cmd.extend(['ceph', 'orch'])
+
+    return cmd
 
 def exit_module(module, out, rc, cmd, err, startd, changed=False, diff=dict(before="", after="")):  # noqa: E501
     endd = datetime.datetime.now()

tests/requirements.txt

@@ -8,3 +8,4 @@ mock
 jmespath
 pytest-rerunfailures
 pytest-cov
+setuptools