Refactor as an Ansible collection

.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+.vagrant

README.md

@@ -1,4 +1,4 @@
-# cephadm-ansible
+# cephadm-ansible (ceph.cephadm)
 
 cephadm-ansible is a collection of Ansible playbooks to simplify
 workflows that are not covered by [cephadm]. The workflows covered

ansible.cfg

@@ -1,7 +1,7 @@
 [defaults]
 log_path = $HOME/ansible/ansible.log
-library = ./library
-module_utils = ./module_utils
+library = ./plugins/modules
+module_utils = ./plugins/module_utils
 roles_path = ./
 
 forks = 20
@@ -23,4 +23,3 @@ control_path = %(directory)s/%%h-%%r-%%p
 ssh_args = -o ControlMaster=auto -o ControlPersist=600s
 pipelining = True
 retries = 10
-

galaxy.yml

@@ -0,0 +1,70 @@
+### REQUIRED
+# The namespace of the collection. This can be a company/brand/organization or product namespace under which all
+# content lives. May only contain alphanumeric lowercase characters and underscores. Namespaces cannot start with
+# underscores or numbers and cannot contain consecutive underscores
+namespace: ceph
+
+# The name of the collection. Has the same character restrictions as 'namespace'
+name: cephadm
+
+# The version of the collection. Must be compatible with semantic versioning
+version: 3.0.0
+
+# The path to the Markdown (.md) readme file. This path is relative to the root of the collection
+readme: README.md
+
+# A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)
+# @nicks:irc/im.site#channel'
+authors:
+  - Guillaume Abrioux <[email protected]>
+  - Ken Dreyer <[email protected]>
+
+### OPTIONAL but strongly recommended
+# A short summary description of the collection
+description: ansible playbooks to be used with cephadm
+
+# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
+# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
+license:
+  - Apache-2.0
+
+# The path to the license file for the collection. This path is relative to the root of the collection. This key is
+# mutually exclusive with 'license'
+# license_file: ''
+
+# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
+# requirements as 'namespace' and 'name'
+tags: ['system']
+
+# Collections that this collection requires to be installed for it to be usable. The key of the dict is the
+# collection label 'namespace.name'. The value is a version range
+# L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version
+# range specifiers can be set and are separated by ','
+dependencies:
+  ansible.posix: ">=1.5.4"
+  community.general: ">=7.5.0"
+
+# The URL of the originating SCM repository
+repository: https://github.com/ceph/cephadm-ansible
+
+# The URL to any online docs
+documentation: https://docs.ceph.com/projects/cephadm-ansible/
+
+# The URL to the homepage of the collection/project
+homepage: https://github.com/ceph/cephadm-ansible
+
+# The URL to the collection issue tracker
+issues: https://github.com/ceph/cephadm-ansible/issues
+
+# A list of file glob-like patterns used to filter any files or directories that should not be included in the build
+# artifact. A pattern is matched from the relative path of the file or directory of the collection directory. This
+# uses 'fnmatch' to match the files or directories. Some directories and files like 'galaxy.yml', '*.pyc', '*.retry',
+# and '.git' are always filtered. Mutually exclusive with 'manifest'
+build_ignore: []
+# A dict controlling use of manifest directives used in building the collection artifact. The key 'directives' is a
+# list of MANIFEST.in style
+# L(directives,https://packaging.python.org/en/latest/guides/using-manifest-in/#manifest-in-commands). The key
+# 'omit_default_directives' is a boolean that controls whether the default directives are used. Mutually exclusive
+# with 'build_ignore'
+# manifest: null
+

meta/runtime.yml

@@ -0,0 +1,52 @@
+---
+# Collections must specify a minimum required ansible version to upload
+# to galaxy
+requires_ansible: '>=2.9,<3,!=2.9.10'
+
+# Content that Ansible needs to load from another location or that has
+# been deprecated/removed
+# plugin_routing:
+#   action:
+#     redirected_plugin_name:
+#       redirect: ns.col.new_location
+#     deprecated_plugin_name:
+#       deprecation:
+#         removal_version: "4.0.0"
+#         warning_text: |
+#           See the porting guide on how to update your playbook to
+#           use ns.col.another_plugin instead.
+#     removed_plugin_name:
+#       tombstone:
+#         removal_version: "2.0.0"
+#         warning_text: |
+#           See the porting guide on how to update your playbook to
+#           use ns.col.another_plugin instead.
+#   become:
+#   cache:
+#   callback:
+#   cliconf:
+#   connection:
+#   doc_fragments:
+#   filter:
+#   httpapi:
+#   inventory:
+#   lookup:
+#   module_utils:
+#   modules:
+#   netconf:
+#   shell:
+#   strategy:
+#   terminal:
+#   test:
+#   vars:
+
+# Python import statements that Ansible needs to load from another location
+# import_redirection:
+#   ansible_collections.ns.col.plugins.module_utils.old_location:
+#     redirect: ansible_collections.ns.col.plugins.module_utils.new_location
+
+# Groups of actions/modules that take a common set of options
+# action_groups:
+#   group_name:
+#     - module1
+#     - module2

