---

playbook简介

playbook是 一个不同于运用Ansible命令行履行办法的形式，其功能更强大灵活。简单来说，playbook是一个十分简单的装备办理和多主机布置系统，不同于任何现已存在的形式，可作为一个合适布置杂乱应用程序的基础。Playbook能够定制装备，能够按照指定的操作过程有序履行，支持同步和异步办法。咱们完结一个使命，例如装置布置一个httpd服务，咱们需求多个模块（一个模块也能够称之为task）供给功能来完结。而playbook便是安排多个task的容器，他的本质便是一个文件，有着特定的安排格局，它采用的语法格局是YAML。

playbook自身由以下各部分组成

• Tasks：使命，即经过 task调用 ansible的模板将多个操作安排在一个playbook中运转
• Variables：变量
• Templates：模板
• Handlers：处理器，当notify地点使命满意changed状况条件时，触发履行的操作
• Roles：人物

编写playbook

示例1：yum装置nginx

vim test1.yaml
---     #yaml文件以---最初，以标明这是一个yaml文件，可省掉
- name: first play     #界说一个play的称号，可省掉
  gather_facts: false    #设置不进行facts信息搜集，这能够加快履行速度，可省掉
  hosts: webservers    #指定要履行使命的被办理主机组，如多个主机组用冒号分隔
  remote_user: root    #指定被办理主机上履行使命的用户
  tasks:     #界说使命列表，使命列表中的各使命按次序逐一在hosts中指定的主机上履行
   - name: test connection    #自界说使命称号
     ping:     #运用 module: [options] 格局来界说一个使命
   - name: disable selinux
     command: '/sbin/setenforce 0'    #command模块和shell模块无需运用key=value格局
     ignore_errors: True     #如履行命令的返回值不为0，就会报错，tasks中止，可运用ignore_errors疏忽失利的使命
   - name: disable firewalld
     service: name=firewalld state=stopped    #运用 module: options 格局来界说使命，option运用key=value格局
   - name: mount cdrom
     mount: src=/dev/sr0 path=/mnt state=mounted fstype=iso9660
     ignore_errors: True
   - name: install httpd
     yum: name=httpd state=latest
   - name: install configuration file for httpd
     copy: src=/opt/httpd.conf dest=/etc/httpd/conf/httpd.conf    #这里需求一个事前准备好的/opt/httpd.conf文件
     notify: "restart httpd"    #如以上操作后为changed的状况时，会经过notify指定的称号触发对应称号的handlers操作
   - name: start httpd service
     service: enabled=true name=httpd state=started
  handlers:     #handlers中界说的便是使命，此处handlers中的使命运用的是service模块
   - name: restart httpd    #notify和handlers中使命的称号必须共同
     service: name=httpd state=restarted
##Ansible在履行完某个使命之后并不会当即去履行对应的handler，而是在当前play中所有一般使命都履行完后再去履行handler，这样的好处是能够屡次触发notify，但最终只履行一次对应的handler，然后防止屡次重启。

解析

履行状况返回

用该剧本进行防火墙的封闭，其间一台现已封闭防火墙，另一台未封闭。

其间现已为所设装备而状况未改动的，会显现为ok。
状况发生改动的，会显现为changed。

ignore_errors: True

如履行命令的返回值不为0，就会报错，tasks中止，可运用ignore_errors疏忽失利的使命

其间一台长途主机selinux设为永久封闭，并重启，使得selinux状况为disabled。另一台selinux仍然为敞开状况。

假如不设置ignore_errors: True，由于selinux状况为disabled，返回值不为0，所以该主机的task会中止。另一台主机不受影响，仍然会持续使命的进行。

设置ignore_errors: True，就会疏忽，持续后面进行使命。

运转playbook

准备工作

事前准备好一个/opt/httpd.conf文件

运转展现

运转该剧本

长途主机的httpd现已运转

浏览器访问也没有问题

示例2：yum装置nginx

- name: second play
  gather_facts: false
  hosts: webservers
  remote_user: root
  tasks:
  - name: disable selinux
    command: '/usr/sbin/setenforce 0'
    ignore_errors: true
  - name: disable firewalld
    service: name=firewalld state=stopped enabled=no
  - name: upload nginx.repo
    copy: src=/etc/yum.repos.d/nginx.repo dest=/etc/yum.repos.d/nginx.repo
  - name: install nginx
    yum: name=nginx state=latest
  - name: prepare httpd configuration file
    copy: src=/opt/default.confdest=/etc/nginx/conf.d/default.conf
    notify: " restart nginx"
  - name: start nginx
    service: name=nginx state=started enabled=yes
  handlers:
  - name: restart nginx
    service: name=nginx state=restarted

