开发模块

模块是一个可重用的、独立的脚本，Ansible 可以代表你本地或远程运行它。模块与你的本地机器、API 或远程系统交互以执行特定任务，例如更改数据库密码或启动云实例。每个模块都可以被 Ansible API 或 ansible 或 ansible-playbook 程序使用。模块提供了一个定义好的接口，接受参数，并在退出之前将 JSON 字符串打印到标准输出以向 Ansible 返回信息。

如果你需要在集合中找到的数千个 Ansible 模块中找不到的功能，你可以轻松编写你自己的自定义模块。当你编写用于本地使用的模块时，你可以选择任何编程语言并遵循你自己的规则。使用本主题学习如何在 Python 中创建 Ansible 模块。创建模块后，必须将其本地添加到相应的目录，以便 Ansible 可以找到并执行它。有关在本地添加模块的详细信息，请参阅在本地添加模块和插件。

如果你正在集合中开发模块，请改用这些文档。

准备开发 Ansible 模块的环境 

你只需要安装 ansible-core 来测试模块。模块可以用任何语言编写，但以下大部分指南都假设你使用的是 Python。要包含在 Ansible 本身中的模块必须是 Python 或 Powershell。

使用 Python 或 Powershell 作为自定义模块的一个优点是可以使用 module_utils 公共代码，它可以完成很多繁重的工作，例如参数处理、日志记录和响应编写等等。

创建模块 

强烈建议你使用 venv 或 virtualenv 进行 Python 开发。

要创建模块：

在你的工作区中创建一个 library 目录。你的测试剧本应该位于同一个目录中。
创建你的新模块文件：$ touch library/my_test.py。或者只需使用你选择的编辑器打开/创建它。
将下面的内容粘贴到你的新模块文件中。它包括必需的 Ansible 格式和文档、一个简单的用于声明模块选项的参数规范和一些示例代码。
修改并扩展代码以实现你希望新模块执行的操作。有关编写简洁明了的模块代码的提示，请参阅编程技巧和 Python 3 兼容性页面。

#!/usr/bin/python

# Copyright: (c) 2018, Terry Jones <[email protected]>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type

DOCUMENTATION = r'''
---
module: my_test

short_description: This is my test module

# If this is part of a collection, you need to use semantic versioning,
# i.e. the version is of the form "2.5.0" and not "2.4".
version_added: "1.0.0"

description: This is my longer description explaining my test module.

options:
    name:
        description: This is the message to send to the test module.
        required: true
        type: str
    new:
        description:
            - Control to demo if the result of this module is changed or not.
            - Parameter description can be a list as well.
        required: false
        type: bool
# Specify this value according to your collection
# in format of namespace.collection.doc_fragment_name
# extends_documentation_fragment:
#     - my_namespace.my_collection.my_doc_fragment_name

author:
    - Your Name (@yourGitHubHandle)
'''

EXAMPLES = r'''
# Pass in a message
- name: Test with a message
  my_namespace.my_collection.my_test:
    name: hello world

# pass in a message and have changed true
- name: Test with a message and changed output
  my_namespace.my_collection.my_test:
    name: hello world
    new: true

# fail the module
- name: Test failure of the module
  my_namespace.my_collection.my_test:
    name: fail me
'''

RETURN = r'''
# These are examples of possible return values, and in general should use other names for return values.
original_message:
    description: The original name param that was passed in.
    type: str
    returned: always
    sample: 'hello world'
message:
    description: The output message that the test module generates.
    type: str
    returned: always
    sample: 'goodbye'
'''

from ansible.module_utils.basic import AnsibleModule


def run_module():
    # define available arguments/parameters a user can pass to the module
    module_args = dict(
        name=dict(type='str', required=True),
        new=dict(type='bool', required=False, default=False)
    )

    # seed the result dict in the object
    # we primarily care about changed and state
    # changed is if this module effectively modified the target
    # state will include any data that you want your module to pass back
    # for consumption, for example, in a subsequent task
    result = dict(
        changed=False,
        original_message='',
        message=''
    )

    # the AnsibleModule object will be our abstraction working with Ansible
    # this includes instantiation, a couple of common attr would be the
    # args/params passed to the execution, as well as if the module
    # supports check mode
    module = AnsibleModule(
        argument_spec=module_args,
        supports_check_mode=True
    )

    # if the user is working with this module in only check mode we do not
    # want to make any changes to the environment, just return the current
    # state with no modifications
    if module.check_mode:
        module.exit_json(**result)

    # manipulate or modify the state as needed (this is going to be the
    # part where your module will do what it needs to do)
    result['original_message'] = module.params['name']
    result['message'] = 'goodbye'

    # use whatever logic you need to determine whether or not this module
    # made any modifications to your target
    if module.params['new']:
        result['changed'] = True

    # during the execution of the module, if there is an exception or a
    # conditional state that effectively causes a failure, run
    # AnsibleModule.fail_json() to pass in the message and the result
    if module.params['name'] == 'fail me':
        module.fail_json(msg='You requested this to fail', **result)

    # in the event of a successful module execution, you will want to
    # simple AnsibleModule.exit_json(), passing the key/value results
    module.exit_json(**result)


