3.3 ansible之playbook

Posted 2021-01-10

playbook

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

YAML语法简介

List：列表，其所有元素均使用“-”打头
示例

A list of tasty fruits

• Apple
• Orange
• Strawberry
• Mango

  YAML介绍

  1 YAML是一个可读性高的用来表达资料序列的格式。YAML参考了其他多种语言，包括：XML、C语言、Python、Perl以及电子邮件格式RFC2822等。Clark Evans在2001年在首次发表了这种语言，另外Ingy d?t Net与Oren Ben-Kiki也是这语言的共同设计者
  2 YAML Ain’t Markup Language，即YAML不是XML。不过，在开发的这种语言时，YAML的意思其实是：”Yet Another Markup Language”（仍是一种标记语言）

特性

YAML的可读性好
YAML和脚本语言的交互性好
YAML使用实现语言的数据类型
YAML有一个一致的信息模型
YAML易于实现
YAML可以基于流来处理
YAML表达能力强，扩展性好
更多的内容及规范参见http://www.yaml.org

YAML语法简介

1 在单一档案中，可用连续三个连字号(—)区分多个档案。另外，还有选择性的连续三个点号( … )用来表示档案结尾
2 次行开始正常写Playbook的内容，一般建议写明该Playbook的功能
3 使用#号注释代码
4 缩进必须是统一的，不能空格和tab混用
5 缩进的级别也必须是一致的，同样的缩进代表同样的级别，程序判别配置的级别是通过缩进结合换行来实现的
6 YAML文件内容和Linux系统大小写判断方式保持一致，是区别大小写的，k/v的值均需大小写敏感
7 k/v的值可同行写也可换行写。同行使用:分隔
8 v可是个字符串，也可是另一个列表
9 一个完整的代码块功能需最少元素需包括 name: task
10 一个name只能包括一个task
11 YAML文件扩展名通常为yml或yaml
12 Dictionary：字典，通常由多个key与value构成

范例：
An employee record
{name: Example Developer, job: Developer, skill: Elite}

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

Playbook核心元素

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

ansible-playbook –t tagsname useradd.yml

范例

[[email protected] ansible]# vim test.yml

• hosts: cen7 要执行的主机
  remote_user: root 用哪个用户执行

  tasks: 任务集

  • name: install package 一条任务要有一个名字
    yum: name=httpd 调用的模块，和参数
  • name: start service
    service: name=httpd state=started enabled=yes

查看playbook中被执行的主机列表

[[email protected] ansible]# ansible-playbook test.yml --list-host

playbook: test.yml

play #1 (cen7): cen7 TAGS: []
pattern: [u‘cen7‘]
hosts (2):
192.168.27.101
192.168.27.102

查看playbook中有哪些任务

ERROR! You must specify a playbook file to run
[[email protected] ansible]# ansible-playbook test.yml --list-tasks

playbook: test.yml

play #1 (cen7): cen7 TAGS: []
tasks:
install package TAGS: []
start service TAGS: []

一个playbook推荐只写一个play，当然可以写多个play

实验

1 安装http服务并把它设置为开机启动，并将端口改为8080端口，开启服务，写一个playbook
2 首先在自己的电脑上装一个http服务，并且修改好配置文件，然后在将配置文件复制到远程主机上，启动服务，这里的所有主机都是centos7的，不同系统版本的http配置文件不一样，所以要同一版本

• hosts: cen7
  remote_user: root

  tasks:

  • name: isntall httpd
    yum: name=httpd
  • name: copy config httpd
    copy: src=/app/httpd.conf dest=/etc/httpd/conf/ backup=yes
  • name: start httpd
    service: name=httpd state=started enabled=yes

当我们在想把配置文件改为80端口，如果在重新执行上面的playbook并不会改过了，因为上面只是定义了启动服务，所以我们要用handlers条件出发

---

• hosts: cen7
  remote_user: root

  tasks:

  • name: isntall httpd
    yum: name=httpd
  • name: copy config httpd
    copy: src=/app/httpd.conf dest=/etc/httpd/conf/ backup=yes
    notify: restart httpd 当copy发生改变时会执行notify所指定的名字任务
  • name: start httpd
    service: name=httpd state=started enabled=yes

  handlers: handlers是一个特殊的tasks也可以写多个任务

  • name: restart httpd
    service: name=httpd state=restarted

