什么是 Ansible Playbook？

news2025/4/22 19:29:25

一、Ansible Playbook 是什么？

Ansible Playbook 是 Ansible 自动化工具的核心组件之一，它是一个以 YAML 格式编写的文件，用于定义一组自动化任务（tasks）。简单来说，Playbook 就像一个“剧本”或“指令清单”，告诉 Ansible 要对哪些主机（目标机器）执行哪些操作（例如安装软件、修改配置文件、检查服务状态等）。

在 Ansible 和 AWX 的上下文中，Playbook 是你实现自动化的主要方式。每次你想让 AWX 执行一个自动化任务（例如测试主机连通性、安装 Nginx、检查磁盘使用情况），你都需要一个 Playbook 文件来描述这些任务。换句话说，Playbook 是你在 AWX 中运行的“脚本”，但它不仅仅是简单的命令集合，而是结构化的自动化任务描述。

Playbook 的核心作用

  1. 定义自动化任务：Playbook 描述了你希望在目标主机上执行的具体操作，例如安装软件、配置服务、检查主机状态等。
  2. 批量管理主机：通过 Playbook，你可以一次性对多台主机执行相同的操作，适合大规模服务器管理。
  3. 确保一致性：Playbook 保证每次执行的操作都是相同的，避免手动操作带来的错误。
  4. 可重复执行：Playbook 可以反复运行，确保系统状态符合预期（例如，如果某个服务未启动，Playbook 可以自动启动它）。
  5. 幂等性：Playbook 具有幂等性，多次运行不会导致意外结果（例如，如果软件已安装，Ansible 不会重复安装）。

二、Playbook 的结构

一个 Playbook 通常由以下几个部分组成（以 YAML 格式编写）：

  • Plays：Playbook 包含一个或多个 Play，每个 Play 定义了一组任务和目标主机。
  • Hosts：指定任务运行的目标主机（可以是单个主机、主机组，或者通过 AWX 的清单动态指定）。
  • Tasks：具体的操作步骤，例如安装软件、复制文件、执行命令等。
  • Modules：Ansible 提供的内置功能模块（例如 ansible.builtin.ping、ansible.builtin.apt），用于执行具体任务。
  • Variables：可以定义变量，用于动态替换 Playbook 中的值（例如主机 IP、用户名等）。

简单 Playbook 示例

以下是在 AWX 环境中创建的 ping.yml Playbook：

---
- name: Ping Test Playbook
  hosts: all
  tasks:
    - name: Ping the host
      ansible.builtin.ping:

逐行解释：

  1. ---：YAML 文件的开头，表示文档开始。
  2. - name: Ping Test Playbook：定义一个 Play，名称为 Ping Test Playbook。
  3. hosts: all：指定目标主机为“所有主机”（all），具体主机由 AWX 的清单（Inventory）决定，例如 AnsibleInventory 中的 localhost。
  4. tasks:：定义任务列表。
  5. - name: Ping the host：定义一个任务，名称为 Ping the host。
  6. ansible.builtin.ping:：调用 Ansible 的 ping 模块，测试目标主机是否可达（通过 SSH 连接）。

这个 Playbook 做了什么？

  • 它会尝试通过 SSH 连接到目标主机（例如 localhost），并执行一个简单的 ping 测试。
  • 如果连接成功，任务状态会显示为“成功”（OK）；如果失败（例如 SSH 连接不上），任务会失败。

三、Playbook 的优势

Playbook 相比传统的脚本（例如 Bash 脚本）有以下优势：

  1. 简单易读：Playbook 使用 YAML 格式，语法简单，容易理解和编写。
  2. 模块化：Ansible 提供了大量模块（例如 apt、copy、service），可以完成几乎所有常见任务。
  3. 幂等性：Playbook 具有幂等性，多次运行不会导致意外结果（例如，如果软件已安装，Ansible 不会重复安装）。
  4. 跨主机管理：Playbook 可以同时对多台主机执行任务，适合批量管理。
  5. 可扩展：可以通过变量、条件语句、循环等增强 Playbook 的灵活性。

四、Playbook 在 AWX 中的作用

