一、基本概念

1.1 playbook基本概念

playbook是由一个或者多个“play”组成的列表，play的主要功能在于将事先归并为一组的主机装扮成事先通过ansible中的task定义好的角色。从根本上来讲，所谓task无非是调用ansible的一个module。将多个play组织在一个playbook中，即可以让他们联同起来按照事先编排的机制同唱一台大戏，palybook采用YAML预言编写。

1.2 yaml基本概念

YAML是一个可读性高用来表达资料序列的格式。YAML参考了其他多种语言，包括：XML、C语言、Python、Perl以及电子邮件格式RFC2822等。Clark Evans在2001年在首次发表了这种语言，另外Ingy dot Net与Oren Ben-Kiki也是这种语言的共同设计者。YAML Ain’t Markup Language，即TAML不是XML。不过，在开发这种语言时，YAML的意思其实是：Yet Another Markup Language（仍是一种标记语言）
特性
YAML的可读性好
YAML和脚本语言的交互性好
YAML使用实现语言的数据类型
YAML有一个一致的信息模型
YAML易于实现
YAML可以基于流来处理
YAML表达能力强，扩展性好
更多内容及规范参见http://www.yaml.org
YAML语法
1、注意
1）在单一档案中，可以连续三个连字号（—-）区分多个档案。另外，还有选择性的连续三个点号（…）用 来表示档案结尾
2）使用#号注释代码
3）缩进必须是统一的，不能空格和tab混用
4）缩进的级别也必须是一致的，同样的缩进代表同样的级别，程序判断配置的级别是通过缩进结合换行来实现的
5）YAML文件内容和linux系统大小写判断方式保持一致，是区别大小写的，k/v的值均需大小写敏感k/v的 值可同行写也可换行写。同行的话，使用：号分割
6）v可是一个字符串，也可是另一个列表
7）一个完成的代码块功能需最少元素包括 name: task
8）一个name只能包括一个task
9）YAML文件扩展名通常为yml或者yaml
2、list：列表
其所有元素均使用“-”打头
示例：
# Alist of tasty fruits
- Apple
- Orange
- Strawberry
- Mango
3、Dictionary：字典
通常由说个key与value构成
示例：
—-
# An employee record
name:Example Developer
job:Developer
skill:Elite
也可将key:value放置于{}中进行表示，用“，”分隔多个key:value
示例：
—-
# An employee record
{name:Example Developer,job:Developer,skill:Elite}
YAML的语法和其他高阶语言类似，并且可以简单表达清单，散列表、标量等数据结构。其结构 （Structure）通过空格来展示，序列（Sequence）里的项目“-”来代表，Map里的键值对用“：”分割。

二、playbook元素字段说明

ansible中文介绍：http://www.ansible.com.cn/
hosts 执行的远程主机列表
tasks 任务集
varniables 内置变量或自定义变量在playbook中调用
templates 模板，可替换模板文件中的变量并实现一些简单逻辑文件
hanslers 和notity结合使用，有特定条件出发操作，满足条件方可执行，否则不执行
tags 标签 指定某条任务执行，用于选择运行playbook中部分代码。ansible具有幂等性，因此会自动化跳过没有变化的部分，即便如此，有些代码为此时其确实没有发生变化的时间依然会非常的长。此时，确信其没有变化，就可以通过tags跳过此些代码片段。

2.1 playbook基础元素

1、hosts
playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的用户身份执行任务。hosts用于指定要执行指定任务的主机，须事先定义在主机清单中
可以是如下形式：
one.example.com
one.example.com:two.example.com
192.168.1.50
192.168.1.
webserver:dbserver 两个组的并集
webserver:&dbserver 两个组的交集
webserver:!dbserver 在webserver组中 但不在dbserver组中
示例： - hosts：webserver:sbserver
2、remote_user
可用于Host和task中。也可以通过制定其通过sudo的方式在远程主机上执行任务，其可用于play全局或某任务；此外；甚至可以在sudo时使用sudo_user: root时切换到用户。
- hosts: web
remote_user: root
tasks:
- name: test connection
ping
remote_user: zhangwei
sudo: yes #默认sudo为root
sudo_user: wang #sudo为wang
3、tasks：
任务列表
格式： module: arguments
注意：shell和command模块后面跟命令，而非key=value
某任务的状态在运行后为change时，可通过‘notify’通知给相应的handlers
某任务可以通过‘tags’打标签，而后可在ansible-playbook命令上使用-t指定进行调用
示例：
tasks：
- name: disable selinux
command: /sbin/setenforce 0
如果命令或脚本的退出码不为零，可以使用如下方式替代
tasks:
- name: run this conamnd and ignore the result
shell : /usr/bin/sommecommand || /bin/true
或者使用ignore_errors来忽略错误信息：
tasks:
- name: run this conamnd and ignore the result
shell : /usr/bin/sommecommand
ignore_errors: True
*示例：
image.png
注意：1、每个name对应一个模块（即一条命令，不能再一个name下面写多条命令，如两个copy）

