在您的模块中支持 Check Mode
让自定义代码能够安全执行演练
在您的模块中支持 Check Mode 是 CoddyKit 上的免费 DevOps Bootcamp 课时。 这是第 4 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 DevOps Bootcamp 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 DevOps Bootcamp 课程共包含 4 节课。
什么是检查模式
使用检查模式时,用户通过 --check 运行剧本,以预览更改。主机上的任何内容都不会真正被修改。
ansible-playbook site.yml --check模块必须主动支持
检查模式并不是自动启用的。您必须声明支持它,让 Ansible 知道您的模块承诺在此模式下不进行任何修改。
在 AnsibleModule 上声明
构建模块时请设置 supports_check_mode=True。这个标志会告诉 Ansible,您的代码会遵守试运行请求。
module = AnsibleModule(
argument_spec=spec,
supports_check_mode=True)读取 module.check_mode
运行时请检查 module.check_mode。用户传入 --check 时它的值为 True,您应据此分支处理逻辑。
if module.check_mode:
module.exit_json(changed=True)计算但不要应用
在检查模式下,您仍然需要计算是否需要更改。只是在向系统写入任何内容之前停止。
报告预期的更改
请使用正确的 changed 值提前退出,让试运行预览保持真实,即使实际上什么也没有发生。
if module.check_mode:
module.exit_json(changed=needs_change)读取始终安全
在检查模式下收集当前状态没有问题,因为读取不会产生任何修改。只有写入步骤必须跳过。
忘记检查模式会很危险
如果不支持检查模式,您的模块可能会在试运行期间仍然修改主机。这会违背用户的预期。
保持与实际运行逻辑一致
检查模式中的更改检测应与正常运行完全一致。错误的预览甚至不如没有预览。
测试两条路径
请分别在带有和不带有 --check 的情况下运行模块。确认试运行报告相同的 changed 结果,同时系统没有被修改。
检查模式建立信任
支持检查模式的模块可以让团队在应用更改前安全地预览结果。正是这种完善程度,让生产模块区别于玩具模块。
快速检查
请回忆一下,模块要支持检查模式,需要满足哪两点。
回顾
传入 supports_check_mode=True,根据 module.check_mode 分支,计算更改但跳过写入,并如实报告 changed。现在您的模块可以安全地进行试运行了。🔍
常见问题解答
「在您的模块中支持 Check Mode」课时是免费的吗?
是的 — 「在您的模块中支持 Check Mode」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 DevOps Bootcamp 课程的其余内容,请升级到 CoddyKit PRO。 DevOps Bootcamp 课程共包含 4 节课。
「在您的模块中支持 Check Mode」这节课中我会学到什么?
让自定义代码能够安全执行演练 你通过在浏览器中直接运行的动手代码来练习 DevOps Bootcamp,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 DevOps Bootcamp 需要有经验吗?
无需任何先前经验。CoddyKit 上的 DevOps Bootcamp 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 4 节课,共 4 节。
「在您的模块中支持 Check Mode」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 DevOps Bootcamp 课中编写并运行代码吗?
能。每节 DevOps Bootcamp 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 何时构建自定义模块
- AnsibleModule 与参数规范
- 返回 JSON 并遵循 changed 约定
- 在您的模块中支持 Check Mode