mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
b233f3f296
* updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
71 lines
2.6 KiB
ReStructuredText
71 lines
2.6 KiB
ReStructuredText
Configuration
|
|
-------------
|
|
|
|
.. contents:: Topics
|
|
|
|
|
|
There are several ways to control Ansible settings, this is a brief descriptoin of them.
|
|
|
|
|
|
.. _the_configuration_file:
|
|
|
|
Configuration file
|
|
++++++++++++++++++
|
|
|
|
Certain settings in Ansible are adjustable via a configuration file (ansible.cfg).
|
|
The stock configuration should be sufficient for most users, but there may be reasons you would want to change them.
|
|
|
|
.. _getting_the_latest_configuration:
|
|
|
|
Getting the latest configuration
|
|
````````````````````````````````
|
|
|
|
If installing ansible from a package manager, the latest ansible.cfg should be present in /etc/ansible, possibly
|
|
as a ".rpmnew" file (or other) as appropriate in the case of updates.
|
|
|
|
If you have installed from pip or from source, however, you may want to create this file in order to override
|
|
default settings in Ansible.
|
|
|
|
An example file is availble `ansible.cfg in source control <https://raw.github.com/ansible/ansible/devel/examples/ansible.cfg>`_
|
|
|
|
For more details and a full listing of available configurations go to :doc:configuration or (starting at Ansible 2.4)
|
|
you can use the :doc:`ansible-config` command line utility to list your available options and inspect the current values.
|
|
|
|
For in depth details you check out :doc:`config`.
|
|
|
|
|
|
Environmental configuration
|
|
+++++++++++++++++++++++++++
|
|
|
|
Ansible also allows configuration of settings via environment variables.
|
|
If these environment variables are set, they will override any setting loaded from the configuration file.
|
|
|
|
You can get a full listing of available variables from :doc:`config`.
|
|
|
|
.. _command_line_configuration:
|
|
|
|
Command line options
|
|
++++++++++++++++++++
|
|
|
|
Not all configuration options are present in the command line, just the ones deemed most useful or common.
|
|
Settings in the command line will override those passed through the configuration file and the environment.
|
|
|
|
The full list of options available is in :doc:`ansible-playbook` and :doc:`ansible`.
|
|
|
|
.. seealso::
|
|
|
|
:doc:`intro_dynamic_inventory`
|
|
Pulling inventory from dynamic sources, such as cloud providers
|
|
:doc:`intro_adhoc`
|
|
Examples of basic commands
|
|
:doc:`playbooks`
|
|
Learning Ansible's configuration, deployment, and orchestration language.
|
|
:doc:`config`
|
|
Ansible's configuration file and environment settings in detail
|
|
:doc:`command_line_tools`
|
|
Ansible's command line tools documentation and detailed options
|
|
`Mailing List <http://groups.google.com/group/ansible-project>`_
|
|
Questions? Help? Ideas? Stop by the list on Google Groups
|
|
`irc.freenode.net <http://irc.freenode.net>`_
|
|
#ansible IRC chat channel
|
|
|