From 22c8522cbf0d1e804325a4f78fc0f8e170040812 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Tue, 19 Sep 2017 17:43:15 -0400 Subject: [PATCH] added missing feature info (#30560) * added missing feature info mostly config related * Copy edit * Copy edit * Copy edit. Clarified warning. --- CHANGELOG.md | 2 ++ docs/docsite/rst/porting_guide_2.4.rst | 16 +++++++++++++--- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ad4491f0cd0..1cae6adebde 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -153,6 +153,8 @@ Ansible Changes By Release - option to toggle failed inventory source parsing between an error or a warning * More fixes for Python 3 across the code base. * win_shell and win_command modules now properly preserve quoted arguments passed on the command-line. Tasks that attempted to work around the issue by adding extra quotes/escaping may need to be reworked. See https://github.com/ansible/ansible/issues/23019 for additional detail. +* All configuration paths are now relative to the `ansible.cfg` file used. +* By user request, a 'configuration macro' (``CWD``) is available to force configured paths to be relative to the current working directory. Please note that this is unsafe and not recommended. #### New Callbacks: diff --git a/docs/docsite/rst/porting_guide_2.4.rst b/docs/docsite/rst/porting_guide_2.4.rst index 028f9eeaf28..1ce4702c670 100644 --- a/docs/docsite/rst/porting_guide_2.4.rst +++ b/docs/docsite/rst/porting_guide_2.4.rst @@ -87,6 +87,9 @@ There have been many changes to the implementation of vars plugins, but both use The most notable difference to users is that vars plugins now get invoked on demand instead of at inventory build time. This should make them more efficient for large inventories, especially when using a subset of the hosts. +.. note:: This also creates a difference with group/host_vars when using them adjacent to playbooks. Before, the 'first' playbook loaded determined the variables; now the 'current' playbook does. We are looking to fix this soon, since 'all playbooks' in the path should be considered for variable loading. + + Inventory plugins ----------------- @@ -112,9 +115,16 @@ To control timeouts use ``command_timeout`` rather than the previous top level ` See :ref:`Ansible Network debug guide ` for more information. -Configuration API -================= +Configuration +============= + + +The configuration system has had some major changes. Users should be unaffected except for the following: + + * All relative paths defined are relative to the `ansible.cfg` file itself. Previously they varied by setting. The new behavior should be more predictable. + * A new macro ``{{CWD}}`` is available for paths, which will make paths relative to the 'current working directory', + this is unsafe but some users really want to rely on this behaviour. -The configuration system has had some major changes, but users should be unaffected. Developers that were working directly with the previous API should revisit their usage as some methods (for example, ``get_config``) were kept for backwards compatibility but will warn users that the function has been deprecated. +Developers that were working directly with the previous API should revisit their usage as some methods (for example, ``get_config``) were kept for backwards compatibility but will warn users that the function has been deprecated. The new configuration has been designed to minimize the need for code changes in core for new plugins. The plugins just need to document their settings and the configuration system will use the documentation to provide what they need. This is still a work in progress; currently only 'callback' and 'connection' plugins support this. More details will be added to the specific plugin developer guides.