6a5cbcf8b8
Change link in the Ansible Config docs to the example `ansible.cfg` file, from the raw download to the web user interface.
59 lines
2.2 KiB
ReStructuredText
59 lines
2.2 KiB
ReStructuredText
.. _intro_configuration:
|
|
|
|
*******************
|
|
Configuring Ansible
|
|
*******************
|
|
|
|
.. contents:: Topics
|
|
|
|
|
|
This topic describes how to control Ansible settings.
|
|
|
|
|
|
.. _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.
|
|
Paths where configuration file is searched are listed in :ref:`reference documentation<ansible_configuration_settings_locations>`.
|
|
|
|
.. _getting_the_latest_configuration:
|
|
|
|
Getting the latest configuration
|
|
--------------------------------
|
|
|
|
If installing Ansible from a package manager, the latest ``ansible.cfg`` file should be present in ``/etc/ansible``, possibly
|
|
as a ``.rpmnew`` file (or other) as appropriate in the case of updates.
|
|
|
|
If you installed Ansible from pip or from source, you may want to create this file in order to override
|
|
default settings in Ansible.
|
|
|
|
An `example file is available on GitHub <https://github.com/ansible/ansible/blob/devel/examples/ansible.cfg>`_.
|
|
|
|
For more details and a full listing of available configurations go to :ref:`configuration_settings<ansible_configuration_settings>`. Starting with Ansible version 2.4, you can use the :ref:`ansible-config` command line utility to list your available options and inspect the current values.
|
|
|
|
For in-depth details, see :ref:`ansible_configuration_settings`.
|
|
|
|
.. _environmental_configuration:
|
|
|
|
Environmental configuration
|
|
===========================
|
|
|
|
Ansible also allows configuration of settings using 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 environment variables from :ref:`ansible_configuration_settings`.
|
|
|
|
|
|
.. _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 :ref:`ansible-playbook` and :ref:`ansible`.
|
|
|