在我的 AWX 环境中（IP 为 192.168.85.133:8052），Playbook 是自动化任务的核心。AWX 通过 任务模板（Job Template） 调用 Playbook 来执行自动化任务。以下是 Playbook 在 AWX 中的典型用途：

1. 运行自动化任务

  • 假设在 AWX 的 模板（Templates） 页面（192.168.85.133:8052/#/templates），创建了一个任务模板 AnsiblePingTest，指定了 Playbook ping.yml。
  • 当点击 火箭图标（Launch）运行任务时，AWX 会：
    1. 使用指定的清单（例如 AnsibleInventory）确定目标主机（例如 localhost）。
    2. 使用指定的凭据（例如 AnsibleSSHCredential）通过 SSH 连接到目标主机。
    3. 在目标主机上执行 ping.yml 中的任务（即 ansible.builtin.ping）。
  • 运行结果会显示在 作业（Jobs） 页面（192.168.85.133:8052/#/jobs/playbook），例如 AnsiblePingTest 的状态（成功或失败）。

2. 定时自动化

  • 在 AWX 的 调度（Schedules） 页面（192.168.85.133:8052/#/workflow_schedules），为 AnsiblePingTest 创建了一个每日调度（DailyAnsiblePing）。
  • 每天到达指定时间（例如 2025/3/25 08:00），AWX 会自动运行 ping.yml，无需手动干预。

3. 批量管理

  • 如果清单 AnsibleInventory 中包含多台主机（例如 localhost 和 192.168.85.134），Playbook 会同时对所有主机执行任务。
  • 例如，ping.yml 会测试所有主机的可达性，运行结果会显示每台主机的状态。

五、Playbook 的实际应用场景

Playbook 的用途非常广泛，以下是一些常见的场景，结合你的 AWX 环境说明：

场景 1：测试主机连通性

  • Playbook：ping.yml 
    ---
- name: Ping Test Playbook
  hosts: all
  tasks:
    - name: Ping the host
      ansible.builtin.ping:
  • 用途：检查目标主机是否可以通过 SSH 连接，适合初步验证 AWX 和 Ansible 的配置是否正确。
  • AWX 操作：
    1. 在 模板 页面运行 AnsiblePingTest。
    2. 在 作业 页面查看结果，如果状态为“成功”，说明主机可达；如果失败，检查 SSH 凭据或网络连接。

场景 2：安装软件

  • Playbook：install_nginx.yml 
    ---
- name: Install Nginx Playbook
  hosts: all
  become: yes  # 以 root 权限运行（需要 sudo）
  tasks:
    - name: Install Nginx
      ansible.builtin.apt:
        name: nginx
        state: present
        update_cache: yes
  • 用途：在目标主机上安装 Nginx 服务器。
  • AWX 操作：
    1. 将 install_nginx.yml 放入项目目录（例如 /var/lib/awx/projects/automation）。
    2. 在 项目 页面（192.168.85.133:8052/#/projects）同步 AnsibleAutomationProject。
    3. 在 模板 页面创建新模板 InstallNginx，指定 Playbook 为 install_nginx.yml。
    4. 运行 InstallNginx，AWX 会自动在目标主机上安装 Nginx。

场景 3：配置服务

  • Playbook：configure_nginx.yml 
    ---
- name: Configure Nginx Playbook
  hosts: all
  become: yes
  tasks:
    - name: Copy Nginx config file
      ansible.builtin.copy:
        src: /var/lib/awx/projects/automation/nginx.conf
        dest: /etc/nginx/nginx.conf
        mode: '0644'
    - name: Restart Nginx
      ansible.builtin.service:
        name: nginx
        state: restarted
  • 用途：将本地的 Nginx 配置文件复制到目标主机，并重启 Nginx 服务。
  • AWX 操作：
    1. 确保 nginx.conf 文件存在于 /var/lib/awx/projects/automation。
    2. 创建任务模板 ConfigureNginx，指定 Playbook 为 configure_nginx.yml。
    3. 运行任务，AWX 会自动更新目标主机的 Nginx 配置并重启服务。

场景 4：批量执行命令

  • Playbook：check_disk.yml 
    ---
