From 1588ad77e22b70a11b4d955bae6df442302f9b7e Mon Sep 17 00:00:00 2001 From: Sam Doran Date: Tue, 19 Nov 2019 10:36:35 -0500 Subject: [PATCH] Update ansible.cfg (#64855) - clean out old options that are now deprecated - clean up formatting of comments a bit - add become plugin examples --- examples/ansible.cfg | 337 ++++++++++++++++++++++--------------------- 1 file changed, 169 insertions(+), 168 deletions(-) diff --git a/examples/ansible.cfg b/examples/ansible.cfg index 27283343582..f92683005b8 100644 --- a/examples/ansible.cfg +++ b/examples/ansible.cfg @@ -1,33 +1,27 @@ -# config file for ansible -- https://ansible.com/ -# =============================================== +# Example config file for ansible -- https://ansible.com/ +# ======================================================= -# nearly all parameters can be overridden in ansible-playbook -# or with command line flags. ansible will read ANSIBLE_CONFIG, +# Nearly all parameters can be overridden in ansible-playbook +# or with command line flags. Ansible will read ANSIBLE_CONFIG, # ansible.cfg in the current working directory, .ansible.cfg in -# the home directory or /etc/ansible/ansible.cfg, whichever it +# the home directory, or /etc/ansible/ansible.cfg, whichever it # finds first -[defaults] +# For a full list of available options, run ansible-config list or see the +# documentanion: https://docs.ansible.com/ansible/latest/reference_appendices/config.html. -# some basic default values... - -#inventory = /etc/ansible/hosts -#library = /usr/share/my_modules/ -#module_utils = /usr/share/my_module_utils/ -#remote_tmp = ~/.ansible/tmp -#local_tmp = ~/.ansible/tmp -#plugin_filters_cfg = /etc/ansible/plugin_filters.yml -#forks = 5 -#poll_interval = 15 -#sudo_user = root -#ask_sudo_pass = True -#ask_pass = True -#transport = smart -#remote_port = 22 -#module_lang = C -#module_set_locale = False - -# plays will gather facts by default, which contain information about +[defaults] +#inventory = /etc/ansible/hosts +#library = ~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules +#module_utils = ~/.ansible/plugins/module_utils:/usr/share/ansible/plugins/module_utils +#remote_tmp = ~/.ansible/tmp +#local_tmp = ~/.ansible/tmp +#forks = 5 +#poll_interval = 0.001 +#ask_pass = False +#transport = smart + +# Plays will gather facts by default, which contain information about # the remote system. # # smart - gather by default, but don't regather if already gathered @@ -46,6 +40,7 @@ # You can combine them using comma (ex: network,virtual) # You can negate them using ! (ex: !hardware,!facter,!ohai) # A minimal set of facts is always gathered. +# #gather_subset = all # some hardware related facts are collected @@ -53,7 +48,8 @@ # option lets you increase or decrease that # timeout to something more suitable for the # environment. -# gather_timeout = 10 +# +#gather_timeout = 10 # Ansible facts are available inside the ansible_facts.* dictionary # namespace. This setting maintains the behaviour which was the default prior @@ -61,131 +57,140 @@ # prefix of 'ansible_'. # This variable is set to True by default for backwards compatibility. It # will be changed to a default of 'False' in a future release. -# ansible_facts. -# inject_facts_as_vars = True - -# additional paths to search for roles in, colon separated -#roles_path = /etc/ansible/roles +# +#inject_facts_as_vars = True -# uncomment this to disable SSH key host checking -#host_key_checking = False +# Paths to search for roles, colon separated +#roles_path = ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles -# change the default callback, you can only have one 'stdout' type enabled at a time. -#stdout_callback = skippy +# Host key checking is enabled by default +#host_key_checking = True +# You can only have one 'stdout' callback type enabled at a time. The default +# is 'default'. The 'yaml' or 'debug' stdout callback plugins are easier to read. +# +#stdout_callback = default +#stdout_callback = yaml +#stdout_callback = debug -## Ansible ships with some plugins that require whitelisting, -## this is done to avoid running all of a type by default. -## These setting lists those that you want enabled for your system. -## Custom plugins should not need this unless plugin author specifies it. -# enable callback plugins, they can output to stdout but cannot be 'stdout' type. +# Ansible ships with some plugins that require whitelisting, +# this is done to avoid running all of a type by default. +# These setting lists those that you want enabled for your system. +# Custom plugins should not need this unless plugin author disables them +# by default. +# +# Enable callback plugins, they can output to stdout but cannot be 'stdout' type. #callback_whitelist = timer, mail # Determine whether includes in tasks and handlers are "static" by # default. As of 2.0, includes are dynamic by default. Setting these # values to True will make includes behave more like they did in the # 1.x versions. +# #task_includes_static = False #handler_includes_static = False # Controls if a missing handler for a notification event is an error or a warning #error_on_missing_handler = True -# change this for alternative sudo implementations -#sudo_exe = sudo - -# What flags to pass to sudo -# WARNING: leaving out the defaults might create unexpected behaviours -#sudo_flags = -H -S -n - -# SSH timeout +# Default timeout for connection plugins #timeout = 10 -# default user to use for playbooks if user is not specified -# (/usr/bin/ansible will use current user as default) +# Default user to use for playbooks if user is not specified +# Uses the connection plugin's default, normally the user currently executing Ansible, +# unless a different user is specified here. +# #remote_user = root -# logging is off by default unless this path is defined -# if so defined, consider logrotate +# Logging is off by default unless this path is defined. #log_path = /var/log/ansible.log -# default module name for /usr/bin/ansible +# Default module to use when running ad-hoc commands #module_name = command -# use this shell for commands executed under sudo -# you may need to change this to bin/bash in rare instances -# if sudo is constrained +# Use this shell for commands executed under sudo. +# you may need to change this to /bin/bash in rare instances +# if sudo is constrained. +# #executable = /bin/sh -# if inventory variables overlap, does the higher precedence one win -# or are hash values merged together? The default is 'replace' but -# this can also be set to 'merge'. -#hash_behaviour = replace - -# by default, variables from roles will be visible in the global variable -# scope. To prevent this, the following option can be enabled, and only +# By default, variables from roles will be visible in the global variable +# scope. To prevent this, set the following option to True, and only # tasks and handlers within the role will see the variables there -#private_role_vars = yes +# +#private_role_vars = False -# list any Jinja2 extensions to enable here: +# List any Jinja2 extensions to enable here. #jinja2_extensions = jinja2.ext.do,jinja2.ext.i18n -# if set, always use this private key file for authentication, same as +# If set, always use this private key file for authentication, same as # if passing --private-key to ansible or ansible-playbook +# #private_key_file = /path/to/file # If set, configures the path to the Vault password file as an alternative to -# specifying --vault-password-file on the command line. +# specifying --vault-password-file on the command line. This can also be +# an executable script that returns the vault password to stdout. +# #vault_password_file = /path/to/vault_password_file -# format of string {{ ansible_managed }} available within Jinja2 +# Format of string {{ ansible_managed }} available within Jinja2 # templates indicates to users editing templates files will be replaced. # replacing {file}, {host} and {uid} and strftime codes with proper values. +# #ansible_managed = Ansible managed: {file} modified on %Y-%m-%d %H:%M:%S by {uid} on {host} + # {file}, {host}, {uid}, and the timestamp can all interfere with idempotence # in some situations so the default is a static string: +# #ansible_managed = Ansible managed -# by default, ansible-playbook will display "Skipping [host]" if it determines a task -# should not be run on a host. Set this to "False" if you don't want to see these "Skipping" +# By default, ansible-playbook will display "Skipping [host]" if it determines a task +# should not be run on a host. Set this to "False" if you don't want to see these "Skipping" # messages. NOTE: the task header will still be shown regardless of whether or not the # task is skipped. +# #display_skipped_hosts = True -# by default, if a task in a playbook does not include a name: field then +# By default, if a task in a playbook does not include a name: field then # ansible-playbook will construct a header that includes the task's action but -# not the task's args. This is a security feature because ansible cannot know +# not the task's args. This is a security feature because ansible cannot know # if the *module* considers an argument to be no_log at the time that the -# header is printed. If your environment doesn't have a problem securing +# header is printed. If your environment doesn't have a problem securing # stdout from ansible-playbook (or you have manually specified no_log in your # playbook on all of the tasks where you have secret information) then you can # safely set this to True to get more informative messages. +# #display_args_to_stdout = False -# by default (as of 1.3), Ansible will raise errors when attempting to dereference +# Ansible will raise errors when attempting to dereference # Jinja2 variables that are not set in templates or action lines. Uncomment this line -# to revert the behavior to pre-1.3. +# to change this behavior. +# #error_on_undefined_vars = False -# by default (as of 1.6), Ansible may display warnings based on the configuration of the +# Ansible may display warnings based on the configuration of the # system running ansible itself. This may include warnings about 3rd party packages or # other conditions that should be resolved if possible. -# to disable these warnings, set the following value to False: +# To disable these warnings, set the following value to False: +# #system_warnings = True -# by default (as of 1.4), Ansible may display deprecation warnings for language +# Ansible may display deprecation warnings for language # features that should no longer be used and will be removed in future versions. -# to disable these warnings, set the following value to False: +# To disable these warnings, set the following value to False: +# #deprecation_warnings = True -# (as of 1.8), Ansible can optionally warn when usage of the shell and +# Ansible can optionally warn when usage of the shell and # command module appear to be simplified by using a default Ansible module -# instead. These warnings can be silenced by adjusting the following +# instead. These warnings can be silenced by adjusting the following # setting or adding warn=yes or warn=no to the end of the command line -# parameter string. This will for example suggest using the git module +# parameter string. This will for example suggest using the git module # instead of shelling out to the git command. -# command_warnings = False +# +#command_warnings = False # set plugin path directories here, separate with colons @@ -203,172 +208,169 @@ #strategy_plugins = /usr/share/ansible/plugins/strategy -# by default, ansible will use the 'linear' strategy but you may want to try -# another one -#strategy = free +# Ansible will use the 'linear' strategy but you may want to try another one. +#strategy = linear -# by default callbacks are not loaded for /bin/ansible, enable this if you +# By default, callbacks are not loaded for /bin/ansible. Enable this if you # want, for example, a notification or logging callback to also apply to # /bin/ansible runs +# #bin_ansible_callbacks = False -# don't like cows? that's unfortunate. +# Don't like cows? that's unfortunate. # set to 1 if you don't want cowsay support or export ANSIBLE_NOCOWS=1 #nocows = 1 -# set which cowsay stencil you'd like to use by default. When set to 'random', +# Set which cowsay stencil you'd like to use by default. When set to 'random', # a random stencil will be selected for each task. The selection will be filtered # against the `cow_whitelist` option below. +# #cow_selection = default #cow_selection = random -# when using the 'random' option for cowsay, stencils will be restricted to this list. +# When using the 'random' option for cowsay, stencils will be restricted to this list. # it should be formatted as a comma-separated list with no spaces between names. # NOTE: line continuations here are for formatting purposes only, as the INI parser # in python does not support them. +# #cow_whitelist=bud-frogs,bunny,cheese,daemon,default,dragon,elephant-in-snake,elephant,eyes,\ # hellokitty,kitty,luke-koala,meow,milk,moofasa,moose,ren,sheep,small,stegosaurus,\ # stimpy,supermilker,three-eyes,turkey,turtle,tux,udder,vader-koala,vader,www -# don't like colors either? +# Don't like colors either? # set to 1 if you don't want colors, or export ANSIBLE_NOCOLOR=1 +# #nocolor = 1 -# if set to a persistent type (not 'memory', for example 'redis') fact values -# from previous runs in Ansible will be stored. This may be useful when +# If set to a persistent type (not 'memory', for example 'redis') fact values +# from previous runs in Ansible will be stored. This may be useful when # wanting to use, for example, IP information from one group of servers # without having to talk to them in the same playbook run to get their # current IP information. +# #fact_caching = memory -#This option tells Ansible where to cache facts. The value is plugin dependent. -#For the jsonfile plugin, it should be a path to a local directory. -#For the redis plugin, the value is a host:port:database triplet: fact_caching_connection = localhost:6379:0 - +# This option tells Ansible where to cache facts. The value is plugin dependent. +# For the jsonfile plugin, it should be a path to a local directory. +# For the redis plugin, the value is a host:port:database triplet: fact_caching_connection = localhost:6379:0 +# #fact_caching_connection=/tmp - - # retry files # When a playbook fails a .retry file can be created that will be placed in ~/ # You can enable this feature by setting retry_files_enabled to True # and you can change the location of the files by setting retry_files_save_path - +# #retry_files_enabled = False #retry_files_save_path = ~/.ansible-retry -# squash actions -# Ansible can optimise actions that call modules with list parameters -# when looping. Instead of calling the module once per with_ item, the -# module is called once with all items at once. Currently this only works -# under limited circumstances, and only with parameters named 'name'. -#squash_actions = apk,apt,dnf,homebrew,pacman,pkgng,yum,zypper - # prevents logging of task data, off by default #no_log = False # prevents logging of tasks, but only on the targets, data is still logged on the master/controller #no_target_syslog = False -# controls whether Ansible will raise an error or warning if a task has no +# Controls whether Ansible will raise an error or warning if a task has no # choice but to create world readable temporary files to execute a module on -# the remote machine. This option is False by default for security. Users may -# turn this on to have behaviour more like Ansible prior to 2.1.x. See -# https://docs.ansible.com/ansible/become.html#becoming-an-unprivileged-user +# the remote machine. This option is False by default for security. Users may +# turn this on to have behaviour more like Ansible prior to 2.1.x. See +# https://docs.ansible.com/ansible/latest/user_guide/become.html#becoming-an-unprivileged-user # for more secure ways to fix this than enabling this option. +# #allow_world_readable_tmpfiles = False -# controls the compression level of variables sent to -# worker processes. At the default of 0, no compression -# is used. This value must be an integer from 0 to 9. -#var_compression_level = 9 - -# controls what compression method is used for new-style ansible modules when -# they are sent to the remote system. The compression types depend on having +# Controls what compression method is used for new-style ansible modules when +# they are sent to the remote system. The compression types depend on having # support compiled into both the controller's python and the client's python. # The names should match with the python Zipfile compression types: # * ZIP_STORED (no compression. available everywhere) # * ZIP_DEFLATED (uses zlib, the default) -# These values may be set per host via the ansible_module_compression inventory -# variable +# These values may be set per host via the ansible_module_compression inventory variable. +# #module_compression = 'ZIP_DEFLATED' # This controls the cutoff point (in bytes) on --diff for files # set to 0 for unlimited (RAM may suffer!). -#max_diff_size = 1048576 - -# This controls how ansible handles multiple --tags and --skip-tags arguments -# on the CLI. If this is True then multiple arguments are merged together. If -# it is False, then the last specified argument is used and the others are ignored. -# This option will be removed in 2.8. -#merge_multiple_cli_flags = True +# +#max_diff_size = 104448 # Controls showing custom stats at the end, off by default -#show_custom_stats = True +#show_custom_stats = False # Controls which files to ignore when using a directory as inventory with # possibly multiple sources (both static and dynamic) +# #inventory_ignore_extensions = ~, .orig, .bak, .ini, .cfg, .retry, .pyc, .pyo # This family of modules use an alternative execution path optimized for network appliances # only update this setting if you know how this works, otherwise it can break module execution +# #network_group_modules=eos, nxos, ios, iosxr, junos, vyos # When enabled, this option allows lookups (via variables like {{lookup('foo')}} or when used as # a loop with `with_foo`) to return data that is not marked "unsafe". This means the data may contain # jinja2 templating language which will be run through the templating engine. # ENABLING THIS COULD BE A SECURITY RISK +# #allow_unsafe_lookups = False # set default errors for all plays #any_errors_fatal = False + [inventory] -# enable inventory plugins, default: 'host_list', 'script', 'auto', 'yaml', 'ini', 'toml' -#enable_plugins = host_list, virtualbox, yaml, constructed +# List of enabled inventory plugins and the order in which they are used. +#enable_plugins = host_list, script, auto, yaml, ini, toml -# ignore these extensions when parsing a directory as inventory source +# Ignore these extensions when parsing a directory as inventory source #ignore_extensions = .pyc, .pyo, .swp, .bak, ~, .rpm, .md, .txt, ~, .orig, .ini, .cfg, .retry # ignore files matching these patterns when parsing a directory as inventory source #ignore_patterns= -# If 'true' unparsed inventory sources become fatal errors, they are warnings otherwise. -#unparsed_is_failed=False +# If 'True' unparsed inventory sources become fatal errors, otherwise they are warnings. +#unparsed_is_failed = False + [privilege_escalation] -#become=True -#become_method=sudo -#become_user=root -#become_ask_pass=False +#become = False +#become_method = sudo +#become_ask_pass = False -[paramiko_connection] +## Connection Plugins ## + +# Settings for each connection plugin go under a section titled '[[plugin_name]_connection]' +# To view available connection plugins, run ansible-doc -t connection -l +# To view available options for a connection plugin, run ansibble-doc -t connection [plugin_name] +# https://docs.ansible.com/ansible/latest/plugins/connection.html + +[paramiko_connection] # uncomment this line to cause the paramiko connection plugin to not record new host -# keys encountered. Increases performance on new host additions. Setting works independently of the +# keys encountered. Increases performance on new host additions. Setting works independently of the # host key checking setting above. #record_host_keys=False # by default, Ansible requests a pseudo-terminal for commands executed under sudo. Uncomment this # line to disable this behaviour. -#pty=False +#pty = False # paramiko will default to looking for SSH keys initially when trying to -# authenticate to remote devices. This is a problem for some network devices -# that close the connection after a key failure. Uncomment this line to +# authenticate to remote devices. This is a problem for some network devices +# that close the connection after a key failure. Uncomment this line to # disable the Paramiko look for keys function #look_for_keys = False # When using persistent connections with Paramiko, the connection runs in a -# background process. If the host doesn't already have a valid SSH key, by -# default Ansible will prompt to add the host key. This will cause connections -# running in background processes to fail. Uncomment this line to have +# background process. If the host doesn't already have a valid SSH key, by +# default Ansible will prompt to add the host key. This will cause connections +# running in background processes to fail. Uncomment this line to have # Paramiko automatically add host keys. #host_key_auto_add = True -[ssh_connection] +[ssh_connection] # ssh arguments to use # Leaving off ControlPersist will result in poor performance, so use # paramiko on older platforms rather than removing it, -C controls compression use @@ -414,13 +416,13 @@ # * smart = try sftp, scp, and piped, in that order [default] #transfer_method = smart -# if False, sftp will not use batch mode to transfer files. This may cause some +# If False, sftp will not use batch mode to transfer files. This may cause some # types of file transfer failures impossible to catch however, and should # only be disabled if your sftp version has problems with batch mode #sftp_batch_mode = False -# The -tt argument is passed to ssh when pipelining is not enabled because sudo -# requires a tty by default. +# The -tt argument is passed to ssh when pipelining is not enabled because sudo +# requires a tty by default. #usetty = True # Number of times to retry an SSH connection to a host, in case of UNREACHABLE. @@ -428,9 +430,9 @@ # so after the first attempt there is 1s wait, then 2s, 4s etc. up to 30s (max). #retries = 3 -[persistent_connection] -# Configures the persistent connection timeout value in seconds. This value is +[persistent_connection] +# Configures the persistent connection timeout value in seconds. This value is # how long the persistent connection will remain idle before it is destroyed. # If the connection doesn't receive a request before the timeout value # expires, the connection is shutdown. The default value is 30 seconds. @@ -442,29 +444,28 @@ # The default value is 30 second. #command_timeout = 30 -[accelerate] -#accelerate_port = 5099 -#accelerate_timeout = 30 -#accelerate_connect_timeout = 5.0 -# The daemon timeout is measured in minutes. This time is measured -# from the last activity to the accelerate daemon. -#accelerate_daemon_timeout = 30 +## Become Plugins ## + +# Settings for become plugins go under a section named '[[plugin_name]_become_plugin]' +# To view available become plugins, run ansible-doc -t become -l +# Te view available options for a specific plugin, run ansible-doc -t become [plugin_name] +# https://docs.ansible.com/ansible/latest/plugins/become.html + +[sudo_become_plugin] +#flags = -H -S -n +#user = root -# If set to yes, accelerate_multi_key will allow multiple -# private keys to be uploaded to it, though each user must -# have access to the system via SSH to add a new key. The default -# is "no". -#accelerate_multi_key = yes [selinux] # file systems that require special treatment when dealing with security context # the default behaviour that copies the existing context or uses the user default # needs to be changed to use the file system dependent context. -#special_context_filesystems=nfs,vboxsf,fuse,ramfs,9p,vfat +#special_context_filesystems=fuse,nfs,vboxsf,ramfs,9p,vfat + +# Set this to True to allow libvirt_lxc connections to work without SELinux. +#libvirt_lxc_noseclabel = False -# Set this to yes to allow libvirt_lxc connections to work without SELinux. -#libvirt_lxc_noseclabel = yes [colors] #highlight = white @@ -484,7 +485,7 @@ [diff] # Always print diff when running ( same as always running with -D/--diff ) -# always = no +#always = False # Set how many context lines to show in diff -# context = 3 +#context = 3