ansible之collections

在 Ansible 中，collections 是一种组织和分发自动化内容的机制。它们帮助你管理不同的 Ansible 组件，例如任务、模块、插件等。以下是对 Ansible collections 的详细介绍，包括它们的功能、如何创建和使用它们，以及它们与其他 Ansible 组件的关系。

什么是 Ansible Collections?

Ansible Collections 是一种将 Ansible 资源（如角色、模块、插件、剧本等）打包在一起的格式。它们使得管理和分享这些资源变得更加方便和一致。

一、Collection 的组成部分

1. 模块 (Modules)：用于执行特定的任务。比如 ansible.builtin.yum 用于在系统上安装软件包。

2. 角色 (Roles)：用于组织一组相关的任务、变量、文件和模板。

3. 插件 (Plugins)：扩展 Ansible 的功能。插件可以是动作插件、回调插件、缓存插件等。

4. 剧本 (Playbooks)：包含一系列任务的 YAML 文件，用于自动化管理任务。

5. 任务 (Tasks)：在剧本中执行的具体操作。

6. 变量 (Variables)：用来配置任务和剧本的动态内容。

7. 模板 (Templates)：使用 Jinja2 模板引擎创建动态配置文件。

二、目录结构

一个 Ansible Collection 的目录结构通常如下：

my_namespace_my_collection/
│
├── README.md
├── galaxy.yml
├── roles/
│   └── my_role/
│       ├── tasks/
│       ├── handlers/
│       ├── templates/
│       └── vars/
├── plugins/
│   ├── modules/
│   ├── filters/
│   ├── lookup/
│   └── ... (其他插件类型)
└── playbooks/
    └── example_playbook.yml

三、如何创建 Ansible Collections

要创建一个新的 Ansible Collection，你可以使用 ansible-galaxy 命令：

ansible-galaxy collection init my_namespace.my_collection

这将会创建一个新的目录结构，其中包含了创建 Collection 所需的基本文件和目录。

四、如何使用 Ansible Collections

1、安装 Collection

可以从 Ansible Galaxy 或其他来源安装 Collection：

ansible-galaxy collection install my_namespace.my_collection

也可以从本地目录或通过 requirements.yml 文件进行安装：

ansible-galaxy collection install ./my_namespace-my_collection

2、Playbook 中使用 Collection

在你的 playbook.yml 文件中，你可以指定要使用的 Collection：

---
- name: Example Playbook
  hosts: all
  collections:
    - my_namespace.my_collection
  tasks:
    - name: Example task
      my_namespace.my_collection.my_module:
        name: example
        state: present

3、管理 Collection

列出已安装的 Collection：

ansible-galaxy collection list

卸载 Collection：

ansible-galaxy collection uninstall my_namespace.my_collection

五、使用 requirements.yml 文件管理 Collection

你可以创建一个 requirements.yml 文件来管理 Collection 的依赖：

---
collections:
  - name: my_namespace.my_collection
    source: https://my.custom.repo/path/to/collection/
    version: 1.0.0

然后使用以下命令安装所有 Collection：

ansible-galaxy collection install -r requirements.yml

六、创建 Collection 的详细步骤

1、创建 Collection

使用 ansible-galaxy collection init 命令初始化 Collection 目录结构。

ansible-galaxy collection init my_namespace.my_collection

2、编辑 galaxy.yml 文件

填写 Collection 的元数据，如名称、描述、作者等：

namespace: my_namespace
name: my_collection
version: '1.0.0'
description: My Collection Description
authors:
  - My Name

3、添加内容

在 roles/、plugins/、playbooks/ 等目录下添加你的 Ansible 资源。

4、打包 Collection

打包 Collection 为一个 .tar.gz 文件：

ansible-galaxy collection build

5、发布 Collection

将打包后的文件上传到 Ansible Galaxy 或其他 Collection 仓库。

ansible-galaxy collection publish my_namespace-my_collection-1.0.0.tar.gz

七、使用 Collection 的最佳实践

1. 命名规范：选择有意义的命名方式，并遵循命名规范。
2. 版本管理：使用语义版本控制来管理 Collection 的版本。
3. 文档：编写清晰的文档，帮助用户了解如何使用 Collection。
4. 测试：确保 Collection 中的所有功能都经过充分测试。