2014-01-04 18:31:44 +00:00
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
2012-02-29 00:08:09 +00:00
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
2015-05-04 02:47:26 +00:00
# Make coding more python3-ish
2015-10-20 01:36:19 +00:00
from __future__ import ( absolute_import , division , print_function )
2015-05-04 02:47:26 +00:00
__metaclass__ = type
2012-03-05 21:06:02 +00:00
import os
2015-07-06 21:12:10 +00:00
from string import ascii_letters , digits
2015-05-04 02:47:26 +00:00
2015-10-16 00:55:23 +00:00
from ansible . compat . six import string_types
from ansible . compat . six . moves import configparser
2012-03-05 21:06:02 +00:00
2015-10-26 21:23:09 +00:00
from ansible . parsing . quoting import unquote
2015-07-04 14:23:30 +00:00
from ansible . errors import AnsibleOptionsError
2013-07-03 20:47:20 +00:00
# copied from utils, avoid circular reference fun :)
def mk_boolean ( value ) :
2013-08-10 22:16:01 +00:00
if value is None :
return False
2013-07-03 20:47:20 +00:00
val = str ( value )
if val . lower ( ) in [ " true " , " t " , " y " , " 1 " , " yes " ] :
return True
else :
return False
2015-09-01 18:47:07 +00:00
def shell_expand ( path ) :
'''
shell_expand is needed as os . path . expanduser does not work
when path is None , which is the default for ANSIBLE_PRIVATE_KEY_FILE
'''
if path :
path = os . path . expanduser ( os . path . expandvars ( path ) )
return path
def get_config ( p , section , key , env_var , default , boolean = False , integer = False , floating = False , islist = False , isnone = False , ispath = False ) :
2013-07-03 20:47:20 +00:00
''' return a configuration variable with casting '''
value = _get_config ( p , section , key , env_var , default )
if boolean :
2015-05-04 02:47:26 +00:00
value = mk_boolean ( value )
if value :
if integer :
value = int ( value )
elif floating :
value = float ( value )
elif islist :
2015-07-06 21:12:10 +00:00
if isinstance ( value , string_types ) :
2015-05-04 02:47:26 +00:00
value = [ x . strip ( ) for x in value . split ( ' , ' ) ]
2015-05-08 14:12:36 +00:00
elif isnone :
if value == " None " :
value = None
2015-09-01 18:47:07 +00:00
elif ispath :
value = shell_expand ( value )
2015-09-01 18:48:59 +00:00
elif isinstance ( value , string_types ) :
value = unquote ( value )
2013-07-03 20:47:20 +00:00
return value
2013-12-12 16:48:02 +00:00
def _get_config ( p , section , key , env_var , default ) :
2013-07-03 20:47:20 +00:00
''' helper function for get_config '''
2012-10-16 22:40:01 +00:00
if env_var is not None :
2012-10-18 02:34:59 +00:00
value = os . environ . get ( env_var , None )
if value is not None :
return value
2012-08-13 23:17:14 +00:00
if p is not None :
try :
2013-09-18 19:03:40 +00:00
return p . get ( section , key , raw = True )
2012-08-13 23:17:14 +00:00
except :
return default
2012-10-19 00:27:39 +00:00
return default
2012-04-13 23:06:11 +00:00
2012-08-13 23:17:14 +00:00
def load_config_file ( ) :
2014-02-14 20:34:58 +00:00
''' Load Config File order(first found is used): ENV, CWD, HOME, /etc/ansible '''
2015-05-04 02:47:26 +00:00
p = configparser . ConfigParser ( )
2014-02-14 20:34:58 +00:00
path0 = os . getenv ( " ANSIBLE_CONFIG " , None )
if path0 is not None :
path0 = os . path . expanduser ( path0 )
2015-07-30 02:28:30 +00:00
if os . path . isdir ( path0 ) :
path0 + = " /ansible.cfg "
2013-10-11 13:25:57 +00:00
path1 = os . getcwd ( ) + " /ansible.cfg "
2014-02-14 20:34:58 +00:00
path2 = os . path . expanduser ( " ~/.ansible.cfg " )
2012-09-10 14:57:32 +00:00
path3 = " /etc/ansible/ansible.cfg "
2014-02-14 20:34:58 +00:00
for path in [ path0 , path1 , path2 , path3 ] :
if path is not None and os . path . exists ( path ) :
2014-08-29 14:43:30 +00:00
try :
p . read ( path )
2015-05-04 02:47:26 +00:00
except configparser . Error as e :
2015-07-04 14:23:30 +00:00
raise AnsibleOptionsError ( " Error reading config file: \n {0} " . format ( e ) )
return p , path
2015-07-05 16:50:36 +00:00
return None , ' '
2012-08-13 23:17:14 +00:00
2015-07-04 14:23:30 +00:00
p , CONFIG_FILE = load_config_file ( )
2012-08-13 23:17:14 +00:00
2013-10-31 17:05:52 +00:00
# check all of these extensions when looking for yaml files for things like
2014-03-07 02:47:49 +00:00
# group variables -- really anything we can load
YAML_FILENAME_EXTENSIONS = [ " " , " .yml " , " .yaml " , " .json " ]
2013-10-31 17:05:52 +00:00
2015-10-15 14:32:55 +00:00
# the default whitelist for cow stencils
DEFAULT_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 ' , ]
2012-08-13 23:17:14 +00:00
# sections in config file
DEFAULTS = ' defaults '
2015-09-01 18:47:07 +00:00
DEPRECATED_HOST_LIST = get_config ( p , DEFAULTS , ' hostfile ' , ' ANSIBLE_HOSTS ' , ' /etc/ansible/hosts ' , ispath = True )
2015-08-18 07:27:39 +00:00
2015-07-10 16:42:59 +00:00
# generally configurable things
2015-05-04 02:47:26 +00:00
DEFAULT_DEBUG = get_config ( p , DEFAULTS , ' debug ' , ' ANSIBLE_DEBUG ' , False , boolean = True )
2015-09-01 18:47:07 +00:00
DEFAULT_HOST_LIST = get_config ( p , DEFAULTS , ' inventory ' , ' ANSIBLE_INVENTORY ' , DEPRECATED_HOST_LIST , ispath = True )
DEFAULT_MODULE_PATH = get_config ( p , DEFAULTS , ' library ' , ' ANSIBLE_LIBRARY ' , None , ispath = True )
DEFAULT_ROLES_PATH = get_config ( p , DEFAULTS , ' roles_path ' , ' ANSIBLE_ROLES_PATH ' , ' /etc/ansible/roles ' , ispath = True )
2014-07-29 12:13:50 +00:00
DEFAULT_REMOTE_TMP = get_config ( p , DEFAULTS , ' remote_tmp ' , ' ANSIBLE_REMOTE_TEMP ' , ' $HOME/.ansible/tmp ' )
2012-08-13 23:17:14 +00:00
DEFAULT_MODULE_NAME = get_config ( p , DEFAULTS , ' module_name ' , None , ' command ' )
DEFAULT_PATTERN = get_config ( p , DEFAULTS , ' pattern ' , None , ' * ' )
2013-08-22 23:04:11 +00:00
DEFAULT_FORKS = get_config ( p , DEFAULTS , ' forks ' , ' ANSIBLE_FORKS ' , 5 , integer = True )
2012-08-13 23:17:14 +00:00
DEFAULT_MODULE_ARGS = get_config ( p , DEFAULTS , ' module_args ' , ' ANSIBLE_MODULE_ARGS ' , ' ' )
2015-12-02 16:55:10 +00:00
DEFAULT_MODULE_LANG = get_config ( p , DEFAULTS , ' module_lang ' , ' ANSIBLE_MODULE_LANG ' , os . getenv ( ' LANG ' , ' en_US.UTF-8 ' ) )
2013-08-22 23:04:11 +00:00
DEFAULT_TIMEOUT = get_config ( p , DEFAULTS , ' timeout ' , ' ANSIBLE_TIMEOUT ' , 10 , integer = True )
DEFAULT_POLL_INTERVAL = get_config ( p , DEFAULTS , ' poll_interval ' , ' ANSIBLE_POLL_INTERVAL ' , 15 , integer = True )
2015-10-24 03:15:45 +00:00
DEFAULT_REMOTE_USER = get_config ( p , DEFAULTS , ' remote_user ' , ' ANSIBLE_REMOTE_USER ' , None )
2013-07-03 20:47:20 +00:00
DEFAULT_ASK_PASS = get_config ( p , DEFAULTS , ' ask_pass ' , ' ANSIBLE_ASK_PASS ' , False , boolean = True )
2015-09-01 18:47:07 +00:00
DEFAULT_PRIVATE_KEY_FILE = get_config ( p , DEFAULTS , ' private_key_file ' , ' ANSIBLE_PRIVATE_KEY_FILE ' , None , ispath = True )
2014-01-23 17:49:07 +00:00
DEFAULT_REMOTE_PORT = get_config ( p , DEFAULTS , ' remote_port ' , ' ANSIBLE_REMOTE_PORT ' , None , integer = True )
2014-02-11 17:03:11 +00:00
DEFAULT_ASK_VAULT_PASS = get_config ( p , DEFAULTS , ' ask_vault_pass ' , ' ANSIBLE_ASK_VAULT_PASS ' , False , boolean = True )
2015-09-01 18:47:07 +00:00
DEFAULT_VAULT_PASSWORD_FILE = get_config ( p , DEFAULTS , ' vault_password_file ' , ' ANSIBLE_VAULT_PASSWORD_FILE ' , None , ispath = True )
2013-07-04 20:47:17 +00:00
DEFAULT_TRANSPORT = get_config ( p , DEFAULTS , ' transport ' , ' ANSIBLE_TRANSPORT ' , ' smart ' )
2013-07-03 20:47:20 +00:00
DEFAULT_SCP_IF_SSH = get_config ( p , ' ssh_connection ' , ' scp_if_ssh ' , ' ANSIBLE_SCP_IF_SSH ' , False , boolean = True )
2015-07-22 18:25:47 +00:00
DEFAULT_SFTP_BATCH_MODE = get_config ( p , ' ssh_connection ' , ' sftp_batch_mode ' , ' ANSIBLE_SFTP_BATCH_MODE ' , True , boolean = True )
2012-10-03 13:59:38 +00:00
DEFAULT_MANAGED_STR = get_config ( p , DEFAULTS , ' ansible_managed ' , None , ' Ansible managed: {file} modified on % Y- % m- %d % H: % M: % S by {uid} on {host} ' )
2012-11-10 06:13:00 +00:00
DEFAULT_SYSLOG_FACILITY = get_config ( p , DEFAULTS , ' syslog_facility ' , ' ANSIBLE_SYSLOG_FACILITY ' , ' LOG_USER ' )
2013-07-15 02:08:36 +00:00
DEFAULT_KEEP_REMOTE_FILES = get_config ( p , DEFAULTS , ' keep_remote_files ' , ' ANSIBLE_KEEP_REMOTE_FILES ' , False , boolean = True )
2013-01-23 20:39:34 +00:00
DEFAULT_HASH_BEHAVIOUR = get_config ( p , DEFAULTS , ' hash_behaviour ' , ' ANSIBLE_HASH_BEHAVIOUR ' , ' replace ' )
2015-07-01 15:32:44 +00:00
DEFAULT_PRIVATE_ROLE_VARS = get_config ( p , DEFAULTS , ' private_role_vars ' , ' ANSIBLE_PRIVATE_ROLE_VARS ' , False , boolean = True )
2013-02-13 16:33:43 +00:00
DEFAULT_JINJA2_EXTENSIONS = get_config ( p , DEFAULTS , ' jinja2_extensions ' , ' ANSIBLE_JINJA2_EXTENSIONS ' , None )
2013-04-04 03:10:30 +00:00
DEFAULT_EXECUTABLE = get_config ( p , DEFAULTS , ' executable ' , ' ANSIBLE_EXECUTABLE ' , ' /bin/sh ' )
2014-06-24 14:56:33 +00:00
DEFAULT_GATHERING = get_config ( p , DEFAULTS , ' gathering ' , ' ANSIBLE_GATHERING ' , ' implicit ' ) . lower ( )
2015-09-01 18:47:07 +00:00
DEFAULT_LOG_PATH = get_config ( p , DEFAULTS , ' log_path ' , ' ANSIBLE_LOG_PATH ' , ' ' , ispath = True )
2015-07-10 05:53:59 +00:00
DEFAULT_FORCE_HANDLERS = get_config ( p , DEFAULTS , ' force_handlers ' , ' ANSIBLE_FORCE_HANDLERS ' , False , boolean = True )
2015-07-18 19:24:44 +00:00
DEFAULT_INVENTORY_IGNORE = get_config ( p , DEFAULTS , ' inventory_ignore_extensions ' , ' ANSIBLE_INVENTORY_IGNORE ' , [ " ~ " , " .orig " , " .bak " , " .ini " , " .cfg " , " .retry " , " .pyc " , " .pyo " ] , islist = True )
2015-11-05 21:21:34 +00:00
DEFAULT_VAR_COMPRESSION_LEVEL = get_config ( p , DEFAULTS , ' var_compression_level ' , ' ANSIBLE_VAR_COMPRESSION_LEVEL ' , 0 , integer = True )
2015-05-14 14:50:22 +00:00
2015-09-26 03:57:03 +00:00
# disclosure
DEFAULT_NO_LOG = get_config ( p , DEFAULTS , ' no_log ' , ' ANSIBLE_NO_LOG ' , False , boolean = True )
2015-09-26 12:22:32 +00:00
DEFAULT_NO_TARGET_SYSLOG = get_config ( p , DEFAULTS , ' no_target_syslog ' , ' ANSIBLE_NO_TARGET_SYSLOG ' , True , boolean = True )
2015-09-26 03:57:03 +00:00
2015-05-14 14:50:22 +00:00
# selinux
2015-07-02 21:24:13 +00:00
DEFAULT_SELINUX_SPECIAL_FS = get_config ( p , ' selinux ' , ' special_context_filesystems ' , None , ' fuse, nfs, vboxsf, ramfs ' , islist = True )
2013-04-27 14:24:26 +00:00
2015-06-15 00:50:38 +00:00
### PRIVILEGE ESCALATION ###
# Backwards Compat
DEFAULT_SU = get_config ( p , DEFAULTS , ' su ' , ' ANSIBLE_SU ' , False , boolean = True )
DEFAULT_SU_USER = get_config ( p , DEFAULTS , ' su_user ' , ' ANSIBLE_SU_USER ' , ' root ' )
2015-09-02 13:29:34 +00:00
DEFAULT_SU_EXE = get_config ( p , DEFAULTS , ' su_exe ' , ' ANSIBLE_SU_EXE ' , None )
2015-09-02 15:31:39 +00:00
DEFAULT_SU_FLAGS = get_config ( p , DEFAULTS , ' su_flags ' , ' ANSIBLE_SU_FLAGS ' , None )
2015-06-15 00:50:38 +00:00
DEFAULT_ASK_SU_PASS = get_config ( p , DEFAULTS , ' ask_su_pass ' , ' ANSIBLE_ASK_SU_PASS ' , False , boolean = True )
DEFAULT_SUDO = get_config ( p , DEFAULTS , ' sudo ' , ' ANSIBLE_SUDO ' , False , boolean = True )
DEFAULT_SUDO_USER = get_config ( p , DEFAULTS , ' sudo_user ' , ' ANSIBLE_SUDO_USER ' , ' root ' )
2015-09-02 13:29:34 +00:00
DEFAULT_SUDO_EXE = get_config ( p , DEFAULTS , ' sudo_exe ' , ' ANSIBLE_SUDO_EXE ' , None )
2015-10-28 06:02:43 +00:00
DEFAULT_SUDO_FLAGS = get_config ( p , DEFAULTS , ' sudo_flags ' , ' ANSIBLE_SUDO_FLAGS ' , ' -H -S -n ' )
2015-06-15 00:50:38 +00:00
DEFAULT_ASK_SUDO_PASS = get_config ( p , DEFAULTS , ' ask_sudo_pass ' , ' ANSIBLE_ASK_SUDO_PASS ' , False , boolean = True )
# Become
2015-08-18 01:31:18 +00:00
BECOME_ERROR_STRINGS = { ' sudo ' : ' Sorry, try again. ' , ' su ' : ' Authentication failure ' , ' pbrun ' : ' ' , ' pfexec ' : ' ' , ' runas ' : ' ' , ' doas ' : ' Permission denied ' } #FIXME: deal with i18n
2015-09-06 13:00:39 +00:00
BECOME_MISSING_STRINGS = { ' sudo ' : ' sorry, a password is required to run sudo ' , ' su ' : ' ' , ' pbrun ' : ' ' , ' pfexec ' : ' ' , ' runas ' : ' ' , ' doas ' : ' Authorization required ' } #FIXME: deal with i18n
2015-08-18 01:31:18 +00:00
BECOME_METHODS = [ ' sudo ' , ' su ' , ' pbrun ' , ' pfexec ' , ' runas ' , ' doas ' ]
2015-09-17 12:59:22 +00:00
BECOME_ALLOW_SAME_USER = get_config ( p , ' privilege_escalation ' , ' become_allow_same_user ' , ' ANSIBLE_BECOME_ALLOW_SAME_USER ' , False , boolean = True )
2014-11-24 21:36:31 +00:00
DEFAULT_BECOME_METHOD = get_config ( p , ' privilege_escalation ' , ' become_method ' , ' ANSIBLE_BECOME_METHOD ' , ' sudo ' if DEFAULT_SUDO else ' su ' if DEFAULT_SU else ' sudo ' ) . lower ( )
2015-06-15 00:50:38 +00:00
DEFAULT_BECOME = get_config ( p , ' privilege_escalation ' , ' become ' , ' ANSIBLE_BECOME ' , False , boolean = True )
2015-05-04 02:47:26 +00:00
DEFAULT_BECOME_USER = get_config ( p , ' privilege_escalation ' , ' become_user ' , ' ANSIBLE_BECOME_USER ' , ' root ' )
2015-06-15 00:50:38 +00:00
DEFAULT_BECOME_EXE = get_config ( p , ' privilege_escalation ' , ' become_exe ' , ' ANSIBLE_BECOME_EXE ' , None )
DEFAULT_BECOME_FLAGS = get_config ( p , ' privilege_escalation ' , ' become_flags ' , ' ANSIBLE_BECOME_FLAGS ' , None )
2015-03-27 12:45:04 +00:00
DEFAULT_BECOME_ASK_PASS = get_config ( p , ' privilege_escalation ' , ' become_ask_pass ' , ' ANSIBLE_BECOME_ASK_PASS ' , False , boolean = True )
2014-11-24 21:36:31 +00:00
2015-07-07 15:59:20 +00:00
# PLUGINS
2015-11-05 02:46:47 +00:00
# Modules that can optimize with_items loops into a single call. Currently
# these modules must (1) take a "name" or "pkg" parameter that is a list. If
# the module takes both, bad things could happen.
# In the future we should probably generalize this even further
# (mapping of param: squash field)
2015-07-07 15:59:20 +00:00
DEFAULT_SQUASH_ACTIONS = get_config ( p , DEFAULTS , ' squash_actions ' , ' ANSIBLE_SQUASH_ACTIONS ' , " apt, yum, pkgng, zypper, dnf " , islist = True )
# paths
2015-09-15 15:38:42 +00:00
DEFAULT_ACTION_PLUGIN_PATH = get_config ( p , DEFAULTS , ' action_plugins ' , ' ANSIBLE_ACTION_PLUGINS ' , ' ~/.ansible/plugins/action:/usr/share/ansible/plugins/action ' , ispath = True )
DEFAULT_CACHE_PLUGIN_PATH = get_config ( p , DEFAULTS , ' cache_plugins ' , ' ANSIBLE_CACHE_PLUGINS ' , ' ~/.ansible/plugins/cache:/usr/share/ansible/plugins/cache ' , ispath = True )
DEFAULT_CALLBACK_PLUGIN_PATH = get_config ( p , DEFAULTS , ' callback_plugins ' , ' ANSIBLE_CALLBACK_PLUGINS ' , ' ~/.ansible/plugins/callback:/usr/share/ansible/plugins/callback ' , ispath = True )
DEFAULT_CONNECTION_PLUGIN_PATH = get_config ( p , DEFAULTS , ' connection_plugins ' , ' ANSIBLE_CONNECTION_PLUGINS ' , ' ~/.ansible/plugins/connection:/usr/share/ansible/plugins/connection ' , ispath = True )
DEFAULT_LOOKUP_PLUGIN_PATH = get_config ( p , DEFAULTS , ' lookup_plugins ' , ' ANSIBLE_LOOKUP_PLUGINS ' , ' ~/.ansible/plugins/lookup:/usr/share/ansible/plugins/lookup ' , ispath = True )
2015-09-21 14:10:21 +00:00
DEFAULT_INVENTORY_PLUGIN_PATH = get_config ( p , DEFAULTS , ' inventory_plugins ' , ' ANSIBLE_INVENTORY_PLUGINS ' , ' ~/.ansible/plugins/inventory:/usr/share/ansible/plugins/inventory ' , ispath = True )
2015-09-15 15:38:42 +00:00
DEFAULT_VARS_PLUGIN_PATH = get_config ( p , DEFAULTS , ' vars_plugins ' , ' ANSIBLE_VARS_PLUGINS ' , ' ~/.ansible/plugins/vars:/usr/share/ansible/plugins/vars ' , ispath = True )
DEFAULT_FILTER_PLUGIN_PATH = get_config ( p , DEFAULTS , ' filter_plugins ' , ' ANSIBLE_FILTER_PLUGINS ' , ' ~/.ansible/plugins/filter:/usr/share/ansible/plugins/filter ' , ispath = True )
DEFAULT_TEST_PLUGIN_PATH = get_config ( p , DEFAULTS , ' test_plugins ' , ' ANSIBLE_TEST_PLUGINS ' , ' ~/.ansible/plugins/test:/usr/share/ansible/plugins/test ' , ispath = True )
2015-05-04 02:47:26 +00:00
DEFAULT_STDOUT_CALLBACK = get_config ( p , DEFAULTS , ' stdout_callback ' , ' ANSIBLE_STDOUT_CALLBACK ' , ' default ' )
2015-07-07 15:59:20 +00:00
# cache
2014-08-11 15:37:30 +00:00
CACHE_PLUGIN = get_config ( p , DEFAULTS , ' fact_caching ' , ' ANSIBLE_CACHE_PLUGIN ' , ' memory ' )
2014-08-11 19:16:51 +00:00
CACHE_PLUGIN_CONNECTION = get_config ( p , DEFAULTS , ' fact_caching_connection ' , ' ANSIBLE_CACHE_PLUGIN_CONNECTION ' , None )
CACHE_PLUGIN_PREFIX = get_config ( p , DEFAULTS , ' fact_caching_prefix ' , ' ANSIBLE_CACHE_PLUGIN_PREFIX ' , ' ansible_facts ' )
CACHE_PLUGIN_TIMEOUT = get_config ( p , DEFAULTS , ' fact_caching_timeout ' , ' ANSIBLE_CACHE_PLUGIN_TIMEOUT ' , 24 * 60 * 60 , integer = True )
2014-07-03 01:02:28 +00:00
2015-06-15 00:50:38 +00:00
# Display
2014-03-16 21:08:26 +00:00
ANSIBLE_FORCE_COLOR = get_config ( p , DEFAULTS , ' force_color ' , ' ANSIBLE_FORCE_COLOR ' , None , boolean = True )
2013-08-10 22:16:01 +00:00
ANSIBLE_NOCOLOR = get_config ( p , DEFAULTS , ' nocolor ' , ' ANSIBLE_NOCOLOR ' , None , boolean = True )
ANSIBLE_NOCOWS = get_config ( p , DEFAULTS , ' nocows ' , ' ANSIBLE_NOCOWS ' , None , boolean = True )
2015-10-15 14:32:55 +00:00
ANSIBLE_COW_SELECTION = get_config ( p , DEFAULTS , ' cow_selection ' , ' ANSIBLE_COW_SELECTION ' , ' default ' )
ANSIBLE_COW_WHITELIST = get_config ( p , DEFAULTS , ' cow_whitelist ' , ' ANSIBLE_COW_WHITELIST ' , DEFAULT_COW_WHITELIST , islist = True )
2013-09-26 14:03:23 +00:00
DISPLAY_SKIPPED_HOSTS = get_config ( p , DEFAULTS , ' display_skipped_hosts ' , ' DISPLAY_SKIPPED_HOSTS ' , True , boolean = True )
2013-10-11 22:37:39 +00:00
DEFAULT_UNDEFINED_VAR_BEHAVIOR = get_config ( p , DEFAULTS , ' error_on_undefined_vars ' , ' ANSIBLE_ERROR_ON_UNDEFINED_VARS ' , True , boolean = True )
HOST_KEY_CHECKING = get_config ( p , DEFAULTS , ' host_key_checking ' , ' ANSIBLE_HOST_KEY_CHECKING ' , True , boolean = True )
2014-04-30 19:44:10 +00:00
SYSTEM_WARNINGS = get_config ( p , DEFAULTS , ' system_warnings ' , ' ANSIBLE_SYSTEM_WARNINGS ' , True , boolean = True )
2013-10-11 22:37:39 +00:00
DEPRECATION_WARNINGS = get_config ( p , DEFAULTS , ' deprecation_warnings ' , ' ANSIBLE_DEPRECATION_WARNINGS ' , True , boolean = True )
2014-06-24 14:56:33 +00:00
DEFAULT_CALLABLE_WHITELIST = get_config ( p , DEFAULTS , ' callable_whitelist ' , ' ANSIBLE_CALLABLE_WHITELIST ' , [ ] , islist = True )
2015-07-18 19:24:44 +00:00
COMMAND_WARNINGS = get_config ( p , DEFAULTS , ' command_warnings ' , ' ANSIBLE_COMMAND_WARNINGS ' , True , boolean = True )
2014-09-10 13:38:24 +00:00
DEFAULT_LOAD_CALLBACK_PLUGINS = get_config ( p , DEFAULTS , ' bin_ansible_callbacks ' , ' ANSIBLE_LOAD_CALLBACK_PLUGINS ' , False , boolean = True )
2015-07-08 20:33:00 +00:00
DEFAULT_CALLBACK_WHITELIST = get_config ( p , DEFAULTS , ' callback_whitelist ' , ' ANSIBLE_CALLBACK_WHITELIST ' , [ ] , islist = True )
2015-05-04 02:47:26 +00:00
RETRY_FILES_ENABLED = get_config ( p , DEFAULTS , ' retry_files_enabled ' , ' ANSIBLE_RETRY_FILES_ENABLED ' , True , boolean = True )
2015-09-01 18:47:07 +00:00
RETRY_FILES_SAVE_PATH = get_config ( p , DEFAULTS , ' retry_files_save_path ' , ' ANSIBLE_RETRY_FILES_SAVE_PATH ' , ' ~/ ' , ispath = True )
2015-05-08 14:12:36 +00:00
DEFAULT_NULL_REPRESENTATION = get_config ( p , DEFAULTS , ' null_representation ' , ' ANSIBLE_NULL_REPRESENTATION ' , None , isnone = True )
2013-10-11 22:37:39 +00:00
# CONNECTION RELATED
2015-10-02 07:43:49 +00:00
ANSIBLE_SSH_ARGS = get_config ( p , ' ssh_connection ' , ' ssh_args ' , ' ANSIBLE_SSH_ARGS ' , ' -o ControlMaster=auto -o ControlPersist=60s ' )
2013-09-18 19:03:40 +00:00
ANSIBLE_SSH_CONTROL_PATH = get_config ( p , ' ssh_connection ' , ' control_path ' , ' ANSIBLE_SSH_CONTROL_PATH ' , " %(directory)s /ansible-ssh- %% h- %% p- %% r " )
Make sudo+requiretty and ANSIBLE_PIPELINING work together
Pipelining is a *significant* performance benefit, because each task can
be completed with a single SSH connection (vs. one ssh connection at the
start to mkdir, plus one sftp and one ssh per task).
Pipelining is disabled by default in Ansible because it conflicts with
the use of sudo if 'Defaults requiretty' is set in /etc/sudoers (as it
is on Red Hat) and su (which always requires a tty).
We can (and already do) make sudo/su happy by using "ssh -t" to allocate
a tty, but then the python interpreter goes into interactive mode and is
unhappy with module source being written to its stdin, per the following
comment from connections/ssh.py:
# we can only use tty when we are not pipelining the modules.
# piping data into /usr/bin/python inside a tty automatically
# invokes the python interactive-mode but the modules are not
# compatible with the interactive-mode ("unexpected indent"
# mainly because of empty lines)
Instead of the (current) drastic solution of turning off pipelining when
we use a tty, we can instead use a tty but suppress the behaviour of the
Python interpreter to switch to interactive mode. The easiest way to do
this is to make its stdin *not* be a tty, e.g. with cat|python.
This works, but there's a problem: ssh will ignore -t if its input isn't
really a tty. So we could open a pseudo-tty and use that as ssh's stdin,
but if we then write Python source into it, it's all echoed back to us
(because we're a tty). So we have to use -tt to force tty allocation; in
that case, however, ssh puts the tty into "raw" mode (~ICANON), so there
is no good way for the process on the other end to detect EOF on stdin.
So if we do:
echo -e "print('hello world')\n"|ssh -tt someho.st "cat|python"
…it hangs forever, because cat keeps on reading input even after we've
closed our pipe into ssh's stdin. We can get around this by writing a
special __EOF__ marker after writing in_data, and doing this:
echo -e "print('hello world')\n__EOF__\n"|ssh -tt someho.st "sed -ne '/__EOF__/q' -e p|python"
This works fine, but in fact I use a clever python one-liner by mgedmin
to achieve the same effect without depending on sed (at the expense of a
much longer command line, alas; Python really isn't one-liner-friendly).
We also enable pipelining by default as a consequence.
2015-11-05 12:01:31 +00:00
ANSIBLE_SSH_PIPELINING = get_config ( p , ' ssh_connection ' , ' pipelining ' , ' ANSIBLE_SSH_PIPELINING ' , True , boolean = True )
2015-03-27 18:24:33 +00:00
ANSIBLE_SSH_RETRIES = get_config ( p , ' ssh_connection ' , ' retries ' , ' ANSIBLE_SSH_RETRIES ' , 0 , integer = True )
2013-07-06 01:42:41 +00:00
PARAMIKO_RECORD_HOST_KEYS = get_config ( p , ' paramiko_connection ' , ' record_host_keys ' , ' ANSIBLE_PARAMIKO_RECORD_HOST_KEYS ' , True , boolean = True )
2015-03-27 18:24:33 +00:00
2015-07-07 15:59:20 +00:00
2014-11-24 21:36:31 +00:00
# obsolete -- will be formally removed
2013-08-22 23:04:11 +00:00
ZEROMQ_PORT = get_config ( p , ' fireball_connection ' , ' zeromq_port ' , ' ANSIBLE_ZEROMQ_PORT ' , 5099 , integer = True )
ACCELERATE_PORT = get_config ( p , ' accelerate ' , ' accelerate_port ' , ' ACCELERATE_PORT ' , 5099 , integer = True )
2013-10-07 12:39:23 +00:00
ACCELERATE_TIMEOUT = get_config ( p , ' accelerate ' , ' accelerate_timeout ' , ' ACCELERATE_TIMEOUT ' , 30 , integer = True )
ACCELERATE_CONNECT_TIMEOUT = get_config ( p , ' accelerate ' , ' accelerate_connect_timeout ' , ' ACCELERATE_CONNECT_TIMEOUT ' , 1.0 , floating = True )
2014-03-23 19:45:05 +00:00
ACCELERATE_DAEMON_TIMEOUT = get_config ( p , ' accelerate ' , ' accelerate_daemon_timeout ' , ' ACCELERATE_DAEMON_TIMEOUT ' , 30 , integer = True )
2014-02-06 08:53:43 +00:00
ACCELERATE_KEYS_DIR = get_config ( p , ' accelerate ' , ' accelerate_keys_dir ' , ' ACCELERATE_KEYS_DIR ' , ' ~/.fireball.keys ' )
ACCELERATE_KEYS_DIR_PERMS = get_config ( p , ' accelerate ' , ' accelerate_keys_dir_perms ' , ' ACCELERATE_KEYS_DIR_PERMS ' , ' 700 ' )
ACCELERATE_KEYS_FILE_PERMS = get_config ( p , ' accelerate ' , ' accelerate_keys_file_perms ' , ' ACCELERATE_KEYS_FILE_PERMS ' , ' 600 ' )
2014-03-19 17:59:06 +00:00
ACCELERATE_MULTI_KEY = get_config ( p , ' accelerate ' , ' accelerate_multi_key ' , ' ACCELERATE_MULTI_KEY ' , False , boolean = True )
2013-09-25 12:15:49 +00:00
PARAMIKO_PTY = get_config ( p , ' paramiko_connection ' , ' pty ' , ' ANSIBLE_PARAMIKO_PTY ' , True , boolean = True )
2012-09-18 12:41:27 +00:00
2015-05-04 02:47:26 +00:00
# galaxy related
DEFAULT_GALAXY_URI = get_config ( p , ' galaxy ' , ' server_uri ' , ' ANSIBLE_GALAXY_SERVER_URI ' , ' https://galaxy.ansible.com ' )
# this can be configured to blacklist SCMS but cannot add new ones unless the code is also updated
2015-07-08 20:33:00 +00:00
GALAXY_SCMS = get_config ( p , ' galaxy ' , ' scms ' , ' ANSIBLE_GALAXY_SCMS ' , ' git, hg ' , islist = True )
2015-05-04 02:47:26 +00:00
2013-11-01 14:51:35 +00:00
# characters included in auto-generated passwords
DEFAULT_PASSWORD_CHARS = ascii_letters + digits + " .,:-_ "
2013-06-18 17:24:30 +00:00
2012-08-13 23:17:14 +00:00
# non-configurable things
2015-05-04 02:47:26 +00:00
MODULE_REQUIRE_ARGS = [ ' command ' , ' shell ' , ' raw ' , ' script ' ]
2015-07-23 17:42:20 +00:00
MODULE_NO_JSON = [ ' command ' , ' shell ' , ' raw ' ]
2014-11-24 21:36:31 +00:00
DEFAULT_BECOME_PASS = None
2012-08-13 23:17:14 +00:00
DEFAULT_SUDO_PASS = None
2012-10-26 18:49:56 +00:00
DEFAULT_REMOTE_PASS = None
2012-08-13 23:17:14 +00:00
DEFAULT_SUBSET = None
2014-01-21 01:19:03 +00:00
DEFAULT_SU_PASS = None
2014-02-11 17:03:11 +00:00
VAULT_VERSION_MIN = 1.0
VAULT_VERSION_MAX = 1.0
2015-07-26 16:21:38 +00:00
MAX_FILE_SIZE_FOR_DIFF = 1 * 1024 * 1024
2015-08-11 23:18:10 +00:00
TREE_DIR = None
2015-08-19 00:02:03 +00:00
LOCALHOST = frozenset ( [ ' 127.0.0.1 ' , ' localhost ' , ' ::1 ' ] )