Ansible playbook的block

最新推荐文章于 2024-05-15 17:46:19 发布
最新推荐文章于 2024-05-15 17:46:19 发布
阅读量546 收藏
点赞数
分类专栏： Ansible 文章标签： ansible
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/duke_ding2/article/details/134047516
版权

环境

  • 控制节点：Ubuntu 22.04
  • Ansible 2.10.8
  • 管理节点：CentOS 8

block

顾名思义，通过block可以把task按逻辑划分到不同的“块”里面，实现“块操作”。此外，block还提供了错误处理功能。

task分组

下面的例子，把3个task放到一个block里面。

创建文件 testBlock1.yml 如下：

---
- name: testBlock1
  hosts: all
  tasks:
  - name: My task 1
    block:
    - name: Part1
      debug:
        msg: "Hello Zhang San"

    - name: Part2
      debug:
        msg: "Hello Li Si"

    - name: Part3
      debug:
        msg: "Hello Wang Wu"
    when: 2 > 1

运行结果如下：

➜  temp ansible-playbook testBlock1.yml

PLAY [testBlock1] **********************************************************************************

TASK [Gathering Facts] *****************************************************************************
ok: [192.168.1.55]

TASK [Part1] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "Hello Zhang San"
}

TASK [Part2] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "Hello Li Si"
}

TASK [Part3] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "Hello Wang Wu"
}

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

如果把block的判断条件 when: 2 > 1 改为 when: 2 == 1 ，则运行结果如下：

➜  temp ansible-playbook testBlock1.yml

PLAY [testBlock1] **********************************************************************************

TASK [Gathering Facts] *****************************************************************************
ok: [192.168.1.55]

TASK [Part1] ***************************************************************************************
skipping: [192.168.1.55]

TASK [Part2] ***************************************************************************************
skipping: [192.168.1.55]

TASK [Part3] ***************************************************************************************
skipping: [192.168.1.55]

PLAY RECAP *****************************************************************************************
192.168.1.55               : ok=1    changed=0    unreachable=0    failed=0    skipped=3    rescued=0    ignored=0

可见，由于条件不满足，block里的3个task都没有执行。

错误处理

如果block里的某个task出错了，则后面的task不再运行。

创建文件 testBlock2.yml 如下：

---
- name: testBlock2
  hosts: all
  tasks:
  - name: My task 1
    block:
    - name: Part1
      debug:
        msg: "Hello Zhang San"

    - name: Part2
      command: /bin/false # will trigger an error

    - name: Part3
      debug:
        msg: "Hello Li Si"

运行结果如下：

➜  temp ansible-playbook testBlock2.yml

PLAY [testBlock2] **********************************************************************************

TASK [Gathering Facts] *****************************************************************************
ok: [192.168.1.55]

TASK [Part1] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "Hello Zhang San"
}

TASK [Part2] ***************************************************************************************
fatal: [192.168.1.55]: FAILED! => {"changed": true, "cmd": ["/bin/false"], "delta": "0:00:00.001904", "end": "2023-10-26 08:50:36.850526", "msg": "non-zero return code", "rc": 1, "start": "2023-10-26 08:50:36.848622", "stderr": "", "stderr_lines": [], "stdout": "", "stdout_lines": []}

PLAY RECAP *****************************************************************************************
192.168.1.55               : ok=2    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0

可见，由于Part2出错，Part3并没有运行。

Ansible的错误处理有两个关键字：

  • rescue ：类似于 catch
  • always ：类似于 finally

先加上 always 看看效果：

---
- name: testBlock2
  hosts: all
  tasks:
  - name: My task 1
    block:
    - name: Part1
      debug:
        msg: "Hello Zhang San"

    - name: Part2
      command: /bin/false # will trigger an error

    - name: Part3
      debug:
        msg: "Hello Li Si"
    always:
    - name: Always do this
      debug:
        msg: "End End End"

➜  temp ansible-playbook testBlock2.yml

PLAY [testBlock2] **********************************************************************************

TASK [Gathering Facts] *****************************************************************************
ok: [192.168.1.55]