运转playbook

ansible-playbook test1.yaml
//补充参数：
-k（–ask-pass）：用来交互输入ssh密码
-K（-ask-become-pass）：用来交互输入sudo密码
-u：指定用户
ansible-playbook test1.yaml --syntax-check    #检查yaml文件的语法是否正确
ansible-playbook test1.yaml --list-task       #检查tasks使命
ansible-playbook test1.yaml --list-hosts      #检查收效的主机
ansible-playbook test1.yaml --start-at-task='install httpd'     #指定从某个task开端运转

检查yaml文件的语法是否正确

此状况表明没有问题

故意制造一个过错，再进行检测

检查tasks使命

此状况表明没有问题

用于检测tasks中出现的过错

检查收效的主机

指定从某个task开端运转

指定从install httpd开端进行

界说、引证变量

- name: second play
  hosts: dbservers
  remote_user: root
  vars:                 #界说变量
   - groupname: mysql   #格局为 key: value
   - username: nginx
  tasks:
   - name: create group
     group: name={{groupname}} system=yes gid=306    #运用 {{key}} 引证变量的值
   - name: create user
     user: name={{username}} uid=306 group={{groupname}} 
   - name: copy file
     copy: content="{{ansible_default_ipv4}}" dest=/opt/vars.txt    #gather_facts设为true，进行facts信息搜集，在setup模块中能够获取facts变量信息

示例：界说变量

运转成果

变量可命令行里界说

格局：ansible-playbook 剧本文件名 -e "变量名=界说的值"

示例：引证fact中的变量

setup能够搜集该组中所有的节点信息，所以setup中fact信息，有时候会剧本编写中需求，而fact的信息也是能够经过变量的办法进行调用

获取长途主机IP地址：

运转成果

履行后，获取到地址并输入到长途主机文件中。

注意：
引证fact中的变量时，不能设置为gather_facts: false，设置后将获取不到变量

迭代

Ansible供给了很多种循环结构，一般都命名为with_items，作用等同于 loop 循环。

• with_items：{{item}}会把所有的列表展开进行遍历输出，with_flattened也能够代替with_items
• with_list：{{item}}会把每个列表当作一个全体输出。假如每个列表中只有一个值，则效果与with items共同。loop也能够代替ith
• with_together：{{item}}引证时会把每个列表相同方位的值对齐兼并后输出
• with nested：{{item}}引证时会把每个列表的值两两组合循环输出

with_item 单循环输出

两个列表时，with_item 循环输出

遍历界说的变量

不止一种变量时

列表也能够横向表明：

with_list 每组列表一同循环的输出

with_together同一列表方位数据组合输出的循环

两个列表数量不一样

with_nested 列表数据循环匹配的循环（依据列表个数界说有多少层的循环）

when条件判别

在Ansible中，供给的仅有一个通用的条件判别是when指令，当when指令的值为true时，则该使命履行，否则不履行该使命。

when一个比较常见的应用场景是完成越过某个主机不履行使命或许只有满意条件的主机履行使命

vim demo7.yaml
---
- hosts: all
  remote_user: root
  tasks:
   - name: stop httpd
     service: name=httpd state=stopped enabled=no
     when: ansible_default_ipv4.address == "192.168.44.30"      #when指令中的变量名不需求手动加上 {{}}
     或 
     when: inventory_hostname == "<主机名>"
ansible-playbook demo7.yaml

原本两台长途主机httpd为敞开，且开机自启动

假如不符合条件直接越过

其间一台现已封闭httpd，另一台未改动。

when条件还能够经过！=（不等于条件来进行判别）

vim demo7.yaml
---
- hosts: all
  remote_user: root
  tasks:
   - name: stop httpd
     service: name=httpd state=stopped enabled=no
     when: ansible_default_ipv4.address != "192.168.44.30"      #when指令中的变量名不需求手动加上 {{}}
     或 
     when: inventory_hostname == "<主机名>"
ansible-playbook demo7.yaml

Templates 模块

Jinja是依据Python的模板引擎。Template类是Jinja的一个重要组件，能够看作是一个编译过的模板文件，用来产生方针文本，传递Python的变量给模板去替换模板中的标记。

过程演示

1. 先准备一个以 .j2 为后缀的 template 模板文件，设置引证的变量

