Ansible 剧本

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

剧本可以

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

剧本语法 

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

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

剧本执行 

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

要定位的托管节点，使用模式
至少要执行一项任务

注意

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

在此示例中，第一个剧目定位 Web 服务器；第二个剧目定位数据库服务器。

---
- 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

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

任务执行 

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

运行剧本时，Ansible 会返回有关连接的信息、所有剧目和任务的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 通信指南