- name: Check Disk Usage Playbook
  hosts: all
  tasks:
    - name: Check disk usage
      ansible.builtin.command: df -h
      register: disk_usage
    - name: Display disk usage
      ansible.builtin.debug:
        msg: "{{ disk_usage.stdout }}"
  • 用途：检查目标主机的磁盘使用情况，并显示结果。
  • AWX 操作：
    1. 创建 Playbook check_disk.yml，放入项目目录。
    2. 创建任务模板 CheckDisk，指定 Playbook 为 check_disk.yml。
    3. 运行任务，在 作业 页面查看每台主机的磁盘使用情况。

六、Playbook 的进阶用法

Playbook 不仅仅可以执行简单任务，还可以通过以下方式增强其功能：

1. 使用变量

变量可以让 Playbook 更灵活。例如：

---
- name: Install Software with Variables
  hosts: all
  become: yes
  vars:
    package_name: nginx
  tasks:
    - name: Install package
      ansible.builtin.apt:
        name: "{{ package_name }}"
        state: present
        update_cache: yes
  • 作用：通过变量 package_name，你可以动态指定要安装的软件（例如 nginx 或 apache2）。
  • AWX 操作：在任务模板中，可以通过 变量 字段覆盖 Playbook 中的变量值。

2. 条件语句

条件语句可以根据条件执行任务。例如：

---
- name: Install Nginx on Ubuntu
  hosts: all
  become: yes
  tasks:
    - name: Install Nginx
      ansible.builtin.apt:
        name: nginx
        state: present
        update_cache: yes
      when: ansible_os_family == "Debian"
  • 作用：只有当目标主机的操作系统是 Debian 系列（例如 Ubuntu）时，才安装 Nginx。

3. 循环

循环可以重复执行任务。例如：

---
- name: Install Multiple Packages
  hosts: all
  become: yes
  tasks:
    - name: Install packages
      ansible.builtin.apt:
        name: "{{ item }}"
        state: present
        update_cache: yes
      loop:
        - nginx
        - vim
        - curl
  • 作用：一次性安装多个软件包（nginx、vim、curl）。

七、在 AWX 中如何管理 Playbook

结合你的 AWX 界面，Playbook 的管理主要涉及以下模块：

1. 项目（Projects）

  • Playbook 存储在项目中（例如 AnsibleAutomationProject）。
  • 项目可以是本地目录（/var/lib/awx/projects/automation）或 Git 仓库。
  • 在 项目 页面（192.168.85.133:8052/#/projects）同步项目后，AWX 会加载 Playbook 文件（例如 ping.yml）。

2. 模板（Templates）

  • 在 模板 页面（192.168.85.133:8052/#/templates）创建任务模板（例如 AnsiblePingTest），指定 Playbook 文件。
  • 任务模板还需指定清单（目标主机）、凭据（SSH 密钥）、执行环境等。

3. 作业（Jobs）

  • 运行任务模板后，AWX 会执行 Playbook，运行结果显示在 作业 页面（192.168.85.133:8052/#/jobs/playbook）。
  • 你可以查看日志，了解 Playbook 的执行细节（例如 Ping Test 失败的原因）。

4. 调度（Schedules）

  • 在 调度 页面（192.168.85.133:8052/#/workflow_schedules）为任务模板设置定时运行（例如 DailyAnsiblePing），让 Playbook 自动执行。

八、Playbook 的调试和故障排查

在 AWX 中运行 Playbook 时，可能会遇到失败的情况。以下是常见的故障排查方法：

1. 查看作业日志

  • 在 作业 页面，点击失败的任务（例如 AnsiblePingTest），查看详细日志。
  • 常见问题：
    • SSH 连接失败：检查凭据（AnsibleSSHCredential）中的私钥和用户名是否正确。
    • Playbook 语法错误：检查 Playbook 文件（例如 ping.yml）的 YAML 语法是否正确。

2. 启用调试模式

  • 在 AWX 的 设置（Settings） → 作业（Jobs） 页面，将日志级别设置为 Debug。
  • 重新运行任务，获取更详细的日志。

3. 测试 Playbook

  • 在 AWX 服务器上手动运行 Playbook，排除 AWX 配置问题：
    ansible-playbook -i /path/to/inventory /var/lib/awx/projects/automation/ping.yml

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/2321247.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