cephadm-set-container-insecure-registries.yml → playbooks/cephadm-set-container-insecure-registries.yml

@@ -33,4 +33,4 @@
         block: |
           [[registry]]
           location = '{{ insecure_registry }}'
-          insecure = true
+          insecure = true

plugins/README.md

@@ -0,0 +1,31 @@
+# Collections Plugins Directory
+
+This directory can be used to ship various plugins inside an Ansible collection. Each plugin is placed in a folder that
+is named after the type of plugin it is in. It can also include the `module_utils` and `modules` directory that
+would contain module utils and modules respectively.
+
+Here is an example directory of the majority of plugins currently supported by Ansible:
+
+```
+└── plugins
+    ├── action
+    ├── become
+    ├── cache
+    ├── callback
+    ├── cliconf
+    ├── connection
+    ├── filter
+    ├── httpapi
+    ├── inventory
+    ├── lookup
+    ├── module_utils
+    ├── modules
+    ├── netconf
+    ├── shell
+    ├── strategy
+    ├── terminal
+    ├── test
+    └── vars
+```
+
+A full list of plugin types can be found at [Working With Plugins](https://docs.ansible.com/ansible-core/2.15/plugins/plugins.html).

module_utils/ceph_common.py → plugins/module_utils/ceph_common.py

@@ -1,9 +1,8 @@
 import datetime
 import time
-from typing import TYPE_CHECKING, List, Dict
+from typing import List, Dict
 
-if TYPE_CHECKING:
-    from ansible.module_utils.basic import AnsibleModule  # type: ignore
+from ansible.module_utils.basic import AnsibleModule  # type: ignore
 
 
 def retry(exceptions, retries=20, delay=1):

library/ceph_config.py → plugins/modules/ceph_config.py

@@ -7,10 +7,7 @@
 __metaclass__ = type
 
 from ansible.module_utils.basic import AnsibleModule  # type: ignore
-try:
-    from ansible.module_utils.ceph_common import exit_module, build_base_cmd_shell, fatal  # type: ignore
-except ImportError:
-    from module_utils.ceph_common import exit_module, build_base_cmd_shell, fatal  # type: ignore
+from ansible_collections.ceph.cephadm.plugins.module_utils.ceph_common import exit_module, build_base_cmd_shell, fatal  # type: ignore
 
 import datetime
 import json

library/ceph_orch_apply.py → plugins/modules/ceph_orch_apply.py

@@ -19,10 +19,7 @@
 __metaclass__ = type
 
 from ansible.module_utils.basic import AnsibleModule  # type: ignore
-try:
-    from ansible.module_utils.ceph_common import exit_module, build_base_cmd_orch  # type: ignore
-except ImportError:
-    from module_utils.ceph_common import exit_module, build_base_cmd_orch
+from ansible_collections.ceph.cephadm.plugins.module_utils.ceph_common import exit_module, build_base_cmd_orch  # type: ignore
 import datetime
 
 

library/ceph_orch_daemon.py → plugins/modules/ceph_orch_daemon.py

@@ -7,10 +7,7 @@
 __metaclass__ = type
 
 from ansible.module_utils.basic import AnsibleModule  # type: ignore
-try:
-    from ansible.module_utils.ceph_common import retry, exit_module, build_base_cmd_orch, fatal  # type: ignore
-except ImportError:
-    from module_utils.ceph_common import retry, exit_module, build_base_cmd_orch, fatal  # type: ignore
+from ansible_collections.ceph.cephadm.plugins.module_utils.ceph_common import retry, exit_module, build_base_cmd_orch, fatal  # type: ignore
 
 import datetime
 import json