ansible 基础知识

英文官网，值得拥有！

http://docs.ansible.com/ansible/list_of_files_modules.html#

摘自：

http://blog.csdn.net/b624023251/article/details/51570049

一、Hosts and Groups（主机与组）
对于/etc/ansible/hosts最简单的定义格式像下面：
1、简单的主机和组
    mail.yanruogu.com
    [webservers]
    web1.yanruogu.com
    web2.yanruogu.com 
    [dbservers]
    db1.yanruogu.com
    db2.yanruogu.com
a、中括号中的名字代表组名，可以根据自己的需求将庞大的主机分成具有标识的组，如上面分了两个组webservers和dbservers组；
b、主机(hosts)部分可以使用域名、主机名、IP地址表示；当然使用前两者时，也需要主机能反解析到相应的IP地址，一般此类配置中多使用IP地址；
2、端口与别名
如果某些主机的SSH运行在自定义的端口上，ansible使用Paramiko进行ssh连接时，不会使用你SSH配置文件中列出的端口，但是如果修改ansible使用openssh进行ssh连接时将会使用：
    192.168.1.1:3091
假如你想要为某些静态IP设置一些别名，可以这样做：
    web1 ansible_ssh_port = 3333 ansible_ssh_host = 192.168.1.2
上面的 web1别名就指代了IP为192.168.1.2，ssh连接端口为3333的主机。
3、指定主机范围
    [webservers]
    www[01:50].yanruogu.com
    [databases]
    db-[a:f].yanruogu.com
上面指定了从web1到web50，webservers组共计50台主机；databases组有db-a到db-f共6台主机。
4、使用主机变量
以下是Hosts部分中经常用到的变量部分：
ansible_ssh_host     #用于指定被管理的主机的真实IP
ansible_ssh_port     #用于指定连接到被管理主机的ssh端口号，默认是22
ansible_ssh_user     #ssh连接时默认使用的用户名
ansible_ssh_pass     #ssh连接时的密码
ansible_sudo_pass     #使用sudo连接用户时的密码
ansible_sudo_exec     #如果sudo命令不在默认路径，需要指定sudo命令路径
ansible_ssh_private_key_file     #秘钥文件路径，秘钥文件如果不想使用ssh-agent管理时可以使用此选项
ansible_shell_type     #目标系统的shell的类型，默认sh
ansible_connection     #SSH 连接的类型： local , ssh , paramiko，在 ansible 1.2 之前默认是 paramiko ，后来智能选择，优先使用基于 ControlPersist 的 ssh （支持的前提）
ansible_python_interpreter     #用来指定python解释器的路径，默认为/usr/bin/python 同样可以指定ruby 、perl 的路径
ansible_*_interpreter     #其他解释器路径，用法与ansible_python_interpreter类似，这里"*"可以是ruby或才perl等其他语言
示例如下：
[test]
192.168.1.1 ansible_ssh_user=root ansible_ssh_pass='P@ssw0rd'
192.168.1.2 ansible_ssh_user=breeze ansible_ssh_pass='123456'
192.168.1.3 ansible_ssh_user=bernie ansible_ssh_port=3055 ansible_ssh_pass='456789'
上面的示例中指定了三台主机，三台主机的用密码分别是P@ssw0rd、123456、45789，指定的ssh连接的用户名分别为root、breeze、bernie，ssh 端口分别为22、22、3055 ，这样在ansible命令执行的时候就不用再指令用户和密码等了。

5、组内变量
变量也可以通过组名，应用到组内的所有成员：
    [test]
    host1
    host2
    [test:vars]
    ntp_server=192.168.1.10
    proxy=192.168.1.20
上面test组中包含两台主机，通过对test组指定vars变更，相应的host1和host2相当于相应的指定了ntp_server和proxy变量参数值 。

6、组的包含与组内变量
    [wuhan]
    web1
    web2
    [suizhou]
    web4
    web3
    [hubei:children]
    wuhan
    suizhou
    [hubei:vars]
    ntp_server=192.168.1.10
    zabbix_server=192.168.1.10
    [china:children]
    hubei
    hunan
    
二、ansible.cfg配置说明