当第一次执行这个playbook会顺序执行，不会触发handlers，因为第一次包都没有装，但是当第二次执行时开始执行handlers，当copy命令执行结果改变时，会执行对应的handlers的任务

playbook基础组件

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

bash
one.example.com
one.example.com:two.example.com
192.168.1.50
192.168.1.*

Websrvs:dbsrvs 两个组的并集
Websrvs:&dbsrvs 两个组的交集
webservers:!phoenix 在websrvs组，但不在dbsrvs组
示例: - hosts: websrvs：dbsrvs

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

• hosts: websrvs
  remote_user: root
  tasks:
  • name: test connection
    ping:
    remote_user: magedu
    sudo: yes 默认sudo为root
    sudo_user:wang sudo为wang

task列表和action

1 play的主体部分是task list。task list中的各任务按次序逐个在hosts中指定的所有主机上执行，即在所有主机上完成第一个任务后再开始第二个。在运行自下而下某playbook时，如果中途发生错误，所有已执行任务都将回滚，因此，在更正playbook后重新执行一次即可
2 task的目的是使用指定的参数执行模块，而在模块参数中可以使用变量。模块执行是幂等的，这意味着多次执行是安全的，因为其结果均一致
每个task都应该有其name，用于playbook的执行结果输出，建议其内容尽可能清晰地描述任务执行步骤。如果未提供name，则action的结果将用于输出

tasks：任务列表

格式：
(1) action: module arguments
(2) module: arguments 建议使用

示例
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

运行playbook

运行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 websrvs

范例1，限定特定的主机执行，并不是所以的主机执行
[[email protected] app]# ansible-playbook httpd.yml --limit 192.168.27.101
只针对101主机执行并不是所有主机

Playbook VS ShellScripts

SHELL脚本

#!/bin/bash

安装Apache

yum install --quiet -y httpd

复制配置文件

cp /path/to/config/httpd.conf
/etc/httpd/conf/httpd.conf
cp/path/to/httpd-vhosts.conf
/etc/httpd/conf/httpd-vhosts.conf

启动Apache，并设置开机启动

service httpd start
chkconfig httpd on

Playbook定义

---

• hosts: all
  tasks:
• name: "安装Apache"
  command: yum install -q -y httpd
• name: "复制配置文件"
  command: cp /tmp/httpd.conf /etc/httpd/conf/httpd.conf
  command: cp /tmp/httpd-vhosts.conf /etc/httpd/conf/httpd-vhosts.conf

• name: "启动Apache，并设置开机启动"
  service: name=httpd state=started enabled=yes

  范例
  示例：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: websrvs
    remote_user: root
    tasks:
  • name: Install httpd
    yum: name=httpd state=present
  • name: Install configure file
    copy: src=files/httpd.conf dest=/etc/httpd/conf/
    • name: start service
      service: name=httpd state=started enabled=yes

      handlers和notify结合使用触发条件

Handlers
是task列表，这些task与前述的task并没有本质上的不同,用于当关注的资源发生变化时，才会采取一定的操作.
notify这个action可用于在每个play的最后被触发，这样可以避免多次有改变发生时每次都执行指定的操作，仅在所有的变化发生完成后一次性地执行指定操作。在notify中列出的操作称为handler，也即notify中调用handler中定义的操作

Playbook中handlers使用

• hosts: websrvs
  remote_user: root
  tasks:
  • name: Install httpd
    yum: name=httpd state=present
  • name: Install configure file
    copy: src=files/httpd.conf dest=/etc/httpd/conf/
    notify: restart httpd
  • name: ensure apache is running
    service: name=httpd state=started enabled=yes
    handlers:
  • name: restart httpd
    service: name=httpd status=restarted

示例

• hosts: websrvs
  remote_user: root
  tasks:
  • name: add group nginx
    tags: user
    user: name=nginx state=present
  • name: add user nginx
    user: name=nginx state=present group=nginx
  • name: Install Nginx
    yum: name=nginx state=present
  • name: config
    copy: src=/root/config.txt dest=/etc/nginx/nginx.conf
    notify:
    • Restart Nginx
    • Check Nginx Process
      handlers:
  • name: Restart Nginx
    service: name=nginx state=restarted enabled=yes
  • name: Check Nginx process
    shell: killall -0 nginx > /tmp/nginx.log

Playbook中tags使用,从剧本中挑出tags代表的任务，只执行这个，其它的不执行

tage的名字可以相同
示例：httpd.yml

