自动化运维工具-Ansible的Playbook的使用

Posted

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了自动化运维工具-Ansible的Playbook的使用相关的知识，希望对你有一定的参考价值。


Playbook的使用

  • ​​前言​​
  • ​​一、Playbook是什么？​​
  • ​​二、playbook使用场景​​
  • ​​三、Playbook格式说明​​
  • ​​四、Play book变量的使用​​
  • ​​1 在主机列表定义变量​​
  • ​​2 在playbook定义变量​​
  • ​​3 命令行参数传递​​
  • ​​五、notifyh和handlers的使用​​
  • ​​示例：触发​​
  • ​​六、Playbook中tags的使用​​
  • ​​七、tepmplates 模板的使用​​
  • ​​jinjia2​​
  • ​​模板安装nginx​​
  • ​​八、条件判断when​​
  • ​​九、迭代with_items​​
  • ​​字符串方式​​
  • ​​字典方式​​
  • ​​十、检测playbook​​
  • ​​参考：​​

前言

往期Ansible目录
​​1、自动化运维工具-Ansible实战指南​​2、自动化运维工具-Ansible的Playbook的使用
3、自动化运维工具-Ansible的Roles的使用
​​4、B站学习链接​​

上一篇说的是Ansible的简单使用，用一些模块来控制远程主机。但是一个一个调用模块也太麻烦了吧，有没有什么办法可以一下调用很多模块让它完成很多任务呢？
这里就用到了Playbook了

一、Playbook是什么？

剧本，就像一些综艺节目的剧本一个意思。按照剧本发展故事情节
在ansible中剧本也是类似的作用，第一步干啥，第二部干啥，第三步干啥…

二、playbook使用场景

可以类比linux中执行shell脚本一样，批量执行命令
ansible中的剧本也是一样，批量处理任务
playbook用的是yaml格式！

三、Playbook格式说明

Hosts：               主机，部署目标
         Tasks：               任务，ansible，执行目的
         Varlables：         变量
         Templates：       包含了模板语法的文本文件；
         Handlers：                   有特定条件触发的任务
         Roles ：              角色  (特别介绍)

以下为playbook常用到的YMAL格式：
　　1、文件的第一行应该以 “—” (三个连字符)开始，表明YMAL文件的开始。
　　2、在同一行中，#之后的内容表示注释，类似于shell，python和ruby。
　　3、YMAL中的列表元素以”-”开头然后紧跟着一个空格，后面为元素内容。
　　4、同一个列表中的元素应该保持相同的缩进。否则会被当做错误处理。
　　5、play中hosts，variables，roles，tasks等对象的表示方法都是键值中间以":“分隔表示，”:"后面还要增加一个空格
　　6、yml文件名以yml结尾或者yaml结尾

示例1：**

---
- hosts: all
  remote_user: root
  
  tasks:
   - name: install a group
     group: name=mygrp system=true 
   - name: install a user
     user: name=user1 group=mygrp system=true
示例2

- hosts: websrvs
  remote_user: root
  
  tasks:
    - name: install httpd package
      yum: name=httpd
    - name: start httpd service 
      service: name=httpd state=started

主要由三个部分组成。

hosts部分：使用hosts指示使用哪个主机或主机组来运行下面的tasks，每个playbook都必须指定hosts，hosts也可以使用通配符格式。主机或主机组在inventory清单中指定，可以使用系统默认的/etc/ansible/hosts，也可以自己编辑，在运行的时候加上-i选项，指定清单的位置即可。在运行清单文件的时候，–list-hosts选项会显示那些主机将会参与执行task的过程中。
remote_user：指定远端主机中的哪个用户来登录远端系统，在远端系统执行task的用户，可以任意指定，也可以使用sudo，但是用户必须要有执行相应task的权限。
tasks：指定远端主机将要执行的一系列动作。tasks的核心为ansible的模块，前面已经提到模块的用法。tasks包含name和要执行的模块，name是可选的，只是为了便于用户阅读，不过还是建议加上去，模块是必须的，同时也要给予模块相应的参数。

四、Play book变量的使用

（1）facts: 可直接调用
（2）ansible-playbook 命令的命令行中的自定义变量
    -e EXTRA_VARS, --extra-vars=EXTRA_VARS  #命令行中定义变量传递至yaml文件。
（3）通过roles传递变量
（4）Host Inventory
（a）向不同的主机传递不同的变量；
    IP/HOSTANME varable=value var2=value2
    在hosts 组ip后添加变量
（b）向组中的主机传递相同的变量
    [group:var]         
    arable=value
注意：Inventory参数：
 用于定义ansible远程连接目标主机时使用的参数，而非传递给playbook的变量。
    ansible_ssh_host   
    ansible_ssh_user
    ansible_ssh_port
    ansible_ssh_pass
    ansible_sudo_pass
        ….
