From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 7C7F01DF75C for ; Fri, 2 May 2025 12:13:50 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1746188030; cv=none; b=tRwYwOFkZNsUuFXT/3IaK55/L428j+trVhrMva0m39cG1uEMNyyeYy6xOQRek6qlLHCdO1jPPA/lK7/HpZ2i0qVgOWJM1GHXwXFlZVIPDnJXSPhagFbvmxdrK2hgCB/V//rIRT4Sysom2WUCv8wvfzCNxdx/xTjPRK4SGGE8QBM= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1746188030; c=relaxed/simple; bh=744eiU4MkWouBAsAlQ9xXIjaPAvxRywD5j6iwlwMBrs=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=u5aNlsGm943onsh/c3ADmh2Hz1QZVmJx+0DAT402L7As7D0aWcm58TIsVB6swcgi0bMowP/wVXw1UDQYhBIfgpDw5qLh5NopMFdKhpJJNT+L+g2bqsRcvtDPy9hmLIaub2ZnmfHSnLU1UwxeUYdfaCdfW9ztNHfSPeaBkNiDPx4= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=VP+h+5bL; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="VP+h+5bL" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 5F131C4CEEB; Fri, 2 May 2025 12:13:49 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1746188030; bh=744eiU4MkWouBAsAlQ9xXIjaPAvxRywD5j6iwlwMBrs=; h=From:Date:Subject:References:In-Reply-To:To:Cc:From; b=VP+h+5bL9HmSlhticJ11tkIZFxK9FWQw4dlt2L5mSSmsRPzDIUlsMryxW921q/zVB hr3BXa/4JGcURYBLBI19tNYdM+p8sMTnIgTISjMtKkZqjX2VNz0lq1P0f/zyxqDpaS pJQ+Gh3+WjYEP3a37Nq9G5PsUlKSdeZlGqg04dCysmB+ugawZ/f6AjW2QchbK2Ye2d Eq/MCnDSytyGs1UNYpY5z7l1KUk5L9ypcJdWldnEPvJ2wIODUSX+XFvHzu1fFzqHwn +UYb6w3AGz7hK0iC4Q9sDCKNPCnrswL0CpL64s9aOx3LkPkLaRNyB/0Iv81caUenFC ymXqLcG7GKfcA== From: Daniel Gomez Date: Fri, 02 May 2025 14:13:27 +0200 Subject: [PATCH v2 10/10] docs: ansible_cfg: add documentation Precedence: bulk X-Mailing-List: kdevops@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20250502-ansible_cfg_inventory-v2-10-d3c19ff4aa6e@samsung.com> References: <20250502-ansible_cfg_inventory-v2-0-d3c19ff4aa6e@samsung.com> In-Reply-To: <20250502-ansible_cfg_inventory-v2-0-d3c19ff4aa6e@samsung.com> To: Luis Chamberlain , Chuck Lever Cc: kdevops@lists.linux.dev, Daniel Gomez , Daniel Gomez X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=5040; i=da.gomez@samsung.com; h=from:subject:message-id; bh=oAogXk+6aseQET1T58bXTZlfzRnOnqYBnjt+c/FjOTI=; b=owEBbQKS/ZANAwAIAYX1bqTp6BOPAcsmYgBoFLbuQ8Lu4a8GMF0grymUnx/BWAxWrfj4RTBC7 73N8vKSgESJAjMEAAEIAB0WIQSyp6nP3QO1QP9YsnGF9W6k6egTjwUCaBS27gAKCRCF9W6k6egT jwEjD/9bG8+qrfmUq//T8GmTzmSY4Xz0Jb2xYKp6w32236f/gA584fWgTHSryO8s6Cgy+R02nDB aq3ZS8Yug8JCZhFzRNbdaoYPYjC1VaTiwsONl5gw59jdUmE8AcU6QyLzxuTTGwRfLwAeKr1a/tz xg82+8ZMrGoSJC31+C6VmxNSFGkTyEfZTPKEgTfKhvuDWipyixPmnulep2IEdtPabjhKuJrhJ33 HUYfIJJHHyIlxZ0QvwAdnQvLIl95MZadV7M421bgmn50JwVFj5x+fJ5Ts+TSLng2qQuw1vU7jc8 YuTodjs5NrevEzbIyDZ2bB8QKiV+GOl7ZALl67Avh2CwX2k1qKf3RwKsdC/J+nV2HO+ztPVKnDW W0ytJyYoFcMM6ps/VdDfxufQIKoF7YT/knbN/wYn7dr3QC90zF3HzAq/vjROS2LtTtoFscDbOIs RZNJz5WlWJs3l7RtLSDq+s7N2ezJD25D490UoEZivgIj4ZjUNLeBIzUaUZdBqCX5Sh8i4VNHzbA eAPRoFOt+80VwxX7jQkB2gavUfZnW/1/6d7ZUIUUimNKJf170n4HRMrGGg++OQ0d/K4OjF/cbbi jQ6Xn6NQ+7v8wYTtDwSCoTztOKUVNf8YDEttKHTMqfxSocujpG0MT3fggnP3Jsgw5taw3QPHBCZ LOqsRJhOMPM1Nog== X-Developer-Key: i=da.gomez@samsung.com; a=openpgp; fpr=B2A7A9CFDD03B540FF58B27185F56EA4E9E8138F From: Daniel Gomez Add documentation file for the Ansible Configuration Module (ansible_cfg). Signed-off-by: Daniel Gomez --- 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 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