cp /etc/httpd/conf/httpd.conf /opt/httpd.conf.j2
vim /opt/httpd.conf.j2
Listen {{http_port}}				#42行，修正
ServerName {{server_name}}			#95行，修正
DocumentRoot "{{root_dir}}"          #119行，修正

2. 修正主机清单文件，运用主机变量界说一个变量名相同，而值不同的变量

[webservers]
192.168.44.30 http_port=192.168.44.30:80 server_name=www.test1.com:80 root_dir=/etc/httpd/htdocs
[dbservers]
192.168.44.40 http_port=192.168.44.40:80 server_name=www.test2.com:80 root_dir=/etc/httpd/htdocs

3. 编写 playbook

vim apache.yaml
---
- hosts: all
  remote_user: root
  vars:
    - package: httpd
    - service: httpd
  tasks:
    - name: install httpd package
      yum: name={{package}} state=latest
    - name: install configure file
      template: src=/opt/httpd.conf.j2 dest=/etc/httpd/conf/httpd.conf     #运用template模板
      notify:
        - restart httpd
    - name: create root dir
      file: path=/etc/httpd/htdocs state=directory
    - name: start httpd server
      service: name={{service}} enabled=true state=started
  handlers:
    - name: restart httpd
      service: name={{service}} state=restarted
ansible-playbook apache.yaml

检查成果：

tags 模块

能够在一个playbook中为某个或某些使命界说“标签”，在履行此playbook时经过ansible-playbook命令运用–tags选项能完成仅运转指定的tasks。
playbook还供给了一个特别的tags为always。作用便是当运用always作为tags的task时，无论履行哪一个tags时，界说有always的tags都会履行。

单标签的运用

vim test1.yaml
---
- name: this is a play for testing variables
  hosts: webservers
  remote_user: root
  tasks:
   - name: position 1
     debug:
       msg: 'ls /opt'
     tags:
      - only
   - name: position 2
     debug:
       msg: 'ls /mnt'
ansible-playbook test1.yaml --tags="only"

多标签的运用

---
- name: this is a play for testing variables
  hosts: webservers
  remote_user: root
  tasks:
   - name: position 1
     debug:
       msg: '测验标签1'
     tags:
      - one
   - name: position 2
     debug:
       msg: '测验标签2'
     tags:
      - two
   - name: position 3
     debug:
       msg: '测验标签3'
     tags:
      - one

通用标签always的运用

- name: this is a play for testing variables
  hosts: webservers
  remote_user: root
  tasks:
   - name: position 1
     debug:
       msg: '测验标签1'
     tags:
      - one
   - name: position 2
     debug:
       msg: '测验标签always'
     tags:
      - always
   - name: position 3
     debug:
       msg: '测验标签3'
     tags:
      - one

Roles 模块

Ansible为了层次化、结构化地安排Playbook，运用了人物（roles），roles能够依据层次型结构主动装载变量文件、task以及handlers等。简单来讲，roles便是经过分别将变量、文件、使命、模块及处理器放置于单独的目录中，并能够快捷地include它们。roles一般用于依据主机构建服务的场景中，但也能够用于构建守护进程等场景中。

简述Ansible人物

数据中心有各种不同类型的主机。如web服务器、数据库服务器，依据开发环境的服务器。随着时刻的推移，具有处理所有这些状况的使命和人员的Ansible playbook将变得巨大而杂乱。

• 人物答应将杂乱的剧本安排成独立的、更小的剧本和文件。
• 人物供给了一种从外部文件加载使命、处理程序和变量的办法。
• 人物也可关联和引证静态的文件和模板。
• 人物能够编写成满意一般用途需求，并且能被重复运用。
• 界说人物的文件具有特定的称号，并以严厉的目录结构进行安排。

roles 的目录结构

cd /etc/ansible/
tree roles/
roles/      #剧本
├── web/    #人物，相当于 playbook 中的 每一个 play 主题
│   ├── files/         #一般文件
│   ├── templates/     #模板文件
│   ├── tasks/         #包括该人物要履行的使命列表
│   ├── handlers/      #处理器,不只该人物能够运用，其他人物也能运用
│   ├── vars/          #其他变量
│   ├── defaults/      #默许变量
│   └── meta/          #元数据
└── db/
    ├── files/
    ├── templates/
    ├── tasks/
    ├── handlers/
    ├── vars/
    ├── defaults/
    └── meta/

roles 内各目录含义解说

