zoukankan      html  css  js  c++  java
  • ansible配置文件详解

    ansible配置文件配置



    配置项介绍 , 配置文件ansible.cfg, 运行playbook时,默认时在yaml文件所在路径寻找,然后再去/etc/ansible/下寻找

    [defaults]
    # 定义默认的hosts文件路径,支持相对路径
    inventory      = ./hosts
    # 定义默认扩展库路径,自定义的模块可以放这里
    library        = ./library
    #module_utils   = /usr/share/my_module_utils/
    # 默认的远端节点脚本复制过去后的路径,与ansible执行机制有关
    #remote_tmp     = ~/.ansible/tmp
    # 本地的
    #local_tmp      = ~/.ansible/tmp
    # 默认是5个并发进程forks
    #forks          = 5
    # 轮巡间隔
    #poll_interval  = 15
    # sudo的用户
    #sudo_user      = root
    #ask_sudo_pass = True
    #ask_pass      = True
    #transport      = smart
    # 默认端口
    #remote_port    = 22
    #module_lang    = C
    #module_set_locale = False
    
    # smart - gather by default, but don't regather if already gathered
    # implicit 开启gather_facts,如果需要关闭则需明文设置 gather_facts: False
    # explicit 关闭gather_facts,如果需要开启则需明文设置gather_facts: True
    gathering = explicit
    
    # This only affects the gathering done by a play's gather_facts directive,
    # by default gathering retrieves all facts subsets
    # all - gather all subsets
    # network - gather min and network facts
    # hardware - gather hardware facts (longest facts to retrieve)
    # virtual - gather min and virtual facts
    # facter - import facts from facter
    # ohai - import facts from ohai
    # 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
    # with a maximum timeout of 10 seconds. This
    # option lets you increase or decrease that
    # timeout to something more suitable for the
    # environment. 
    # gather_timeout = 10
    
    # additional paths to search for roles in, colon separated
    roles_path    = /etc/ansible/roles:/usr/share/ansible/roles
    
    # uncomment this to disable SSH key host checking
    host_key_checking = False
    
    # change the default callback, you can only have one 'stdout' type  enabled at a time.
    # default stdout_callback = default
    # skippy :
    # actionable : 只显示changed状态的tasks
    # oneline : like ansible-playbook -o *.yml  display on oneline for every action
    # minimal : display every action is or not excuted
    # debug :  显示debug信息
    stdout_callback = debug
    
    
    # enable callback plugins, they can output to stdout but cannot be 'stdout' type.
    #callback_whitelist = timer, mail
    # 回调显示 timer显示每个tasks的时间
    callback_whitelist = timer
    
    # 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 = True
    #handler_includes_static = True
    
    # 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
    timeout = 20
    
    # default user to use for playbooks if user is not specified
    # (/usr/bin/ansible will use current user as default)
    # 指定远程的用户为root,则不需要在playbook中指定remote_user: root
    remote_user = root
    
    # 如果注释此选项则不输出执行日志,开启可以将playbook的执行过程写入日志路径,但是该日志不会归档
    log_path = /var/log/ansible.log
    
    # default module name for /usr/bin/ansible
    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
    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
    # tasks and handlers within the role will see the variables there
    #private_role_vars = yes
    
    # jinja2的扩展模块支持,可以根据jinja2版本新增加的扩容库添加
    jinja2_extensions = jinja2.ext.do,jinja2.ext.i18n,jinja2.ext.loopcontrols,jinja2.ext.with_, jinja2.ext.autoescape
    
    # 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.
    #vault_password_file = /path/to/vault_password_file
    
    # 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"
    # 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
    # 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
    # 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
    # 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
    # Jinja2 variables that are not set in templates or action lines. Uncomment this line
    # to revert the behavior to pre-1.3.
    #error_on_undefined_vars = False
    
    # by default (as of 1.6), 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:
    system_warnings = False
    
    # by default (as of 1.4), 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:
    deprecation_warnings = False
    
    # (as of 1.8), 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
    # 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
    # instead of shelling out to the git command.
     command_warnings = False
    
    
    # set plugin path directories here, separate with colons
    #action_plugins     = /usr/share/ansible/plugins/action
    #cache_plugins      = /usr/share/ansible/plugins/cache
    #callback_plugins   = /usr/share/ansible/plugins/callback
    #connection_plugins = /usr/share/ansible/plugins/connection
    #lookup_plugins     = /usr/share/ansible/plugins/lookup
    #inventory_plugins  = /usr/share/ansible/plugins/inventory
    #vars_plugins       = /usr/share/ansible/plugins/vars
    #filter_plugins     = /usr/share/ansible/plugins/filter
    #test_plugins       = /usr/share/ansible/plugins/test
    #terminal_plugins   = /usr/share/ansible/plugins/terminal
    #strategy_plugins   = /usr/share/ansible/plugins/strategy
    
    
    # free , debug , linear 三种,
    # free  每个host按照task执行,不与其他host相关联,也就是说host会一直把自己的tasks执行完,再继续下一个host的,此种执行方式,会发现每次执行task时,显示的 却不一定是当前task的进程。
    # debug 类似pdb.strace() 如果有错误会直接进入调试模式
    # linear    线性的执行策略,所有hosts逐一task执行,每次并发5个,同步执行。
    strategy = linear
    
    # 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 = True
    
    
    # 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',
    # 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.
    # 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?
    # 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
    # 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
    
    
    # retry files
    # When a playbook fails by default a .retry file will be created in ~/
    # You can disable this feature by setting retry_files_enabled to False
    # 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
    # 执行ansible的过程会在target node的/var/log/messages下写入执行过程,默认是写入的
    # 要不写入,取消注释,改成True
    no_target_syslog = True
    
    # 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
    # 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
    # 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
    #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
    
    # Controls showing custom stats at the end, off by default
    #show_custom_stats = True
    
    # 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
    
    # 遇到任何错误就会终止执行,也可以在playbook中指定 any_errors_fatal: true
    any_errors_fatal = True
    
    [inventory]
    # enable inventory plugins, default: 'host_list', 'script', 'yaml', 'ini'
    enable_plugins = advanced_host_list, host_list, virtualbox, yaml, constructed, script, ini
    
    # 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
    
    [privilege_escalation]
    #become=True
    #become_method=sudo
    #become_user=root
    #become_ask_pass=False
    
    [paramiko_connection]
    # 默认用ssh方式,如果用python paramiko模块链接,才需要此段配置
    # 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
    # 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
    
    # 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
    # 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
    # Paramiko automatically add host keys.
    #host_key_auto_add = True
    
    [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
    #ssh_args = -C -o ControlMaster=auto -o ControlPersist=60s
    
    # The base directory for the ControlPath sockets. 
    # This is the "%(directory)s" in the control_path option
    # 
    # Example: 
    # control_path_dir = /tmp/.ansible/cp
    #control_path_dir = ~/.ansible/cp
    
    # The path to use for the ControlPath sockets. This defaults to a hashed string of the hostname, 
    # port and username (empty string in the config). The hash mitigates a common problem users 
    # found with long hostames and the conventional %(directory)s/ansible-ssh-%%h-%%p-%%r format. 
    # In those cases, a "too long for Unix domain socket" ssh error would occur.
    #
    # Example:
    # control_path = %(directory)s/%%h-%%r
    #control_path =
    
    # Enabling pipelining reduces the number of SSH operations required to
    # execute a module on the remote server. This can result in a significant
    # performance improvement when enabled, however when using "sudo:" you must
    # first disable 'requiretty' in /etc/sudoers
    #
    # By default, this option is disabled to preserve compatibility with
    # sudoers configurations that have requiretty (the default on many distros).
    #
    pipelining = True
    
    # Control the mechanism for transferring files (old)
    #   * smart = try sftp and then try scp [default]
    #   * True = use scp only
    #   * False = use sftp only
    #scp_if_ssh = smart
    
    # Control the mechanism for transferring files (new)
    # If set, this will override the scp_if_ssh option
    #   * sftp  = use sftp to transfer files
    #   * scp   = use scp to transfer files
    #   * piped = use 'dd' over SSH to transfer files
    #   * 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
    # 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
    
    [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.
    connect_timeout = 30
    
    # Configures the persistent connection retry timeout.  This value configures the
    # the retry timeout that ansible-connection will wait to connect
    # to the local domain socket. This value must be larger than the
    # ssh timeout (timeout) and less than persistent connection idle timeout (connect_timeout).
    # The default value is 15 seconds.
    #connect_retry_timeout = 15
    
    # The command timeout value defines the amount of time to wait for a command
    # or RPC call before timing out. The value for the command timeout must
    # be less than the value of the persistent connection idle timeout (connect_timeout)
    # The default value is 10 second.
    #command_timeout = 10
    
    [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
    
    # 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
    
    # Set this to yes to allow libvirt_lxc connections to work without SELinux.
    #libvirt_lxc_noseclabel = yes
    
    [colors]
    #highlight = white
    #verbose = blue
    #warn = bright purple
    #error = red
    #debug = dark gray
    #deprecate = purple
    #skip = cyan
    #unreachable = red
    #ok = green
    #changed = yellow
    #diff_add = green
    #diff_remove = red
    #diff_lines = cyan
    
    
    [diff]
    # Always print diff when running ( same as always running with -D/--diff )
    # always = no
    
    # Set how many context lines to show in diff
    # context = 3
    
    
  • 相关阅读:
    “同形异义字”钓鱼攻击
    研发管理101军规#001 两周迭代,形成团队持续习惯
    全新 PingCode 正式发布
    Python基础数据类型——tuple浅析
    Python基础变量类型——List浅析
    有了这个神器,快速告别垃圾短信邮件
    零基础打造一款属于自己的网页搜索引擎
    一篇文章教会你使用Python网络爬虫下载酷狗音乐
    趣味解读Python面向对象编程 (类和对象)
    上古神器Gvim--从入门到精通
  • 原文地址:https://www.cnblogs.com/wangl-blog/p/9572103.html
Copyright © 2011-2022 走看看