O que é runbook
Runbook é o roteiro que descreve como executar uma tarefa operacional ou responder a um incidente. Ele reúne os passos, os comandos e o resultado esperado de cada etapa.
O roteiro é feito para ser seguido durante a urgência. Por isso, a sequência precisa ser curta e a verificação precisa aparecer logo depois do comando.
O que um runbook contém
O início informa o pré-requisito, o acesso necessário e o efeito esperado. O meio traz a sequência de comandos, com o resultado que confirma cada passo.
O fim indica a verificação e o que fazer quando um passo falha. Também registra o responsável pela manutenção do roteiro e a data da última execução.
O que ele não é
O runbook não substitui a documentação de arquitetura nem o postmortem. Ele é operacional, e a explicação do sistema fica em outro documento.
Um roteiro longo demais perde utilidade. Quando a tarefa exige muitos desvios, o caminho é separar o procedimento comum e tratar a exceção em uma seção própria.
Exemplo
Como conferir
Execute o roteiro em staging e compare o resultado com o esperado. Confira os comandos, o tempo de cada etapa e o caminho de retorno. Atualize o texto quando o sistema mudar.
O log confirma o que aconteceu durante a execução. O monitoramento mostra o efeito depois da mudança, e o roteiro fecha o ciclo entre a ação e a verificação.
Dúvidas frequentes
Perguntas frequentes sobre Runbook
- Runbook é a mesma coisa que documentação de arquitetura?
- Não. A documentação de arquitetura explica como o sistema é. O runbook explica o que fazer em uma tarefa ou em uma falha, com passos e verificação.
- Todo procedimento precisa de runbook?
- Os procedimentos repetidos e os que exigem resposta rápida ganham mais com o roteiro. Uma tarefa executada uma vez pode ficar em uma nota curta.
- Como manter o runbook atualizado?
- Execute o roteiro depois de cada mudança no sistema. O passo que não funciona é corrigido na hora, e a data da última execução fica registrada.
- O runbook dispensa a experiência acumulada?
- Não. Ele reduz a dependência de memória e encurta o tempo de resposta. A leitura do caso continua necessária quando o comportamento foge do previsto.
Para continuar
Recursos relacionados
Site de referência
Wikipedia: runbook
Apresenta o conceito e o uso do roteiro na operação de sistemas.
Abrir recursoDocumentação
Google SRE: estar de plantão
Descreve a preparação e os recursos usados durante o plantão.
Abrir recursoAplicação na formação
Formação DevOps
Na Formação DevOps, o runbook aparece no deploy, na rotação de backup e na resposta a um serviço fora do ar.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.