约定、提示和陷阱

在设计和开发模块时，请遵循以下基本约定和提示，以编写简洁易用的代码

模块范围

特别是如果你想将你的模块贡献到现有的 Ansible 集合中，请确保每个模块包含足够的逻辑和功能，但不要太多。如果这些指南看起来令人困惑，请考虑你是否真的需要编写模块。

  • 每个模块都应该具有简洁且定义良好的功能。基本上，遵循 UNIX 的“做好一件事”的理念。

  • 不要为现有模块添加 get、list 或 info 状态选项 - 创建一个新的 _info 或 _facts 模块。

  • 模块不应该要求用户了解要使用的 API/工具的所有底层选项。例如，如果必选模块选项的合法值无法记录，则该模块不属于 Ansible Core。

  • 模块应该包含与资源交互的大部分逻辑。围绕复杂 API 的轻量级包装器迫使用户将其过多的逻辑卸载到他们的 playbook 中。如果你想将 Ansible 连接到复杂的 API，创建多个模块来与 API 的较小的独立部分交互。

  • 避免创建执行其他模块工作的模块；这会导致代码重复和差异，并使事物不那么统一、不可预测且难以维护。模块应该是构建块。如果你在问“如何让一个模块执行其他模块”……你需要编写一个角色。

设计模块接口

  • 如果你的模块正在处理一个对象，则该对象的选项应尽可能称为 name，或接受 name 作为别名。

  • 接受布尔值的模块应该接受 yes、no、true、false 或用户可能提供的任何其他值。AnsibleModule 通用代码使用 type='bool' 支持这一点。

  • 避免使用 action/command，它们是命令式的而不是声明式的，还有其他方法可以表达相同的意思。

通用指南和提示

  • 每个模块都应在一个文件中自包含，以便 ansible-core 可以自动传输它。

  • 模块名称必须使用下划线而不是连字符或空格作为单词分隔符。使用连字符和空格将阻止 ansible-core 导入你的模块。

  • 开发模块时始终使用 hacking/test-module.py 脚本 - 它会警告你常见的陷阱。

  • 如果你有一个返回特定于你的安装的信息的本地模块，则该模块的一个好名称是 site_info。

  • 消除或最小化依赖项。如果你的模块有依赖项，请在模块文件顶部记录它们，并在依赖项导入失败时引发 JSON 错误消息。

  • 不要直接写入文件；使用临时文件，然后使用 ansible.module_utils.basic 中的 atomic_move 函数将更新后的临时文件移动到适当位置。这可以防止数据损坏并确保保留文件的正确上下文。

  • 避免创建缓存。Ansible 的设计没有中央服务器或权限，因此你无法保证它不会以不同的权限、选项或位置运行。如果你需要中央权限，请将其放在 Ansible 之上（例如，使用堡垒/CM/CI 服务器、AWX 或 Red Hat Ansible Automation Platform）；不要尝试将其构建到模块中。

  • 如果你将你的模块打包到 RPM 中，请将模块安装在控制机器上的 /usr/share/ansible 中。将模块打包到 RPM 中是可选的。

函数和方法

  • 每个函数都应该简洁明了，并描述有意义的工作量。

  • “不要重复自己”通常是一个很好的理念。

  • 函数名应使用下划线：my_function_name。

  • 每个函数的名称都应该描述该函数的作用。

  • 每个函数都应该有一个文档字符串。

  • 如果你的代码嵌套过多，这通常表示循环体可以受益于成为一个函数。我们现有代码的部分内容有时不是这方面的最佳示例。

Python 提示

  • 包含一个包装正常执行的 main 函数。

  • 从条件语句中调用你的 main 函数，以便你可以将其导入单元测试中 - 例如

if __name__ == '__main__':
    main()

导入和使用共享代码

  • 尽可能使用共享代码 - 不要重复造轮子。Ansible 提供了 AnsibleModule 通用 Python 代码，以及许多常见用例和模式的实用程序。你还可以为适用于多个模块的文档创建文档片段。

  • 在导入其他库的同时导入 ansible.module_utils 代码。

  • 不要使用通配符 (*) 导入其他 Python 模块；而应列出你正在导入的函数（例如，from some.other_python_module.basic import otherFunction）。

  • 在 try/except 中导入自定义包，捕获任何导入错误，并在 main() 中使用 fail_json() 处理它们。例如

import traceback

from ansible.module_utils.basic import missing_required_lib

LIB_IMP_ERR = None
try:
    import foo
    HAS_LIB = True
except:
    HAS_LIB = False
    LIB_IMP_ERR = traceback.format_exc()

然后在 main() 中，紧接在 argspec 之后，执行以下操作

if not HAS_LIB:
    module.fail_json(msg=missing_required_lib("foo"),
                     exception=LIB_IMP_ERR)

并在模块的 DOCUMENTATION 块 的 requirements 部分记录依赖项。

处理模块故障

当您的模块失败时，帮助用户了解发生了什么问题。如果您正在使用 AnsibleModule 通用 Python 代码，当您调用 fail_json 时，failed 元素将自动包含在内。为了实现礼貌的模块故障行为

  • 在 msg 中包含一个 failed 密钥以及一个字符串解释。如果您不这样做，Ansible 将使用标准返回码：0=成功，非零=失败。

  • 不要引发回溯（堆栈跟踪）。Ansible 可以处理堆栈跟踪并自动将任何无法解析的内容转换为失败的结果，但模块故障时引发堆栈跟踪对用户不友好。

  • 不要使用 sys.exit()。从模块对象中使用 fail_json()。

