在剧本中使用集合

安装完成后，您可以通过其完全限定的集合名称 (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 搜索角色内任务的哪些集合。即使调用角色的剧本在单独的 collections 关键字条目中定义了不同的集合，Ansible 也会使用角色内部定义的集合列表。在集合中定义的角色始终隐式地首先搜索其自己的集合，因此您无需使用 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 导入程序的限制。

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