查看远程主机的全部系统信息
ansible all -m setup  #收集到的远程主机的变量

1 在主机列表定义变量

(1)变量的定义示例:         
  变量定义位置 /etc/ansible/hosts
  普通变量
    [web]
    172.16.250.240  http_port=80
    172.16.252.18   http_port=8080  
  组变量
    [web:var1]
    http_port=80
    [web]
    172.16.250.240  
    172.16.252.18    
  在playbook中定义变量的方法
    Vars：
      - var1：value1
      - var2：value2
  命令行指定变量
    nsible-playbook -e  调用

实例：

自动化运维工具-Ansible的Playbook的使用_python


自动化运维工具-Ansible的Playbook的使用_java_02

2 在playbook定义变量

自动化运维工具-Ansible的Playbook的使用_python_03

自动化运维工具-Ansible的Playbook的使用_nginx_04

3 命令行参数传递

[root@ansible ansible]# cat yum.yml 
---
- hosts: wsr
  remote_user: root

  tasks:
  - name: install package
    yum: name= pkname  state=present

自动化运维工具-Ansible的Playbook的使用_devops_05

五、notifyh和handlers的使用

Ansible提供了notify指令和handlers功能。如果在某个task中定义了notify指令，当Ansible在监控到该任务 changed=1时，会触发该notify指令所定义的handler，然后去执行handler。所谓handler，其实就是task，无论在写法上还是作用上它和task都没有区别，唯一的区别在于hander是被触发而被动执行的，不像普通task一样会按流程正常执行。

示例：触发

[root@ansible ansible]# cat apache.yml 
---
- hosts: wsr
  remote_user: root
  tasks:
  - name: install pk
    yum: name=httpd
  - name: copy file
    copy: src=file/httpd.conf dest=/etc/httpd/conf/ #只要src文件内容发生改变，就会触发handlers也就是重启服务
    notify: 
      - restart httpd
  - name: start httpd service
    service: name=httpd state=started enabled=yes
  handlers:
   - name: restart httpd
     service: name=httpd state=restarted

处理器是根据对应Task的返回状态来进行判断的。当Task(任务)状态为changed时，处理器就会执行你写好的handlers(处理器)操作。

利用notify、handlers触发式重启服务。

[root@ansible ansible]# ansible-playbook apache.yml 

PLAY [wsr] *****************************************************************************

TASK [Gathering Facts] *****************************************************************
ok: [192.168.100.20]
ok: [192.168.100.10]

TASK [install pk] **********************************************************************
ok: [192.168.100.20]
ok: [192.168.100.10]

TASK [copy file] ***********************************************************************
changed: [192.168.100.20]
changed: [192.168.100.10]

TASK [start httpd service] *************************************************************
ok: [192.168.100.20]
ok: [192.168.100.10]

RUNNING HANDLER [restart httpd] ********************************************************
changed: [192.168.100.20]
changed: [192.168.100.10]

PLAY RECAP *****************************************************************************
192.168.100.10             : ok=5    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
192.168.100.20             : ok=5    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

六、Playbook中tags的使用

tags即标签，tags可以和一个play（就是很多个task）或者一个task进行捆绑。然后再执行play book时只需指定相应的tags即可仅执行与tags绑定的task。

[root@centos7_1yaml]# vim web-3.yml
---
- hosts: web
 remote_user: root
 tasks:
 - name: install httpd package
   yum: name=httpd state=present
 - name: install configure file
   copy: src=/apps/work/files/httpd.conf dest=/etc/httpd/conf/
   tags: instconf              #tags
 - name: start httpd service
   service: name=httpd state=started
[root@centos7_1 yaml]# ansible-playbook -tinstconf  web-3.yml 

#指定tags instconf 执行。
ansible-playbookweb-3.yml --tags=" instconf "  
执行此命令同样仅执行instconf 标签内容。

七、tepmplates 模板的使用

jinjia2

Jinja2是基于python的模板引擎，功能比较类似于php的smarty，J2ee的Freemarker和velocity。它能完全支持

unicode，并具有集成的沙箱执行环境，应用广泛。

Jinja2 语言： 字面量：
字符串：使用单引号或双引号；
数字：整数，浮点数
列表：[item1,item2 ……]
元组：(item1item2…,)va
字典：key1：value，key2：value….
布尔型： true/filase
算数运算：
+,- , * , / , // , % **
比较操作：
==， != , >= ,<=
逻辑运算：
and，or， not，
流表达式
For、IF、when

模板安装nginx

在本机安装nginx服务，拷贝模板到本地，进行修改并命名为nginx.conf.j2

[root@ansible ansible]# cp /etc/nginx/nginx.conf ./


