[PATCH v2 10/10] docs: ansible_cfg: add documentation

[Daniel Gomez <da.gomez@kernel.org>]

From: Daniel Gomez <da.gomez@samsung.com>

Add documentation file for the Ansible Configuration Module
(ansible_cfg).

Signed-off-by: Daniel Gomez <da.gomez@samsung.com>
---
 MAINTAINERS                           |   1 +
 docs/kdevops-ansible-configuration.md | 102 ++++++++++++++++++++++++++++++++++
 2 files changed, 103 insertions(+)

diff --git a/MAINTAINERS b/MAINTAINERS
index d6f578c0be62ac3809084223ae190a70d3b23d0a..87273caa77c737de6b3d6b3c88c12653a1f886d9 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -72,6 +72,7 @@ M:	Daniel Gomez <da.gomez@samsung.com>
 L:	kdevops@lists.linux.dev
 S:	Maintained
 T:	git https://github.com/linux-kdevops/kdevops.git
+F:	docs/kdevops-ansible-configuration.md
 F:	kconfigs/Kconfig.ansible_cfg
 F:	playbooks/ansible_cfg.yml
 F:	playbooks/roles/ansible_cfg
diff --git a/docs/kdevops-ansible-configuration.md b/docs/kdevops-ansible-configuration.md
new file mode 100644
index 0000000000000000000000000000000000000000..c5d3a5d5d7ada4821735d6eae7e93512216a2e85
--- /dev/null
+++ b/docs/kdevops-ansible-configuration.md
@@ -0,0 +1,102 @@
+# kdevops Ansible Configuration
+
+The Ansible Configuration module in kdevops allows the user to configure the
+[Ansible configuration file](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#the-configuration-file)
+, typically `ansible.cfg` (in kdevops `$TOPDIR_PATH` directory). This file
+includes some Ansible settings such as the callback plugin and the Ansible
+inventory file configuration (a comma-separated list).
+
+
+## Ansible Configuration File (`ANSIBLE_CFG_FILE`)
+
+This setting allows the user to define a path and filename to the Ansible
+configuration file.
+
+If the specified file already exists, it will not be overwritten. Otherwise,
+kdevops will generate one using the Kconfig settings.
+
+Default: `$(TOPDIR_PATH)/ansible.cfg`
+
+See: [Ansible config file](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#the-configuration-file)
+
+
+## Ansible Inventory File (`ANSIBLE_CFG_INVENTORY`)
+
+Comma-separated list of Ansible inventory source paths. Each entry can be a path
+to a file or directory.
+
+Example: `/path/to/hosts,/path/to/inventory_dir`
+
+This is written to the `[defaults]` section of the generated `ansible.cfg`:
+
+```ini
+[defaults]
+inventory = /path/to/hosts,/path/to/inventory_dir
+```
+
+Default: `$(TOPDIR_PATH)/hosts`
+
+See: [Ansible inventory sources](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#default-host-list)
+
+
+## Callback Plugin Configuration (`ANSIBLE_CFG_CALLBACK_PLUGIN*`)
+
+The callback plugin determines how Ansible output is displayed. You may select one of:
+
+- [debug](https://docs.ansible.com/ansible/latest/collections/ansible/posix/debug_callback.html): formatted stdout/stderr display
+- [dense](https://docs.ansible.com/ansible/latest/collections/community/general/dense_callback.html): minimal stdout output
+- custom: this allows defining the plugin name manually
+
+See more plugins:
+[Ansible callback plugins list](https://docs.ansible.com/ansible/latest/collections/index_callback.html)
+
+Also, see the Parameters section in the debug/dense for a description of the
+callback plugin options.
+
+
+## Python Interpreter Configuration (`ANSIBLE_CFG_INTERPRETER_PYTHON`)
+
+This allows selecting how Ansible discovers or uses a Python interpreter on target systems.
+
+Options include:
+
+- auto
+- auto_legacy
+- auto_legacy_client
+- auto_silent
+- custom: this allows defining the path manually
+
+See:
+- [Interpreter Discovery](https://docs.ansible.com/ansible/latest/reference_appendices/interpreter_discovery.html#interpreter-discovery)
+- [Using Python 3](https://docs.ansible.com/ansible/latest/reference_appendices/python_3_support.html#using-python-3-on-the-managed-machines-with-commands-and-playbooks)
+
+This option can be controlled via command line Makefile parameter `ANSIBLE_CFG_INTERPRETER_PYTHON`.
+
+
+## Forks Configuration (`ANSIBLE_CFG_FORKS`)
+
+Control the number of parallel forks (concurrent tasks) Ansible may use.
+
+Default: 10
+
+See: [Forks](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_strategies.html#setting-the-number-of-forks)
+
+This option can be controlled via command line Makefile parameter `ANSIBLE_CFG_FORKS`.
+
+
+## Ansible Deprecation Warnings (`ANSIBLE_CFG_DEPRECATION_WARNINGS`)
+
+Toggle whether Ansible displays deprecation warnings.
+
+Default: Enabled
+
+See: [Deprecation warnings](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#deprecation-warnings)
+
+
+## Ansible Reconnection Retries (`ANSIBLE_CFG_RECONNECTION_RETRIES`, OpenSUSE only)
+
+Number of SSH reconnection attempts. Ansible retries connections only on SSH return code 255.
+
+Default: 2000
+
+See: [Reconnection retries](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/ssh_connection.html#parameter-reconnection_retries)

-- 
2.49.0