OPS07-BP03 Uso de runbooks para realizar los procedimientos
Un runbook es un proceso documentado para lograr un resultado específico. Los runbooks consisten en una serie de pasos que alguien sigue para conseguir algo. Los runbooks se han utilizado en operaciones que se remontan a los primeros días de la aviación. En las operaciones en la nube, utilizamos runbooks para reducir el riesgo y lograr los resultados deseados. En su forma más simple, un runbook es una lista de verificación para completar una tarea.
Los runbooks son una parte esencial del funcionamiento de su carga de trabajo. Desde la incorporación de un nuevo miembro del equipo hasta el despliegue de una versión importante, los runbooks son los procesos codificados que proporcionan resultados coherentes independientemente de quién los utilice. Los runbooks deben publicarse en una ubicación central y actualizarse a medida que el proceso evolucione, ya que la actualización de los runbooks es un componente clave de un proceso de administración de cambios. También deben incluir directrices sobre la gestión de errores, las herramientas, los permisos, las excepciones y las escalaciones en caso de que se produzca un problema.
A medida que su organización madure, comience a automatizar los runbooks. Comience con runbooks que sean cortos y se utilicen con frecuencia. Utilice lenguajes de scripting para automatizar pasos o facilitar su realización. A medida que automatice los primeros runbooks, dedicará tiempo a automatizar runbooks más complejos. Con el tiempo, la mayoría de sus runbooks deberían estar automatizados de alguna manera.
Resultado deseado: Su equipo dispone de una colección de guías paso a paso para realizar las tareas de la carga de trabajo. Los runbooks contienen el resultado deseado, las herramientas y los permisos necesarios, y las instrucciones para la gestión de errores. Se almacenan en una ubicación central y se actualizan con frecuencia.
Patrones comunes de uso no recomendados:
-
Depender de la memoria para completar cada paso de un proceso.
-
Desplegar manualmente los cambios sin una lista de verificación.
-
Diferentes miembros del equipo realizan el mismo proceso pero con diferentes pasos o resultados.
-
Dejar que los runbooks se desincronicen con los cambios del sistema y la automatización.
Beneficios de establecer esta práctica recomendada:
-
Reducción de los índices de error en las tareas manuales.
-
Las operaciones se realizan de forma coherente.
-
Los nuevos miembros del equipo pueden empezar a realizar tareas antes.
-
Los runbooks pueden automatizarse para reducir el trabajo.
Nivel de riesgo expuesto si no se establece esta práctica recomendada: Medio
Guía para la implementación
Los runbooks pueden adoptar varias formas en función del nivel de madurez de su organización. Como mínimo, deben consistir en un documento de texto paso a paso. El resultado deseado debe indicarse claramente. Documente claramente los permisos o herramientas especiales necesarios. Proporcione directrices detalladas sobre la gestión de errores y las escalaciones en caso de que algo vaya mal. Indique el propietario del runbook y publíquelo en una ubicación central. Una vez que el runbook esté documentado, valídelo haciendo que otra persona de su equipo lo ejecute. A medida que los procedimientos evolucionen, actualice sus runbooks de acuerdo con su proceso de administración de cambios.
Sus runbooks deben automatizarse a medida que su organización madura. Con servicios como las automatizaciones de AWS Systems Manager, puede transformar un texto plano en automatizaciones que pueden ejecutarse contra su carga de trabajo. Estas automatizaciones pueden ejecutarse en respuesta a eventos, reduciendo la carga operativa para mantener su carga de trabajo.
Ejemplo de cliente
AnyCompany Retail debe realizar actualizaciones del esquema de la base de datos durante despliegues de software. El equipo de operaciones en la nube trabajó con el equipo de administración de bases de datos para crear un runbook para desplegar manualmente estos cambios. El runbook enumeraba cada paso del proceso en forma de lista de verificación. Incluía una sección sobre la gestión de errores en caso de que algo saliera mal. Publicaron el runbook en su wiki interna junto con sus otros runbooks. El equipo de operaciones en la nube tiene previsto automatizar el runbook en un futuro sprint.
Pasos para la aplicación
Si no tiene un repositorio de documentos, un repositorio de control de versiones es un buen lugar para empezar a crear su biblioteca de runbooks. Puede crear sus runbooks usando Markdown. Hemos proporcionado una plantilla de runbook de ejemplo que puede utilizar para empezar a crear runbooks.
# Runbook Title ## Runbook Info | Runbook ID | Description | Tools Used | Special Permissions | Runbook Author | Last Updated | Escalation POC | |-------|-------|-------|-------|-------|-------|-------| | RUN001 | What is this runbook for? What is the desired outcome? | Tools | Permissions | Your Name | 2022-09-21 | Escalation Name | ## Steps 1. Step one 2. Step two
-
Si no tiene un repositorio de documentación o un wiki, cree un nuevo repositorio de control de versiones en su sistema de control de versiones.
-
Identifique un proceso que no tenga un runbook. Un proceso ideal es aquel que se lleva a cabo de forma semirregular, es corto en número de pasos y tiene errores de bajo impacto.
-
En su repositorio de documentos, cree un nuevo borrador de documento Markdown utilizando la plantilla. Introduzca
Runbook Title
y los campos necesarios enRunbook Info
. -
Empezando por el primer paso, rellene la parte
Steps
del runbook. -
Asigne el runbook a un miembro del equipo. Pídales que utilicen el runbook para validar los pasos. Si falta algo o hay que aclararlo, actualice el runbook.
-
Publique el runbook en su almacén de documentación interno. Una vez publicado, comuníquelo a su equipo y a otras partes interesadas.
-
Con el tiempo, creará una biblioteca de runbooks. A medida que esa biblioteca crezca, comience a trabajar para automatizar los runbooks.
Nivel de esfuerzo para el plan de implementación: Bajo El estándar mínimo para un runbook es una guía de texto paso a paso. La automatización de runbooks puede aumentar el esfuerzo de implementación.
Recursos
Prácticas recomendadas relacionadas:
-
OPS02-BP02 Los procesos y procedimientos han identificado a los propietarios: los runbooks deben tener un propietario encargado de su mantenimiento.
-
OPS07-BP04 Usar guías de estrategias para investigar problemas: los runbooks y guías de categorías son semejantes pero tienen una diferencia clave y es que un runbook tiene un resultado deseado. En muchos casos los runbooks se activan una vez que una guía de categorías ha identificado una causa raíz.
-
OPS10-BP01 Uso de un proceso para la administración de eventos, incidentes y problemas: los runbooks forman parte de una buena práctica de gestión de eventos, incidentes y problemas.
-
OPS10-BP02 Tener un proceso por alerta: los runbooks y las guías de categorías deben usarse como respuesta a alertas. Con el tiempo, estas reacciones deberían automatizarse.
-
OPS11-BP04 Realizar la administración de conocimientos: el mantenimiento de los runbooks es una parte fundamental de la administración de conocimientos.
Documentos relacionados:
Vídeos relacionados:
Ejemplos relacionados:
Servicios relacionados: