自动化运维：Ansible脚本之playbook剧本

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

（2）组成

 Target section：   定义将要执行 playbook 的远程主机组

  Variable section： 定义 playbook 运行时需要使用的变量

  Task section：     定义将要在远程主机上执行的任务列表

  Handler section：  定义 task 执行完成以后需要调用的任务

（3）目录层

其对应的目录层为五个，如下：

一般所需的目录层有：(视情况可变化)
  vars     变量层
  tasks    任务层
  handlers 触发条件
  files    文件
  template 模板

（4）Playbook的核心元素

Tasks：任务，由模板定义的操作列表。调用模块完成的某操作，一个任务对应一个模块的调用。

Variables：变量

Templates：模板，即使用模板语法的文件

Handlers：由特定条件触发的Tasks

Roles：角色。可以组织 playbook。基于一个已知的文件结构，去自动的加载某些 vars_files，tasks 以及 handlers

2.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表达能力强，扩展性好

（3）语法

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

---.表明YAML一个文件的开始
#表中的所有成员都开始于相同的缩进级别, 并且使用一个 "- " 作为开头(一个横杠和一个空格):如：
---
# 一个美味水果的列表
- Apple
- Orange
- Banana
- Mango

#一个字典是由一个简单的 键: 值 的形式组成(这个冒号后面必须是一个空格):如
---
# 一位职工的记录
name: Example Developer
job: Developer
skill: Elite

#字典也可以写成一行，但要用大括号{}把它括起来
---
# 一位职工的记录
{name: Example Developer, job: Developer, skill: Elite}

3.使用ansible批量安装apache服务

(1) 环境

表1 环境

192.168.204.199	ansible
192.168.204.69	客户端	webservers
192.168.204.186	客户端	dbservers

（2）配置文件

vim test1.yaml
---     #yaml文件以---开头，以表明这是一个yaml文件，可省略
- name: first play     #定义一个play的名称，可省略
  gather_facts: false    #设置不进行facts信息收集，这可以加快执行速度，可省略
  hosts: dbservers    #指定要执行任务的被管理主机组，如多个主机组用冒号分隔
  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: 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，从而避免多次重启。

运行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开始运行

4.定义、引用变量

vim test2.yaml

- 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    #在setup模块中可以获取facts变量信息

在命令行里定义变量


ansible-playbook test2.yaml -e "username=nginx"

dbservers验证

[root@mysql01 home]# cat /etc/passwd | grep nginx
nginx:x:306:306:Nginx web server:/var/lib/nginx:/sbin/nologin

5.指定远程主机sudo切换用户

---
- hosts: dbservers
  remote_user: gzia          
  become: yes	                 #2.6版本以后的参数，之前是sudo，意思为切换用户运行
  become_user: root              #指定sudo用户为root
执行playbook时：ansible-playbook test1.yml -K <密码>

6.when条件判断

在Ansible中，提供的唯一一个通用的条件判断是when指令，当when指令的值为true时，则该任务执行，否则不执行该任务。

when一个比较常见的应用场景是实现跳过某个主机不执行任务或者只有满足条件的主机执行任务

vim test3.yaml
---
- hosts: all
  remote_user: root
  tasks:
   - name: shutdown host 
     command: /sbin/shutdown -r now
     when: ansible_default_ipv4.address == "192.168.204.186"      #when指令中的变量名不需要手动加上 {{}}
或 
     when: inventory_hostname == "<主机名>"

运行playbook

ansible-playbook test3.yaml

dbservers查看

[root@mysql01 ~]# cat /etc/passwd
……
test1:x:1001:1001::/home/test1:/bin/bash
test2:x:1002:1002::/home/test2:/bin/bash

7.迭代

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

vim test4.yaml
---
- name: play1
  hosts: dbservers
  gather_facts: false
  tasks: 
    - name: create directories
      file:
        path: "{{item}}"
        state: directory
      with_items:          #等同于 loop:
        - /tmp/test1
        - /tmp/test2
    - name: add users
      user: name={{item.name}} state=present groups={{item.groups}}
      with_items:
        - name: test1
          groups: wheel
        - name: test2
          groups: root
或
      with_items:
        - {name:'test1', groups:'wheel'}
        - {name:'test2', groups:'root'}

运行playbook