2.2 playbook常用命令

运行playbook方式
ansible-playbook … [options]
常见选项
—check (-C)只检测可能会发生的改变，但不真正执行操作
—list-hosts 列出运行任务的主机
—limit 主机列表 只针对主机列表中的主机执行
-v 显示过程 -vv -vvv更详细
示例：
[root@ansible ansible]# ansible-playbook -C file.yaml　语法检查，以及模拟运行是否有错误
ansible-playbook file.yml —check 只检测
ansible-playbook file.yml
ansible-playbook file.yml —limit webserver
ansible-playbook file.yml —list-hosts # 查看主机
ansible-playbook file.yml —list-tasks #查看任务列表
ansible-playbook file.yml —list-tags # 查看标签

2.3 handlers和notify结合使用触发条件

为什么要使用handlers和notify
image.png
上面的问题：当我们修改配置文件后，再次执行该yaml文件时,http不会重新启动,新拷贝的配置文件,不会生效
handlers
是tasks列表，这些task与前述的task并没有本质上的不同，用于当关注的资源发生变化时，才会采取一定的操作
notify
此action可用于在每个play的最后被出发，这样可以避免多次有改变发生时，每次都执行指定的操作，仅在所有的变化发生完后一次性执行指定的操作。在notify中列出的操作称为handler，也即notify中调用handler中定义的操作

  1. ---
  2. - hosts: webservs
  3.   remote_user: root
  5.   tasks:
  6.     - name: install httpd
  7.       yum: name=httpd
  8.     - name: copy conf file
  9.       copy: src=files/httpd.conf dest=/etc/httpd/conf/ backup=yes
  10.       notify: restart httpd
  11.     - name: start service
  12.       service: name=httpd state=started enabled=yes
  14.   handlers:
  15.     - name: restart httpd
  16.       service: name=httpd state=restarted

当文件被修改时，就会触发notify通知handlers执行重启动作,在此例中我将配置文件监听端口修改为8080,然后执行playbook,后通过查看端口监听状态,已被修改为8080,服务正常.
image.png

2.4 tags标签**

tags标签的作用就是用来标识playbook中的每一个action动作,从而在命令行中我们可以通过指定标签从而执行指定的某一个动作.
image.png

ansible-playbook httpd.yml —list-tags #查看标签列表
[root@ansible ansible]# ansible-playbook -t inshttpd,reshttpd httpd.yaml 【使用-t 指定标签名字】
image.png
注意：tags标签命名可以相同，不通模块下写入相同tags标签，执行时，打入标签的模块会同时执行**

2.5 playbook中变量的使用

变量的优先级：命令行中的-e > playbook中定义的变量 > 主机清单中定义的变量
变量名：仅能由字母、数字和下划线组成，且只能以字母开头
变量来源：
1、ansible setup facts 远程主机的所有变量都可以直接调用
ansible all -m setup #查看远程主机的所有变量
ansible all -m setup -a ‘filter=ansible_hostname’#过滤主机中的变量
ansible all -m setup -a ‘filter=ansible_hostname’ #过滤主机的主机全名
这里查找到的变量可以直接在playbook中调用
2、在/etc/ansible/hosts中定义
普通变量：主机组中主机单独定义，优先级高与公共变量
公共组变量：针对主机组中所有主机定义统一变量
image.png
image.png
image.png
备注：普通变量的优先级高于公共变量
3、通过命令行指定变量的值，优先级最高
[root@ansible ansible]# ansible-playbook -e “inspkg1=httpd inspkg2=memcached” inspkg.yaml
image.png
image.png
4、在playbook中定义
[root@ansible ansible]# ansible-playbook inspkg.yaml
image.png
image.png

6、使用变量文件
可以单独顶一个文件存放变量值
[root@192-168-10-22 ansible]# cat vars.yaml
var1: httpd
var2: memcached

  1. ---
  2. - hosts: webservs
  3.   remote_user: root
  4.   vars_files: 
  5.     - vars.yaml
  6.   tasks:
  7.     - name: install pkg
  8.       yum: name={{ var1 }}
  9.     - name: start service
  10.       service: name={{var1}} state=started enabled=yes
  11.     - name: create file
  12.       file: name=/data/{{ var2 }}.log state=touch

image.png

2.6 templates模板

文本文件，嵌套有脚本（使用模板编程语言编写）
jinja2语言，使用字面量，有下面形式:
字符串：使用单引号或者双引号
数字：整数，浮点数
列表：[item1，itme2,…]
元组：（item1，itme2,…）
字典：{key1:value1,key2:value2,…}
布尔型：true/false
算术运算：+，-，，/，//，%，*
比较操作：==,！=,>,>=,<,<=
逻辑运算：and,or,not
流表达式：For If When（循环语句）
小记：在模板目录template下写入模板文件，文件中可以直接调用setup变量（src可以直接书写模板目录下的文件）