def main():
    run_module()


if __name__ == '__main__':
    main()

创建 info 或 facts 模块 

Ansible 使用 facts 模块收集目标机器的信息，并使用 info 模块收集其他对象或文件的信息。如果你发现自己试图向现有模块添加 state: info 或 state: list，这通常表示需要一个新的专用 _facts 或 _info 模块。

在 Ansible 2.8 及更高版本中，我们有两种信息模块，它们是 *_info 和 *_facts。

如果模块名为 <something>_facts，则应是因为其主要目的是返回 ansible_facts。不要使用 _facts 来命名不执行此操作的模块。仅对特定于主机机器的信息使用 ansible_facts，例如网络接口及其配置、操作系统和已安装的程序。

查询/返回一般信息（而不是 ansible_facts）的模块应命名为 _info。一般信息是非主机特定信息，例如在线/云服务的信息（你可以从同一主机访问同一在线服务的不同帐户），或从机器访问的虚拟机和容器的信息，或单个文件或程序的信息。

Info 和 facts 模块就像任何其他 Ansible 模块一样，只有少数几个小要求

它们必须命名为 <something>_info 或 <something>_facts，其中 <something> 是单数。
Info *_info 模块必须以结果字典的形式返回，以便其他模块可以访问它们。
Fact *_facts 模块必须在结果字典的 ansible_facts 字段中返回，以便其他模块可以访问它们。
它们必须支持 check_mode。
它们不得对系统进行任何更改。
它们必须记录返回字段和示例。

你可以将你的 facts 添加到结果的 ansible_facts 字段中，如下所示：

module.exit_json(changed=False, ansible_facts=dict(my_new_fact=value_of_fact))

其余部分与创建普通模块一样。

验证你的模块代码 

修改上面的示例代码以执行你想要的操作后，你可以试用你的模块。如果你在验证模块代码时遇到错误，我们的调试技巧将有所帮助。

在本地验证你的模块代码 

最简单的方法是使用 ansible adhoc 命令

ANSIBLE_LIBRARY=./library ansible -m my_test -a 'name=hello new=true' remotehost

如果你的模块不需要针对远程主机，你可以像这样快速轻松地在本地运行你的代码：

ANSIBLE_LIBRARY=./library ansible -m my_test -a 'name=hello new=true' localhost

如果出于任何原因（pdb、使用 print()、更快迭代等），你想避免使用 Ansible，另一种方法是创建一个参数文件，一个基本的 JSON 配置文件，它将参数传递给你的模块，以便你可以运行它。将参数文件命名为 /tmp/args.json 并添加以下内容：

{
    "ANSIBLE_MODULE_ARGS": {
        "name": "hello",
        "new": true
    }
}

然后可以在本地直接测试模块。这将跳过打包步骤并直接使用 module_utils 文件

$ python library/my_test.py /tmp/args.json

它应该返回如下输出：

{"changed": true, "state": {"original_message": "hello", "new_message": "goodbye"}, "invocation": {"module_args": {"name": "hello", "new": true}}}

在 playbook 中验证你的模块代码 

只要 library 目录与剧本位于同一目录中，你就可以轻松地通过将其包含在 playbook 中来运行完整的测试。

在任何目录中创建一个 playbook：$ touch testmod.yml
将以下内容添加到新的 playbook 文件中：

- name: test my new module
  hosts: localhost
  tasks:
  - name: run the new module
    my_test:
      name: 'hello'
      new: true
    register: testout
  - name: dump test output
    debug:
      msg: '{{ testout }}'

运行 playbook 并分析输出：$ ansible-playbook ./testmod.yml

测试你新创建的模块 

请查看我们的测试章节以获取更详细的信息，包括测试模块文档、添加集成测试等的说明。

注意

如果要为 Ansible 贡献代码，每个新的模块和插件都应该有集成测试，即使这些测试无法在 Ansible CI 基础设施上运行。在这种情况下，应该在别名文件中使用unsupported别名标记这些测试。

回馈 Ansible 

如果您想通过添加新功能或修复错误来为ansible-core贡献代码，请创建 ansible/ansible 仓库的分支，并使用devel分支作为起点，在新的功能分支上进行开发。当您拥有良好的工作代码更改后，您可以通过选择您的功能分支作为源，并选择 Ansible devel 分支作为目标来向 Ansible 仓库提交拉取请求。

如果您想为Ansible 集合贡献模块，请在打开拉取请求之前，查看我们的提交清单、编程技巧和维护 Python 2 和 Python 3 兼容性的策略，以及关于测试的信息。

社区指南介绍了如何打开拉取请求以及接下来会发生什么。

沟通和开发支持 

请访问Ansible 沟通指南，了解如何加入讨论。

鸣谢 

感谢 Thomas Stringer (@trstringer) 为本主题贡献了源材料。