自动化运维工具——ansible剧本playbook（三）

一、Playbook——Ansible剧本

playbook是由一个或多个 “play”组成的列表

play的主要功能在于将事先归并为一组的主机装扮成事先通过ansible中的task定义好的角色，从根本上来讲，所谓task无非是调用ansible的一个module。将多个play组织在一个playbook中，既可以让他们联同起来按事先编排的及时同唱一台大戏

**Playbook采用YAML语言编写

二、YAML语言介绍

YAML是一个可读性高的用来表达资料序列的格式。YAML参考了其他多种语言，包括：XML、C语言、Python、Perl以及电子邮件格式RFC2822 等。Clark Evans在2001年在首次发表了这种语言，另外Ingy döt Net与Oren Ben-Kiki也是这语言的共同设计者

YAML Ain't Markup Language，即YAML不是XML。不过，在开发的这种语言时，YAML的意思其实是："Yet Another Markup Language"（仍是一种标记语言）

特性

• YAML的可读性好
• YAML和脚本语言的交互性好
• YAML使用实现语言的数据类型
• YAML有一个一致的信息模型
• YAML易于实现
• YAML可以基于流来处理
• YAML表达能力强，扩展性好

三、YAML语法简介

• 在单一档案中，可用连续三个连字号(——)区分多个档案。另外，还有选择性的连续三个点号( ... )用来表示档案结尾

• 次行开始正常写Playbook的内容，一般建议写明该Playbook的功能

• 使用#号注释代码

• 缩进必须是统一的，不能空格和tab混用

• 缩进的级别也必须是一致的，同样的缩进代表同样的级别，程序判别配置的级别是通过缩进结合换行来实现的

• YAML文件内容和Linux系统大小写判断方式保持一致，是区别大小写的，k/v的值均需大小写敏感

• k/v的值可同行写也可换行写。同行使用:分隔

• v可是个字符串，也可是另一个列表

• 一个完整的代码块功能需最少元素需包括 name: task

• 一个name只能包括一个task

• YAML文件扩展名通常为yml或yaml

• Dictionary：字典，通常有多个key与value构成，也可以将k:v放置于{}中进行表示，用 ,分隔多个k:v键值对

//第一种
---
# An employee record
name: Example Developer
job: Developer
skill: Elite
//第二种
---
# An employee record
{name: Example Developer, job: Developer, skill: Elite}

四、YAML语法

YAML的语法和其他高阶语言类似，并且可以简单表达清单、散列表、标量等数据结构。其结构（Structure）通过空格来展示，序列（Sequence）里的项用"-"来代表，Map里的键值对用":"分隔

//实例：
    name: John Smith
    age: 41
    gender: Male
    spouse:
        name: Jane Smith
        age: 37
        gender: Female
    children:
        - name: Jimmy Smith
            age: 17
            gender: Male
        - name: Jenny Smith
            age 13
            gender: Female

1. Playbook核心元素

• Hosts //执行的远程主机列表
• Tasks //任务集
• Varniables //内置变量或自定义变量在playbook中调用
• Templates //模块，可替换模块文件中的变量并实现一些简单逻辑的文件
• Handlers //和notity结合使用，由特定条件触发的操作，满足条件方才执行，否则不执行
• tags //标签 指定某条任务执行，用于选择运行playbook中的部分代码。ansible具有幂等性，因此会自动跳过没有变化的部分，即便如此，有些代码为测试其确实没有发生变化的时间依然会非常地长。此时，如果确信其没有变化，就可以通过tags跳过此些代码片断

2. playbook基础组件

1. Hosts

    playbook中的每一个play的目的都是为了让某个或某些主机以某个指定的用户身份执行任务。hosts用于指定要执行指定任务的主机，须事先定义在主机清单中

//可以是如下形式：
    one.example.com
    one.example.com:two.example.com
    192.168.1.50
    192.168.1.*

webServer:mysqlServer    //两组的并集
webServer:&mysqlServer  //两组的交集
webServer:!appServere     //在webServer组中，但是不在appServer组中
//实例
    - hosts: webServer : mysqlServer

2. remote_user

可用于Host和task中。也可以通过指定其通过sudo的方式在远程主机上执行任务，其可用于play全局或某任务；此外，甚至可以在sudo时使用sudo_user指定sudo时切换的用户

//实例：

 - hosts: webServer
     remote_user: root
   tasks:
        - name: test connection
            ping:
            remote_user: devUser
            sudo: yes    //默认sudo为root
            sudo_user:yunwei          //sudo为yunwei

3. task列表和action

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

task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量。模块执行是幂等的，这意味着多次执行是安全的，因为其结果均一致

每个task都应该有其name，用于playbook的执行结果输出，建议其内容尽可能清晰地描述任务执行步骤。如果未提供name，则action的结果将用于输出

tasks：任务列表

格式：

（1）action：module arguments

（2）module：arguments //建议使用

注意：shell和command模块后面跟命令，而非key=value

• 某任务的状态在运行后为changed时，可通过“notify” 通知给相应的handlers
• 任务可以通过"tags"打标签，而后可在ansible-playbook命令上使用 -t 指定进行调用

//实例：
    tasks:
        - name:disable Selinux
           command:/sbin/setenfoce 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/somecomma
        ignore_errors: True

4. tags

给某个动作打个标签，在需要的时候，指定这个标签，指定执行特定的内容