这里使用nginx对templates进行说明，下面的playbook将默认的nginx配置文件复制到被管理主机
图中标注的是nginx默认的配置项
修改前：
image.png

  1. ---
  2. - hosts: webservs
  3.   remote_user: root
  5.   tasks:
  6.     - name: install pkg
  7.       yum: name=nginx
  8.     - name: copy template
  9.       template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf
  10.     - name: start service
  11.       service: name=nginx  state=started enabled=yes

2、执行结果，可见worker进程都只有一个，worker进行默认auto是根据服务器的CPU数量来启动相应数量的worker进程
image.png
修改后：
１、通过setup模块查看cpu的变量
image.png
２、修改模板配置，这里为了演示效果，我把虚拟机CPU改成了2，所以下面可以看到worker的数量为6
image.png
３、playbook

  1. ---
  2. - hosts: webservs
  3.   remote_user: root
  5.   tasks:
  6.     - name: install pkg
  7.       yum: name=nginx
  8.     - name: copy template
  9.       template: src=nginx.conf.j2 dest=/etc/nginx/nginx.conf
  10.       notify: restartnginx
  11.     - name: start service
  12.       service: name=nginx  state=started enabled=yes
  13.   handlers:
  14.     - name: restartnginx
  15.       service: name=nginx state=restarted

4、执行结果
image.png
备注：上面同样也可以通过变量的形式对nginx配置文件中的其他参数进行修改，从而实现对不同主机达到不同配置的效果

2.7 when在template中的运用

条件测试：如果需要根据变量，facts或此前任务的执行结果来作为某task执行与否的前提时要用到条件测试，通过when语句实现，在task中使用，jinja2的语法格式
when语句
在task后添加when子句即可使用户条件测试；when语句支持jinji2表达式语法
示例：
- name: ‘shutdown redhad flavored systems’
command: /sbin/shutdown -h now
when: ansible_os_family == “RedHat”
如下示例是通过判断不同的系统版本，从而复制不同的配置文件，ansible_distribution_major_version是系统默认的参数，也可通过自定义变量方式进行配置

  1. ---
  2. - hosts: webservs
  3.   remote_user: root
  5.   tasks:
  6.     - name: install pkg
  7.       yum: name=nginx
  8.     - name: copy template for centos6
  9.       template: src=nginx.conf6.j2 dest=/etc/nginx/nginx.conf
  10.       when: ansible_distribution_major_version == "6"
  11.       notify: restartnginx
  12.     - name: copy template for centos7
  13.       template: src=nginx.conf7.j2 dest=/etc/nginx/nginx.conf
  14.       when: ansible_distribution_major_version == "7"
  15.       notify: restartnginx
  16.     - name: start service
  17.       service: name=nginx  state=started enabled=yes
  18.   handlers:
  19.     - name: restartnginx
  20.       service: name=nginx state=restarted

2.8 with_item在template中的运用

迭代：当有需要重复执行的任务时，可以使用迭代机制，对迭代项的引用，固定变量名为“item”，要在task中使用with_items给定要迭代的元素列表
列表格式：
字符串
字典

  1. ---
  2. - hosts: webservs
  3.   remote_user: root
  5.   tasks:
  6. ---
  7. - hosts: webservs
  8.   remote_user: root
  10.   tasks:
  11.     - name: create some files 
  12.       file: name=/data/{{item}} state=touch 
  13.       with_items:
  14.         - file1
  15.         - file2
  16.         - file3
  17.     - name: install some pkgs
  18.       yum: name={{'htop','sl','hping3'}}

运行结果：
image.png
with_items的嵌套

  1. ---
  2. - hosts: webservs
  3.   remote_user: root
  5.   tasks:
  6.     - name: create some groups
  7.       group: name={{ item }}
  8.       when: ansible_distribution_major_version == "7"
  9.       with_items:
  10.         - group1
  11.         - group2
  12.         - group3
  13.     - name: create some user
  14.       user: name={{ item.name }} group={{ item.group }}
  15.       with_items:
  16.         - { name: 'user1', group: 'group1' }
  17.         - { name: 'user2', group: 'group2' }
  18.         - { name: 'user3', group: 'group3' }

运行结果：
image.png

2.9 if和for在template中的运用

yaml文件

  1. ---
  2. - hosts: webservs
  3.   remote_user: root
  5.   vars:
  6.     ports:
  7.       - web1:
  8.         port: 81
  9.         name: web1.magedu.com
  10.         rootdir: /data/website1
  11.       - web2:
  12.         port: 82
  13.         #name: web2.magedu.com
  14.         rootdir: /data/website2
  15.   tasks:
  16.     - name: copy conf
  17.       template: src=ifor.conf.j2 dest=/data/ifor.conf

模板文件

  1. {% for p in ports %}
  2. server{
  3.       listen {{p.port}}
  4. {% if p.name is defined %}
  5.       servername {{p.name}}
  6. {% endif %}
  7.       documentroot {{p.rootdir }}
  8. }
  9. {% endfor %}

运行结果
image.png