Skip to content

Commit

Permalink
Add example.config and main documentation of the roles_path feature.
Browse files Browse the repository at this point in the history
  • Loading branch information
mpdehaan committed Oct 12, 2013
1 parent 6322322 commit fee360f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
29 changes: 29 additions & 0 deletions docsite/latest/rst/intro_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion examples/ansible.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit fee360f

Please sign in to comment.