Ansible 示例设置

您已经了解了 playbook、清单、角色和变量。本节将所有这些元素结合起来，并概述了用于自动化 Web 服务的示例设置。

示例设置按功能组织 playbook、角色、清单和带有变量的文件。播放和任务级别的标签提供了更大的粒度和控制。这是一种强大而灵活的方法，但还有其他方法可以组织 Ansible 内容。您对 Ansible 的使用应该适合您的需求，因此请随时修改此方法并相应地组织您的内容。

示例目录布局

此布局将大多数任务组织在角色中，每个环境使用一个清单文件，并在顶级目录中使用一些 playbook

production                # inventory file for production servers
staging                   # inventory file for staging environment

group_vars/
   group1.yml             # here we assign variables to particular groups
   group2.yml
host_vars/
   hostname1.yml          # here we assign variables to particular systems
   hostname2.yml

library/                  # if any custom modules, put them here (optional)
module_utils/             # if any custom module_utils to support modules, put them here (optional)
filter_plugins/           # if any custom filter plugins, put them here (optional)

site.yml                  # main playbook
webservers.yml            # playbook for webserver tier
dbservers.yml             # playbook for dbserver tier
tasks/                    # task files included from playbooks
    webservers-extra.yml  # <-- avoids confusing playbook with task files

roles/
    common/               # this hierarchy represents a "role"
        tasks/            #
            main.yml      #  <-- tasks file can include smaller files if warranted
        handlers/         #
            main.yml      #  <-- handlers file
        templates/        #  <-- files for use with the template resource
            ntp.conf.j2   #  <------- templates end in .j2
        files/            #
            bar.txt       #  <-- files for use with the copy resource
            foo.sh        #  <-- script files for use with the script resource
        vars/             #
            main.yml      #  <-- variables associated with this role
        defaults/         #
            main.yml      #  <-- default lower priority variables for this role
        meta/             #
            main.yml      #  <-- role dependencies and optional Galaxy info
        library/          # roles can also include custom modules
        module_utils/     # roles can also include custom module_utils
        lookup_plugins/   # or other types of plugins, like lookup in this case

    webtier/              # same kind of structure as "common" was above, done for the webtier role
    monitoring/           # ""
    fooapp/               # ""

注意

默认情况下，Ansible 假设您的 playbook 存储在一个目录中，角色存储在名为 roles/ 的子目录中。随着要自动化的任务增多，您可以考虑将 playbook 移动到名为 playbooks/ 的子目录中。如果您这样做，则必须使用 ansible.cfg 文件中的 roles_path 设置配置到 roles/ 目录的路径。

备用目录布局

您还可以将每个清单文件与其 group_vars/host_vars 放在一个单独的目录中。如果您的 group_vars/host_vars 在不同环境中没有太多共同点，这尤其有用。布局可能如下例所示

inventories/
   production/
      hosts               # inventory file for production servers
      group_vars/
         group1.yml       # here we assign variables to particular groups
         group2.yml
      host_vars/
         hostname1.yml    # here we assign variables to particular systems
         hostname2.yml

   staging/
      hosts               # inventory file for staging environment
      group_vars/
         group1.yml       # here we assign variables to particular groups
         group2.yml
      host_vars/
         stagehost1.yml   # here we assign variables to particular systems
         stagehost2.yml

library/
module_utils/
filter_plugins/

site.yml
webservers.yml
dbservers.yml

roles/
    common/
    webtier/
    monitoring/
    fooapp/

此布局为您提供了更大的环境灵活性，以及不同环境之间清单变量的完全分离。但是，这种方法更难维护，因为文件更多。有关组织组和主机变量的更多信息，请参阅 组织主机和组变量。

示例组和主机变量

这些带有变量的示例组和主机文件包含适用于每台机器或一组机器的值。例如，亚特兰大的数据中心有自己的 NTP 服务器。因此，在设置 ntp.conf 文件时，您可以使用与此示例类似的代码

---
# file: group_vars/atlanta
ntp: ntp-atlanta.example.com
backup: backup-atlanta.example.com

同样，webservers 组中的主机具有一些不适用于数据库服务器的配置

---
# file: group_vars/webservers
apacheMaxRequestsPerChild: 3000
apacheMaxClients: 900

默认值或普遍适用的值属于名为 group_vars/all 的文件中

---
# file: group_vars/all
ntp: ntp-boston.example.com
backup: backup-boston.example.com

如有必要，您可以在 host_vars 目录中定义系统中的特定硬件差异

---
# file: host_vars/db-bos-1.example.com
foo_agent_port: 86
bar_agent_port: 99