Dynamics 365 Business Central 财务经常性一般日记帐做帐方法简介

Dynamics 365 Business Central 财务经常性一般日记帐做帐方法简介

#BC ERP# #Navision# #Recurring General Journal# 在BC ERP中为了方便财务做些经常性的一般日记帐的方法，为了省时省事会用到Recurring General Journal模块是一个好方法。在这里将分别用不同的示例 对经常性日记帐的各种方法做一介绍： 经常性日记帐 …
阅读更多...
Mybatis注解的基础操作——02

Mybatis注解的基础操作——02

写mybatis代码的方法有两种： 注解xml方式 本篇就介绍注解的方式 mybatis的操作主要有增删改查，下面进行一一讲解。 目录 一、参数传递 二、增（Insert） 三、删（Delete） 四、改（Update&#…
阅读更多...
在 IntelliJIDEA中实现Spring Boot多实例运行：修改配置与批量启动详解

在 IntelliJIDEA中实现Spring Boot多实例运行：修改配置与批量启动详解

前言 一、通过 ‌修改配置‌ 实现多实例运行二、通过 ‌批量启动‌ 实现多实例运行三、常见问题及解决方案四、最佳实践与扩展五、总结 在微服务开发中，经常需要同时启动多个服务实例进行测试或模拟集群环境。‌IntelliJ IDEA‌ 作为Java开发者常用工具，…
阅读更多...
Mongodb分片模式部署

Mongodb分片模式部署

MongoDB 分片集群部署教程 1. 概述 MongoDB 分片是一种用于处理大规模数据集的集群技术。通过分片，MongoDB 可以将数据分布在多个服务器上，从而提高存储容量和读写性能。本教程将详细介绍如何从零开始部署 MongoDB 分片集群。 介绍 分片集群中主要由三…
阅读更多...
ElementPlus 快速入门

ElementPlus 快速入门