Ansible默认安装好后有一个配置文件/etc/ansible/ansible.cfg，该配置文件中定义了ansible的主机的默认配置部分，如默认是否需要输入密码、是否开启sudo认证、action_plugins插件的位置、hosts主机组的位置、是否开启log功能、默认端口、key文件位置等等。
具体如下：
    [defaults]
    # some basic default values...
    hostfile       = /etc/ansible/hosts   \\指定默认hosts配置的位置
    # library_path = /usr/share/my_modules/
    remote_tmp     = $HOME/.ansible/tmp
    pattern        = *
    forks          = 5
    poll_interval  = 15
    sudo_user      = root  \\远程sudo用户
    #ask_sudo_pass = True  \\每次执行ansible命令是否询问ssh密码
    #ask_pass      = True  \\每次执行ansible命令时是否询问sudo密码
    transport      = smart
    remote_port    = 22
    module_lang    = C
    gathering = implicit
    host_key_checking = False    \\关闭第一次使用ansible连接客户端是输入命令提示
    log_path    = /var/log/ansible.log \\需要时可以自行添加。chown -R root:root ansible.log
    system_warnings = False    \\关闭运行ansible时系统的提示信息，一般为提示升级
    # set plugin path directories here, separate with colons
    action_plugins     = /usr/share/ansible_plugins/action_plugins
    callback_plugins   = /usr/share/ansible_plugins/callback_plugins
    connection_plugins = /usr/share/ansible_plugins/connection_plugins
    lookup_plugins     = /usr/share/ansible_plugins/lookup_plugins
    vars_plugins       = /usr/share/ansible_plugins/vars_plugins
    filter_plugins     = /usr/share/ansible_plugins/filter_plugins
    fact_caching = memory
    [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
如果在对之前未连接的主机进行连结时报错如下：
ansible test -a 'uptime'
    192.168.1.1| FAILED =>Using a SSH password instead of a key is not possible because HostKey checking is enabled and sshpass does not support this.Please add this host's fingerprint to your known_hosts file to manage this host.
    192.168.1.2 | FAILED => Using a SSH password instead of a key is not possible because Host Key checking is enabled and sshpass does not support this.  Please add this host's fingerprint to your known_hosts file to manage this host.
是由于在本机的~/.ssh/known_hosts文件中并有fingerprint key串，ssh第一次连接的时候一般会提示输入yes 进行确认为将key字符串加入到  ~/.ssh/known_hosts 文件中。
方法1：
在进行ssh连接时，可以使用-o参数将StrictHostKeyChecking设置为no，使用ssh连接时避免首次连接时让输入yes/no部分的提示。通过查看ansible.cfg配置文件，发现如下行：
[ssh_connection]
# ssh arguments to use
# Leaving off ControlPersist will result in poor performance, so use
# paramiko on older platforms rather than removing it
#ssh_args = -o ControlMaster=auto -o ControlPersist=60s
可以启用ssh_args 部分，使用下面的配置，避免上面出现的错误：
ssh_args = -o ControlMaster=auto -o ControlPersist=60s -o StrictHostKeyChecking＝no
方法2：
在ansible.cfg配置文件中，也会找到如下配置：
# uncomment this to disable SSH key host checking
host_key_checking = False  
默认host_key_checking部分是注释的，通过找开该行的注释，同样也可以实现跳过ssh 首次连接提示验证部分。但在实际测试中，似乎并没有效果，建议使用方法1.
其他部分
默认ansible 执行的时候，并不会输出日志到文件，不过在ansible.cfg 配置文件中有如下行：
log_path = /var/log/ansible.log
默认log_path这行是注释的，打开该行的注释，所有的命令执行后，都会将日志输出到/var/log/ansible.log文件。

三、ansible命令执行模块

1、命令说明
一个ad-hoc命令的执行，需要按以下格式进行执行：
    ansible 主机或组-m 模块名-a '模块参数'  ansible参数
    
    
2、后台执行
当命令执行时间比较长时，也可以放到后台执行，使用-B、-P参数，如下：
    ansible all -B 3600-a "/usr/bin/long_running_operation --do-stuff" #后台执行命令3600s，-B 表示后台执行的时间
    ansible all -m async_status -a "jid=123456789"  #检查任务的状态
    ansible all -B 1800-P 60-a "/usr/bin/long_running_operation --do-stuff" #后台执行命令最大时间是1800s即30分钟，-P 每60s检查下状态，默认15s
    
3、command模块执行
命令执行模块包含如下 四个模块：
    command模块：该模块通过-a跟上要执行的命令可以直接执行，不过命令里如果有带有如下字符部分则执行不成功 “  "<", ">", "|",  "&" ；
    shell 模块：用法基本和command一样，不过其是通过/bin/sh进行执行，所以shell 模块可以执行任何命令，就像在本机执行一样；
    raw模块：用法和shell 模块一样 ，其也可以执行任意命令，就像在本机执行一样；
    script模块：其是将管理端的shell 在被管理主机上执行，其原理是先将shell 复制到远程主机，再在远程主机上执行，原理类似于raw模块。
    注：raw模块和comand、shell 模块不同的是其没有chdir、creates、removes参数，chdir参数的作用就是先切到chdir指定的目录后，再执行后面的命令，这在后面很多模块里都会有该参数 。
command模块包含如下选项： 
    creates：一个文件名，当该文件存在，则该命令不执行 
    free_form：要执行的linux指令 
    chdir：在执行指令之前，先切换到该指定的目录 
    removes：一个文件名，当该文件不存在，则该选项不执行
    executable：切换shell来执行指令，该执行路径必须是一个绝对路径

使用chdir的示例：
    ansible 192.168.1.1 -m command -a 'chdir=/tmp/test.txt touch test.file'
    ansible 192.168.1.1 -m shell -a 'chdir=/tmp/test.txt touch test2.file'
    ansible 192.168.1.1 -m raw -a 'chdir=/tmp/text.txt touch test3.file'
    三个命令都会返回执行成功的状态。不过实际上只有前两个文件会被创建成功。使用raw模块的执行的结果文件事实上也被正常创建了，不过不是在chdir指定的目录，而是在当前执行用户的家目录。
creates与removes示例：
    ansible 192.168.1.1 -a 'creates=/tmp/server.txt uptime' #当/tmp/server.txt文件存在时，则不执行uptime指令
    ansible 192.168.1.1 -a 'removes=/tmp/server.txt uptime' #当/tmp/server.txt文件不存在时，则不执行uptime指令
    
3、script模块
script模块示例：
    要执行的脚本文件script.sh内容如下：
        #/bin/bash
        ifconfig
        df -hT
    执行ansible指令：ansible 10.212.52.252 -m script -a 'script.sh' |egrep '>>|stdout'
    
四、其他常用模块

1、ping模块
测试主机是否是通的，用法很简单，不涉及参数：
ansible test -m ping

2、setup模块
setup模块，主要用于获取主机信息，在playbooks里经常会用到的一个参数gather_facts就与该模块相关。setup模块下经常使用的一个参数是filter参数，具体使用示例如下：
    ansible 10.212.52.252 -m setup -a 'filter=ansible_*_mb'   //查看主机内存信息
    ansible 10.212.52.252 -m setup -a 'filter=ansible_eth[0-2]'   //查看地接口为eth0-2的网卡信息
    ansible all -m setup --tree /tmp/facts   //将所有主机的信息输入到/tmp/facts目录下，每台主机的信息输入到主机名文件中（/etc/ansible/hosts里的主机名）

3、file模块
file模块主要用于远程主机上的文件操作，file模块包含如下选项： 
    force：需要在两种情况下强制创建软链接，一种是源文件不存在但之后会建立的情况下；另一种是目标软链接已存在,需要先取消之前的软链，然后创建新的软链，有两个选项：yes|no 
    group：定义文件/目录的属组 
    mode：定义文件/目录的权限
    owner：定义文件/目录的属主
    path：必选项，定义文件/目录的路径
    recurse：递归的设置文件的属性，只对目录有效
    src：要被链接的源文件的路径，只应用于state=link的情况
    dest：被链接到的路径，只应用于state=link的情况 
    state：  
        directory：如果目录不存在，创建目录
        file：即使文件不存在，也不会被创建
        link：创建软链接
        hard：创建硬链接
        touch：如果文件不存在，则会创建一个新的文件，如果文件或目录已存在，则更新其最后修改时间
        absent：删除目录、文件或者取消链接文件
使用示例：
    ansible test -m file -a "src=/etc/fstab dest=/tmp/fstab state=link"
    ansible test -m file -a "path=/tmp/fstab state=absent"
    ansible test -m file -a "path=/tmp/test state=touch"

4、copy模块
复制文件到远程主机，copy模块包含如下选项：
    backup：在覆盖之前将原文件备份，备份文件包含时间信息。有两个选项：yes|no 
    content：用于替代"src",可以直接设定指定文件的值 
    dest：必选项。要将源文件复制到的远程主机的绝对路径，如果源文件是一个目录，那么该路径也必须是个目录 
    directory_mode：递归的设定目录的权限，默认为系统默认权限
    force：如果目标主机包含该文件，但内容不同，如果设置为yes，则强制覆盖，如果为no，则只有当目标主机的目标位置不存在该文件时，才复制。默认为yes
    others：所有的file模块里的选项都可以在这里使用
    src：要复制到远程主机的文件在本地的地址，可以是绝对路径，也可以是相对路径。如果路径是一个目录，它将递归复制。在这种情况下，如果路径使用"/"来结尾，则只复制目录里的内容，如果没有使用"/"来结尾，则包含目录在内的整个内容全部复制，类似于rsync。 
    validate ：The validation command to run before copying into place. The path to the file to validate is passed in via '%s' which must be present as in the visudo example below.
示例如下：
    ansible test -m copy -a "src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644"
    ansible test -m copy -a "src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes"
    ansible test -m copy -a "src=/mine/sudoers dest=/etc/sudoers validate='visudo -cf %s'"
    
5、service模块
用于管理服务
该模块包含如下选项： 
    arguments：给命令行提供一些选项 
    enabled：是否开机启动 yes|no
    name：必选项，服务名称 
    pattern：定义一个模式，如果通过status指令来查看服务的状态时，没有响应，就会通过ps指令在进程中根据该模式进行查找，如果匹配到，则认为该服务依然在运行
    runlevel：运行级别
    sleep：如果执行了restarted，在则stop和start之间沉睡几秒钟
    state：对当前服务执行启动，停止、重启、重新加载等操作（started,stopped,restarted,reloaded）
使用示例：
ansible test -m service -a "name=httpd state=started enabled=yes"
    asnible test -m service -a "name=foo pattern=/usr/bin/foo state=started"
    ansible test -m service -a "name=network state=restarted args=eth0"
    
6、yum模块
使用yum包管理器来管理软件包，其选项有： 
    config_file：yum的配置文件 
    disable_gpg_check：关闭gpg_check 
    disablerepo：不启用某个源 
    enablerepo：启用某个源
    name：要进行操作的软件包的名字，也可以传递一个url或者一个本地的rpm包的路径 
    state：状态（present，absent，latest）
示例如下：
    ansible test -m yum -a 'name=httpd state=latest'
    ansible test -m yum -a 'name="@Development tools" state=present'
    ansible test -m yum -a 'name=http://nginx.org/packages/centos/6/noarch/RPMS/nginx-release-centos-6-0.el6.ngx.noarch.rpm state=present'
    
7、user模块与group模块
user模块是请求的是useradd, userdel, usermod三个指令，goup模块请求的是groupadd, groupdel, groupmod 三个指令。
1、user模块
    home：指定用户的家目录，需要与createhome配合使用
    groups：指定用户的属组
    uid：指定用的uid
    password：指定用户的密码
    name：指定用户名
    createhome：是否创建家目录 yes|no
    system：是否为系统用户
    remove：当state=absent时，remove=yes则表示连同家目录一起删除，等价于userdel -r
    state：是创建还是删除
    shell：指定用户的shell环境
使用示例：
    user: name=johnd comment="John Doe" uid=1040 group=admin
    user: name=james shell=/bin/bash groups=admins,developers append=yes user: name=johnd state=absent remove=yes
    user: name=james18 shell=/bin/zsh groups=developers expires=1422403387
    user: name=test generate_ssh_key=yes ssh_key_bits=2048 ssh_key_file=.ssh/id_rsa    #生成密钥时，只会生成公钥文件和私钥文件，和直接使用ssh-keygen指令效果相同，不会生成authorized_keys文件。
注：指定password参数时，不能使用明文密码，因为后面这一串密码会被直接传送到被管理主机的/etc/shadow文件中，所以需要先将密码字符串进行加密处理。然后将得到的字符串放到password中即可。
    echo "123456" | openssl passwd -1 -salt $(< /dev/urandom tr -dc '[:alnum:]' | head -c 32) -stdin
    $1$4P4PlFuE$ur9ObJiT5iHNrb9QnjaIB0
    #使用上面的密码创建用户
    ansible all -m user -a 'name=foo password="$1$4P4PlFuE$ur9ObJiT5iHNrb9QnjaIB0"'
    不同的发行版默认使用的加密方式可能会有区别，具体可以查看/etc/login.defs文件确认，centos 6.5版本使用的是SHA512加密算法。
2、group示例
ansible all -m group -a 'name=somegroup state=present'

8、unarchive模块
用于解压文件，模块包含如下选项：
    copy：在解压文件之前，是否先将文件复制到远程主机，默认为yes。若为no，则要求目标主机上压缩包必须存在。
    creates：指定一个文件名，当该文件存在时，则解压指令不执行
    dest：远程主机上的一个路径，即文件解压的路径 
    grop：解压后的目录或文件的属组
    list_files：如果为yes，则会列出压缩包里的文件，默认为no，2.0版本新增的选项
    mode：解决后文件的权限
    src：如果copy为yes，则需要指定压缩文件的源路径 
    owner：解压后文件或目录的属主
示例如下：
    - unarchive: src=foo.tgz dest=/var/lib/foo
    - unarchive: src=/tmp/foo.zip dest=/usr/local/bin copy=no
    - unarchive: src=https://example.com/example.zip dest=/usr/local/bin copy=no