TASK [Part1] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "Hello Zhang San"
}

TASK [Part2] ***************************************************************************************
fatal: [192.168.1.55]: FAILED! => {"changed": true, "cmd": ["/bin/false"], "delta": "0:00:00.002734", "end": "2023-10-26 08:52:19.329781", "msg": "non-zero return code", "rc": 1, "start": "2023-10-26 08:52:19.327047", "stderr": "", "stderr_lines": [], "stdout": "", "stdout_lines": []}

TASK [Always do this] ******************************************************************************
ok: [192.168.1.55] => {
    "msg": "End End End"
}

PLAY RECAP *****************************************************************************************
192.168.1.55               : ok=3    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0

可见，Part2出错， always 也会运行（当然，Part3不会运行）。

注意：加上 always ，failed仍然是1。

现在来试一下 rescue ：

---
- name: testBlock2
  hosts: all
  tasks:
  - name: My task 1
    block:
    - name: Part1
      debug:
        msg: "Hello Zhang San"

    - name: Part2
      command: /bin/false # will trigger an error

    - name: Part3
      debug:
        msg: "Hello Li Si"
    always:
    - name: Always do this
      debug:
        msg: "End End End"
    rescue:
    - name: Rescue tasks
      debug:
        msg: "Something is wrong!"

运行结果如下：

➜  temp ansible-playbook testBlock2.yml

PLAY [testBlock2] **********************************************************************************

TASK [Gathering Facts] *****************************************************************************
ok: [192.168.1.55]

TASK [Part1] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "Hello Zhang San"
}

TASK [Part2] ***************************************************************************************
fatal: [192.168.1.55]: FAILED! => {"changed": true, "cmd": ["/bin/false"], "delta": "0:00:00.001726", "end": "2023-10-26 09:00:01.785445", "msg": "non-zero return code", "rc": 1, "start": "2023-10-26 09:00:01.783719", "stderr": "", "stderr_lines": [], "stdout": "", "stdout_lines": []}

TASK [Rescue tasks] ********************************************************************************
ok: [192.168.1.55] => {
    "msg": "Something is wrong!"
}

TASK [Always do this] ******************************************************************************
ok: [192.168.1.55] => {
    "msg": "End End End"
}

PLAY RECAP *****************************************************************************************
192.168.1.55               : ok=4    changed=0    unreachable=0    failed=0    skipped=0    rescued=1    ignored=0

注意，always是在rescue之后运行的（Part3仍然不会运行）。

注：如果task没有出错， rescue 不会被触发。

rescue与handler

我们知道，当task运行成功，状态改变时，可以用 notify 来触发handler。但如果后续的task出错了，则当前task的handler并不会触发。如果有 rescue ，则handler仍然会被触发（在 always 之后）。在 rescue 中可以通过 meta: flush_handlers 来立即触发handler（在 always 之前）。

---
- name: testBlock2
  hosts: all
  tasks:
  - name: My task 1
    block:
    - name: Part1
      debug:
        msg: "Hello Zhang San"
      changed_when: true
      notify: Run me even after an error

    - name: Part2
      command: /bin/false # will trigger an error

    - name: Part3
      debug:
        msg: "Hello Li Si"
    always:
    - name: Always do this
      debug:
        msg: "End End End"
    rescue:
    - name: Rescue tasks
      #debug:
      #  msg: "Something is wrong!"
      meta: flush_handlers
  handlers:
  - name: Run me even after an error
    debug:
      msg: 'This handler runs even on error'

运行结果如下：

➜  temp ansible-playbook testBlock2.yml

PLAY [testBlock2] **********************************************************************************

TASK [Gathering Facts] *****************************************************************************
ok: [192.168.1.55]

TASK [Part1] ***************************************************************************************
changed: [192.168.1.55] => {
    "msg": "Hello Zhang San"
}

TASK [Part2] ***************************************************************************************
fatal: [192.168.1.55]: FAILED! => {"changed": true, "cmd": ["/bin/false"], "delta": "0:00:00.002172", "end": "2023-10-26 09:11:26.530609", "msg": "non-zero return code", "rc": 1, "start": "2023-10-26 09:11:26.528437", "stderr": "", "stderr_lines": [], "stdout": "", "stdout_lines": []}

