Fix module_utils issues

Modified paths to ceph_common in modules Move ca_common functions -> ceph_common Signed-off-by: Teoman ONAY <[email protected]>
ceph · Jul 25, 2024 · 015ac5d · 015ac5d
1 parent 1513a33
commit 015ac5d
Show file tree

Hide file tree

Showing 20 changed files with 109 additions and 169 deletions.
diff --git a/plugins/module_utils/ca_common.py b/plugins/module_utils/ca_common.py
diff --git a/plugins/module_utils/ceph_common.py b/plugins/module_utils/ceph_common.py
@@ -10,6 +10,97 @@
 
 ExceptionType = TypeVar('ExceptionType', bound=BaseException)
 
+def generate_cmd(cmd='ceph',
+                 sub_cmd=None,
+                 args=None,
+                 user_key=None,
+                 cluster='ceph',
+                 user='client.admin',
+                 container_image=None,
+                 interactive=False):
+    '''
+    Generate 'ceph' command line to execute
+    '''
+
+    if user_key is None:
+        user_key = '/etc/ceph/{}.{}.keyring'.format(cluster, user)
+
+    cmd = pre_generate_cmd(cmd, container_image=container_image, interactive=interactive)  # noqa: E501
+
+    base_cmd = [
+        '-n',
+        user,
+        '-k',
+        user_key,
+        '--cluster',
+        cluster
+    ]
+
+    if sub_cmd is not None:
+        base_cmd.extend(sub_cmd)
+
+    cmd.extend(base_cmd) if args is None else cmd.extend(base_cmd + args)
+
+    return cmd
+
+
+def container_exec(binary, container_image, interactive=False):
+    '''
+    Build the docker CLI to run a command inside a container
+    '''
+
+    container_binary = os.getenv('CEPH_CONTAINER_BINARY')
+    command_exec = [container_binary, 'run']
+
+    if interactive:
+        command_exec.extend(['--interactive'])
+
+    command_exec.extend(['--rm',
+                         '--net=host',
+                         '-v', '/etc/ceph:/etc/ceph:z',
+                         '-v', '/var/lib/ceph/:/var/lib/ceph/:z',
+                         '-v', '/var/log/ceph/:/var/log/ceph/:z',
+                         '--entrypoint=' + binary, container_image])
+    return command_exec
+
+
+def is_containerized():
+    '''
+    Check if we are running on a containerized cluster
+    '''
+
+    if 'CEPH_CONTAINER_IMAGE' in os.environ:
+        container_image = os.getenv('CEPH_CONTAINER_IMAGE')
+    else:
+        container_image = None
+
+    return container_image
+
+
+def pre_generate_cmd(cmd, container_image=None, interactive=False):
+    '''
+    Generate ceph prefix command
+    '''
+    if container_image:
+        cmd = container_exec(cmd, container_image, interactive=interactive)
+    else:
+        cmd = [cmd]
+
+    return cmd
+
+
+def exec_command(module, cmd, stdin=None, check_rc=False):
+    '''
+    Execute command(s)
+    '''
+
+    binary_data = False
+    if stdin:
+        binary_data = True
+    rc, out, err = module.run_command(cmd, data=stdin, binary_data=binary_data, check_rc=check_rc)  # noqa: E501
+
+    return rc, cmd, out, err
+
 
 def retry(exceptions: Type[ExceptionType], module: "AnsibleModule", retries: int = 20, delay: int = 1) -> Callable:
     def decorator(f: Callable) -> Callable:

diff --git a/plugins/modules/ceph_authtool.py b/plugins/modules/ceph_authtool.py
@@ -3,7 +3,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import container_exec, \
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import container_exec, \
                                                is_containerized
 except ImportError:
     from module_utils.ca_common import container_exec, \

diff --git a/plugins/modules/ceph_crush.py b/plugins/modules/ceph_crush.py
@@ -9,7 +9,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import fatal
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import fatal
 except ImportError:
     from module_utils.ca_common import fatal
 import datetime

diff --git a/plugins/modules/ceph_crush_rule.py b/plugins/modules/ceph_crush_rule.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import exit_module, \
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import exit_module, \
                                                generate_cmd, \
                                                is_containerized, \
                                                exec_command

diff --git a/plugins/modules/ceph_dashboard_user.py b/plugins/modules/ceph_dashboard_user.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import generate_cmd, \
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import generate_cmd, \
                                                is_containerized, \
                                                exec_command, \
                                                exit_module, \

diff --git a/plugins/modules/ceph_ec_profile.py b/plugins/modules/ceph_ec_profile.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import is_containerized, \
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import is_containerized, \
                                                generate_cmd, \
                                                exec_command, \
                                                exit_module

diff --git a/plugins/modules/ceph_fs.py b/plugins/modules/ceph_fs.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import is_containerized, \
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import is_containerized, \
                                                exec_command, \
                                                generate_cmd, \
                                                exit_module

diff --git a/plugins/modules/ceph_key.py b/plugins/modules/ceph_key.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import generate_cmd, \
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import generate_cmd, \
                                                is_containerized, \
                                                container_exec, \
                                                fatal

diff --git a/plugins/modules/ceph_mgr_module.py b/plugins/modules/ceph_mgr_module.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import exit_module, \
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import exit_module, \
                                                generate_cmd, \
                                                is_containerized
 except ImportError:

diff --git a/plugins/modules/ceph_osd.py b/plugins/modules/ceph_osd.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import exit_module, generate_cmd, is_containerized  # noqa: E501
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_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

diff --git a/plugins/modules/ceph_osd_flag.py b/plugins/modules/ceph_osd_flag.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import exit_module, \
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import exit_module, \
                                                generate_cmd, \
                                                is_containerized
 except ImportError:

diff --git a/plugins/modules/ceph_pool.py b/plugins/modules/ceph_pool.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import generate_cmd, \
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import generate_cmd, \
                                                pre_generate_cmd, \
                                                is_containerized, \
                                                exec_command, \

diff --git a/plugins/modules/ceph_volume.py b/plugins/modules/ceph_volume.py
@@ -2,7 +2,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import exec_command, \
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import exec_command, \
                                                is_containerized, \
                                                fatal
 except ImportError:

diff --git a/plugins/modules/ceph_volume_simple_activate.py b/plugins/modules/ceph_volume_simple_activate.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import exit_module
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import exit_module
 except ImportError:
     from module_utils.ca_common import exit_module
 import datetime

diff --git a/plugins/modules/ceph_volume_simple_scan.py b/plugins/modules/ceph_volume_simple_scan.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import exit_module
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import exit_module
 except ImportError:
     from module_utils.ca_common import exit_module
 import datetime

diff --git a/plugins/modules/cephadm_adopt.py b/plugins/modules/cephadm_adopt.py
@@ -17,7 +17,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 try:
-    from ansible.module_utils.ca_common import exit_module
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import exit_module
 except ImportError:
     from module_utils.ca_common import exit_module
 import datetime

diff --git a/plugins/modules/radosgw_caps.py b/plugins/modules/radosgw_caps.py
@@ -19,7 +19,7 @@
 from ansible.module_utils.basic import AnsibleModule
 
 try:
-    from ansible.module_utils.ca_common import (
+    from ansible_collections.ceph.automation.plugins.module_utils.ceph_common import (
         exit_module,
         exec_command,
         is_containerized,