ansible-playbook  --tags [-t]   tagsname1,tagsname2  filename.yml
//指定执行 tags1，和tags2

五、运行playbook

1. 运行playbook的方式

`ansible-playbook  <filename.yml>  ...[options]`

    //常见选项
    --check        //只检测可能发生的改变，但不真正执行操作
    --list-hosts        //列出运行任务的主机
    --limit        //主机列表，只针对主机列表中的主机执行
    -v  //显示过程  -vv  -vvv

    //示例：
ansible-playbook file.yml --check   //只检测，不执行
ansible-playbook file.yml
ansible-playbook file.yml --limit webServer

2. Playbook示例

---

 - host:all
   tasks:
    - name: "installed Apache"
        command:yum install -q -y httpd
    - name: "copy config_File"
        command:cp /tmp/httpd.conf   /etc/httpd/conf/httpd.conf
        command: cp /tmp/httpd-vhosts.conf  /etc/httpd/conf/httpd-vhosts.conf
    - name:"started Apache, setting enabled start"
       service:name=httpd state=started enabled=yes

使用shell脚本编写如下

//示例：system.yml
---

 - hosts:all
    remote_user:root

    tasks:
     - name: create mysql user
        user: name=mysql  system=yes uid=36
     - name: create a group
        group:name=httpd system=yes

//示例：httpd.yml
---

 - hosts:webServer
    remote_user:root

    tasks:
     - name:install httpd
        yum:name=httpd state=present

     - name:install configure file
        copy:src=/tmp/httpd.conf  dest=/etc/httpd/conf/

     - name:start service
        service:name=httpd state=started enabled=yes

3. handlers和notify结合使用触发条件

① Handlers

handlers是task列表，这些task与前述的task并没有本质上的不同，用于当关注的资源发生变化时，才会采取一定的操作

② notify

notify这个action可用于在每个play的最后被触发，这样可以避免多次有改变发生时每次都执行指定的操作，仅在所有的变化发生完成后一次性地执行指定操作。在notify中列出的操作称为handler，也即notify中调用handler中定义的操作

③ Playbook中的handlers使用

---

---

---

④ Playbook中的tags使用

ansible-playbook  -t conf   httpd.yml
// 指定运行 httpd.yml文件中的 conf tags标签，  -t == --tags

六、Playbook中变量使用

1. 变量来源

• ansible setup facts 远程主机的所有变量都可以直接调用

• 在/etc/absible/hosts中定义
  
  普通变量：主机组中主机单独定义，优先级高于公共变量
  
  公共变量：又叫组变量，针对主机组中所有主机定义统一变量

• 通过命令行指定变量，优先级最高
  
  ansible-playbook -e varname=value

• 在playbook中定义

        vars:
            - var1:value1
            - var2:value2

• 在role中定义；roles目录下可以设置vars目录，定义变量

2. 变量命名规则

变量名仅能由字母，数字和下划线组成，且只能以字母开头

• 变量定义：key=value
  
  例如：http_port = 80
• 变量调用方式：
  
  通过{{ variable_name }} 调用变量，且变量名前后必须有空格，有时用 "{{ variable_name }}" 才生效
  
  ansible-playbook -e 选项指定
  
  ansible-playbook test.yml -e "hosts=webServer user=yunwei"

各种变量优先级：命令行 -e > vars_files指定变量文件 > 主机清单普通变量 > 主机清单公共(组)变量

变量示例1：

vim var1.yml
---
    - hosts: webServer
      remote_user: root
      tasks:
      - name: install package
        yum:name= {{ pack_name }} state=present

ansible-playbook -e pkname=httpd var1.yml

变量示例2：

vim var2.yml
---
    - hosts: webServer
      remote_user: root

      vars:
      - username: user1
      - groupname: group1

      tasks:
        - name: create group
          group: name={{ groupname }} state=present
        - name: create user
          user: name={{ username }}  state=present

//可以直接运行
ansible-playbook var2.yml
//也可以在命令行中设置变量，命令行变量优先
ansible-playbook  -e "username=webuser  groupname=nginx" var2.yml

3. 主机变量

可以在inventory中定义主机时为其添加主机变量以便于在playbook中使用

//示例：
//在主机清单中设置
    [webServer]
    172.16.1.101 http_port=81 maxRequestsPerChild=808
    172.16.1.102 http_port=82 maxRequestsPerChild=909

4. 组变量

组变量是指赋予给指定组内所有主机上的在playbook中可用的变量

//示例：
//在主机清单中设置
    [webServer]
    www1.test.com
    www2.test.com

    [webServer:vars]
    ntp_server=ntp.test.com
    nfs_server=nfs.test.com

5. 普通变量

//在主机清单中设置
    [webServer]
    172.16.1.110 http_port=8081  hostname=web1
    172.16.1.120 http_port=8082  hostname=web2

6. 公共（组）变量

//在主机清单中设置
    [webServer:vars]
    http_port=8800
    mark="_"

    [webServer]
    172.16.1.201  http_port=81 hostname=web1
    172.16.1.202  http_port=82 hostname=web2

ansible webServer -m hostname -a 'name={{ hostname }}{{ mark }}{{ http_port }}

// 命令行指定变量
ansible webServer –e http_port=8000 –m hostname –a ‘name={{ hostname }}{{ mark }}{{ http_port }}