Cómo usar Handlers en Ansible

Los handlers en Ansible son tareas que se ejecutan cuando son notificadas por otras tareas. Se utilizan principalmente para llevar a cabo acciones que deben realizarse solo cuando ocurre un cambio en el sistema, como reiniciar servicios, recargar configuraciones o reiniciar aplicaciones. Los handlers ayudan a mantener la idempotencia y eficiencia de los playbooks, ya que solo se ejecutan cuando es necesario.

¿Qué es un Handler en Ansible?

Un handler es una tarea especial que se activa mediante la directiva notify de otra tarea. Los handlers suelen utilizarse para gestionar servicios y recursos dependientes, como reiniciar nginx después de modificar su archivo de configuración. Si una tarea notifica a un handler y no hubo cambios en esa tarea, el handler no se ejecutará.

¿Cómo funciona un Handler?

El flujo de trabajo de un handler es el siguiente:

1. Una tarea dentro del playbook realiza un cambio (por ejemplo, copia un archivo de configuración).

2. La tarea activa un handler utilizando la directiva notify.

3. Si el cambio ocurre, Ansible ejecuta el handler al final de la ejecución del playbook para garantizar que todas las tareas se completen primero.

Sintaxis y Definición de Handlers

Los handlers se definen de manera similar a las tareas (tasks), pero dentro de una sección handlers. Un ejemplo básico de un playbook con un handler:

Explicación:

1. Tarea copy: Copia un archivo de configuración de Nginx en el servidor de destino.

2. Directiva notify: Notifica al handler llamado Reiniciar Nginx si el archivo se copia (es decir, si hay un cambio).

3. Handler Reiniciar Nginx: Reinicia el servicio de Nginx solo si el archivo nginx.conf ha sido modificado.

Cómo Definir y Usar Handlers en Ansible

1. Definir un Handler

Los handlers se definen en la sección handlers: dentro de un playbook o en un archivo separado (handlers/main.yml) dentro de un rol. La sintaxis es similar a las tareas estándar:

2. Notificar un Handler

Para activar un handler, se utiliza la directiva notify dentro de la tarea correspondiente:

En este caso, si el archivo apache2.conf se actualiza, el handler Reiniciar Apache será notificado y se ejecutará al final de la ejecución del playbook.

3. Múltiples Handlers

Puedes notificar a más de un handler desde la misma tarea:

Aquí, la tarea copy notifica a dos handlers: Reiniciar Servicio de Aplicación y Recargar Firewall.

4. Mismo Handler para múltiples tareas

Varios cambios en diferentes tareas pueden notificar al mismo handler. Si un handler es notificado varias veces, se ejecutará solo una vez:

El handler Reiniciar Nginx solo se ejecutará una vez, al final del playbook, independientemente de cuántas tareas lo hayan notificado.

Ejemplos de Uso de Handlers en Ansible

1. Recargar un servicio tras copiar un archivo

En este ejemplo, si my.cnf se actualiza, el servicio de MySQL se recarga para aplicar la nueva configuración.

2. Reiniciar un servicio al actualizar un paquete

Si el paquete openssh-server se actualiza, se reinicia el servicio SSH para aplicar la nueva versión.

3. Uso de Handlers dentro de Roles

Los handlers dentro de un rol se definen en el archivo handlers/main.yml. Un ejemplo básico de un rol llamado apache:

Estructura del rol:

Archivo tasks/main.yml:

Archivo handlers/main.yml:

En este caso, el rol apache reinicia el servicio de Apache solo si se modifica el archivo de configuración.

Buenas Prácticas para Usar Handlers

1. Usa nombres descriptivos para los handlers, como Reiniciar Apache o Recargar Firewall, en lugar de nombres genéricos.

2. Evita el uso innecesario de handlers para tareas que no requieren un reinicio o recarga.

3. Agrupa tareas similares en un solo handler para evitar reinicios múltiples de servicios.

4. Verifica la idempotencia de las tareas que notifican a handlers. Asegúrate de que las tareas no generen cambios innecesarios.

5. Usa listen en lugar de name en Ansible 2.7 y posteriores. listen permite asociar varios handlers a un solo nombre, mejorando la organización:

Referencia oficial

Para más detalles, consulta la documentación oficial de Ansible sobre Handlers en Ansible Handlers.