ansible-playbook test4.yaml

8.Templates 模块

Jinja是基于Python的模板引擎。Template类是Jinja的一个重要组件，可以看作是一个编译过的模板文件，用来产生目标文本，传递Python的变量给模板去替换模板中的标记。

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

 cp /opt/httpd.conf /opt/httpd.conf.j2

修改配置文件

vim /opt/httpd.conf.j2
Listen {{http_port}}				#42行，修改
ServerName {{server_name}}			#95行，修改
DocumentRoot "{{root_dir}}"         #119行，修改
<Directory "{{root_dir}}">          #131修改 配置目录访问权限

(2)修改主机清单文件，使用主机变量定义一个变量名相同，而值不同的变量

vim /etc/ansible/hosts       
[webservers]
192.168.111.176 http_port=192.168.111.176:80 server_name=www.accp.com:80 root_dir=/etc/httpd/htdocs
 
[dbservers]
192.168.111.177 http_port=192.168.111.177:80 server_name=www.benet.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

制作测试网页

#创建目录
mkdir -p /etc/httpd/htdocs
touch /etc/httpd/htdocs/index.html


#制作网页测试文件
ansible 192.168.204.69 -m shell -a "echo 'this is mao' > /etc/httpd/htdocs/index.html"   

 
ansible 192.168.204.186 -m shell -a "echo 'this is david' > /etc/httpd/htdocs/index.html"

#登录访问查看
curl http://192.168.204.69
curl http://192.168.204.186

运行playbook

ansible-playbook apache.yaml

访问

http://192.168.204.69

http://192.168.204.186

9.tags 模块

可以在一个playbook中为某个或某些任务定义“标签”，在执行此playbook时通过ansible-playbook命令使用--tags选项能实现仅运行指定的tasks。

playbook还提供了一个特殊的tags为always。作用就是当使用always当tags的task时，无论执行哪一个tags时，定义有always的tags都会执行。

vim webhosts.yaml
---
- hosts: webservers
  remote_user: root
  tasks:
    - name: Copy hosts file
      copy: src=/etc/hosts dest=/opt/hosts
      tags:
      - only     #可自定义
    - name: touch file
      file: path=/opt/testhost state=touch
	  tags:
	  - always    #表示始终要运行的代码
 
 
 
ansible-playbook webhosts.yaml --tags="only"

vim dbhosts.yaml
---
- hosts: dbservers
  remote_user: root
  tasks:
    - name: Copy hosts file
      copy: src=/etc/hosts dest=/opt/hosts
      tags:
        - only
    - name: touch file
      file: path=/opt/testhost state=touch
 
 
ansible-playbook dbhosts.yaml --tags="only"

分别去两台被管理主机上去查看文件创建情况

10.Roles 模块

Ansible为了层次化、结构化地组织Playbook，使用了角色（roles），roles可以根据层次型结构自动装载变量文件、task以及handlers等。简单来讲，roles就是通过分别将变量、文件、任务、模块及处理器放置于单独的目录中，并可以便捷地include它们。roles一般用于基于主机构建服务的场景中，但也可以用于构建守护进程等场景中。

//roles 的目录结构：
cd /etc/ansible/
tree roles/
roles/
├── web/
│   ├── 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

二、实验

1.使用ansible批量安装apache服务

(1) 准备一个httpd的配置文件

（2）编写playbook

执行程序

查看客户端服务

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

检查tasks任务

检查生效的主机

指定从某个task开始运行

2.定义、引用变量

（1）编写playbook

（2）在命令行里定义变量

dbservers验证成功

3.指定远程主机sudo切换用户

4.when条件判断

（1）编写playbook

（2）执行

可以看到192.168.204.186服务器重启，192.168.204.69则跳过重启操作

5.迭代

（1）编写playbook

（2）执行playbook

(3) dbservers查看

6.Templates 模块

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

修改配置文件

(2)修改主机清单文件，使用主机变量定义一个变量名相同，而值不同的变量

(3)编写 playbook

（4）创建目录及文件

（5）制作测试网页

（6）执行playbook

（7）测试

（8）访问

7.tags 模块

（1）编写 playbook

（2）编写第二个playbook

（3）执行playbook

(4) 分别去两台被管理主机上去查看文件创建情况

已新增hosts和testhost文件

