From fee360f33e2180cdf968e03c32eae29d6a364065 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Sat, 12 Oct 2013 10:15:00 -0400 Subject: [PATCH] Add example.config and main documentation of the roles_path feature. --- docsite/latest/rst/intro_configuration.rst | 29 ++++++++++++++++++++++ examples/ansible.cfg | 4 ++- 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/docsite/latest/rst/intro_configuration.rst b/docsite/latest/rst/intro_configuration.rst index d73de48c49..835be78489 100644 --- a/docsite/latest/rst/intro_configuration.rst +++ b/docsite/latest/rst/intro_configuration.rst @@ -133,6 +133,19 @@ different locations:: Most users will not need to use this feature. See :doc:`developing_plugins` for more details +.. _deprecation_warnings: + +deprecation_warnings +==================== + +.. versionadded:: 1.3 + +Allows disabling of deprecating warnings in ansible-playbook output:: + + deprecation_warnings = True + +Deprecation warnings indicate usage of legacy features that are slated for removal in a future release of Ansible. + .. _display_skipped_hosts: display_skipped_hosts @@ -390,6 +403,22 @@ always default to the current user:: remote_user = root +.. _roles_path + +roles_path +========== + +.. version_added: '1.4' + +The roles path indicate additional directories beyond the 'roles/' subdirectory of a playbook project to search to find Ansible +roles. For instance, if there was a source control repository of common roles and a different repository of playbooks, you might +choose to establish a convention to checkout roles in /opt/mysite/roles like so:: + + roles_path = /opt/mysite/roles + +Roles will be first searched for in the playbook directory. Should a role not be found, it will indicate all the possible paths +that were searched. + .. _sudo_exe: sudo_exe diff --git a/examples/ansible.cfg b/examples/ansible.cfg index acb8e52e90..a9306a6119 100644 --- a/examples/ansible.cfg +++ b/examples/ansible.cfg @@ -12,7 +12,6 @@ hostfile = /etc/ansible/hosts library = /usr/share/ansible -#roles_path = /etc/ansible/roles remote_tmp = $HOME/.ansible/tmp pattern = * forks = 5 @@ -23,6 +22,9 @@ sudo_user = root transport = smart remote_port = 22 +# additional paths to search for roles in, colon seperated +#roles_path = /etc/ansible/roles + # uncomment this to disable SSH key host checking #host_key_checking = False