ANSIBLE工具

Ansible简介安装

Ansible是一个综合的强大的管理工具,他可以对多台主机安装操作系统,并为这些主机安装不同的应用程序,也可以通知指挥这些主机完成不同的任务.查看多台主机的各种信息的状态等,ansible都可以通过模块的方式来完成。

Ansible特性

• No agents：不需要再被管理节点上安装客户端，只要有sshd即可
• No server：在服务端不需要启动任何服务，只需要执行命令就行
• No additional PKI：由于不基于ssl，所以也不基于PKI工作
• Modules in any language：基于模块工作，ansible拥有众多的模块
• YAML：支持YAML语法
• SSH by default：默认使用ssh控制各节点

Ansible的基本组件

• 核心：ansible
• 核心模块（Core Modules）：这些都是ansible自带的模块
• 扩展模块（Custom Modules）：如果核心模块不足以完成某种功能，可以添加扩展模块
• 插件（Plugins）：完成模块功能的补充
• 剧本（Playbooks）：把需要完成的多个任务定义在剧本中
• 连接插件（Connectior Plugins）：ansible基于连接插件连接到各个主机上，虽然ansible是使用ssh连接到各个主机的，但是它还支持其他的连接方法，所以需要有连接插件
• 主机群（Host Inventory）：ansible在管理多台主机时，可以选择只对其中的一部分执行某些操作

Ansible工作机制

Ansible 在管理节点将 Ansible 模块通过 SSH 协议（或者 Kerberos、LDAP）推送到被管理端执 行，执行完之后自动删除，可以使用 SVN 等来管理自定义模块及编排。

Ansible的安装

Ansible的安装方式有很多种，常用的安装方法是基于yum或者源码，如果是基于yum安装，需要配置epel源，然后直接执行下面命令安装

yum -y install ansible

主机清单hosts

Ansible 通过读取默认的主机清单配置/etc/ansible/hosts,可以同时连接到多个远程主机上执行任务, 默认路径可以通过修改 ansible.cfg 的 hostfile 参数指定路径。

Hosts and Groups（主机与组）

对于/etc/ansible/hosts最简单的定义格式像下面：

简单的主机和组

# 中括号中的名字代表组名，可以根据自己的需求将庞大的主机分成具有标识的组，如上面分了两个组webservers和dbservers组；  
# 主机(hosts)部分可以使用域名、主机名、IP地址表示；当然使用前两者时，也需要主机能反解析到相应的IP地址，一般此类配置中多使用IP地址；
mail.yanruogu.com
[webservers]
web1.yanruogu.com
web2.yanruogu.com 
[dbservers]
db1.yanruogu.com
db2.yanruogu.com

端口与别名

如果某些主机的SSH运行在自定义的端口上，ansible使用Paramiko进行ssh连接时，不会使用你SSH配置文件中列出的端口，但是如果修改ansible使用openssh进行ssh连接时将会使用：

192.168.1.1:3091

假如你想要为某些静态IP设置一些别名，可以这样做：

# web1别名就指代了IP为192.168.1.2，ssh连接端口为3333的主机  
web1 ansible_ssh_port = 3333 ansible_ssh_host = 192.168.1.2

指定主机范围

# 下面指定了从web1到web50，webservers组共计50台主机；databases组有db-a到db-f共6台主机
[webservers]
www[01:50].yanruogu.com
[databases]
db-[a:f].yanruogu.com

使用主机变量

以下是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等其他语言

下面是一个简单的示例：

