如何创建 Ansible Playbooks 来自动化 Ubuntu 系统配置

介绍

Ansible 是一个简单的配置管理系统，可用于自动化和组织大型计算机网络的系统配置任务。虽然其他一些配置管理系统需要在服务器和客户端系统上安装许多不同的软件包，但使用 Ansible 只需要安装一个服务器组件并且具有对客户端机器的 SSH 访问权限。

在之前的指南中，我们讨论了如何安装 Ansible 软件并学习基本命令。在本指南中，我们将讨论 Ansible playbook，这是 Ansible 创建自动化脚本来配置客户端计算机的方式。

我们假设您已经配置了一个 Ansible 服务器和一些客户端，就像我们在上一个教程中留下的那样。在我们的指南中，服务器是一台 Ubuntu 12.04 机器，我们将要配置的客户端也是 Ubuntu 12.04 机器，以便解释更容易。

什么是 Ansible Playbooks?

Ansible playbook 是以脚本方式向远程计算机发送命令的一种方式。与单独使用 Ansible 命令从命令行远程配置计算机不同，您可以通过向一个或多个系统传递脚本来配置整个复杂的环境。

Ansible playbook 是用 YAML 数据序列化格式编写的。如果您不知道什么是数据序列化格式，可以将其视为一种将程序化数据结构（列表、数组、字典等）转换为可以轻松存储到磁盘的格式的方法。然后可以在以后使用该文件来重新创建结构。JSON 是另一种流行的数据序列化格式，但 YAML 更容易阅读。

每个 playbook 包含一个或多个 plays，它们将主机映射到特定功能。Ansible 通过称为 tasks 的内容来实现这一点，这些内容基本上是模块调用。

探索一个基本的 Playbook

让我们看一个基本的 playbook：

---
- hosts: dropletstasks:- name: Installs nginx web serverapt: pkg=nginx state=installed update_cache=truenotify:- start nginxhandlers:- name: start nginxservice: name=nginx state=started

让我们分解一下这些部分，以便我们了解这些文件是如何构建的以及每个部分的含义。

文件以以下内容开始：

---

这是 YAML 要求的，以将文件解释为一个正确的文档。YAML 允许一个文件中存在多个“文档”，每个文档由 --- 分隔，但 Ansible 只希望每个文件只有一个，因此这应该只出现在文件顶部。

YAML 对空格非常敏感，并使用它来将不同的信息组合在一起。您应该只使用空格而不是制表符，并且必须对文件使用一致的空格以便正确读取。具有相同缩进级别的项目被视为同级元素。

以 - 开头的项目被视为列表项。具有 key: value 格式的项目被视为哈希或字典。这基本上就是基本的 YAML。

YAML 文档基本上定义了一个包含元素的分层树结构，其中包含的元素位于左侧。

在第二行，我们有以下内容：

---
- hosts: droplets

这是 YAML 中的列表项，就像我们上面学到的那样，但由于它位于最左侧级别，它也是 Ansible 的“play”。Play 基本上是在一组特定主机上执行的任务组，以使它们能够执行您想要分配给它们的功能。每个 play 必须指定一个主机或一组主机，就像我们在这里做的那样。

接下来，我们有一组任务：

---
- hosts: dropletstasks:- name: Installs nginx web serverapt: pkg=nginx state=installed update_cache=truenotify:- start nginx

在顶层，我们有“tasks:”，与“hosts:”处于相同级别。这包含一个列表（因为它以“-”开头），其中包含键值对。

第一个键“name”更像是描述而不是名称。您可以随意命名它。

接下来的键是“apt”。这是对 Ansible 模块的引用，就像当我们使用 ansible 命令并键入类似以下内容时：

ansible -m apt -a 'whatever' all

此模块允许我们指定一个软件包以及它应该处于的状态，在我们的情况下是“installed”。update-cache=true 部分告诉我们的远程机器在安装软件之前更新其软件包缓存（apt-get update）。

“notify” 项包含一个包含一个项目的列表，称为“start nginx”。这不是内部 Ansible 命令，而是对处理程序的引用，当从任务内部调用时，它可以执行某些功能。我们将在下面定义“start nginx”处理程序。

---
- hosts: dropletstasks:- name: Installs nginx web serverapt: pkg=nginx state=installed update_cache=truenotify:- start nginxhandlers:- name: start nginxservice: name=nginx state=started

“handlers” 部分与“hosts”和“tasks”处于相同级别。处理程序就像任务一样，但只有在任务告诉它们客户端系统发生了更改时才会运行。