8.Roles 模块

(1)查看roles 的目录结构

① 创建以 roles 命名的目录


mkdir /etc/ansible/roles/ -p    #yum装完默认就有

②创建全局变量目录（可选）

③在 roles 目录中分别创建以各角色名称命令的目录，如 httpd、mysql

④在每个角色命令的目录中分别创建files、handlers、tasks、templates、meta、defaults和vars目录，用不到的目录可以创建为空目录，也可以不创建

⑤在每个角色的 handlers、tasks、meta、defaults、vars 目录下创建 main.yml 文件，千万不能自定义文件名

⑥ 修改 site.yml 文件，针对不同主机去调用不同的角色

⑦ 运行 ansible-playbook

三、问题

1.play剧本执行报错语法错误

（1）错误

（2）原因分析

出现未识别的语句

（3）修改配置文件

修改前：

修改后：

2.play剧本执行报错未挂载

(1)报错执行

(2)原因分析

客户端没有挂载光盘

（3）解决方法

方法一：可以在脚本里添加以下代码

- name: check mount
  shell: df - h | grep /dev/sr0 || mount /dev/sr0 /mnt

方法二：到服务器挂在本地磁盘

mount /dev/cdrom /mnt

3.play剧本执行报错 SELinux is disabled

（1）报错

（2）原因分析

setenforce: SELinux is disabled、

说明selinux已经被彻底的关闭了

（3）解决方法

1.剧本报错，90%问题在于语法有问题，检查一下
[root@ansible opt]# ansible-playbook test1.yml --syntax-check

playbook: test1.yml		'//语法正确。pass'

2.看一下报错原因，因为返回值非0，表示执行不成功
  可能是因为我之前都是默认改了selinux配置文件为disabled的原因

3.修改完配置文件，恢复为默认项了
[root@localhost ~]# vim /etc/selinux/config 
#SELINUX=disabled
SELINUX=enforing
'//保存退出后，仍不能执行成功，'
'//systemctl daemon-reload使配置文件修改生效也不行'

4.只能使用重启了
reboot
...
...

5.再来测试一把
[root@ansible ansible]# ansible-playbook /opt/test1.yaml

PLAY [first play] ***************************************************************************************************************************

TASK [test connection] **********************************************************************************************************************
ok: [192.168.204.186]

TASK [disable selinux] **********************************************************************************************************************
changed: [192.168.204.186]

TASK [disable firewalld] ********************************************************************************************************************
ok: [192.168.204.186]

TASK [install httpd] ************************************************************************************************************************
ok: [192.168.204.186]

TASK [install configuration file for httpd] *************************************************************************************************
changed: [192.168.204.186]

TASK [start httpd service] ******************************************************************************************************************
changed: [192.168.204.186]

RUNNING HANDLER [restart httpd] *************************************************************************************************************
changed: [192.168.204.186]

PLAY RECAP **********************************************************************************************************************************
192.168.204.186            : ok=7    changed=4    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

必须重启linux，不重启是没办法立刻开启selinux的关闭

1 命令查看出selinux的状态 
sestatus -v 
2 临时关闭 selinux 
setenforce 0 
3 永久关闭selinux 
vim /etc/sysconfig/selinux 
把里边的一行改为 
SELINUX=disabled

setenforce 1 设置SELinux 成为enforcing模式 
setenforce 0 设置SELinux 成为permissive模式 
如果要彻底禁用SELinux 需要在/etc/sysconfig/selinux中设置参数selinux=0

成功

4.play剧本执行报错UID已存在

(1) 报错

（2）原因分析

UID 306已存在

（3）解决方法

userdel 删除用户
默认删除：不删除家目录里面的数据

删除test用户：[root@mysql01 ~]# userdel test01

userdel：userdel：组“test01”没有移除，因为它不是用户 test01 的主组

提示：当前sa是test的主组，test组提示没有删除。
删除test组：[root@mysql01 ~]# groupdel test01

检查家目录看看是否删除（没有删除）
[root@mysql01 ~]# ls /home/
ee  li  madou  oldboy  op  test  test01  test0

[root@mysql01 ~]# id test01

检查用户是否被删除了（删除了）
id: test01: no such user 


-r  连带用户家目录一起删除

带-r删除用户同时会删除家目录及里面内容（慎用）

