Ansible 中的文件包含与导入机制

本文介绍了在 Ansible 中如何通过模块化方式管理复杂的 Playbook，包括使用 include 和 import 系列语句来拆分和重用代码。

概述

当 Playbook 变得冗长或复杂时，可以将其拆分为多个小文件以提高可管理性。Ansible 提供了模块化的方式将多个 Playbook 或任务列表组合起来，便于在不同项目中重用代码。

Ansible 主要有两种重用代码的方式：

include 关键字（如 include_tasks、include_role）：动态包含，在运行时处理
import 关键字（如 import_playbook、import_tasks）：静态导入，在解析时处理

注意：传统的 include 语句（用于任务和 Playbook 级别）仍然可用，但此功能将在 Ansible 2.12 版本中移除，建议使用更具体的导入/包含方法。

1. Playbook 级别的导入

import_playbook 允许导入外部 Playbook 文件，只能在 Play 级别使用。导入的多个 Playbook 会按照导入顺序执行。

示例：主 Playbook (main.yml)

bash 复制代码

---
# 主 Playbook 依次导入三个子 Playbook
- name: 导入 Web 服务器准备配置
  import_playbook: pre_web.yml

- name: 导入 FTP 服务器准备配置
  import_playbook: pre_vsftpd.yml

- name: 导入数据库服务器准备配置
  import_playbook: pre_db.yml

示例：Web 服务器准备 (pre_web.yml)

bash 复制代码

---
- name: 配置 Web 服务器
  hosts: node1
  tasks:
    - name: 安装 Apache HTTP 服务器
      yum:
        name: httpd
        state: present

示例：FTP 服务器准备 (pre_vsftpd.yml)

bash 复制代码

---
- name: 配置 FTP 服务器
  hosts: node1
  tasks:
    - name: 安装 vsftpd 服务
      yum:
        name: vsftpd
        state: present

示例：数据库服务器准备 (pre_db.yml)

bash 复制代码

---
- name: 配置数据库服务器
  hosts: node1
  tasks:
    - name: 安装 MariaDB 服务器
      yum:
        name: mariadb-server
        state: present

2. 任务级别的导入与包含

在任务级别，可以使用 import_tasks（静态导入）或 include_tasks（动态包含）来引入外部任务文件。

示例：主 Playbook

bash 复制代码

---
- name: 安装 Web 服务器
  hosts: node1
  tasks:
    - name: 导入任务文件
      import_tasks: tasks.yaml  # 静态导入，在解析时处理
      
    # 以下两种方式也可用，但不推荐（将在 2.12 版本移除）
    # - include: tasks.yaml
    # - include_tasks: tasks.yaml  # 动态包含，在运行时处理

示例：任务文件 (tasks.yaml)

bash 复制代码

---
- name: 安装 Apache HTTP 服务器
  yum:
    name: httpd
    state: present

- name: 启动 HTTP 服务
  service:
    name: httpd
    state: started

3. 任务文件的实用场景

将任务分组为独立的外部文件管理有以下优势：

模块化配置：可以为不同的配置方面（用户创建、软件安装、服务配置等）创建独立的任务集合
跨部门协作：不同团队（开发、运维、DBA）可以编写自己的任务文件，由系统经理集成
条件执行：可以创建按特定条件执行的任务组，提高灵活性

最佳实践是创建专用目录存储任务文件，使 Playbook 结构更清晰，组件更易管理。

4. 包含变量文件

include_vars 模块用于导入外部 YAML 格式的变量文件。

示例：主 Playbook

复制代码

---
- name: 安装 Web 应用软件包
  hosts: node1
  tasks:
    - name: 包含变量文件
      include_vars: variables.yml  # 导入外部变量定义
      
    - name: 调试输出导入的变量
      debug:
        msg: >
          "已导入 {{ packages['web_package'] }} 和 {{ packages.db_package }}"

示例：变量文件 (variables.yml)

复制代码

---
# 定义软件包名称的变量
packages:
  web_package: httpd        # Web 服务器软件包
  db_package: mariadb-server # 数据库服务器软件包

总结

通过使用 Ansible 的导入和包含功能，可以：

将复杂的 Playbook 拆分为可管理的模块
提高代码的可重用性和可维护性
支持团队协作和专业化分工
根据需要条件性地执行任务组

建议优先使用 import_* 和 include_* 系列的具体语句，而不是通用的 include 语句，以确保代码的未来兼容性。o