• files：用来寄存由 copy 模块或 script 模块调用的文件。
• templates：用来寄存 jinjia2 模板，template 模块会主动在此目录中寻觅 jinjia2 模板文件。
• tasks：此目录应当包括一个 main.yml 文件，用于界说此人物的使命列表，此文件能够运用 include 包括其它的位于此目录的 task 文件。
• handlers：此目录应当包括一个 main.yml 文件，用于界说此人物中触发条件时履行的动作。
• vars：此目录应当包括一个 main.yml 文件，用于界说此人物用到的变量。
• defaults：此目录应当包括一个 main.yml 文件，用于为当前人物设定默许变量。
• meta：此目录应当包括一个 main.yml 文件，用于界说此人物的特别设定及其依靠联系。

在一个 playbook 中运用 roles 的过程

（1）创立以 roles 命名的目录
mkdir /etc/ansible/roles/ -p    #yum装完默许就有
（2）创立全局变量目录（可选）
mkdir /etc/ansible/group_vars/ -p
touch /etc/ansible/group_vars/all     #文件名自己界说，引证的时候注意
（3）在 roles 目录中分别创立以各人物称号命名的目录，如 httpd、mysql
mkdir /etc/ansible/roles/httpd
mkdir /etc/ansible/roles/mysql
（4）在每个人物命名的目录中分别创立files、handlers、tasks、templates、meta、defaults和vars目录，用不到的目录能够创立为空目录，也能够不创立
mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta}
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta}
（5）在每个人物的 handlers、tasks、meta、defaults、vars 目录下创立 main.yml 文件，千万不能自界说文件名
touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml
（6）修正 site.yml 文件，针对不同主机去调用不同的人物
vim /etc/ansible/site.yml
---
- hosts: webservers
  remote_user: root
  roles:
     - httpd
- hosts: dbservers
  remote_user: root
  roles:
     - mysql
（7）运转 ansible-playbook
cd /etc/ansible
ansible-playbook site.yml
示例：
mkdir /etc/ansible/roles/httpd/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/mysql/{files,templates,tasks,handlers,vars,defaults,meta} -p
mkdir /etc/ansible/roles/php/{files,templates,tasks,handlers,vars,defaults,meta} -p
touch /etc/ansible/roles/httpd/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/mysql/{defaults,vars,tasks,meta,handlers}/main.yml
touch /etc/ansible/roles/php/{defaults,vars,tasks,meta,handlers}/main.yml
------编写httpd模块------
写一个简单的tasks/main.yml
vim /etc/ansible/roles/httpd/tasks/main.yml
- name: install apache
  yum: name={{pkg}} state=latest
- name: start apache
  service: enabled=true name={{svc}} state=started
//界说变量：能够界说在全局变量中，也能够界说在roles人物变量中，一般界说在人物变量中
vim /etc/ansible/roles/httpd/vars/main.yml
pkg: httpd
svc: httpd
-------编写mysql模块-------
vim /etc/ansible/roles/mysql/tasks/main.yml
- name: install mysql
  yum: name={{pkg}} state=latest
- name: start mysql
  service: enabled=true name={{svc}} state=started
vim /etc/ansible/roles/mysql/vars/main.yml
pkg:
  - mariadb
  - mariadb-server
svc: mariadb
-------编写php模块-----
vim /etc/ansible/roles/php/tasks/main.yml
- name: install php
  yum: name={{pkg}} state=latest
- name: start php-fpm
  service: enabled=true name={{svc}} state=started
vim /etc/ansible/roles/php/vars/main.yml
pkg:
  - php
  - php-fpm
svc: php-fpm
-----编写roles示例-----
vim /etc/ansible/site.yml
---
- hosts: webservers
  remote_user: root
  roles:
   - httpd
   - mysql
   - php
cd /etc/ansible
ansible-playbook site.yml

总结

迭代循环办法

• with_items：{{item}}会把所有的列表展开进行遍历输出，with_flattened也能够代替with_items
• with_list：{{item}}会把每个列表当作一个全体输出。假如每个列表中只有一个值，则效果与with items共同。loop也能够代替ith
• with_together：{{item}}引证时会把每个列表相同方位的值对齐兼并后输出
• with nested：{{item}}引证时会把每个列表的值两两组合循环输出

when

when判别返回值为true，即条件成立时履行当前使命，条件不成立则不履行当前使命
when: inventoryhostname =='主机名|IP'
when: facts信息字段!='XXXXXXX'