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 可以包含的内容不仅仅是 hosts 行和任务。例如，上面的 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 

您可以在执行 playbook 之前，使用 ansible-lint 获取关于 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 沟通指南