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)

---
# 主 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)

---
- name: 配置 Web 服務器hosts: node1tasks:- name: 安裝 Apache HTTP 服務器yum:name: httpdstate: present

示例：FTP 服務器準備 (pre_vsftpd.yml)

---
- name: 配置 FTP 服務器hosts: node1tasks:- name: 安裝 vsftpd 服務yum:name: vsftpdstate: present

示例：數據庫服務器準備 (pre_db.yml)

---
- name: 配置數據庫服務器hosts: node1tasks:- name: 安裝 MariaDB 服務器yum:name: mariadb-serverstate: present

2. 任務級別的導入與包含

在任務級別，可以使用 import_tasks（靜態導入）或 include_tasks（動態包含）來引入外部任務文件。

示例：主 Playbook

---
- name: 安裝 Web 服務器hosts: node1tasks:- name: 導入任務文件import_tasks: tasks.yaml  # 靜態導入，在解析時處理# 以下兩種方式也可用，但不推薦（將在 2.12 版本移除）# - include: tasks.yaml# - include_tasks: tasks.yaml  # 動態包含，在運行時處理

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

---
- name: 安裝 Apache HTTP 服務器yum:name: httpdstate: present- name: 啟動 HTTP 服務service:name: httpdstate: started

3. 任務文件的實用場景

將任務分組為獨立的外部文件管理有以下優勢：

1. 模塊化配置：可以為不同的配置方面（用戶創建、軟件安裝、服務配置等）創建獨立的任務集合
2. 跨部門協作：不同團隊（開發、運維、DBA）可以編寫自己的任務文件，由系統經理集成
3. 條件執行：可以創建按特定條件執行的任務組，提高靈活性

最佳實踐是創建專用目錄存儲任務文件，使 Playbook 結構更清晰，組件更易管理。

4. 包含變量文件

include_vars 模塊用于導入外部 YAML 格式的變量文件。

示例：主 Playbook

---
- name: 安裝 Web 應用軟件包hosts: node1tasks:- 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