前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Ansible 2 -- 5 playbook 语法

Ansible 2 -- 5 playbook 语法

作者头像
mafeifan
发布2019-07-22 15:06:50
1.2K0
发布2019-07-22 15:06:50
举报
文章被收录于专栏:finleyMa

playbook

使用 Ansible 时,绝大部分时间将花费在编写playbook上。playbook 英文直译是剧本的意思,是一个Ansible术语,它指的是用于配置管理的脚本。

playbook 是 YAML格式的,yaml格式可以很方便的被转换为json供开发语言使用

顺便推荐一个在线的yaml转json

playbook是一个非常简单的配置管理和多主机部署系统,不同于任何已经存在的模式,可作为一个适合部署复杂应用程序的基础。playbook可以定制配置,可以按指定的操作步骤有序执行,支持同步及异步方式。

playbook是ansible实现批量自动化最重要的手段。在其中可以使用变量、引用、循环等功能,功能比较强大。

一个playbook就是一组play组成的列表

每个play必须包含host和task,play就可以想象为连接到主机(host)上执行任务(task)的事物

host就是inventory中定义的主机

tasks下定义一系列的task任务列表,依次执行,如果执行某任务失败了,后续的任务不会执行

image.png

示例

playbook.yml

代码语言:javascript
复制
---  # yaml文件可以以 --- 开头
  - name: the first demo  # 使用 '-' 减号作为列表项,会被解析为json数组,注意在playbook中name属性不是必须的,表示描述,表示圈定一个范围,范围内的项都属于该列表。
    hosts: cloud  # 每一个playbook中必须包含"hosts"和"tasks"项
    tasks:
      - name: execute date cmd  # 描述这个task
        command: /bin/date # 本质是加载并执行ansible对应的模块

转换为JSON

代码语言:javascript
复制
[ { 
   name: 'the first demo',
    hosts: 'cloud',
    tasks: [ 
       { 
          name: 'execute date cmd', 
          command: '/bin/date' 
       } 
   ] 
} ]

执行前先检查 ansible-playbook playbook.yml --check

有用的flag

--check 对支持check的大部分核心模块,输出真正执行会进行哪些更改 --diff 报告更改,比如操作文件,会告诉用户之前之后发生了哪些变化,由于会产生大量输出,最好在单一主机使用

另外例子

代码语言:javascript
复制
 ---
- hosts: localhost # 列表1
  remote_user: root
  tasks:
    - name: test1 # 子列表,下面是shell模块,是一个动作,所以定义为列表,只不过加了个name
      shell: echo /tmp/a.txt
      register: hi_var
    - debug: var=hi_var.stdout # 调用模块,这是动作,所以也是列表 # 同样是动作,包含文件
    - include: /tmp/nginx.yml
    - include: /tmp/mysql.yml
- copy:   # 调用模块,定义为列表。但模块参数是虚拟性内容,应定义为字典而非列表 
        src: /etc/resolv.conf  # 模块参数1
        dest: /tmp   # 模块参数2
- hosts: 192.168.100.65  # 列表2
  remote_user: root
  vars:
    nginx_port: 80  # 定义变量,是虚拟性的内容,应定义为字典而非列表
    mysql_port: 3306
  vars_files:
    - nginx_port.yml  # 无法写成key/value格式,且是实体文件,因此定义为列表
  tasks:
    - name: test2
      shell: echo /tmp/a.txt
      register: hi_var  # register是和最近一个动作绑定的
    - debug: var=hi_var.stdout

通过 ansible-playbook -h 获取所有参数列表 首先ansible-playbook -C playbook.yml检查语法。这里我故意写错了,在 -name同级添加了 hosts,这是不允许的,所以报错了。Ansible 的错误提示还是很方便的。

image.png

修改后:

image.png

playbook中的配置项

playbook 除了hosts和tasks还有其他配置项:

  • name play的描述,Ansible执行时会打印出来
  • remote_user 指定在远程主机上执行任务的用户
  • vars
  • vars_files

配置 playbook 例子,包含了1个play,3个tasks,1个handlers

notify和handler

ansible中几乎所有的模块都具有幂等性,这意味着被控主机的状态是否发生改变是能被捕捉的,即每个任务的 changed=true或changed=false。ansible在捕捉到changed=true时,可以触发notify组件(如果定义了该组件)。 notify是一个组件,并非一个模块,它可以直接定义action,其主要目的是调用handler。例如:

代码语言:javascript
复制

tasks:
     - name: copy template file to remote host
       template: src=/etc/ansible/nginx.conf.j2 dest=/etc/nginx/nginx.conf
       notify:
         - restart nginx
         - test web page
       copy: src=nginx/index.html.j2 dest=/usr/share/nginx/html/index.html
       notify:
         - restart nginx
 handlers:
     - name: restart nginx
       service: name=nginx state=restarted
     - name: test web page
       shell: curl -I http://192.168.100.10/index.html | grep 200 || /bin/false

这表示当执行template模块的任务时,如果捕捉到changed=true,那么就会触发notify,如果分发的index.html改 变了,那么也重启nginx(当然这是没必要的)。notify下定义了两个待调用的handler。handler主要用于重启服务或者触发系统重启,除此之外很少使用handler。

handler的定义和tasks的定义完全一样,唯一需要限定的是handler中task的name必须和notify中定义的名称相同。

代码语言:javascript
复制

注意,notify是在执行完一个play中所有task后被触发的,在一个play中也只会被触发一次。

意味着如果一个play中有多个task出现了changed=true,它也只会触发一次。例如上面的示例中,向nginx复制配置文件和复制

index.html时如果都发生了改变,都会触发重启nginx操作。但是只会在执行完play后重启一次,以避免多余的重启。

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2019.07.19 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • playbook
  • 示例
  • 有用的flag
  • playbook中的配置项
  • notify和handler
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档