[root@ansible ansible]# head nginx.conf 
# For more information on configuration, see:
#   * Official English Documentation: http://nginx.org/en/docs/
#   * Official Russian Documentation: http://nginx.org/ru/docs/

user nginx;
worker_processes  ansible_processor_vcpus ;
error_log /var/log/nginx/error.log;
pid /run/nginx.pid;

# Load dynamic modules. See /usr/share/doc/nginx/README.dynamic.
.........................
..................
......

[root@ansible templates]# ll
total 4
-rw-r--r--. 1 root root 2361 Jul 11 03:42 nginx.conf.j2
[root@ansible ansible]# cat nginx.yml 
---
- hosts: wsr
  remote_user: root

  tasks:
  - name: install nginx
    yum: name=nginx
  - name: create nginx user
    user: name=nginx shell=/sbin/nologin
  - name: copy cfg
    template: src=templates/nginx.conf.j2 dest=/etc/nginx/nginx.conf
    notify: restart nginx
  - name: start service nginx
    service: name=nginx state=started
  handlers:
  - name: restart nginx
    service: name=nginx state=restarted
[root@ansible ansible]# ansible-playbook nginx.yml 

PLAY [wsr] ******************************************************************************************

TASK [Gathering Facts] ******************************************************************************
ok: [192.168.100.20]
ok: [192.168.100.10]

TASK [install nginx] ********************************************************************************
ok: [192.168.100.10]
ok: [192.168.100.20]

TASK [create nginx user] ****************************************************************************
changed: [192.168.100.20]
changed: [192.168.100.10]

TASK [copy cfg] *************************************************************************************
ok: [192.168.100.20]
ok: [192.168.100.10]

TASK [start service nginx] **************************************************************************
changed: [192.168.100.10]
changed: [192.168.100.20]

PLAY RECAP ******************************************************************************************
192.168.100.10             : ok=5    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
192.168.100.20             : ok=5    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

因为我两台远程主机都是2个vcpu，所以显示的都是2。

自动化运维工具-Ansible的Playbook的使用_java_06

如果启动nginx 的时候报错，可以创建nginx用户即可解决

八、条件判断when

when 语句：在task中使用。Jinja2的语法格式

tasks：
- name: install conf file to Centos7
  template:src=files/nginxconf.c7.j2 dest=/etc/nginx/nginx.conf
when: ansible_distribution_major_version==”7”
- name: install conf file to Centos6
  template:src=files/nginxconf.c6.j2 dest=/etc/nginx/nginx.conf
  when:ansible_distribution_major_version ==”6”

以上语法表示若查询远程主机系统为centos6则执行，install conf file to Centos6。
若为cenos7则执行install conf file to Centos7。

九、迭代with_items

循环迭代，需要重复执行的任务；对迭代项引用，固定变量名为item，而后在task中使用with_items给定迭代的元素列表；

示例1：

字符串方式

- name： install some package
  yum：name= item   state=present
  with_items:
    - nginx
    - memecached
    - php-fpm

字典方式

- name: add  some groups
      group: name= item  
      with_items:
        - group1
        - group2
        - group3
     - name: add some user
       user: name= item.name  group=item.group
       with_items:
         - name: user1,group: group1
         - name: user2,group: group2
         - name: user3,group: group3

自动化运维工具-Ansible的Playbook的使用_devops_07


自动化运维工具-Ansible的Playbook的使用_python_08

十、检测playbook

运行playbook，使用ansible-playbook命令

(1) 检测语法

ansible-playbook --syntax-check /path/to/playbook.yaml
(2) 测试运行
ansible-playbook -C /path/to/playbook.yaml
–list-hosts # 列出主机
–list-tasks # 列出任务
–list-tags # 列出标签

(3) 运行

ansible-playbook /path/to/playbook.yaml
-t TAGS, --tags=TAGS
–skip-tags=SKIP_TAGS
–start-at-task=START_AT
在执行playbook前，可以做些检查

检查palybook语法

ansible-playbook -i hosts httpd.yml --syntax-check
列出要执行的主机

ansible-playbook -i hosts httpd.yml --list-hosts
列出要执行的任务

ansible-playbook -i hosts httpd.yml --list-tasks

参考：



​​https://www.bilibili.com/video/BV1HZ4y1p7Bf?from=search&seid=18094357415317710924​​


以上是关于自动化运维工具-Ansible的Playbook的使用的主要内容，如果未能解决你的问题，请参考以下文章

自动化运维工具-Ansible的Playbook的使用

自动化运维工具ansible Playbook介绍

自动化运维工具Ansible实战playbook使用

运维自动化工具 Ansible-playbook

自动化运维工具Ansible实战playbook

自动化运维工具 Ansible ——playbook 剧本详解及简易案例