例如，我们在这里有一个处理程序，在安装软件包后启动 Nginx 服务。只有当“Installs nginx web server”任务导致系统发生更改时，即软件包必须安装且尚未存在时，才会调用处理程序。

我们可以将此 playbook 保存到一个名为“nginx.yml”的文件中。

只是为了一些背景，如果您要在 JSON 中编写相同的文件，它可能看起来像这样：

[{"hosts": "droplets","tasks": [{"name": "Installs nginx web server","apt": "pkg=nginx state=installed update_cache=true","notify": ["start nginx"]}],"handlers": [{"name": "start nginx","service": "name=nginx state=started"}]}
]

正如您所看到的，YAML 更加紧凑，大多数人会说更易读。

运行 Ansible Playbook

一旦你建立了一个 playbook，你可以使用以下格式轻松调用它：

ansible-playbook <span class="highlight">playbook.yml</span>

例如，如果我们想在所有 droplets 上安装并启动 Nginx，我们可以执行以下命令：

ansible-playbook nginx.yml

由于 playbook 本身指定了它应该运行的主机（即我们在上一篇教程中创建的 “droplets” 组），我们不必指定要运行的主机。

然而，如果我们想要将主机列表过滤为仅适用于其中一个主机，我们可以添加一个标志来指定文件中主机的子集：

ansible-playbook -l <span class="highlight">host_subset</span> <span class="highlight">playbook.yml</span>

因此，如果我们只想在 “host3” 上安装并运行 Nginx，我们可以输入以下命令：

ansible-playbook -l host3 nginx.yml

向 Playbook 添加功能

现在我们的 playbook 如下所示：

---
- hosts: dropletstasks:- name: Installs nginx web serverapt: pkg=nginx state=installed update_cache=truenotify:- start nginxhandlers:- name: start nginxservice: name=nginx state=started

它很简单，而且它可以工作，但它只是安装了一个软件并启动了它。这本身并没有太多好处。

我们可以通过向 playbook 添加任务来扩展功能。

添加默认索引文件

我们可以通过添加以下行来告诉它将文件从 Ansible 服务器传输到主机上：

---
- hosts: dropletstasks:- name: Installs nginx web serverapt: pkg=nginx state=installed update_cache=truenotify:- start nginx<span class="highlight">    - name: Upload default index.html for host</span>
<span class="highlight">      copy: src=static_files/index.html dest=/usr/share/nginx/www/ mode=0644</span>handlers:- name: start nginxservice: name=nginx state=started

然后我们可以在当前目录下创建一个名为 static_files 的目录，并在其中放置一个 index.html 文件。

mkdir static_files
nano static_files/index.html

在这个文件中，让我们创建一个基本的 HTML 结构：

<html><head><title>This is a sample page</title></head><body><h1>Here is a heading!</h1><p>Here is a regular paragraph.  Wow!</p></body>
</html>

保存并关闭文件。

现在，当我们重新运行 playbook 时，Ansible 将检查每个任务。它会看到 Nginx 已经安装在主机上，所以它会保持不变。它会看到新的任务部分，并用我们服务器上的文件替换默认的 index.html 文件。

注册结果

当你手动安装和配置服务时，几乎总是需要知道你的操作是否成功。我们可以通过使用 “register” 将这个功能嵌入到我们的 playbook 中。

对于每个任务，我们可以选择在一个变量中注册它的结果（失败或成功），以便以后可以检查。

在使用这个功能时，我们还必须告诉 Ansible 忽略该任务的错误，因为通常情况下，如果出现任何问题，它会中止该主机的 playbook 执行。

因此，如果我们想要检查任务是否失败，以决定后续步骤，我们可以使用注册功能。

例如，我们可以告诉我们的 playbook 如果存在 index.php 文件，则上传它。如果该任务失败，我们可以尝试上传一个 index.html 文件。我们将在另一个任务中检查失败的条件，因为我们只想在 PHP 文件失败时上传 HTML 文件：

---
- hosts: dropletstasks:- name: Installs nginx web serverapt: pkg=nginx state=installed update_cache=truenotify:- start nginx<span class="highlight">- name: Upload default index.php for host</span><span class="highlight">copy: src=static_files/index.php dest=/usr/share/nginx/www/ mode=0644</span><span class="highlight">register: php</span><span class="highlight">ignore_errors: True</span><span class="highlight">- name: Remove index.html for host</span><span class="highlight">command: rm /usr/share/nginx/www/index.html</span><span class="highlight">when: php|success</span>- name: Upload default index.html for hostcopy: src=static_files/index.html dest=/usr/share/nginx/www/ mode=0644<span class="highlight">when: php|failed</span>handlers:- name: start nginxservice: name=nginx state=started