优雅地处理异常（错误）

  • 提前验证 - 快速失败并返回有用且清晰的错误消息。

  • 使用防御性编程 - 为您的模块使用简单的设计，优雅地处理错误，并避免直接堆栈跟踪。

  • 可预测地失败 - 如果必须失败，请以最期望的方式进行。要么模仿底层工具，要么模仿系统的工作方式。

  • 提供有关您正在执行的操作的有用消息，并将异常消息添加到其中。

  • 避免使用万能异常，除非底层 API 提供了关于尝试操作的非常好的错误消息，否则它们不是很有用。

创建正确且信息丰富的模块输出

模块必须仅输出有效的 JSON。请遵循以下准则以创建正确、有用的模块输出

  • 模块返回数据必须编码为严格的 UTF-8。无法返回 UTF-8 编码数据的模块应返回使用 base64 等编码的数据。可选地，模块可以确定它们是否可以编码为 UTF-8，并利用 errors='replace' 来替换非 UTF-8 字符，从而使返回值有损。

  • 使您的顶级返回类型为哈希（字典）。

  • 在顶级哈希中嵌套复杂返回值。

  • 在顶级返回哈希中包含任何列表或简单标量值。

  • 不要将模块输出发送到标准错误，因为系统会将标准输出与标准错误合并并阻止 JSON 解析。

  • 捕获标准错误并将其作为 JSON 中的变量返回到标准输出。命令模块就是这样实现的。

  • 永远不要在模块中执行 print("some status message")，因为它不会生成有效的 JSON 输出。

  • 始终返回有用的数据，即使没有更改。

  • 关于返回值保持一致（某些模块过于随机），除非这对状态/操作不利。

  • 使返回值可重用 - 大多数时候您不想阅读它，但您确实想处理它并重新利用它。

  • 如果处于差异模式，则返回差异。这并非所有模块都要求，因为某些模块没有意义，但请在适用时包含它。

  • 启用您的返回值使用 Python 的标准 JSON 编码器和解码器 库序列化为 JSON。基本 Python 类型（字符串、整数、字典、列表等）是可序列化的。

  • 不要使用 exit_json() 返回对象。相反，将您需要的字段从对象转换为字典的字段，并返回字典。

  • 来自许多主机的结果将一次聚合，因此您的模块应该只返回相关输出。返回日志文件的全部内容通常是不好的做法。

如果模块返回 stderr 或无法生成有效的 JSON，则 Ansible 中仍将显示实际输出，但命令将不会成功。

遵循 Ansible 约定

Ansible 约定在所有模块、剧本和角色中提供可预测的用户界面。要在模块开发中遵循 Ansible 约定

  • 在模块之间使用一致的名称（是的，我们有很多遗留偏差 - 不要使问题变得更糟！）。

  • 在您的模块中使用一致的选项（参数）。

  • 不要使用“message”或“syslog_facility”作为选项名称，因为 Ansible 在内部使用这些名称。

  • 将选项与其他模块规范化 - 如果 Ansible 和您的模块连接到的 API 对相同选项使用不同的名称，请为您的选项添加别名，以便用户可以选择在任务和剧本中使用哪个名称。

  • 从 *_facts 模块返回的事实位于 结果字典 的 ansible_facts 字段中，以便其他模块可以访问它们。

  • 在所有 *_info 和 *_facts 模块中实现 check_mode。基于事实信息进行条件化的剧本，只有在 check_mode 中返回事实时，才能在 check_mode 中正确地进行条件化。通常，在实例化 AnsibleModule 时，您可以添加 supports_check_mode=True。

  • 使用模块特定的环境变量。例如，如果您在 module_utils.api 中使用帮助程序进行基本身份验证，并使用 module_utils.urls.fetch_url()，并且您回退到环境变量以获取默认值，请使用模块特定的环境变量，例如 API_<MODULENAME>_USERNAME，以避免模块之间的冲突。

  • 保持模块选项简单且专注 - 如果您在现有选项上加载了许多选择/状态，请考虑添加一个新的简单选项。

  • 尽可能保持选项小。将大型数据结构传递给选项可能会为我们节省一些任务，但它增加了一个复杂的要求，我们无法在传递给模块之前轻松验证。

  • 如果要将复杂数据传递给选项，请编写一个允许此操作的专家模块，以及一些提供对底层 API 和服务的更“原子”操作的较小模块。复杂的操作需要复杂的数据。让用户选择是否在任务和剧本中或在 vars 文件中反映这种复杂性。

  • 实现声明性操作（而不是 CRUD），以便用户可以忽略现有状态并专注于最终状态。例如，使用 started/stopped、present/absent。

  • 努力实现一致的最终状态（又名幂等性）。如果在同一系统上连续运行两次模块会导致两个不同的状态，请查看您是否可以重新设计或重写以实现一致的最终状态。如果不能，请记录行为及其原因。

  • 在标准 Ansible 返回结构中提供一致的返回值，即使对于通常在其他选项下返回的键使用 NA/None。

模块安全

  • 避免从 shell 传递用户输入。

  • 始终检查返回码。

  • 您必须始终使用 module.run_command，而不是 subprocess 或 Popen 或 os.system。

  • 除非绝对必要，否则避免使用 shell。

  • 如果必须使用 shell，则必须将 use_unsafe_shell=True 传递给 module.run_command。

  • 如果模块中的任何变量都可能来自带有 use_unsafe_shell=True 的用户输入，则必须使用 pipes.quote(x) 将其包装。

  • 在获取 URL 时，使用 fetch_url 或 open_url 来自 ansible.module_utils.urls。不要使用 urllib2，它不会原生验证 TLS 证书，因此对于 https 不安全。

  • 标记为 no_log=True 的敏感值将自动从模块返回值中删除该值。如果您的模块可能将这些敏感值作为字典键名称的一部分返回，则应调用 ansible.module_utils.basic.sanitize_keys() 函数以从键中删除这些值。请参阅 uri 模块以获取示例。