如何创建一个 Ansilbe 项目

了解 Ansible

Ansible 是一款开源的自动化工具，用于配置管理、应用部署、任务执行以及多主机的编排。它基于 Python 开发，使用 YAML 文件作为配置语言，通过 SSH 协议与目标主机通信。其无代理的架构使得操作更加简单高效。详细请参考官方文档。

Ansible 包含两个主要组成部分：

1. Ansible Project：，完整的 Ansible 开源发行版，包括核心引擎 Ansible Core 和一系列社区支持的模块、插件、集合等工具包。
2. Ansible Core：， Ansible 的核心引擎，提供运行 Playbook 的基本功能，精简但功能强大。

常用命令行工具

以下是 Ansible 的主要命令行工具及其用途：

命令	功能概述	常见应用场景
ansible	单任务执行	测试或快速执行简单任务
ansible-config	管理和验证配置文件	验证配置文件格式或生成模板
ansible-console	交互式任务执行	快速调试和任务探索
ansible-doc	模块文档查询	查阅模块功能和参数使用方法
ansible-galaxy	角色和集合管理	初始化、发布、安装角色或集合
ansible-inventory	管理和验证库存文件	检查主机组定义是否正确
ansible-playbook	运行 Playbook 文件	执行自动化任务
ansible-pull	拉取并运行 Playbook 文件	主动模式的配置部署
ansible-vault	加密和解密敏感信息文件	安全存储密码或凭据

了解这些命令可以帮助我们更高效地创建和管理 Ansible 项目。接下来我们将详细介绍如何创建 Ansible 项目。

创建一个 Ansible 项目

创建 Ansible 项目时，可以根据需求选择两种主要方式：

1. 创建 Ansible 角色（Role）项目：适用于单一项目内部的自动化任务管理。
2. 创建 Ansible 集合（Collection）项目：用于跨项目共享自动化任务，支持更复杂的功能模块。

角色与集合的区别

特点	Role（ansible-galaxy init）	Collection（ansible-galaxy collection init）
范围	适用于单个项目内部组织自动化内容	跨项目、团队或社区共享，支持复杂功能组织
内容支持	仅支持角色（Roles）	支持角色、模块、插件、Playbook、文档、测试等
分发和共享	不适合直接分发，需手动复制	可通过 Ansible Galaxy 或内部仓库发布和安装
复杂度	适合简单项目，结构清晰	适合复杂项目，功能模块化且组织严谨
插件和扩展支持	不支持插件和模块，只支持角色任务	支持自定义模块（Python）、插件（Callback、Filter 等）
依赖声明	无法声明角色间依赖	可以声明依赖（其他 Collections 或特定 Ansible 版本）
推荐场景	简单项目或一次性任务	企业级、复杂需求或需要分发的项目

创建 Ansible 角色项目

通过 ansible-galaxy init 创建角色项目，适合简单或单一自动化任务的组织。

mkdir ansible-demo
cd ansible-demo
ansible-galaxy init ansible-demo

默认生成的项目结构：

ansible-demo/
├── ansible-demo/
│   ├── defaults/       # 默认变量
│   │   └── main.yml
│   ├── files/          # 静态文件
│   ├── handlers/       # 任务处理器
│   │   └── main.yml
│   ├── meta/           # 元数据
│   │   └── main.yml
│   ├── tasks/          # 任务逻辑
│   │   └── main.yml
│   ├── templates/      # 模板文件
│   ├── tests/          # 测试任务
│   │   ├── inventory
│   │   └── test.yml
│   ├── vars/           # 变量文件
│   │   └── main.yml
│   ├── README.md       # 项目说明

角色没有明确的入口，通常需要通过 Playbook 调用。例如：

创建 Playbook 文件：

mkdir playbooks
cat > playbooks/setup.yml << EOF
- name: Run ansible-demo role
  hosts: all
  roles:
    - ansible-demo
EOF

运行角色：

ansible-playbook -i inventory/hosts playbooks/setup.yml

创建 Ansible 集合项目

通过 ansible-galaxy collection init 创建集合项目，适合复杂或需要共享的任务。

mkdir ansible-collection-demo
cd ansible-collection-demo
ansible-galaxy collection init demonamespace.demo

生成的项目结构：

ansible-collection-demo/
|── demonamespace.demo/
│   ├── docs/       # 文档目录
│   │   └── README.md
│   ├── meta/       # 元数据
│   │   └── runtime.yml
│   ├── plugins/    # 插件目录
│   ├── roles/      # 角色目录
│   ├── galaxy.yml  # 集合定义文件
│   ├── README.md   # 项目说明

调用集合内角色：

创建一个 Playbook 调用集合角色：

- name: Run a role from collection
  hosts: all
  roles:
    - demonamespace.demo.my_role

运行 Playbook：

ansible-playbook -i inventory/hosts playbooks/setup.yml

总结

Ansible 提供了灵活的工具和项目组织方式，根据需求可以选择创建角色或集合项目：

• 角色项目（Role）：适用于单一项目内部的自动化任务管理，结构简单清晰。
• 集合项目（Collection）：适用于企业级、跨团队协作的复杂需求，支持更丰富的功能模块和共享机制。

在创建 Ansible 项目时，推荐使用清晰的目录结构和 Playbook 作为任务入口，同时充分利用 Ansible 的模块化特性，提升自动化任务的复用性和可维护性。

无论是角色还是集合，都能帮助团队简化部署和配置流程，充分发挥 Ansible 的自动化能力。