RUNNING HANDLER [Run me even after an error] *******************************************************
ok: [192.168.1.55] => {
    "msg": "This handler runs even on error"
}

TASK [Always do this] ******************************************************************************
ok: [192.168.1.55] => {
    "msg": "End End End"
}

PLAY RECAP *****************************************************************************************
192.168.1.55               : ok=4    changed=1    unreachable=0    failed=0    skipped=0    rescued=1    ignored=0

本例中，Part1运行成功，且改变了状态，所以触发了handler Run me even after an error 。但由于Part2出错，如果没有 rescue ，则Part1的handler不会触发。加上 rescue 之后，就会触发Part1的handler。本例中加上了 meta: flush_handlers ，所以会立即触发handler。

参考

  • https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_blocks.html
蓝黑2020
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
openssh升级ansible-playbook
12-25
openssh升级ansible-playbook
Ansible Playbook的定义
01-07
Ansible的Playbook使用YAML编写，YAML的语法规则如下： YAML文件中的第一行为“—”，表示这是一个YAML文件； YAML中的字段大小写敏感； YAML与Python一样，使用缩进表示层级关系； YAML的缩进不允许使用Tab键，只允许使用空格，且空格的数目不重要，只要相同层级的元素左侧对齐即可； “#”表示注释，从这个字符一直到行尾都会被解析器忽略。   YAML支持三种格式的数据，分别是： 对象：键值对的集合，又称为映射，类似于Python中的字典； 数组：一组按次序排列的值，又称为序列（sequence），类似于Python中的列表； 纯量（scalar
Ansible playbook中 block用法
疯飙的蜗牛
09-18 454
就是一组逻辑的tasks。使用block可以将多个任务合并为一个组。还可以做错误处理，即当任务发生错误后，执行rescue任务。# always：block和rescue里的tasks无论是否运行成功，都会运行always里的tasks。# rescue：block里的tasks,如果运行失败,才会运行rescue里的tasks。# block：block里的tasks,如果运行正确,则不会运行rescue；
Ansible Playbook中的条件控制
果冻想
06-16 391
Ansible是一个系列文章，我会尽量以通俗易懂、诙谐幽默的总结方式给大家呈现这些枯燥的知识点，让学习变的有趣一些。 Ansible系列博文直达链接：Ansible入门系列 前言 Ansible一直都在进化的路上，他一直都在让自己变的更强大，所以，没有逻辑控制的绝对是Low的。对于Ansible来说，如果没有逻辑控制的功能，是不完美的。逻辑控制功能对于我们日常使用Ansible来说，也是一个很大的功能，在Ansible的Playbook中主要是以下三种逻辑控制： when：条件判断语句，类似于编程语言.
Ansible Playbook中Block块
果冻想
10-28 1550
前言在Ansible中，可以将多个action组装成一个块，然后根据不同条件执行这个块，这就好比我们日常编程中的多个语句组成一个函数一样，方便我们对代码的管理。由于这部分内容很少，这里直...
Ansible（5）——Playbook中loop、when 、block、循环、判断语句的用法、roles编写、导入和包含task等
dghfttgv的博客
03-12 3919
本实验是基于前篇《Ansible（4）—— Playbook语法之变量的类型》实验环境下进行的，其中普通用户devops已经创建好，授权、免密都配置好了。在编辑好playbook.yml下进行的 上一实验的博客链接：https://blog.csdn.net/dghfttgv/article/details/104808636 目录 一、playbook中一些常用语句块的用法 （一）、ign...
《Ansible Playbook扩展：block块》
东城绝神
03-09 649
《Ansible模块篇：block块功能详解》
[Ansible系列]ansible playbook的条件语句
qq_43714097的博客
01-09 1414
在写playbook时，有时候playbook的结果依赖于变量，fact或者前一个任务执行的结果，或者有的时候我们会基于上一个task执行返回的结果而决定如何执行后续的task，这个时候我们就需要用到条件语句，而在ansible-playbook中条件语句的关键字就是when。条件语句在Ansible中使用场景：· 在目标主机上定义一个硬限制，比如目标主机的最小内存必须达到多少，再能执行该task；· 捕获一个命令的输出，根据命令的输出结果的不同来触发不同的task；
ansible playbook 中的条件判断与block
qq_36417677的博客
04-06 891
前文中，我们使用"when"关键字对条件进行判断，如果条件成立，则执行对应的任务，但是，我们可以发现，当条件成立时，我们只能执行一个任务，如果我们想要在条件成立时，执行三个任务，该怎么办呢？难道我们要在这三个任务的每个任务中都加入相同的条件判断么？这种方法也太麻烦了，显然应该有更好的方法，没错，我们可以借助"block"解决这个小问题。 在ansible中，可以使用"block"关键字将多个任务整...
ansible中的block的用法
weixin_45138731的博客
07-06 7750
在说block用法之前，先说一下ansible的yaml文件中判断的使用，符合when的条件的时候，执行，不满足条件就不执行，例如： - name: when用法举例 hosts: all tasks: - name: 修改文件权限 file: src=/root/test.txt.j2 dest=/opt/test.txt mode=0644 when: '$USER=root' 再来看block的例子： - name: block的用法 hosts: no
Ansible PlayBook Supervisor
11-04
Ansible PlayBook Supervisor
Ansible PlayBook Nginx
11-04
Ansible PlayBook Nginx
ansible-playbooks:ansible playbook 的例子
06-19
ansible-剧本警告！ 此存储库已弃用，如果您想了解如何创建可重用和奇特的角色，请访问 一种简单快捷的开发环境部署方式。 测试： Ubuntu 10.04 x32/64（损坏的 postgresql 和 php5-fpm 池） Ubuntu 12.04 x32/64 - ...
Ansible任务控制loop循环、when和block条件判断介绍演示
树下一少年的博客
10-25 1208
--tasks:debug:loop:- 'a'- 'b'- 'c'"msg": "a""msg": "b""msg": "c"---tasks:debug:循环输出hello和nihao---tasks:debug:loop:"msg": {"msg": {循环创建user1和user2---tasks:user:loop:uid: 1011uid: 1012---tasks:debug:​---tasks:debug:​---
ansible-playbook之block
weixin_33974433的博客
11-22 569
Ansible在2.0版本引入块功能，块功能可以将任务进行分组，并且可以块级别上应用任务变量，同时支持在块内进行异常处理 常用语法： - block:定义块 rescue:当出现异常时，执行的语句 always:无论结果如何都要执行的语句 块用法示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
ansible-playbook中的block模块，如果中途失败了，怎样退出整个playbook
jiangbb8686的博客
07-27 454
在Ansible中，如果使用了block模块，并且希望在其中的任务失败时退出整个playbook，可以通过设置block模块的属性`rescue`为`yes`来实现。在上述示例中，如果"Task 2"失败，则会执行"Rescue task"，并且整个playbook会退出。如果"Task 2"成功，则会继续执行后续的任务。注意：block模块中的任务失败后，不会抛出异常，因此可以使用`rescue`属性来捕获失败并执行相应的任务。
一篇文章搞清楚ansible的任务块，loop循环和sudo命令
m0_52508197的博客
09-24 318
一篇文章搞清楚ansible的任务块和loop循环
Ansible_03_高级playbook
爱喝可乐的w
04-21 285
Ansible用于实现复杂任务的方式
5.3_Ansible中的playbook
最新发布
weixin_46927961的博客
05-15 363
（5）YAML的字典 两种写法等价 ##5.vim 设定技巧##
Ansible playbook wordpress文件迁移
05-24
以下是使用 Ansible playbook 迁移 WordPress 文件的基本步骤： 1. 在目标服务器上安装 WordPress：使用 Ansible playbook 在目标服务器上安装 WordPress，包括 Apache、PHP、MySQL 和 WordPress 本身。 2. 在源...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值