如果您使用 动态清单，Ansible 会自动创建许多动态组。因此，类似 class:webserver 的标签将自动加载 group_vars/ec2_tag_class_webserver 文件中的变量。

注意

您可以使用名为 hostvars 的特殊变量访问主机变量。有关这些变量的列表，请参阅 特殊变量。 hostvars 变量只能访问特定于主机的变量，不能访问组变量。

按功能组织的示例 playbook

使用此设置，单个 playbook 可以定义整个基础架构。 site.yml playbook 导入其他两个 playbook。一个用于 webservers，另一个用于数据库服务器

---
# file: site.yml
- import_playbook: webservers.yml
- import_playbook: dbservers.yml

位于顶级目录的 webservers.yml playbook 将 webservers 组的配置映射到与 webservers 组相关的角色

---
# file: webservers.yml
- hosts: webservers
  roles:
    - common
    - webtier

使用此设置，您可以通过运行 site.yml 来配置整个基础架构。或者，要仅配置基础架构的一部分，请运行 webservers.yml。这类似于 Ansible 的 --limit 参数，但更明确一些

ansible-playbook site.yml --limit webservers
ansible-playbook webservers.yml

基于功能的角色中的示例任务和处理程序文件

Ansible 加载角色子目录中任何名为 main.yml 的文件。此示例 tasks/main.yml 文件配置 NTP

---
# file: roles/common/tasks/main.yml

- name: be sure ntp is installed
  yum:
    name: ntp
    state: present
  tags: ntp

- name: be sure ntp is configured
  template:
    src: ntp.conf.j2
    dest: /etc/ntp.conf
  notify:
    - restart ntpd
  tags: ntp

- name: be sure ntpd is running and enabled
  ansible.builtin.service:
    name: ntpd
    state: started
    enabled: true
  tags: ntp

这是一个处理程序文件示例。仅当某些任务报告更改时才会触发处理程序。处理程序在每个播放的末尾运行

---
# file: roles/common/handlers/main.yml
- name: restart ntpd
  ansible.builtin.service:
    name: ntpd
    state: restarted

有关更多信息，请参阅 角色。

示例设置的功能

上面描述的基本组织结构支持许多不同的自动化选项。要重新配置整个基础架构

ansible-playbook -i production site.yml

要重新配置所有内容上的 NTP

ansible-playbook -i production site.yml --tags ntp

要仅重新配置 webservers

ansible-playbook -i production webservers.yml

要仅重新配置波士顿的 webservers

ansible-playbook -i production webservers.yml --limit boston

要仅重新配置波士顿的前 10 个 webservers，然后是接下来的 10 个

ansible-playbook -i production webservers.yml --limit boston[0:9]
ansible-playbook -i production webservers.yml --limit boston[10:19]

示例设置还支持基本的临时命令

ansible boston -i production -m ping
ansible boston -i production -m command -a '/sbin/reboot'

要发现特定 Ansible 命令将运行哪些任务或哪些主机名将受到影响

# confirm what task names would be run if I ran this command and said "just ntp tasks"
ansible-playbook -i production webservers.yml --tags ntp --list-tasks

# confirm what hostnames might be communicated with if I said "limit to boston"
ansible-playbook -i production webservers.yml --limit boston --list-hosts

组织部署或配置

示例设置说明了典型的配置拓扑。在进行多层部署时，您可能需要一些其他 playbook 在层之间跳转以推出应用程序。在这种情况下，您可以使用类似 deploy_exampledotcom.yml 的 playbook 来增强 site.yml。但是，一般概念仍然适用。使用 Ansible，您可以使用相同的实用程序进行部署和配置。因此，您可能会重用组并将操作系统配置与应用程序部署保存在单独的 playbook 或角色中。

将“playbook”视为体育比赛的比喻——您可以有一套针对所有基础架构的战术。然后，您有在不同时间和用于不同目的的情况战术。

使用本地 Ansible 模块

如果 playbook 相对于其 YAML 文件有一个 ./library 目录，则可以使用此目录将 Ansible 模块自动添加到模块路径。这将模块与 playbook 组织在一起。例如，请参阅本节开头的目录结构。

另请参阅

YAML 语法

了解 YAML 语法

使用 playbook

回顾基本的 playbook 功能

集合索引

浏览现有的集合、模块和插件

您是否应该开发一个模块？

了解如何通过编写自己的模块来扩展 Ansible

模式：定位主机和组

了解如何选择主机

沟通

有问题？需要帮助？想分享你的想法？访问 Ansible 通信指南