Ansible 剧本

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

剧本可以

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

剧本语法 

剧本以 YAML 格式表示，语法最小。如果您不熟悉 YAML，请查看我们对YAML 语法的概述，并考虑为您的文本编辑器安装一个附加组件（请参见其他工具和程序）来帮助您在剧本中编写干净的 YAML 语法。

剧本由一个或多个按顺序排列的“play”组成。术语“剧本”和“play”是体育类比。每个 play 执行剧本的整体目标的一部分，运行一个或多个任务。每个任务调用一个 Ansible 模块。

剧本执行 

剧本从上到下按顺序运行。在每个 play 中，任务也从上到下按顺序运行。包含多个“play”的剧本可以协调多机器部署，在一个 play 中运行您的 Web 服务器，然后在另一个 play 中运行您的数据库服务器，然后在第三个 play 中运行您的网络基础设施，等等。至少，每个 play 定义两件事

使用模式要定位的受管节点
至少要执行一个任务

注意

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

在此示例中，第一个 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

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

任务执行 

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

当您运行一个剧本时，Ansible 会返回有关连接、所有 play 和任务的name 行、每个任务在每台机器上是否成功或失败以及每个任务在每台机器上是否进行更改的信息。在剧本执行的底部，Ansible 提供了对目标节点及其执行情况的摘要。一般性失败和致命“不可达”通信尝试在计数中保持分离。

预期状态和“幂等性”

大多数 Ansible 模块会检查预期最终状态是否已经实现，如果该状态已经实现，则退出而不执行任何操作，以便重复该任务不会更改最终状态。表现出这种行为的模块通常被称为“幂等的”。无论您运行剧本一次还是多次，结果都应该相同。但是，并非所有剧本和模块都表现出这种行为。如果您不确定，请在生产环境中多次运行剧本之前，在沙箱环境中对其进行测试。

运行剧本 

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

ansible-playbook playbook.yml -f 10

在运行剧本时使用--verbose标志以查看来自成功模块和失败模块的详细输出。

在检查模式下运行剧本 

Ansible 的检查模式允许您在不对系统应用任何更改的情况下执行剧本。您可以使用检查模式在生产环境中实施剧本之前测试剧本。

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

ansible-playbook --check playbook.yaml

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

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

Ansible-Pull 

如果您希望反转 Ansible 的体系结构，以便节点签入中央位置，而不是将配置推送到它们，则可以。

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

假设您对签出位置进行负载平衡，ansible-pull本质上可以无限扩展。

运行ansible-pull --help以获取详细信息。

验证剧本 

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

ansible-lint 

您可以使用ansible-lint来获取有关您的剧本的详细、Ansible 特定反馈，然后再执行它们。例如，如果您对页面顶部附近的名为verify-apache.yml的剧本运行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]，推荐的修复方法是在剧本中将state: latest更改为state: present。

另请参见

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