• hosts: websrvs
  remote_user: root
  tasks:
  • name: Install httpd
    yum: name=httpd state=present
  • name: Install configure file
    copy: src=files/httpd.conf dest=/etc/httpd/conf/
    tags: conf
  • name: start httpd service
    tags: service
    service: name=httpd state=started enabled=yes

[[email protected] app]# ansible-playbook -t conf，service httpd.yml

可以一次启动多个tags标签。加-t或者–tags

Playbook中变量使用

变量名：仅能由字母、数字和下划线组成，且只能以字母开头
变量来源：
1 ansible setup facts 远程主机的所有变量都可直接调用
2 在/etc/ansible/hosts中定义
普通变量：主机组中主机单独定义，优先级高于公共变量
公共（组）变量：针对主机组中所有主机定义统一变量
3 通过命令行指定变量，优先级最高
ansible-playbook –e varname=value
4 在playbook中定义
bash
vars:</li>
<li>var1: value1</li>
<li>var2: value2

5 在role中定义
用setup模块可以查看机器的所有的内置变量

ansible cen7 -m setup

也可以用filter参数搜索变量,支持通配符

[[email protected] app]# ansible cen7 -m setup -a ‘filter=hostname‘
192.168.27.102 | SUCCESS => {
"ansible_facts": {
"ansible_hostname": "g102"
},
"changed": false
}
192.168.27.101 | SUCCESS => {
"ansible_facts": {
"ansible_hostname": "g101"
},
"changed": false
}
[[email protected] app]# ansible cen7 -m setup -a ‘filter=nodename‘
192.168.27.101 | SUCCESS => {
"ansible_facts": {
"ansible_nodename": "g101.com"
},
"changed": false
}
192.168.27.102 | SUCCESS => {
"ansible_facts": {
"ansible_nodename": "g102.com"
},
"changed": false
}
[[email protected] app]# ansible cen7 -m setup -a ‘filter=fqdn‘
192.168.27.102 | SUCCESS => {
"ansible_facts": {
"ansible_fqdn": "g102.com"
},
"changed": false
}
192.168.27.101 | SUCCESS => {
"ansible_facts": {
"ansible_fqdn": "g101.com"
},
"changed": false
}
最好写全名称
可以查ip地址
ct, raw, meta
[[email protected] app]# ansible cen7 -m setup -a ‘filter=addr‘
192.168.27.102 | SUCCESS => {
"ansible_facts": {
"ansible_all_ipv4_addresses": [
"192.168.27.102"
],
"ansible_all_ipv6_addresses": [
"fe80::20c:29ff:fe8b:f0dd"
]
},
"changed": false
}
192.168.27.101 | SUCCESS => {
"ansible_facts": {
"ansible_all_ipv4_addresses": [
"192.168.27.101"
],
"ansible_all_ipv6_addresses": [
"fe80::20c:29ff:fec3:887f"
]
},
"changed": false
}

Playbook中变量使用

变量命名
变量名仅能由字母、数字和下划线组成，且只能以字母开头
变量定义：key=value
示例：http_port=80
变量调用方式：
通过{{ variable_name }} 调用变量，且变量名前后必须有空格，有时用“{{ variable_name }}”才生效

ansible-playbook –e 选项指定

ansible-playbook test.yml -e "hosts=www user=mageedu"

范例1:var.yml

• hosts: websrvs
  remote_user: root
  tasks
  • name: install package
    yum: name={{ pkname }} state=present

ansible-playbook -e pkname=httpd var.yml

范例在playbook中赋值并调用

[[email protected] ansible]# vim var2.yml

• hosts: cen7
  remote_user: root
  vars: //如果要在play中第一变量要用vars

  • username: user123 //变量名：赋值
  • groupname: group123

  tasks:

  • name: create group
    group: name={{ groupname }} //调用变量
  • name: create uesr
    user: name={{ username }} group={{ groupname }} home=/app/{{ username }}dir //可以写变量加其它字段
    [[email protected] ansible]# ansible-playbook var2.yml
    [[email protected] ansible]# ansible cen7 -a ‘getent passwd user123‘
    192.168.27.101 | SUCCESS | rc=0 >>
    user123:x:1001:1001::/app/user123dir:/bin/bash

    范例2：变量

    vim var2.yml
    -hosts: websrvs
    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=user2 groupname=group2” var2.yml

用yum模块可以一次安装或卸载多个包

ansible cen7 -m yum -a ‘name=dstat,httpd state=absent‘