目录 前言 为什么要学习 ElementPlus？ 正文 步骤 1 创建 一个工程化的vue 项目 ​2 安装 element-Plus :Form 表单 | Element Plus 1 点击 当前界面的指南 2 点击左边菜单栏上的安装，选择包管理器 3 运行该命令 demo(案例1 ） 步骤 …
阅读更多...
C++输入输出流第二弹：文件输入输出流and字符串输入输出流

C++输入输出流第二弹：文件输入输出流and字符串输入输出流

目录 文件输入输出流（重点） 文件输入流 文件输入流对象的创建 对测试代码进行解读： 1. 代码核心逻辑 2. 读取过程详解 3. 关键特性总结 4. 注意事项 5. 完整流程示例 这里既然提到了 >> 流，那么就对他进行进一步的…
阅读更多...
TCP传输---计算机网络

TCP传输---计算机网络

TCP结构 源端口和目标端口：标识通信的应用程序。序列号：标记发送的数据段的顺序序号。确认号 ( ACK)：确认接收到的数据序号。标志位：控制连接状态，包括 SYN（同步）、ACK（确认&#xf…
阅读更多...
基于TweenMax和SVG的炫酷弹性进度条动画特效

基于TweenMax和SVG的炫酷弹性进度条动画特效

这是一款效果非常炫酷的基于TweenMax和SVG的炫酷弹性进度条动画特效。该弹性进度条特效在点击触发按钮之后，按钮会变形为进度条，然后一个滑块在它上面滑动，就像重物滑过绳子的感觉，非常有创意。 在线演示 使用方法 该弹性进度条效…
阅读更多...
python面试高频考点（深度学习大模型方向）

python面试高频考点（深度学习大模型方向）

1. python中yeild和return的区别？ 2. 介绍一下pytohn中的上下文管理器？ 在Python中，上下文管理器（Context Manager） 是一种通过 with 语句管理资源的协议，确保资源（如文件、数据库连接、线程锁…
阅读更多...
六、重学C++—深入探索new delete

六、重学C++—深入探索new delete

上一章节： 五、重学C—类(封装继承)-CSDN博客https://blog.csdn.net/weixin_36323170/article/details/146458436?spm1001.2014.3001.5502 本章节代码： cpp CuiQingCheng/cppstudy - 码云 - 开源中国https://gitee.com/cuiqingcheng/cppstudy/tree/m…
阅读更多...
Unity代码热更新和资源热更新

Unity代码热更新和资源热更新

知识点来源：人间自有韬哥在，hybridclr,豆包 目录 一、代码热更新1.代码热更新概述2.HybridCLR 二、资源热更新1.资源热更新概述2.AB包2.1.AB包的加载2.2.卸载AB包2.3.加载AB包依赖包2.4.获取MD52.5.生成对比文件2.6.更新AB包 3.Addressable3.1.AssetRef…
阅读更多...
于纷扰中寻静谧：正念观照的智慧之旅

于纷扰中寻静谧：正念观照的智慧之旅

在现代社会的快节奏浪潮中，我们仿若被裹挟前行的浮萍，生活的压力与信息的洪流冲刷着内心的宁静，焦虑与迷茫如影随形。而正念观照，恰似一叶扁舟，能引领我们在心灵的海洋中回归自我，探寻那片澄澈之境。 正念…
阅读更多...
环境评价分析中土地利用现状图的制作方法

环境评价分析中土地利用现状图的制作方法

在环境评价中，土地利用现状图是重要的基础图件，用于分析项目区域的土地利用类型、分布格局及其生态环境特征。 以下是制作土地利用现状图的详细步骤和方法： 一、前期准备工作 确定制图范围和比例尺 根据评价范围确定制图区域边界 常用比例…
阅读更多...
编程题记录3

编程题记录3

九宫幻方 题目链接：https://www.lanqiao.cn/problems/100/learning/?page1&first_category_id1&second_category_id3&tags%E7%9C%81%E8%B5%9B&tag_relationintersection 先旋转、镜像得到所有的情况，可以发现情况是可以暴力得出的。…
阅读更多...
sql语句给表添加一个递增列

sql语句给表添加一个递增列

SSMS–》视图-》数据库(表)-》新建查询 ALTER TABLE [表名] DROP COLUMN ID ALTER TABLE [表名] ADD ID INT IDENTITY(1,1)执行完以上操作，会在表的最后一列添加一个自增字段 接下来如何把最后一个字段放到第一个字段呢？ 假如sqlserver 表test 有以下…
阅读更多...
vue java 实现大地图切片上传

vue java 实现大地图切片上传

文章目录 一、项目背景二、页面三、代码1.前端2.mock-i18n.js文件3.xx.js文件定义方法4.配置文件 application.properties5.后端方法 四、易错点易错点1：前端要进行分片切割，然后再分片上传。易错点2：后端配置文件要配置。易错点3&#xff1a…
阅读更多...
langchain+ollama+deepseek的部署（win）

langchain+ollama+deepseek的部署（win）

ANACONDA 安装 官网：Download Anaconda Distribution | Anaconda 配置系统环境 在系统变量中配置 检查是否配置成功 通过 cmd 窗口输入： conda info 如图：表示成功 配置你的虚拟环境 二、安装 ollama allama 安装 官网地址&#xff1a…
阅读更多...
deepseek实战教程-第四篇开放平台接口文档使用

deepseek实战教程-第四篇开放平台接口文档使用

第二篇讲解了如何本地安装大模型，然后编写一个基于jsspringboot的项目，通过页面实现对话的功能。实际上，上面的demo用到是deepseek提供的接口，那么deepseek共提供了多少接口呢？这就要讨论到deepseek的接口库了&#xf…
阅读更多...
一站式电脑工具箱，功能全面且实用

一站式电脑工具箱，功能全面且实用

小明工具箱是一款集成了系统设置、维护工具、实用工具、图像处理等四大类工具的电脑工具箱，涵盖了上百种实用工具，能够满足用户在文件管理、文本处理、系统优化、图像处理等多方面的需求。 初次使用，需双击软件，便会自动将工具解压…
阅读更多...
那些正常的动态规划

那些正常的动态规划

文章目录 前言动态规划到底是啥？ 线性dp最长上升子序列子集和子序列和子串的区别内容分析 最大上升子序列例题1——[NOIP2004 提高组] 合唱队形分析 最长公共子序列最长公共子串 平面dp例题2——[NOIP2000 提高组] 方格取数分析 例题3——[NOIP2008 提高组] 传纸条分…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023