Brian Coca b233f3f296 updated plugin docs (#30490 )

* 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

2017-09-22 23:19:50 -04:00

2.6 KiB

Raw Blame History

Configuration

Topics

There are several ways to control Ansible settings, this is a brief descriptoin of them.

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

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

For more details and a full listing of available configurations go to :doc:configuration or (starting at Ansible 2.4) you can use the ansible-config command line utility to list your available options and inspect the current values.

For in depth details you check out 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 config.

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 ansible-playbook and ansible.

intro_dynamic_inventory: Pulling inventory from dynamic sources, such as cloud providers
intro_adhoc: Examples of basic commands
playbooks: Learning Ansible's configuration, deployment, and orchestration language.
config: Ansible's configuration file and environment settings in detail
command_line_tools: Ansible's command line tools documentation and detailed options
Mailing List: Questions? Help? Ideas? Stop by the list on Google Groups
irc.freenode.net: #ansible IRC chat channel

2.6 KiB Raw Blame History