[root@mysql01 ~]# userdel -r  test01

生产经验，一般采取注释方法(此法是伪删除，其实并没有删除):
[root@mysql01 ~]# vim /etc/passwd
[root@mysql01 ~]# grep -w test02 /etc/passwd
#test02:x:1112:1111::/home/test02:/bin/bash
[root@oldboyedu ~]# id test02
id: test02: no such user

禁止使用删除的命令：

 1）rm不要直接用，可以用find+xargs+rm删除，删除前要先备份（太大可异地备份）。
    或用mv移动到回收站替换rm。
 2）尽量不要卸载软件，可以用rpm -e删除，禁止使用yum remove 软件名方式删除。
 3）尽量不要删除用户，可创建和删除【用户组】以vim /etc/passwd进入后注释对应的用户行替代使用userdel删除。。

5. play剧本执行报错路径不存在

（1）报错

路径不存在

缺少测试网页

（2）原因分析

路径不存在，调用模块未对其

（3）解决方法

修改前：

修改后：

创建路径及网页

写入内容到测试网页

6. play剧本执行报错

(1)play剧本执行完apache页面未跳转

（2）原因分析

配置文件错误

（3）解决方法

修改第131行

成功

四、总结

playbook是由一个或多个模块组成的，使用多个不同的模块，完成一件事情。需要熟练掌握ansible中各个模块对应的功能以及YAML的语法规则。
缩进: YAML使用一个固定的缩进风格表示层级结构,每个缩进由两个空格组成, 不能使用tabs;
冒号: 以冒号结尾的除外，其他所有冒号后面所有必须有空格;
短横线: 表示列表项，使用一个短横杠加一个空格。多个项使用同样的缩进级别作为同一列表;

playbook-->一个或多个play组成-->play内容称为任务tasks-->一个tasks就是一次ansible 模块的调用。

command模块和shell模块无需使用key=value格式

使用 module: options 格式来定义任务，option使用key=value格式

with_items 等同于 loop

运行playbook：

#运行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开始运行

playbook剧本：

vim  XXX.yaml
- name:                      #指定play名称
  hosts:                     #指定主机组
  remote_user:               #执行用户 
  gather_facts: true|false   #是否收集远程主机facts信息
  vars:                      #定义变量
  tasks:                     #定义task任务列表
  - name:                 #定义task任务名称
    模块:                 #定义任务使用的模块和参数
    with_items:           #定义循环列表
    when:                 #定义判断条件（== != >= > <= <），true则执行任务，否则不执行任务
	ignore_errors: true   #忽略任务失败
    notify:               #定义task任务changed状态时触发的任务名
    tags:                 #指定标签，ansible-playbook --tags 仅执行拥有指定 tags 标签的任务（always标签总会执行）
  handlers:                  #定义notify触发的任务列表

task任务模块语法格式：

横向格式：
模块名: 参数选项1=值  参数选项2={{变量名}}  ...

纵向格式：
模块名:
  参数选项1: 值
  参数选项2: "{{变量名}}"
  ...

with_items和变量的语法格式：

横向格式：
with_items: ["值1", "值2", "值3"]

值为对象（键值对字段）时：
with_items:
- {key1: value1, key2: value2, ...}
- {key1: value3, key2: value4, ...}

纵向格式：
with_items:
- 值1
- 值2
- 值3

值为对象（键值对字段）时：
with_items:
- key1: value1
  key2: value2
- key1: value3
  key2: value4

template模板模块：

（1）先要准备一个xxx.j2模板文件，在文件中使用 {{变量名}} 引用主机变量 或者 vars 自定义的变量 及 facts 字段的值
（2）在playbook中的tasks中定义template模板配置  template: src=xxx.j2  dest=xxx

用户和用户组相关的配置文件:
直接相关的有4个文件

/etc/passwd   ##用户的主配置文件，用户的各种属性（UID,GID,家目录，登录SHELL）
/etc/shadow   ##用户密码文件，存放密码及密码的属性（失效时间，修改密码时间等）。

/etc/group    ##组文件，存放用户组及属性。
/etc/gshadow  ##用户组的密码文件（废弃）

和用户相关的命令:

useradd 添加用户
usermod 修改用户
userdel 删除用户
id      查看用户

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)