0Pricing
Ansible Academy · 课时

使用 fail 模块进行自定义断言

通过清晰的消息停止 Play

使用 fail 模块进行自定义断言 是 CoddyKit 上的免费 Ansible Academy 课时。 这是第 4 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Ansible Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Ansible Academy 课程共包含 4 节课。

用清晰的消息停止执行

有时您会希望有意停止剧本,并说明有帮助的原因。fail 模块正是为此设计的。🛑

fail 模块

ansible.builtin.fail 会用您编写的自定义消息停止当前主机,而不是显示晦涩难懂的错误。

- name: Refuse unsupported OS
  ansible.builtin.fail:
    msg: "This playbook supports Ubuntu only"

用 when 控制 fail

单独使用 fail 总会停止执行,因此请将它与 when 配合使用。只有满足您的保护条件时,剧本才会失败。

- ansible.builtin.fail:
    msg: "app_version is required"
  when: app_version is not defined

快速失败,尽早失败

将保护性检查放在剧本开头。在部署进行到一半时失败之前,尽早捕获错误输入会更好。

assert 模块

ansible.builtin.assert 更适合进行验证:将条件放入 that 中,只要有一个条件为 false,它就会失败。

- ansible.builtin.assert:
    that:
      - app_port is defined
      - app_port | int > 1024

自定义 assert 消息

为 assert 添加 fail_msg 和 success_msg,可以在两种结果下都输出友好的消息。每次运行都能提供清晰的反馈。

- ansible.builtin.assert:
    that: disk_free > 500
    fail_msg: "Need at least 500MB free"
    success_msg: "Disk space OK"

assert 一次检查多个条件

assert 在 that 中接收一个列表。每个条件都必须为 true;第一个为 false 的条件会让任务失败,并显示您的消息。

fail 与 assert

对于通过 when 中的逻辑有意停止一次的情况,请使用 fail;对于简洁地验证一组条件,请使用 assert。

插入值

您的 msg 可以包含变量,以提供上下文。显示错误的值,让操作人员准确知道需要修复什么。

- ansible.builtin.fail:
    msg: "Port {{ app_port }} is out of range"

让断言成为文档

优秀的断言也可以充当持续更新的文档:它们在一个位置说明剧本的预期并强制执行这些预期。📝

assert 的 quiet 模式

在 assert 上将 quiet 设置为 true,可以跳过逐个条件的输出。当您只关心失败而不关心通过的检查时,这很方便。

- ansible.builtin.assert:
    that: app_port is defined
    quiet: true

快速检查

让我们选择合适的工具。

回顾

fail 模块会用清晰的消息停止剧本,而 assert 会简洁地验证条件。主动保护您的剧本。✅

常见问题解答

「使用 fail 模块进行自定义断言」课时是免费的吗?

是的 — 「使用 fail 模块进行自定义断言」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Ansible Academy 课程的其余内容,请升级到 CoddyKit PRO。 Ansible Academy 课程共包含 4 节课。

「使用 fail 模块进行自定义断言」这节课中我会学到什么?

通过清晰的消息停止 Play 你通过在浏览器中直接运行的动手代码来练习 Ansible Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Ansible Academy 需要有经验吗?

无需任何先前经验。CoddyKit 上的 Ansible Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 4 节课,共 4 节。

「使用 fail 模块进行自定义断言」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 Ansible Academy 课中编写并运行代码吗?

能。每节 Ansible Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 使用 block 将任务分组
  2. 使用 rescue 与 always 实现 Try / Catch
  3. 控制失败:failed_when 与 ignore_errors
  4. 使用 fail 模块进行自定义断言
← 返回 Ansible Academy