Ansible Playbook

Ansible Playbook 提供了一种可重复使用、简单易用的配置管理和多机器部署系统，非常适合部署复杂的应用程序。如果需要多次使用 Ansible 执行任务，请编写 playbook 并将其置于源代码控制之下。然后，可以使用 playbook 来推送新配置或确认远程系统的配置。

Playbook 可以

声明配置
在多个机器集上，以定义的顺序编排任何手动排序过程的步骤
同步或异步启动任务

Playbook 语法 

Playbook 以 YAML 格式表示，语法最少。如果您不熟悉 YAML，请查看我们的 YAML 语法概述，并考虑为您的文本编辑器安装一个插件（请参阅其他工具和程序），以帮助您在 playbook 中编写简洁的 YAML 语法。

Playbook 由有序列表中的一个或多个“play”组成。“playbook”和“play”这两个术语是体育运动的类比。每个 play 执行 playbook 的总体目标的一部分，运行一个或多个任务。每个任务调用一个 Ansible 模块。

Playbook 执行 

Playbook 从上到下按顺序运行。在每个 play 中，任务也从上到下按顺序运行。具有多个“play”的 Playbook 可以编排多机器部署，在一个 play 中在您的 Web 服务器上运行，然后在另一个 play 中在您的数据库服务器上运行，然后在第三个 play 中在您的网络基础设施上运行，依此类推。至少，每个 play 定义了两件事

使用模式作为目标的受管节点
至少一个要执行的任务

注意

在 Ansible 2.10 及更高版本中，我们建议您在 playbook 中使用完全限定的集合名称，以确保选择正确的模块，因为多个集合可以包含同名的模块（例如，user）。请参阅在 playbook 中使用集合。

在此示例中，第一个 play 的目标是 Web 服务器；第二个 play 的目标是数据库服务器。

---
- name: Update web servers
  hosts: webservers
  remote_user: root

  tasks:
  - name: Ensure apache is at the latest version
    ansible.builtin.yum:
      name: httpd
      state: latest

  - name: Write the apache config file
    ansible.builtin.template:
      src: /srv/httpd.j2
      dest: /etc/httpd.conf

- name: Update db servers
  hosts: databases
  remote_user: root

  tasks:
  - name: Ensure postgresql is at the latest version
    ansible.builtin.yum:
      name: postgresql
      state: latest

  - name: Ensure that postgresql is started
    ansible.builtin.service:
      name: postgresql
      state: started

您的 playbook 可以包含的不仅仅是主机行和任务。例如，上面的 playbook 为每个 play 设置一个 remote_user。这是 SSH 连接的用户帐户。您可以在 playbook、play 或任务级别添加其他 Playbook 关键字，以影响 Ansible 的行为方式。Playbook 关键字可以控制连接插件、是否使用特权提升、如何处理错误等等。为了支持各种环境，Ansible 允许您将许多这些参数设置为命令行标志、Ansible 配置或清单。学习这些数据源的优先级规则将帮助您扩展 Ansible 生态系统。

任务执行 

默认情况下，Ansible 按照顺序，一次一个，针对与主机模式匹配的所有机器执行每个任务。每个任务使用特定参数执行一个模块。当任务在所有目标机器上执行完毕后，Ansible 将继续执行下一个任务。您可以使用策略来更改此默认行为。在每个 play 中，Ansible 将相同的任务指令应用于所有主机。如果某个任务在主机上失败，Ansible 将把该主机从 playbook 的其余部分中删除。

当您运行 playbook 时，Ansible 返回有关连接的信息、所有 play 和任务的 name 行、每个任务在每台机器上是否成功或失败，以及每个任务是否在每台机器上进行了更改。在 playbook 执行的底部，Ansible 提供了一个有关目标节点及其性能的摘要。一般失败和致命的“无法访问”的通信尝试在计数中分开。

期望状态和“幂等性”

大多数 Ansible 模块都会检查是否已达到所需的最终状态，如果已达到该状态，则会退出而不执行任何操作，以便重复该任务不会更改最终状态。以这种方式运行的模块通常被称为“幂等”。无论您运行 playbook 一次还是多次，结果都应该相同。但是，并非所有 playbook 和所有模块都以这种方式运行。如果您不确定，请在沙盒环境中测试您的 playbook，然后再在生产环境中多次运行它们。

运行 Playbook 

要运行您的 playbook，请使用 ansible-playbook 命令。

ansible-playbook playbook.yml -f 10

运行 playbook 时，请使用 --verbose 标志，以查看成功模块以及不成功模块的详细输出。

在检查模式下运行 Playbook 

Ansible 的检查模式允许您执行 playbook，而不会对系统进行任何更改。您可以使用检查模式在生产环境中实施 playbook 之前对其进行测试。

要在检查模式下运行 playbook，您可以将 -C 或 --check 标志传递给 ansible-playbook 命令

ansible-playbook --check playbook.yaml

执行此命令将正常运行 playbook，但 Ansible 不会进行任何修改，而只会提供有关它将进行的更改的报告。此报告包含诸如文件修改、命令执行和模块调用等详细信息。

检查模式提供了一种安全实用的方法来检查 playbook 的功能，而不会对系统造成意外更改的风险。此外，它还是一个用于排除未按预期运行的 playbook 故障的宝贵工具。

Ansible-Pull 

如果您想反转 Ansible 的架构，以便节点签入到一个中心位置，而不是将配置推送到它们，则可以这样做。

ansible-pull 是一个小脚本，它将从 git 中检出配置指令的存储库，然后针对该内容运行 ansible-playbook。

假设您对检出位置进行负载均衡，ansible-pull 可以无限扩展。

运行 ansible-pull --help 以了解详细信息。

验证 Playbook 

您可能希望在运行 playbook 之前对其进行验证，以捕获语法错误和其他问题。 ansible-playbook 命令提供了几个用于验证的选项，包括 --check、--diff、--list-hosts、--list-tasks 和 --syntax-check。用于验证 playbook 的工具介绍了用于验证和测试 playbook 的其他工具。

ansible-lint 

您可以使用 ansible-lint 在执行 playbook 之前获取有关 playbook 的详细 Ansible 特定反馈。例如，如果您在页面顶部的名为 verify-apache.yml 的 playbook 上运行 ansible-lint，则应获得以下结果

$ ansible-lint verify-apache.yml
[403] Package installs should not use latest
verify-apache.yml:8
Task/Handler: ensure apache is at the latest version

ansible-lint 默认规则页面介绍了每个错误。对于 [403]，建议的修复是将 playbook 中的 state: latest 更改为 state: present。

另请参阅

ansible-lint: 了解如何测试 Ansible Playbook 语法
YAML 语法: 了解 YAML 语法
一般提示: 在现实世界中管理 playbook 的提示
集合索引: 浏览现有集合、模块和插件
您是否应该开发一个模块？: 了解如何通过编写自己的模块来扩展 Ansible
模式：定位主机和组: 了解如何选择主机
交流: 有问题？需要帮助？想分享您的想法？请访问 Ansible 交流指南