解密 Ansible Handlers：确保幂等的服务重启

Ansible handlers 解决了一个常见的部署问题：你的配置文件可能在每次运行时都被检查，但你的服务应该只在文件实际发生变化时重启。如果没有 handlers，你的 playbook 可能会无缘无故地重启健康的服务。

本指南解释了 handlers 的工作原理、在哪里定义它们，以及何时提前刷新它们。示例使用 Web 服务，但相同的模式适用于应用工作进程、调度程序和系统守护进程。

什么是 Ansible Handlers？

在 Ansible 中，handler 是一个仅在另一个任务通知它之后才运行的任务。当一个任务更改了某些内容并包含 notify 时，Ansible 会将匹配的 handler 加入队列。

Handler 的关键特性：

由通知触发： 当一个已更改的任务使用 notify 时，handler 会运行。
每个 play 运行一次： 如果五个任务通知同一个 handler，Ansible 仍然只在 play 结束时运行它一次。
最适合重启和重载： Handlers 非常适合仅在配置更改后执行的服务操作。

为什么在服务重启时使用 Handlers？

Ansible handlers 的主要用例是服务管理。当你更新 Apache、Nginx 或应用程序配置文件时，服务通常需要重启或重载。你只希望在部署的文件与当前文件不同时执行该操作。

考虑替代方案：

没有 handlers： 除非你添加额外条件，否则直接重启任务会在每次 playbook 到达它时运行。
使用 handlers： 模板或复制任务仅在报告 changed 时通知重启。

例如，一个生产环境的 Nginx playbook 可能每小时运行一次以强制执行配置漂移。使用 handlers，未更改的配置文件不会导致每小时重载。

如何实现 Ansible Handlers

Handlers 位于 playbook 的 handlers 部分或角色内的 handlers/main.yml 中。Handler 的名称必须与 notify 使用的名称匹配。

基本 Handler 语法

Handlers 在 playbook 级别或角色内的 handlers 块中声明。

---
- name: 配置并重启 Web 服务器
  hosts: webservers
  become: yes
  tasks:
    - name: 确保 Apache 配置文件存在
      template:
        src: templates/httpd.conf.j2
        dest: /etc/httpd/conf/httpd.conf
      notify:
        - 重启 Apache

  handlers:
    - name: 重启 Apache
      service:
        name: httpd
        state: restarted

在这个例子中：

使用 template 任务部署新的 Apache 配置文件 (httpd.conf)。
notify 关键字设置为 重启 Apache。这意味着如果 template 任务成功更改了 httpd.conf 文件，Ansible 将向名为 重启 Apache 的 handler 发送信号。
handlers 部分定义了 重启 Apache handler，它使用 service 模块重启 httpd 服务。

通知多个 Handlers

单个任务可以通知多个 handlers。如果更改一个配置需要重启多个服务或执行多个清理操作，这很有用。

---
- name: 部署应用程序并更新数据库和 Web 服务器
  hosts: app_servers
  become: yes
  tasks:
    - name: 更新应用程序配置
      copy:
        src: files/app.conf
        dest: /etc/app/app.conf
      notify:
        - 重启应用程序服务
        - 重载 Nginx

  handlers:
    - name: 重启应用程序服务
      service:
        name: myapp
        state: restarted

    - name: 重载 Nginx
      service:
        name: nginx
        state: reloaded

在这个场景中，如果 app.conf 被更新，重启应用程序服务 和 重载 Nginx 这两个 handlers 都将被触发。

在角色中使用 Handlers

Handlers 通常在 Ansible 角色中使用。它们定义在角色的 handlers/main.yml 文件中。当角色内的任务（或包含该角色的 playbook 中的任务）通知角色中定义的 handler 时，Ansible 将执行它。

假设你有一个名为 apache 的角色，结构如下：

apache/
├── handlers/
│   └── main.yml
└── tasks/
    └── main.yml

apache/tasks/main.yml：

---
- name: 部署 Apache 配置
  template:
    src: httpd.conf.j2
    dest: /etc/httpd/conf/httpd.conf
  notify:
    - 重启 Apache

apache/handlers/main.yml：

---
- name: 重启 Apache
  service:
    name: httpd
    state: restarted

然后，在你的 playbook 中，你将包含该角色：

---
- name: 使用 Apache 角色配置 Web 服务器
  hosts: webservers
  become: yes
  roles:
    - apache

当 apache 角色中的 部署 Apache 配置 任务执行并修改配置时，apache/handlers/main.yml 中定义的 重启 Apache handler 将被触发。

使用 Handlers 的最佳实践

保持每个 handler 专注于一个操作。
使用与操作匹配的名称，例如 重载 Nginx。
当服务支持重载且不需要完全重启时，优先使用 state: reloaded。
避免在配置任务之后直接使用重启任务。
记住，除非你刷新它们，否则被通知的 handlers 会在 play 结束时运行。

高级概念：刷新 Handlers

默认情况下，handlers 在每个 play 结束时运行一次。有时你需要在后续任务继续之前进行重启。例如，你可能需要在写入主配置后重启应用程序，然后再运行健康检查或迁移。

---
- name: 执行需要立即重启服务的顺序配置更新
  hosts: servers
  become: yes
  tasks:
    - name: 更新主配置文件
      copy:
        src: files/primary.conf
        dest: /etc/myapp/primary.conf
      notify:
        - 重启 Myapp

    - name: 刷新 handlers 以立即应用重启
      meta: flush_handlers

    - name: 更新辅助配置文件
      copy:
        src: files/secondary.conf
        dest: /etc/myapp/secondary.conf
      notify:
        - 重启 Myapp

  handlers:
    - name: 重启 Myapp
      service:
        name: myapp
        state: restarted

在这里，第一个配置更改触发了 重启 Myapp，而 meta: flush_handlers 立即运行它。如果后续任务更改了另一个文件，它可以再次通知同一个 handler。

何时寻求专业帮助

当 handler 重启生产数据库、负载均衡器或集群服务时，请请求审查。某些系统需要滚动重启、仲裁检查或排空步骤，这些不应隐藏在简单的 handler 后面。

要点

每当已更改的任务应触发服务重启、重载或守护进程重载时，请使用 Ansible handlers。它们使你的 playbook 保持幂等，减少不必要的重启，并使服务更改更易于推理。