在剧本中使用集合

安装后，您可以通过其完全限定的集合名称 (FQCN) 引用集合内容

- name: Reference a collection content using its FQCN
  hosts: all
  tasks:

    - name: Call a module using FQCN
      my_namespace.my_collection.my_module:
        option1: value

这适用于角色或任何类型的在集合中分发的插件

- name: Reference collections contents using their FQCNs
  hosts: all
  tasks:

    - name: Import a role
      ansible.builtin.import_role:
        name: my_namespace.my_collection.role1

    - name: Call a module
      my_namespace.mycollection.my_module:
        option1: value

    - name: Call a debug task
      ansible.builtin.debug:
        msg: '{{ lookup("my_namespace.my_collection.lookup1", 'param1')| my_namespace.my_collection.filter1 }}'

使用 collections 关键字简化模块名称

使用 collections 关键字，您可以定义一个集合列表，您的角色或剧本应该在其中搜索未限定的模块和操作名称。因此，您可以使用 collections 关键字，然后在整个角色或剧本中简单地引用模块和操作插件的简短名称。

警告

如果您的剧本同时使用 collections 关键字和一个或多个角色，则角色不会继承由剧本设置的集合。这是我们建议您始终使用 FQCN 的原因之一。有关角色的详细信息，请参见下文。

在角色中使用 collections

在角色中，您可以使用角色的 meta/main.yml 中的 collections 关键字来控制 Ansible 在角色内部的任务中搜索哪些集合。Ansible 将使用角色内部定义的集合列表，即使调用角色的剧本在单独的 collections 关键字条目中定义了不同的集合。集合内部定义的角色始终隐式地首先搜索他们自己的集合，因此您不需要使用 collections 关键字来访问相同集合中包含的模块、操作或其他角色。

# myrole/meta/main.yml
collections:
  - my_namespace.first_collection
  - my_namespace.second_collection
  - other_namespace.other_collection

在剧本中使用 collections

在剧本中，您可以控制 Ansible 搜索哪些模块和操作插件来执行。但是，您在剧本中调用的任何角色都定义他们自己的集合搜索顺序；它们不会继承调用剧本的设置。即使角色没有定义自己的 collections 关键字，情况也是如此。

- name: Run a play using the collections keyword
  hosts: all
  collections:
    - my_namespace.my_collection

  tasks:

    - name: Import a role
      ansible.builtin.import_role:
        name: role1

    - name: Run a module not specifying FQCN
      my_module:
        option1: value

    - name: Run a debug task
      ansible.builtin.debug:
        msg: '{{ lookup("my_namespace.my_collection.lookup1", "param1")| my_namespace.my_collection.filter1 }}'

使用 collections 关键字仅仅为非命名空间插件和角色引用创建了一个有序的“搜索路径”。它不会安装内容或以其他方式更改 Ansible 加载插件或角色的行为。请注意，仍然需要为非操作或模块插件（例如，查找、过滤器和测试）使用 FQCN。

使用 collections 关键字时，无需将 ansible.builtin 添加到搜索列表中。当省略时，默认情况下以下内容可用

  1. 通过 ansible-base/ansible-core 可用的标准 ansible 模块和插件

  2. 对旧的第三方插件路径的支持

通常，最好使用模块或插件的 FQCN 而不是 collections 关键字。

使用来自集合的剧本

版本 2.11 中的新增功能。

您也可以在集合中分发剧本，并使用与插件相同的语义调用它们

ansible-playbook my_namespace.my_collection.playbook1 -i ./myinventory

从剧本内部

- name: Import a playbook
  ansible.builtin.import_playbook: my_namespace.my_collection.playbookX

创建此类剧本时的一些建议，hosts: 应该是一般的，或者至少有一个变量输入。

- hosts: all  # Use --limit or customized inventory to restrict hosts targeted

- hosts: localhost  # For things you want to restrict to the control node

- hosts: '{{target|default("webservers")}}'  # Assumes inventory provides a 'webservers' group, but can also use ``-e 'target=host1,host2'``

这将在 collections: 关键字中有一个隐式条目 my_namespace.my_collection，就像角色一样。

注意

  • 剧本名称，就像其他集合资源一样，有一组受限的有效字符。名称只能包含小写字母数字字符、加号和下划线，并且必须以字母字符开头。连字符 - 字符对集合中的剧本名称无效。名称包含无效字符的剧本不可寻址：这是用于加载集合资源的 Python 导入器的限制。

  • 集合中的剧本不支持“相邻”插件，所有插件都必须位于集合特定的目录中。