ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity
community.general/lib/ansible/constants.py

232 lines
15 KiB
Python
Raw Normal View History

Update various copyrights. Not complete, but sufficient.
2014-01-04 19:31:44 +01:00
# (c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
Relicensing to GPLv3, all previous committers ok'd on mailing list.
2012-02-29 01:08:09 +01: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/>.
Making the switch to v2
2015-05-04 04:47:26 +02:00
# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
Update constants.py to pull module path and the hosts file from the environment (ANSIBLE_{LIBRARY,HOSTS}) if defined. Update manpages to represent this. Also update the env-setup script to set ANSIBLE_{LIBRARY,HOSTS}.
2012-03-05 22:06:02 +01:00
import os
Default -u (user) and "user:" in playbooks to the current user.
2012-08-11 23:33:34 +02:00
import pwd
Fix installing to virtualenvs.
2012-11-01 19:40:28 +01:00
import sys
Making the switch to v2
2015-05-04 04:47:26 +02:00
from six.moves import configparser
Revised patch for more password entropy
2013-11-01 15:51:35 +01:00
from string import ascii_letters, digits
Update constants.py to pull module path and the hosts file from the environment (ANSIBLE_{LIBRARY,HOSTS}) if defined. Update manpages to represent this. Also update the env-setup script to set ANSIBLE_{LIBRARY,HOSTS}.
2012-03-05 22:06:02 +01:00
Makes host key checking the default behavior but can be disabled in ansible.cfg or by environment variable.
2013-07-03 22:47:20 +02:00
# copied from utils, avoid circular reference fun :)
def mk_boolean(value):
These fields are booleans.
2013-08-11 00:16:01 +02:00
if value is None:
return False
Makes host key checking the default behavior but can be disabled in ansible.cfg or by environment variable.
2013-07-03 22:47:20 +02:00
val = str(value)
if val.lower() in [ "true", "t", "y", "1", "yes" ]:
return True
else:
return False
Change safe_eval to a strict white list
2014-06-24 16:56:33 +02:00
def get_config(p, section, key, env_var, default, boolean=False, integer=False, floating=False, islist=False):
Makes host key checking the default behavior but can be disabled in ansible.cfg or by environment variable.
2013-07-03 22:47:20 +02:00
''' return a configuration variable with casting '''
value = _get_config(p, section, key, env_var, default)
if boolean:
Making the switch to v2
2015-05-04 04:47:26 +02:00
value = mk_boolean(value)
if value:
if integer:
value = int(value)
elif floating:
value = float(value)
elif islist:
if isinstance(value, basestring):
value = [x.strip() for x in value.split(',')]
Makes host key checking the default behavior but can be disabled in ansible.cfg or by environment variable.
2013-07-03 22:47:20 +02:00
return value
Remove unused parameter from _get_config
2013-12-12 17:48:02 +01:00
def _get_config(p, section, key, env_var, default):
Makes host key checking the default behavior but can be disabled in ansible.cfg or by environment variable.
2013-07-03 22:47:20 +02:00
''' helper function for get_config '''
Docs + fix variable precedence of environment variables (ok, ok, I give in!)
2012-10-17 00:40:01 +02:00
if env_var is not None:
Env var vs config priority fixing
2012-10-18 04:34:59 +02:00
value = os.environ.get(env_var, None)
if value is not None:
return value
config file support
2012-08-14 01:17:14 +02:00
if p is not None:
try:
Make ssh's ControlPath configurable via ansible.cfg This shouldn't generally be needed unless you're working in an environment that uses rediculously long FQDNs; if the name is too long, you wind up hitting unix domain socket filepath limits enforced by ssh.
2013-09-18 21:03:40 +02:00
return p.get(section, key, raw=True)
config file support
2012-08-14 01:17:14 +02:00
except:
return default
delete extra else clause
2012-10-19 02:27:39 +02:00
return default
Add support for specifying sudo passwords to both ansible & playbook. Nopasswd sudo is no longer required.
2012-04-14 01:06:11 +02:00
config file support
2012-08-14 01:17:14 +02:00
def load_config_file():
Config resoution order correction and documentation.
2014-02-14 21:34:58 +01:00
''' Load Config File order(first found is used): ENV, CWD, HOME, /etc/ansible '''
Making the switch to v2
2015-05-04 04:47:26 +02:00
p = configparser.ConfigParser()
Config resoution order correction and documentation.
2014-02-14 21:34:58 +01:00
path0 = os.getenv("ANSIBLE_CONFIG", None)
if path0 is not None:
path0 = os.path.expanduser(path0)
GH-4452 Corrected config load order to match docs with cwd > ~ > /etc Signed-off-by: Philip Schwartz <philip.schwartz@rackspace.com>
2013-10-11 15:25:57 +02:00
path1 = os.getcwd() + "/ansible.cfg"
Config resoution order correction and documentation.
2014-02-14 21:34:58 +01:00
path2 = os.path.expanduser("~/.ansible.cfg")
Add support for ./ansible.cfg file Ansible support configuration in: ``` ~/.ansible.cfg /etc/ansible/ansible.cfg ``` this patch add current user (usefull where user have some different projects) with the oreder: ``` ./ansible.cfg ~/.ansible.cfg /etc/ansible/ansible.cfg ```
2012-09-10 16:57:32 +02:00
path3 = "/etc/ansible/ansible.cfg"
Config resoution order correction and documentation.
2014-02-14 21:34:58 +01:00
for path in [path0, path1, path2, path3]:
if path is not None and os.path.exists(path):
Handle exceptions during config file parsing Handle uncaught exceptions during config file parsing
2014-08-29 16:43:30 +02:00
try:
p.read(path)
Making the switch to v2
2015-05-04 04:47:26 +02:00
except configparser.Error as e:
print("Error reading config file: \n{0}".format(e))
Handle exceptions during config file parsing Handle uncaught exceptions during config file parsing
2014-08-29 16:43:30 +02:00
sys.exit(1)
Config resoution order correction and documentation.
2014-02-14 21:34:58 +01:00
return p
return None
config file support
2012-08-14 01:17:14 +02:00
Further fixes for constants following config introduction Added an ANSIBLE_CONFIG variable to poteentially override ~/.ansible.cfg Used os.path.expanduser against all paths that might be read in to allow ~ to be used in config files. I'd have preferred it if os.path.expanduser took None as an argument but it doesn't. If remote_port *is* set in the ansible config file, then it will be interpreted as a string (at which point ssh.connect fails with an obscure message). Most other numeric variables are handled by the OptionsParser which takes a type variable when setting up the option - but remote_port is not an option, so never cast to int. It might be worth adding a type field to get_config that defaults to a string. That could be e.g. file or int, which then casts it correctly.
2012-08-14 12:22:47 +02:00
def shell_expand_path(path):
ANSIBLE_CONFIG take precedence over ./ansible.cfg
2012-09-28 18:21:56 +02:00
''' shell_expand_path is needed as os.path.expanduser does not work
Further fixes for constants following config introduction Added an ANSIBLE_CONFIG variable to poteentially override ~/.ansible.cfg Used os.path.expanduser against all paths that might be read in to allow ~ to be used in config files. I'd have preferred it if os.path.expanduser took None as an argument but it doesn't. If remote_port *is* set in the ansible config file, then it will be interpreted as a string (at which point ssh.connect fails with an obscure message). Most other numeric variables are handled by the OptionsParser which takes a type variable when setting up the option - but remote_port is not an option, so never cast to int. It might be worth adding a type field to get_config that defaults to a string. That could be e.g. file or int, which then casts it correctly.
2012-08-14 12:22:47 +02:00
when path is None, which is the default for ANSIBLE_PRIVATE_KEY_FILE '''
if path:
Expand variables in configuration files, take two e.g. $HOME.
2014-07-29 14:20:30 +02:00
path = os.path.expanduser(os.path.expandvars(path))
Further fixes for constants following config introduction Added an ANSIBLE_CONFIG variable to poteentially override ~/.ansible.cfg Used os.path.expanduser against all paths that might be read in to allow ~ to be used in config files. I'd have preferred it if os.path.expanduser took None as an argument but it doesn't. If remote_port *is* set in the ansible config file, then it will be interpreted as a string (at which point ssh.connect fails with an obscure message). Most other numeric variables are handled by the OptionsParser which takes a type variable when setting up the option - but remote_port is not an option, so never cast to int. It might be worth adding a type field to get_config that defaults to a string. That could be e.g. file or int, which then casts it correctly.
2012-08-14 12:22:47 +02:00
return path
config file support
2012-08-14 01:17:14 +02:00
p = load_config_file()
active_user = pwd.getpwuid(os.geteuid())[0]
refactor to catch edge cases, remove repeated code - Move all the supported YAML file extensions into a constant - Use helper functions to avoid duplicate code for group/host vars - Catch and disallow some confusing situations, such as the presence of multiple group/host vars files for the same group/host, but with different extensions. For example having both group_vars/all.yml and group_vars/all.yaml. - Catch and report file system permission issues, symlink errors, unexpected file system objects - Trivial performance improvement from making fewer stat system calls - Restructuring that makes it easy for a following patch to support directory recursion
2013-10-31 18:05:52 +01:00
# check all of these extensions when looking for yaml files for things like
Also search .json filenames
2014-03-07 03:47:49 +01:00
# group variables -- really anything we can load
YAML_FILENAME_EXTENSIONS = [ "", ".yml", ".yaml", ".json" ]
refactor to catch edge cases, remove repeated code - Move all the supported YAML file extensions into a constant - Use helper functions to avoid duplicate code for group/host vars - Catch and disallow some confusing situations, such as the presence of multiple group/host vars files for the same group/host, but with different extensions. For example having both group_vars/all.yml and group_vars/all.yaml. - Catch and report file system permission issues, symlink errors, unexpected file system objects - Trivial performance improvement from making fewer stat system calls - Restructuring that makes it easy for a following patch to support directory recursion
2013-10-31 18:05:52 +01:00
config file support
2012-08-14 01:17:14 +02:00
# sections in config file
DEFAULTS='defaults'
fixed new become settings, rearranged constants to find PE related vars easier
2015-06-15 02:50:38 +02:00
# generaly configurable things
Making the switch to v2
2015-05-04 04:47:26 +02:00
DEFAULT_DEBUG = get_config(p, DEFAULTS, 'debug', 'ANSIBLE_DEBUG', False, boolean=True)
DEFAULT_HOST_LIST = shell_expand_path(get_config(p, DEFAULTS, 'hostfile', 'ANSIBLE_HOSTS', get_config(p, DEFAULTS,'inventory','ANSIBLE_INVENTORY', '/etc/ansible/hosts')))
changes for package loading of modules
2014-09-26 17:25:56 +02:00
DEFAULT_MODULE_PATH = get_config(p, DEFAULTS, 'library', 'ANSIBLE_LIBRARY', None)
Shell expand DEFAULT_ROLES_PATH fixes #4897
2014-06-21 01:22:11 +02:00
DEFAULT_ROLES_PATH = shell_expand_path(get_config(p, DEFAULTS, 'roles_path', 'ANSIBLE_ROLES_PATH', '/etc/ansible/roles'))
Don't expand remote_tmp path locally
2014-07-29 14:13:50 +02:00
DEFAULT_REMOTE_TMP = get_config(p, DEFAULTS, 'remote_tmp', 'ANSIBLE_REMOTE_TEMP', '$HOME/.ansible/tmp')
config file support
2012-08-14 01:17:14 +02:00
DEFAULT_MODULE_NAME = get_config(p, DEFAULTS, 'module_name', None, 'command')
DEFAULT_PATTERN = get_config(p, DEFAULTS, 'pattern', None, '*')
For defaults that are integers, enforce it for config supplied values. If a user supplies a string in the config (rather than an int), the code should fix that- or blow up immediately- rather than allowing that value to work it's way down and break w/in the connection object; when that happens, the actual error is opaque and requires pdb.set_trace() to run down.
2013-08-23 01:04:11 +02:00
DEFAULT_FORKS = get_config(p, DEFAULTS, 'forks', 'ANSIBLE_FORKS', 5, integer=True)
config file support
2012-08-14 01:17:14 +02:00
DEFAULT_MODULE_ARGS = get_config(p, DEFAULTS, 'module_args', 'ANSIBLE_MODULE_ARGS', '')
Set the default LANG to en_US.UTF-8 and also set LC_CTYPE Fixes #6737
2014-04-22 07:47:26 +02:00
DEFAULT_MODULE_LANG = get_config(p, DEFAULTS, 'module_lang', 'ANSIBLE_MODULE_LANG', 'en_US.UTF-8')
For defaults that are integers, enforce it for config supplied values. If a user supplies a string in the config (rather than an int), the code should fix that- or blow up immediately- rather than allowing that value to work it's way down and break w/in the connection object; when that happens, the actual error is opaque and requires pdb.set_trace() to run down.
2013-08-23 01:04:11 +02: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)
config file support
2012-08-14 01:17:14 +02:00
DEFAULT_REMOTE_USER = get_config(p, DEFAULTS, 'remote_user', 'ANSIBLE_REMOTE_USER', active_user)
Makes host key checking the default behavior but can be disabled in ansible.cfg or by environment variable.
2013-07-03 22:47:20 +02:00
DEFAULT_ASK_PASS = get_config(p, DEFAULTS, 'ask_pass', 'ANSIBLE_ASK_PASS', False, boolean=True)
Further fixes for constants following config introduction Added an ANSIBLE_CONFIG variable to poteentially override ~/.ansible.cfg Used os.path.expanduser against all paths that might be read in to allow ~ to be used in config files. I'd have preferred it if os.path.expanduser took None as an argument but it doesn't. If remote_port *is* set in the ansible config file, then it will be interpreted as a string (at which point ssh.connect fails with an obscure message). Most other numeric variables are handled by the OptionsParser which takes a type variable when setting up the option - but remote_port is not an option, so never cast to int. It might be worth adding a type field to get_config that defaults to a string. That could be e.g. file or int, which then casts it correctly.
2012-08-14 12:22:47 +02:00
DEFAULT_PRIVATE_KEY_FILE = shell_expand_path(get_config(p, DEFAULTS, 'private_key_file', 'ANSIBLE_PRIVATE_KEY_FILE', None))
Make default ANSIBLE_REMOTE_PORT None The ansible remote port should be None, not 22. Having a default value of 22 means that '-o Port 22' will be appended to the ssh connection all of the time. This is incorrect as when one would like to use something like an ssh configuration file (-F) that sets the port to something other than 22. Part of this change requires that we check that, in get_config, the value is not None before trying to cast it into an integer or float.
2014-01-23 18:49:07 +01:00
DEFAULT_REMOTE_PORT = get_config(p, DEFAULTS, 'remote_port', 'ANSIBLE_REMOTE_PORT', None, integer=True)
Ansible vault: a framework for encrypting any playbook or var file.
2014-02-11 18:03:11 +01:00
DEFAULT_ASK_VAULT_PASS = get_config(p, DEFAULTS, 'ask_vault_pass', 'ANSIBLE_ASK_VAULT_PASS', False, boolean=True)
Allow --vault-password-file to work with a script as well as a flat file
2014-06-03 16:34:42 +02:00
DEFAULT_VAULT_PASSWORD_FILE = shell_expand_path(get_config(p, DEFAULTS, 'vault_password_file', 'ANSIBLE_VAULT_PASSWORD_FILE', None))
Default to 'smart' transport, which will use OpenSSH if it can support ControlPersist.
2013-07-04 22:47:17 +02:00
DEFAULT_TRANSPORT = get_config(p, DEFAULTS, 'transport', 'ANSIBLE_TRANSPORT', 'smart')
Makes host key checking the default behavior but can be disabled in ansible.cfg or by environment variable.
2013-07-03 22:47:20 +02:00
DEFAULT_SCP_IF_SSH = get_config(p, 'ssh_connection', 'scp_if_ssh', 'ANSIBLE_SCP_IF_SSH', False, boolean=True)
Allow user-specified $ansible_managed string with named parameters
2012-10-03 15:59:38 +02: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}')
Add ability to specify syslog facility for modules Update constants.py so that one can specify environmental variable ANSIBLE_SYSLOG_FACILITY or syslog_facility in ansible.cfg to define the syslog facility to use. Alternatively, you can specify ansible_syslog_facility in inventory. Runner now replaces the syslog facility in the openlog() call with the default or the injected variables ansible_syslog_facility. This also updates hacking/test-module to behave similarly.
2012-11-10 07:13:00 +01:00
DEFAULT_SYSLOG_FACILITY = get_config(p, DEFAULTS, 'syslog_facility', 'ANSIBLE_SYSLOG_FACILITY', 'LOG_USER')
now ANSIBLE_KEEP_REMOTE_FILE acts as boolean Signed-off-by: Brian Coca <briancoca+dev@gmail.com>
2013-07-15 04:08:36 +02:00
DEFAULT_KEEP_REMOTE_FILES = get_config(p, DEFAULTS, 'keep_remote_files', 'ANSIBLE_KEEP_REMOTE_FILES', False, boolean=True)
Adds user-selectable hash merging support in vars Hash variables are currently overriden if they are redefined. This doesn't let the user refine hash entries or overriding selected keys, which can, for some, be a desirable feature. This patch let the user force hash merging by setting the hash_behaviour value to "merge" (without the quotes) in ansible.cfg However, by default, ansible behaves like it always did and if any value besides "merge" is used ("replace" is suggested in the example ansible.cfg file), it will also behave as always.
2013-01-23 21:39:34 +01:00
DEFAULT_HASH_BEHAVIOUR = get_config(p, DEFAULTS, 'hash_behaviour', 'ANSIBLE_HASH_BEHAVIOUR', 'replace')
Allow role variables to be optionally kept in a private scope
2015-07-01 17:32:44 +02:00
DEFAULT_PRIVATE_ROLE_VARS = get_config(p, DEFAULTS, 'private_role_vars', 'ANSIBLE_PRIVATE_ROLE_VARS', False, boolean=True)
Fixes jina typos Moved *jina* to *jinja2*
2013-02-13 17:33:43 +01:00
DEFAULT_JINJA2_EXTENSIONS = get_config(p, DEFAULTS, 'jinja2_extensions', 'ANSIBLE_JINJA2_EXTENSIONS', None)
Added DEFAULT_EXECUTABLE as a constant Use DEFAULT_EXECUTABLE when no executable is passed to _low_level_command_exec Works as a standard constant - can be overridden in all the normal ways and defaults to /bin/sh Motiviation is for a user that only has /bin/bash in /etc/sudoers
2013-04-04 05:10:30 +02:00
DEFAULT_EXECUTABLE = get_config(p, DEFAULTS, 'executable', 'ANSIBLE_EXECUTABLE', '/bin/sh')
Change safe_eval to a strict white list
2014-06-24 16:56:33 +02:00
DEFAULT_GATHERING = get_config(p, DEFAULTS, 'gathering', 'ANSIBLE_GATHERING', 'implicit').lower()
made special treatment of certain filesystem for selinux configurable
2015-05-14 16:50:22 +02:00
DEFAULT_LOG_PATH = shell_expand_path(get_config(p, DEFAULTS, 'log_path', 'ANSIBLE_LOG_PATH', ''))
# selinux
DEFAULT_SELINUX_SPECIAL_FS = get_config(p, 'selinux', 'special_context_filesystems', None, 'fuse, nfs, vboxsf', islist=True)
Adds a logfile for ansible playbooks that can be set by the environment or configuration file.
2013-04-27 16:24:26 +02:00
fixed new become settings, rearranged constants to find PE related vars easier
2015-06-15 02:50:38 +02: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')
DEFAULT_SU_EXE = get_config(p, DEFAULTS, 'su_exe', 'ANSIBLE_SU_EXE', 'su')
DEFAULT_SU_FLAGS = get_config(p, DEFAULTS, 'su_flags', 'ANSIBLE_SU_FLAGS', '')
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')
DEFAULT_SUDO_EXE = get_config(p, DEFAULTS, 'sudo_exe', 'ANSIBLE_SUDO_EXE', 'sudo')
DEFAULT_SUDO_FLAGS = get_config(p, DEFAULTS, 'sudo_flags', 'ANSIBLE_SUDO_FLAGS', '-H')
DEFAULT_ASK_SUDO_PASS = get_config(p, DEFAULTS, 'ask_sudo_pass', 'ANSIBLE_ASK_SUDO_PASS', False, boolean=True)
# Become
now detects incorrect password with sudo and su (at least in english)
2015-06-15 07:30:03 +02:00
BECOME_ERROR_STRINGS = {'sudo': 'Sorry, try again.', 'su': 'Authentication failure', 'pbrun': '', 'pfexec': '', 'runas': ''} #FIXME: deal with i18n
fixes password error detection for ssh connection plugin removes sycnronize test that does not work with current sudo setup Fixes #10434
2015-03-11 20:55:37 +01:00
BECOME_METHODS = ['sudo','su','pbrun','pfexec','runas']
preliminary privlege escalation unification + pbrun - become constants inherit existing sudo/su ones - become command line options, marked sudo/su as deprecated and moved sudo/su passwords to runas group - changed method signatures as privlege escalation is collapsed to become - added tests for su and become, diabled su for lack of support in local.py - updated playbook,play and task objects to become - added become to runner - added whoami test for become/sudo/su - added home override dir for plugins - removed useless method from ask pass - forced become pass to always be string also uses to_bytes - fixed fakerunner for tests - corrected reference in synchronize action plugin - added pfexec (needs testing) - removed unused sudo/su in runner init - removed deprecated info - updated pe tests to allow to run under sudo and not need root - normalized become options into a funciton to avoid duplication and inconsistencies - pushed suppored list to connection classs property - updated all connection plugins to latest 'become' pe - includes fixes from feedback (including typos) - added draft docs - stub of become_exe, leaving for future v2 fixes
2014-11-24 22:36:31 +01: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()
fixed new become settings, rearranged constants to find PE related vars easier
2015-06-15 02:50:38 +02:00
DEFAULT_BECOME = get_config(p, 'privilege_escalation', 'become', 'ANSIBLE_BECOME',False, boolean=True)
Making the switch to v2
2015-05-04 04:47:26 +02:00
DEFAULT_BECOME_USER = get_config(p, 'privilege_escalation', 'become_user', 'ANSIBLE_BECOME_USER', 'root')
fixed new become settings, rearranged constants to find PE related vars easier
2015-06-15 02:50:38 +02: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)
removed folding sudo/su to become logic from constants as it is already present downstream in playbook/play/tasks
2015-03-27 13:45:04 +01:00
DEFAULT_BECOME_ASK_PASS = get_config(p, 'privilege_escalation', 'become_ask_pass', 'ANSIBLE_BECOME_ASK_PASS', False, boolean=True)
preliminary privlege escalation unification + pbrun - become constants inherit existing sudo/su ones - become command line options, marked sudo/su as deprecated and moved sudo/su passwords to runas group - changed method signatures as privlege escalation is collapsed to become - added tests for su and become, diabled su for lack of support in local.py - updated playbook,play and task objects to become - added become to runner - added whoami test for become/sudo/su - added home override dir for plugins - removed useless method from ask pass - forced become pass to always be string also uses to_bytes - fixed fakerunner for tests - corrected reference in synchronize action plugin - added pfexec (needs testing) - removed unused sudo/su in runner init - removed deprecated info - updated pe tests to allow to run under sudo and not need root - normalized become options into a funciton to avoid duplication and inconsistencies - pushed suppored list to connection classs property - updated all connection plugins to latest 'become' pe - includes fixes from feedback (including typos) - added draft docs - stub of become_exe, leaving for future v2 fixes
2014-11-24 22:36:31 +01:00
fixed new become settings, rearranged constants to find PE related vars easier
2015-06-15 02:50:38 +02:00
# Plugin paths
preliminary privlege escalation unification + pbrun - become constants inherit existing sudo/su ones - become command line options, marked sudo/su as deprecated and moved sudo/su passwords to runas group - changed method signatures as privlege escalation is collapsed to become - added tests for su and become, diabled su for lack of support in local.py - updated playbook,play and task objects to become - added become to runner - added whoami test for become/sudo/su - added home override dir for plugins - removed useless method from ask pass - forced become pass to always be string also uses to_bytes - fixed fakerunner for tests - corrected reference in synchronize action plugin - added pfexec (needs testing) - removed unused sudo/su in runner init - removed deprecated info - updated pe tests to allow to run under sudo and not need root - normalized become options into a funciton to avoid duplication and inconsistencies - pushed suppored list to connection classs property - updated all connection plugins to latest 'become' pe - includes fixes from feedback (including typos) - added draft docs - stub of become_exe, leaving for future v2 fixes
2014-11-24 22:36:31 +01:00
DEFAULT_ACTION_PLUGIN_PATH = get_config(p, DEFAULTS, 'action_plugins', 'ANSIBLE_ACTION_PLUGINS', '~/.ansible/plugins/action_plugins:/usr/share/ansible_plugins/action_plugins')
DEFAULT_CACHE_PLUGIN_PATH = get_config(p, DEFAULTS, 'cache_plugins', 'ANSIBLE_CACHE_PLUGINS', '~/.ansible/plugins/cache_plugins:/usr/share/ansible_plugins/cache_plugins')
DEFAULT_CALLBACK_PLUGIN_PATH = get_config(p, DEFAULTS, 'callback_plugins', 'ANSIBLE_CALLBACK_PLUGINS', '~/.ansible/plugins/callback_plugins:/usr/share/ansible_plugins/callback_plugins')
DEFAULT_CONNECTION_PLUGIN_PATH = get_config(p, DEFAULTS, 'connection_plugins', 'ANSIBLE_CONNECTION_PLUGINS', '~/.ansible/plugins/connection_plugins:/usr/share/ansible_plugins/connection_plugins')
DEFAULT_LOOKUP_PLUGIN_PATH = get_config(p, DEFAULTS, 'lookup_plugins', 'ANSIBLE_LOOKUP_PLUGINS', '~/.ansible/plugins/lookup_plugins:/usr/share/ansible_plugins/lookup_plugins')
DEFAULT_VARS_PLUGIN_PATH = get_config(p, DEFAULTS, 'vars_plugins', 'ANSIBLE_VARS_PLUGINS', '~/.ansible/plugins/vars_plugins:/usr/share/ansible_plugins/vars_plugins')
DEFAULT_FILTER_PLUGIN_PATH = get_config(p, DEFAULTS, 'filter_plugins', 'ANSIBLE_FILTER_PLUGINS', '~/.ansible/plugins/filter_plugins:/usr/share/ansible_plugins/filter_plugins')
Making the switch to v2
2015-05-04 04:47:26 +02:00
DEFAULT_STDOUT_CALLBACK = get_config(p, DEFAULTS, 'stdout_callback', 'ANSIBLE_STDOUT_CALLBACK', 'default')
preliminary privlege escalation unification + pbrun - become constants inherit existing sudo/su ones - become command line options, marked sudo/su as deprecated and moved sudo/su passwords to runas group - changed method signatures as privlege escalation is collapsed to become - added tests for su and become, diabled su for lack of support in local.py - updated playbook,play and task objects to become - added become to runner - added whoami test for become/sudo/su - added home override dir for plugins - removed useless method from ask pass - forced become pass to always be string also uses to_bytes - fixed fakerunner for tests - corrected reference in synchronize action plugin - added pfexec (needs testing) - removed unused sudo/su in runner init - removed deprecated info - updated pe tests to allow to run under sudo and not need root - normalized become options into a funciton to avoid duplication and inconsistencies - pushed suppored list to connection classs property - updated all connection plugins to latest 'become' pe - includes fixes from feedback (including typos) - added draft docs - stub of become_exe, leaving for future v2 fixes
2014-11-24 22:36:31 +01:00
Fix some copyrights, fix a misc test.
2014-08-11 17:37:30 +02:00
CACHE_PLUGIN = get_config(p, DEFAULTS, 'fact_caching', 'ANSIBLE_CACHE_PLUGIN', 'memory')
Rename some INI keys for fact caching defaults
2014-08-11 21:16:51 +02: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)
WIP on the re-implementation of fact caching and various backends.
2014-07-03 03:02:28 +02:00
fixed new become settings, rearranged constants to find PE related vars easier
2015-06-15 02:50:38 +02:00
# Display
Merge commit.
2014-03-16 22:08:26 +01:00
ANSIBLE_FORCE_COLOR = get_config(p, DEFAULTS, 'force_color', 'ANSIBLE_FORCE_COLOR', None, boolean=True)
These fields are booleans.
2013-08-11 00:16:01 +02: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)
Optionally display Skipping [host] messages.
2013-09-26 16:03:23 +02:00
DISPLAY_SKIPPED_HOSTS = get_config(p, DEFAULTS, 'display_skipped_hosts', 'DISPLAY_SKIPPED_HOSTS', True, boolean=True)
Deprecation warnings of several flavors, nice and purple and can be disabled in ansible.cfg.
2013-10-12 00:37:39 +02: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)
Adding a new system_warnings config option to supress warnings
2014-04-30 21:44:10 +02:00
SYSTEM_WARNINGS = get_config(p, DEFAULTS, 'system_warnings', 'ANSIBLE_SYSTEM_WARNINGS', True, boolean=True)
Deprecation warnings of several flavors, nice and purple and can be disabled in ansible.cfg.
2013-10-12 00:37:39 +02:00
DEPRECATION_WARNINGS = get_config(p, DEFAULTS, 'deprecation_warnings', 'ANSIBLE_DEPRECATION_WARNINGS', True, boolean=True)
Change safe_eval to a strict white list
2014-06-24 16:56:33 +02:00
DEFAULT_CALLABLE_WHITELIST = get_config(p, DEFAULTS, 'callable_whitelist', 'ANSIBLE_CALLABLE_WHITELIST', [], islist=True)
Make command warnings off by default to minimize surprises.
2014-08-22 22:12:32 +02:00
COMMAND_WARNINGS = get_config(p, DEFAULTS, 'command_warnings', 'ANSIBLE_COMMAND_WARNINGS', False, boolean=True)
Add documentation about bin_ansible_callbacks setting. Standardization and cleanup.
2014-09-10 15:38:24 +02:00
DEFAULT_LOAD_CALLBACK_PLUGINS = get_config(p, DEFAULTS, 'bin_ansible_callbacks', 'ANSIBLE_LOAD_CALLBACK_PLUGINS', False, boolean=True)
Allow callback plugins to be whitelisted
2015-06-29 16:55:48 +02:00
DEFAULT_CALLBACK_WHITELIST = get_config(p, DEFAULTS, 'callback_whitelist', 'ANSIBLE_CALLBACK_WHITELIST', None, islist=True)
Making the switch to v2
2015-05-04 04:47:26 +02:00
RETRY_FILES_ENABLED = get_config(p, DEFAULTS, 'retry_files_enabled', 'ANSIBLE_RETRY_FILES_ENABLED', True, boolean=True)
RETRY_FILES_SAVE_PATH = get_config(p, DEFAULTS, 'retry_files_save_path', 'ANSIBLE_RETRY_FILES_SAVE_PATH', '~/')
Deprecation warnings of several flavors, nice and purple and can be disabled in ansible.cfg.
2013-10-12 00:37:39 +02:00
# CONNECTION RELATED
Merge branch 'nocows' of git://github.com/jpmens/ansible into devel Conflicts: lib/ansible/callbacks.py lib/ansible/constants.py
2013-04-27 17:34:39 +02:00
ANSIBLE_SSH_ARGS = get_config(p, 'ssh_connection', 'ssh_args', 'ANSIBLE_SSH_ARGS', None)
Make ssh's ControlPath configurable via ansible.cfg This shouldn't generally be needed unless you're working in an environment that uses rediculously long FQDNs; if the name is too long, you wind up hitting unix domain socket filepath limits enforced by ssh.
2013-09-18 21:03:40 +02:00
ANSIBLE_SSH_CONTROL_PATH = get_config(p, 'ssh_connection', 'control_path', 'ANSIBLE_SSH_CONTROL_PATH', "%(directory)s/ansible-ssh-%%h-%%p-%%r")
Bug in constants.py, ANSIBLE_SSH_PIPELINING should be coerced to boolean
2014-01-22 14:54:28 +01:00
ANSIBLE_SSH_PIPELINING = get_config(p, 'ssh_connection', 'pipelining', 'ANSIBLE_SSH_PIPELINING', False, boolean=True)
Retry exec command via ssh_retry This PR adds the option to retry failed ssh executions, if the failure is caused by ssh itself, not the remote command. This can be helpful if there are transient network issues. Retries are only implemented in the openssh connection plugin and are disabled by default. Retries are enabled by setting ssh_connection > retries to an integer greater than 0. Running a long series of playbooks, or a short playbook against a large cluster may result in transient ssh failures, some examples logged [here](https://trello.com/c/1yh6csEQ/13-ssh-errors). Ansible should be able to retry an ssh connection in order to survive transient failures. Ansible marks a host as failed the first time it fails to contact it.
2015-03-27 19:24:33 +01:00
ANSIBLE_SSH_RETRIES = get_config(p, 'ssh_connection', 'retries', 'ANSIBLE_SSH_RETRIES', 0, integer=True)
Make it possible to tell paramiko to not record new host keys, which can be slow with a large number of hosts. -c ssh is preferred in most cases if you have ControlPersist available, otherwise if you are comfortable you can turn off recording while leaving host key checking on, etc.
2013-07-06 03:42:41 +02:00
PARAMIKO_RECORD_HOST_KEYS = get_config(p, 'paramiko_connection', 'record_host_keys', 'ANSIBLE_PARAMIKO_RECORD_HOST_KEYS', True, boolean=True)
Retry exec command via ssh_retry This PR adds the option to retry failed ssh executions, if the failure is caused by ssh itself, not the remote command. This can be helpful if there are transient network issues. Retries are only implemented in the openssh connection plugin and are disabled by default. Retries are enabled by setting ssh_connection > retries to an integer greater than 0. Running a long series of playbooks, or a short playbook against a large cluster may result in transient ssh failures, some examples logged [here](https://trello.com/c/1yh6csEQ/13-ssh-errors). Ansible should be able to retry an ssh connection in order to survive transient failures. Ansible marks a host as failed the first time it fails to contact it.
2015-03-27 19:24:33 +01:00
preliminary privlege escalation unification + pbrun - become constants inherit existing sudo/su ones - become command line options, marked sudo/su as deprecated and moved sudo/su passwords to runas group - changed method signatures as privlege escalation is collapsed to become - added tests for su and become, diabled su for lack of support in local.py - updated playbook,play and task objects to become - added become to runner - added whoami test for become/sudo/su - added home override dir for plugins - removed useless method from ask pass - forced become pass to always be string also uses to_bytes - fixed fakerunner for tests - corrected reference in synchronize action plugin - added pfexec (needs testing) - removed unused sudo/su in runner init - removed deprecated info - updated pe tests to allow to run under sudo and not need root - normalized become options into a funciton to avoid duplication and inconsistencies - pushed suppored list to connection classs property - updated all connection plugins to latest 'become' pe - includes fixes from feedback (including typos) - added draft docs - stub of become_exe, leaving for future v2 fixes
2014-11-24 22:36:31 +01:00
# obsolete -- will be formally removed
For defaults that are integers, enforce it for config supplied values. If a user supplies a string in the config (rather than an int), the code should fix that- or blow up immediately- rather than allowing that value to work it's way down and break w/in the connection object; when that happens, the actual error is opaque and requires pdb.set_trace() to run down.
2013-08-23 01:04:11 +02: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)
Merge branch 'devel' of git://github.com/nextus/ansible into devel Conflicts: lib/ansible/constants.py
2013-10-07 14:39:23 +02: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)
Adding in a configurable option for the accelerate daemon timeout This was apparently an oversite, as it has never been configurable despite having a module parameter for the timeout.
2014-03-23 20:45:05 +01:00
ACCELERATE_DAEMON_TIMEOUT = get_config(p, 'accelerate', 'accelerate_daemon_timeout', 'ACCELERATE_DAEMON_TIMEOUT', 30, integer=True)
made accelerate keys directory configurable, and permissions for the file and dir configurable, and gave them a safe default
2014-02-06 09:53:43 +01: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')
Acclerate improvements * Added capability to support multiple keys, so clients from different machines can connect to a single daemon instance * Any activity on the daemon will cause the timeout to extend, so that the daemon must be idle for the full number of minutes before it will auto- shutdown * Various other small fixes to remove some redundancy Fixes #5171
2014-03-19 18:59:06 +01:00
ACCELERATE_MULTI_KEY = get_config(p, 'accelerate', 'accelerate_multi_key', 'ACCELERATE_MULTI_KEY', False, boolean=True)
#4227 in upstream repo
2013-09-25 14:15:49 +02:00
PARAMIKO_PTY = get_config(p, 'paramiko_connection', 'pty', 'ANSIBLE_PARAMIKO_PTY', True, boolean=True)
Load additional plugins from path specified in configuration
2012-09-18 14:41:27 +02:00
Making the switch to v2
2015-05-04 04:47:26 +02: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
GALAXY_SCMS = get_config(p, 'galaxy', 'scms', 'ANSIBLE_GALAXY_SCMS', ['git','hg'], islist=True)
Revised patch for more password entropy
2013-11-01 15:51:35 +01:00
# characters included in auto-generated passwords
DEFAULT_PASSWORD_CHARS = ascii_letters + digits + ".,:-_"
cleanup example config file + Squashed commit of the following: commit c36b66dc952dfff91043ecbca56cf3f1f8f00703 Merge: 240d7bf f4cf934 Author: Michael DeHaan <michael@ansibleworks.com> Date: Tue Jun 18 13:04:51 2013 -0400 Merge branch 'unevaluated-vars' of git://github.com/lorin/ansible into lorin_undefined Conflicts: lib/ansible/runner/__init__.py commit f4cf93436767f73b62a16067ab5e628830045896 Merge: 2531440 07a1365 Author: Lorin Hochstein <lorin@nimbisservices.com> Date: Thu Jun 6 11:07:41 2013 -0400 Merge branch 'devel' into unevaluated-vars commit 253144045cbafd7d72836f1017c62ac4ba623186 Author: Lorin Hochstein <lorin@nimbisservices.com> Date: Thu Jun 6 11:06:37 2013 -0400 Fail template from file on undefined vars If config option is set, raise an exception if templating from a file and a variable is undefined. commit aecb71d8b75257f0f3e11a9b176fc3737aecef8d Author: Lorin Hochstein <lorin@nimbisservices.com> Date: Wed Jun 5 17:12:12 2013 -0400 Add fail_on_undefined flag Add a fail_on_undefined flag to the template and template_from_string methods. If this flag is true, then re-raise the ninja2.excpetions.UndefinedError instead of swallowing it. commit cbb1808f0585f01536240aee05a1bfd06c4b4647 Merge: d4bbf49 41425fb Author: Lorin Hochstein <lorin@nimbisservices.com> Date: Wed Jun 5 16:14:12 2013 -0400 Merge branch 'devel' into unevaluated-vars commit d4bbf492b0b63c789d66ab60d0ec634d100fca82 Author: Lorin Hochstein <lorin@nimbisservices.com> Date: Mon Jun 3 19:46:13 2013 -0400 template: Raise UndefinedError exception In template_from_string, raise an undefined error if it occurs. Have the caller catch it and throw an AnsibleUndefinedVariable commit c94780280515f1f3756fdc429b2b1e87b365e9b7 Merge: 8d919d6 be33bcf Author: Lorin Hochstein <lorin@nimbisservices.com> Date: Mon Jun 3 10:09:43 2013 -0400 Merge branch 'devel' into unevaluated-vars commit 8d919d6c97b28a42f47ca7248c542695baf6175f Merge: 0f68ad8 b8630d2 Author: Lorin Hochstein <lorin@nimbisservices.com> Date: Thu May 30 16:27:48 2013 -0400 Merge branch 'devel' into unevaluated-vars commit 0f68ad8193ac17488e339a258f8c63fdae399c26 Author: Lorin Hochstein <lorin@nimbisservices.com> Date: Thu May 30 14:32:03 2013 -0400 Optionally fail task on undefined variables This patch introduces a new configuration option called error_on_undefined_vars, which defaults to false. If this option is set to true, then a task which has unevaluated variables in its arguments will fail instead of running. Output looks like this: TASK: [set rabbitmq password] ************************************************* fatal: [10.20.0.7] => Undefined variables: rabbitmq_user, rabbitmq_password
2013-06-18 19:24:30 +02:00
config file support
2012-08-14 01:17:14 +02:00
# non-configurable things
Making the switch to v2
2015-05-04 04:47:26 +02:00
MODULE_REQUIRE_ARGS = ['command', 'shell', 'raw', 'script']
preliminary privlege escalation unification + pbrun - become constants inherit existing sudo/su ones - become command line options, marked sudo/su as deprecated and moved sudo/su passwords to runas group - changed method signatures as privlege escalation is collapsed to become - added tests for su and become, diabled su for lack of support in local.py - updated playbook,play and task objects to become - added become to runner - added whoami test for become/sudo/su - added home override dir for plugins - removed useless method from ask pass - forced become pass to always be string also uses to_bytes - fixed fakerunner for tests - corrected reference in synchronize action plugin - added pfexec (needs testing) - removed unused sudo/su in runner init - removed deprecated info - updated pe tests to allow to run under sudo and not need root - normalized become options into a funciton to avoid duplication and inconsistencies - pushed suppored list to connection classs property - updated all connection plugins to latest 'become' pe - includes fixes from feedback (including typos) - added draft docs - stub of become_exe, leaving for future v2 fixes
2014-11-24 22:36:31 +01:00
DEFAULT_BECOME_PASS = None
config file support
2012-08-14 01:17:14 +02:00
DEFAULT_SUDO_PASS = None
Added config option to control default of asking or not for sudo password Signed-off-by: Brian Coca <briancoca+ansible@gmail.com>
2012-10-26 20:49:56 +02:00
DEFAULT_REMOTE_PASS = None
config file support
2012-08-14 01:17:14 +02:00
DEFAULT_SUBSET = None
Revert "Revert "Merge pull request #5325 from angstwad/add-su-support"" This reverts commit c17d0e0357f1f3bdc7389eaa3171444fccda8b76. Conflicts: lib/ansible/runner/connection_plugins/paramiko_ssh.py
2014-01-21 02:19:03 +01:00
DEFAULT_SU_PASS = None
Ansible vault: a framework for encrypting any playbook or var file.
2014-02-11 18:03:11 +01:00
VAULT_VERSION_MIN = 1.0
VAULT_VERSION_MAX = 1.0
Copy permalink