# 指定了三台主机，三台主机的用密码分别是P@ssw0rd、123456、45789，指定的ssh连接的用户名分别为root、breeze、bernie，ssh 端口分别为22、22、3055 ，这样在ansible命令执行的时候就不用再指令用户和密码等了
[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'

组内变量

变量也可以通过组名，应用到组内的所有成员：

# test组中包含两台主机，通过对test组指定vars变更，相应的host1和host2相当于相应的指定了ntp_server和proxy变量参数值

[test]
host1
host2
[test:vars]
ntp_server=192.168.1.10
proxy=192.168.1.20

组的包含与组内变量

下面是一个示例，指定了一个武汉组有web1、web2；随州组有web3、web4主机；又指定了一个湖北组，同时包含武汉和随州；同时为该组内的所有主机指定了2个vars变量。设定了一个组中国组，包含湖北、湖南。

[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
注：vars变量在ansible ad-hoc部分中基本用不到，主要用在ansible-playbook中。

Patterns（主机与组正则匹配部分）

把Patterns 直接理解为正则实际是不完全准确的，正常的理解为patterns意味着在ansible中管理哪些主机，也可以理解为，要与哪台主机进行通信。在探讨这个问题之前我们先看下ansible的用法：

ansible <pattern_goes_here> -m <module_name> -a <arguments>

直接上一个示例：

# 对webservers 组或主机重启httpd服务 ，其中webservers 就是Pattern部分
ansible webservers -m service -a "name=httpd state=restarted"

之所以上面说Pattern（模式）可以理解为正则，主要针对下面经常用到的用法而言的:

1. 表示所有的主机可以使用all 或 *

2. 通配符与逻辑或

利用通配符还可以指定一组具有规则特征的主机或主机名，冒号表示or－－－逻辑或：

web1.yanruogu.com
web1.yanruogu.com:web2.yanruogu.com
192.168.1.1
192.168.1.*

当然，这里的*通配符也可以用在前面，如：

*.yanruogu.com
*.com    
webservers1[0]     #表示匹配 webservers1 组的第 1 个主机
webservers1[0:25]  #表示匹配 webservers1 组的第 1 个到第 25 个主机（官网文档是":"表示范围，测试发现应该使用"-",注意不要和匹配多个主机组混淆）

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

ssh报错处理

如果在对之前未连接的主机进行连结时报错如下：

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 首次连接提示验证部分。但在实际测试中，似乎并没有效果

其他配置

默认ansible 执行的时候，并不会输出日志到文件，不过在ansible.cfg 配置文件中有如下行：

log_path = /var/log/ansible.log

默认log_path这行是注释的，打开该行的注释，所有的命令执行后，都会将日志输出到/var/log/ansible.log文件。

 一般的写法

 ansible -i /etc/ansible/hosts -u root -m command -a "ls /mnt"

常用模块

Ad-Hoc 是指ansible下临时执行的一条命令，并且不需要保存的命令，对于复杂的命令会使用playbook。Ad-hoc的执行依赖于模块，ansible官方提供了大量的模块。 如：command、raw、shell、file、cron等，具体可以通过ansible-doc -l 进行查看 。可以使用ansible-doc -s module来查看某个模块的参数，也可以使用ansible-doc help module来查看该模块更详细的信息。

Ad-hoc

命令说明

一个ad-hoc命令的执行，需要按以下格式进行执行：

ansible 主机或组-m 模块名-a '模块参数'  ansible参数

• 主机和组，是在/etc/ansible/hosts 里进行指定的部分，当然动态Inventory 使用的是脚本从外部应用里获取的主机；
• 模块名，可以通过ansible-doc -l 查看目前安装的模块，默认不指定时，使用的是command模块，具体可以查看/etc/ansible/ansible.cfg 的“#module_name = command ” 部分，默认模块可以在该配置文件中进行修改；
• 模块参数，可以通过 “ansible-doc -s 模块名” 查看具体的用法及后面的参数；
• ansible参数，可以通过ansible命令的帮助信息里查看到，这里有很多参数可以供选择，如是否需要输入密码、是否sudo等。

命令执行模块

命令执行模块包含如下 四个模块：

• command模块：该模块通过-a跟上要执行的命令可以直接执行，不过命令里如果有带有如下字符部分则执行不成功 “ "<", ">", "|", "&" ；
• shell 模块：用法基本和command一样，不过其是通过/bin/sh进行执行，所以shell 模块可以执行任何命令，就像在本机执行一样；
• raw模块：用法和shell 模块一样 ，其也可以执行任意命令，就像在本机执行一样；
• script模块：其是将管理端的shell 在被管理主机上执行，其原理是先将shell 复制到远程主机，再在远程主机上执行，原理类似于raw模块。

raw模块和comand、shell 模块不同的是其没有chdir、creates、removes参数，chdir参数的作用就是先切到chdir指定的目录后，再执行后面的命令，这在后面很多模块里都会有该参数 。

command模块

command模块包含如下选项：

• creates：一个文件名，当该文件存在，则该命令不执行
• free_form：要执行的linux指令
• chdir：在执行指令之前，先切换到该指定的目录
• removes：一个文件名，当该文件不存在，则该选项不执行
• executable：切换shell来执行指令，该执行路径必须是一个绝对路径

chdir示例：

# 三个命令都会返回执行成功的状态。不过实际上只有前两个文件会被创建成功。使用raw模块的执行的结果文件事实上也被正常创建了，不过不是在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'

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指令

script模块

示例：

#要执行的脚本文件script.sh内容如下： 
#/bin/bash
ifconfig
df -hT
# 执行ansible指令：
ansible 10.212.52.252 -m script -a 'script.sh' |egrep '>>|stdout'

ping模块

测试主机是否是通的，用法很简单，不涉及参数：

ansible test -m ping

setup模块

setup模块，主要用于获取主机信息，在playbooks里经常会用到的一个参数gather_facts就与该模块相关。setup模块下经常使用的一个参数是filter参数，具体使用示例如下：

# 查看主机内存信息
ansible 10.212.52.252 -m setup -a 'filter=ansible_*_mb'

# 查看地接口为eth0-2的网卡信息
ansible 10.212.52.252 -m setup -a 'filter=ansible_eth[0-2]' 

# 将所有主机的信息输入到/tmp/facts目录下，每台主机的信息输入到主机名文件中（/etc/ansible/hosts里的主机名）
ansible all -m setup --tree /tmp/facts   

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"

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'"

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"

cron模块

用于管理计划任务

包含如下选项：

• backup：对远程主机上的原任务计划内容修改之前做备份
• cron_file：如果指定该选项，则用该文件替换远程主机上的cron.d目录下的用户的任务计划
• day：日（1-31，，/2,……）
• hour：小时（0-23，，/2，……）
• minute：分钟（0-59，，/2，……）
• month：月（1-12，，/2，……）
• weekday：周（0-7，*，……）
• job：要执行的任务，依赖于state=present
• name：该任务的描述
• special_time：指定什么时候执行，参数：reboot,yearly,annually,monthly,weekly,daily,hourly
• state：确认该任务计划是创建还是删除
• user：以哪个用户的身份执行

示例：

ansible test -m cron -a 'name="a job for reboot" special_time=reboot job="/some/job.sh"'
ansible test -m cron -a 'name="yum autoupdate" weekday="2" minute=0 hour=12 user="root"'
ansible test -m cron  -a 'backup="True" name="test" minute="0" hour="5,2" job="ls -alh > /dev/null"'
ansilbe test -m cron -a 'cron_file=ansible_yum-autoupdate state=absent'

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'

user模块与group模块

user模块是请求的是useradd, userdel, usermod三个指令，goup模块请求的是groupadd, groupdel, groupmod 三个指令。

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
#生成密钥时，只会生成公钥文件和私钥文件，和直接使用ssh-keygen指令效果相同，不会生成authorized_keys文件
user: name=test generate_ssh_key=yes ssh_key_bits=2048 ssh_key_file=.ssh/id_rsa  

需要说明的是，在指定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加密算法。

group示例

group: name=somegroup state=present

synchronize模块

使用rsync同步文件，其参数如下：

• archive: 归档，相当于同时开启recursive(递归)、links、perms、times、owner、group、-D选项都为yes ，默认该项为开启
• checksum: 跳过检测sum值，默认关闭
• compress:是否开启压缩
• copy_links：复制链接文件，默认为no ，注意后面还有一个links参数
• delete: 删除不存在的文件，默认no
• dest：目录路径
• dest_port：默认目录主机上的端口 ，默认是22，走的ssh协议
• dirs：传输目录不进行递归，默认为no，即进行目录递归
• rsync_opts：rsync参数部分
• set_remote_user：主要用于/etc/ansible/hosts中定义或默认使用的用户与rsync使用的用户不同的情况
• mode: push或pull 模块，push模的话，一般用于从本机向远程主机上传文件，pull 模式用于从远程主机上取文件

使用示例：

src=some/relative/path dest=/some/absolute/path rsync_path="sudo rsync"
src=some/relative/path dest=/some/absolute/path archive=no links=yes
src=some/relative/path dest=/some/absolute/path checksum=yes times=no
src=/tmp/helloworld dest=/var/www/helloword rsync_opts=--no-motd,--exclude=.git mode=pull

filesystem模块

在块设备上创建文件系统
常用选项：

• dev：目标块设备
• force：在一个已有文件系统 的设备上强制创建
• fstype：文件系统的类型
• opts：传递给mkfs命令的选项

示例：

ansible test -m filesystem -a 'fstype=ext2 dev=/dev/sdb1 force=yes'
ansible test -m filesystem -a 'fstype=ext4 dev=/dev/sdb1 opts="-cc"'

mount模块

配置挂载点
选项：

• dump
• fstype：必选项，挂载文件的类型
• name：必选项，挂载点
• opts：传递给mount命令的参数
• src：必选项，要挂载的文件
• state：必选项
  • present：只处理fstab中的配置
  • absent：删除挂载点
  • mounted：自动创建挂载点并挂载之
  • umounted：卸载

示例：

name=/mnt/dvd src=/dev/sr0 fstype=iso9660 opts=ro state=present
name=/srv/disk src='LABEL=SOME_LABEL' state=present
name=/home src='UUID=b3e48f45-f933-4c8e-a700-22a159ec9077' opts=noatime state=present

ansible test -a 'dd if=/dev/zero of=/disk.img bs=4k count=1024'
ansible test -a 'losetup /dev/loop0 /disk.img'
ansible test -m filesystem 'fstype=ext4 force=yes opts=-F dev=/dev/loop0'
ansible test -m mount 'name=/mnt src=/dev/loop0 fstype=ext4 state=mounted opts=rw'

get_url 模块

该模块主要用于从http、ftp、https服务器上下载文件（类似于wget），主要有如下选项：

• sha256sum：下载完成后进行sha256 check；
• timeout：下载超时时间，默认10s
• url：下载的URL
• url_password、url_username：主要用于需要用户名密码进行验证的情况
• use_proxy：是事使用代理，代理需事先在环境变更中定义

示例：

get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440
get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf sha256sum=b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c

unarchive模块

用于解压文件，模块包含如下选项：

• copy：在解压文件之前，是否先将文件复制到远程主机，默认为yes。若为no，则要求目标主机上压缩包必须存在。
• creates：指定一个文件名，当该文件存在时，则解压指令不执行
• dest：远程主机上的一个路径，即文件解压的路径
• group：解压后的目录或文件的属组
• 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

playbook 简单使用

ansbile-playbook是一系列ansible命令的集合，利用yaml 语言编写。playbook命令根据自上而下的顺序依次执行。同时，playbook开创了很多特性,它可以允许你传输某个命令的状态到后面的指令,如你可以从一台机器的文件中抓取内容并附为变量,然后在另一台机器中使用,这使得你可以实现一些复杂的部署机制,这是ansible命令无法实现的。

playbook通过ansible-playbook命令使用,它的参数和ansible命令类似,如参数-k(–ask-pass) 和 -K (–ask-sudo) 来询问ssh密码和sudo密码,-u指定用户,这些指令也可以通过规定的单元写在playbook 。
ansible-playbook的简单使用方法: ansible-playbook example-play.yml 。

一个简单的示例

下面是一个简单的ansible-playbook示例，可以了解其构成:

# cat user.yml
- name: create user
  hosts: all
  user: root
  gather_facts: false  不需要setup
  vars:
user:"test"
  tasks:
    - name: create  user
      user: name="{{ user }}"

上面的playbook 实现的功能是新增一个用户：

• name参数对该playbook实现的功能做一个概述，后面执行过程中，会打印 name变量的值 ；
• hosts参数指定了对哪些主机进行参作；
• user参数指定了使用什么用户登录远程主机操作；
• gather_facts参数指定了在以下任务部分执行前，是否先执行setup模块获取主机相关信息，这在后面的task会使用到setup获取的信息时用到；
• vars参数，指定了变量，这里指定一个user变量，其值为test ，需要注意的是，变量值一定要用引号引住；
• task指定了一个任务，其下面的name参数同样是对任务的描述，在执行过程中会打印出来。
  • user提定了调用user模块；
  • name是user模块里的一个参数，而增加的用户名字调用了上面user变量的值。

同样，如果想实现把这个新增的用户删除，只需将该playbook文件的最后一行替换为如下行再执行相应的playbook即可：

user: name="{{ user }}" state=absent remove=yes

通过Playbook安装apache示例

通过ansible-playbook实现对多台主机同时同时安装apache。需要注意的是，多台被管理主机的操作系统可能不相同，而导致apache包名不同，假设同时存在CentOS和Debian两种操作系统，具体playbook内容如下：

# cat install_apache.yml
- hosts: all
  remote_user: root
  gather_facts:True
  tasks:
- name: install apache on CentOS
    yum: name=httpd state=present
    when: ansible_os_family =="CentOS"
- name: install apache on Debian
    yum: name=apache2 state=present
    when: ansible_os_family =="Debian"

上面使用了when语句，同时也开启了gather_facts setup模块，这里的ansible_os_family变量和就是直接使用的setup模块获取的信息。如果有大量主机，就在运行的时候加上-f然后选择一个合适的并发主机数量即可。

playbook的构成

playbook是由一个或多个"play"组成的列表。play的主要功能在于将事先归并为一组的主机装扮成事先通过ansible中的task定义好的角色。从根本上来讲所谓task无非是调用ansible的一个module。将多个play组织在一个playbook中即可以让它们联同起来按事先编排的机制同唱一台大戏。其主要有以下四部分构成:

• Target section： 定义将要执行 playbook 的远程主机组
• Variable section： 定义 playbook 运行时需要使用的变量
• Task section： 定义将要在远程主机上执行的任务列表
• Handler section： 定义 task 执行完成以后需要调用的任务

而其对应的目录层为五个（一般情况下，可视情况而变化），如下：

• vars: 变量层
• tasks: 任务层
• handlers: 触发条件
• files: 文件
• template 模板

Hosts和Users

playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的用户身份执行任务。

• hosts：用于指定要执行指定任务的主机其可以是一个或多个由冒号分隔主机组。
• remote_user ：用于指定远程主机上的执行任务的用户。不过remote_user也可用于各task中。也可以通过指定其通过sudo的方式在远程主机上执行任务其可用于play全局或某任务。此外甚至可以在sudo时使用sudo_user指定sudo时切换的用户。
• user：于remote_user相同
• sudo：如果设置为yes，执行该任务组的用户在执行任务的时候，获取root权限
• sudo_user：如果设置user为breeze，sudo为yes，sudo_user为bernie时，则breeze用户在执行任务时会获得bernie用户的权限
• connection：通过什么方式连接到远程主机，默认为ssh
• gather_facts：除非明确说明不需要在远程主机上执行setup模块，否则默认自动执行。如果确实不需要setup模块传递过来的变量，则可以将该选项设置为False

示例：

- hosts: webnodes
  tasks:
    - name: test ping connection:
    remote_user: test
    sudo: yes

任务列表和action

play的主体部分是任务列表。

任务列表中的各任务按次序逐个在hosts中指定的所有主机上执行即在所有主机上完成第一个任务后再开始第二个。在自上而下运行某playbook时如果中途发生错误，所有已执行任务都将回滚因此在更正playbook后重新执行一次即可。

task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量。模块执行是幂等的，这意味着多次执行是安全的，因为其结果均一致。每个task都应该有其name用于 playbook的执行结果输出，建议其内容尽可能清晰地描述任务执行步骤。如果未提供name则action的结果将用于输出。

定义task的可以使用"action: module options"或"module: options"的格式，推荐使用后者以实现向后兼容。如果action一行的内容过多也可使用在行首使用几个空白字符进行换行。

tasks:
  - name: make sure apache is running
    service: name=httpd state=running

需要说明的是，在众多模块中只有command和shell模块仅需要给定一个列表而无需使用“key=value”格式。例如：

tasks:
  - name: disable selinux
    command: /sbin/setenforce 0  

如果命令或脚本的退出码不为零可以使用如下方式替代：

tasks:
  - name: run this command and ignore the result
    shell: /usr/bin/somecommand || /bin/true

可以使用ignore_errors来忽略错误信息：

tasks:
  - name: run this command and ignore the result
    shell: /usr/bin/somecommand
    ignore_errors: True

handlers

用于当关注的资源发生变化时采取一定的操作。

"notify"这个action可用于在每个play的最后被触发，这样可以避免多次有改变发生时每次都执行指定的操作，取而代之仅在所有的变化发生完成后一次性地执行指定操作。

在notify中列出的操作称为handler也即notify中调用handler中定义的操作。

在notify中定义内容一定要和tasks中定义的 - name 内容一样，这样才能达到触发的效果，否则会不生效。
- name: template configuration file
  template: src=template.j2 dest=/etc/foo.conf
  notify:
  - restart memcached
  - restart apache

handler是task列表，这些task与前述的task并没有本质上的不同：

handlers:
  - name: restart memcached
    service: name=memcached state=restarted
  - name: restart apache
    service: name=apache state=restarted 

play常用模块

playbook的模块与在ansible命令行下使用的模块有一些不同。这主要是因为在playbook中会使用到一些facts变量和一些通过setup模块从远程主机上获取到的变量。有些模块没法在命令行下运行，就是因为它们需要这些变量。而且即使那些可以在命令行下工作的模块也可以通过playbook的模块获取一些更高级的功能。

template

在实际应用中，我们的配置文件有些地方可能会根据远程主机的配置的不同而有稍许的不同，template可以使用变量来接收远程主机上setup收集到的facts信息，针对不同配置的主机，定制配置文件。用法大致与copy模块相同。

常用参数：

• backup：如果原目标文件存在，则先备份目标文件
• dest：目标文件路径
• force：是否强制覆盖，默认为yes
• group：目标文件属组
• mode：目标文件的权限
• owner：目标文件属主
• src：源模板文件路径
• validate：在复制之前通过命令验证目标文件，如果验证通过则复制

官方简单示例：

- template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644
- template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode="u=rw,g=r,o=r"
- template: src=/mine/sudoers dest=/etc/sudoers validate='visudo -cf %s'

named.conf配置文件的jinja2模板示例：

options {
listen-on port 53 {
127.0.0.1;
{% for ip in ansible_all_ipv4_addresses %}
{{ ip }};
{% endfor %}
};
listen-on-v6 port 53 { ::1; };
directory "/var/named";
dump-file "/var/named/data/cache_dump.db";
statistics-file "/var/named/data/named_stats.txt";
memstatistics-file "/var/named/data/named_mem_stats.txt";
};
zone "." IN {
type hint;
file "named.ca";
};
include "/etc/named.rfc1912.zones";
include "/etc/named.root.key";
{# Variables for zone config #}
{% if 'authorativenames' in group_names %}
{% set zone_type = 'master' %}
{% set zone_dir = 'data' %}
{% else %}
{% set zone_type = 'slave' %}
{% set zone_dir = 'slaves' %}
{% endif %}
zone "internal.example.com" IN {
type {{ zone_type }};
file "{{ zone_dir }}/internal.example.com";
{% if 'authorativenames' not in group_names %}
masters { 192.168.2.2; };
{% endif %}
};

playbook的引用该模板配置文件的方法示例：

- name: Setup BIND
  host: allnames
  tasks:
    - name: configure BIND
      template: src=templates/named.conf.j2 dest=/etc/named.conf owner=root group=named mode=0640

set_fact

set_fact模块可以自定义facts，这些自定义的facts可以通过template或者变量的方式在playbook中使用。如果你想要获取一个进程使用的内存的百分比，则必须通过set_fact来进行计算之后得出其值，并将其值在playbook中引用。

下面是一个配置mysql innodb buffer size的示例：

- name: Configure MySQL
  hosts: mysqlservers
  tasks:
    - name: install MySql
      yum: name=mysql-server state=installed

    - name: Calculate InnoDB buffer pool size
      set_fact: innodb_buffer_pool_size_mb="{{ ansible_memtotal_mb / 2 }}"

    - name: Configure MySQL
      template: src=templates/my.cnf dest=/etc/my.cnf owner=root group=root mode=0644
      notify: restart mysql

    - name: Start MySQL
      service: name=mysqld state=started enabled=yes
  handlers:
    - name: restart mysql
      service: name=mysqld state=restarted

my.cnf的配置示例：

# {{ ansible_managed }}
[mysqld]
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
# Disabling symbolic-links is recommended to prevent assorted
security risks
symbolic-links=0
# Configure the buffer pool
innodb_buffer_pool_size = {{ innodb_buffer_pool_size_mb|int }}M
[mysqld_safe]
log-error=/var/log/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid