Capítulo 16 — Documentação técnica e segurança
Mapa da aula
Aula 16 publicada. Mapa, exemplo, EX046.
flowchart TD
N0["16.1 Runbooks"]
N1["16.2 Linhas de base"]
N2["16.3 Segurança e autorização"]
N3["16.4 Mantendo os documentos atualizados"]
N4["16.5 Caso resolvido"]
N5["16.6 Atividade prática"]
N6["16.7 Escrevendo para o turno da noite"]
N7["16.9 Compartilhando a documentação"]
N0 --> N1 --> N2 --> N3 --> N4 --> N5 --> N6 --> N7
N7 --> EX["Exemplo resolvido"]
EX --> Q["Exercício EX046"]
Desenho lógico
flowchart LR
N0["16.1 Runbooks"]
N1["16.2 Linhas de base"]
N2["16.3 Segurança e autorização"]
N3["16.4 Mantendo os documentos atualizados"]
N4["16.5 Caso resolvido"]
N5["16.6 Atividade prática"]
N6["16.7 Escrevendo para o turno da noite"]
N7["16.9 Compartilhando a documentação"]
N0 --> N1 --> N2 --> N3 --> N4 --> N5 --> N6 --> N7 --> Q["EX046"]
[16.1 Runbooks]
|
v
[16.2 Linhas de base]
|
v
[16.3 Segurança e autorização]
|
v
[16.4 Mantendo os documentos atualizados]
|
v
[16.5 Caso resolvido]
|
v
[16.6 Atividade prática]
|
v
[16.7 Escrevendo para o turno da noite]
|
v
[16.9 Compartilhando a documentação]
|
v
[Exemplo resolvido] --> [Exercício EX046]
Objetivos de aprendizagem
Você vai (1) escrever runbooks para as operações pós-quânticas; (2) documentar linhas de base de configuração; (3) seguir as regras de segurança e de autorização; e (4) manter a documentação atualizada.
16.1 Runbooks
Um runbook diz: quando usá-lo (sintomas), o que verificar, as ações seguras, a reversão, como confirmar, a quem ligar. Escreva runbooks para quedas da proporção híbrida, timeouts de handshakes grandes, ausência de grupo compartilhado e erros de verificação de certificado.
No HHG, o runbook de queda da proporção híbrida é um exemplo. Mantenha cada runbook curto o bastante para ser seguido durante uma indisponibilidade e teste-o no laboratório antes de confiar nele. Nomeie um responsável por cada runbook e a data da última revisão. Vincule cada um aos alertas que devem acioná-lo.
16.2 Linhas de base
Uma linha de base de configuração lista as configurações aprovadas para cada tipo de serviço: versões do TLS, grupos e ordem, KexAlgorithms do SSH, tipos de certificado, campos de log. Guarde-a sob controle de versão; as mudanças passam por revisão.
No HHG, a linha de base contém a ordem de grupos aprovada X25519MLKEM768:X25519:secp256r1 para o TLS e o KexAlgorithms com o híbrido primeiro para o SSH. A reversão da API de reservas a usou. Compare regularmente as configurações em execução com a linha de base e trate qualquer diferença como constatação. Registre cada mudança na linha de base com o seu motivo.
16.3 Segurança e autorização
Nunca execute testes ativos em produção sem aprovação por escrito; nunca tente forçar downgrades fora do laboratório isolado; nunca manuseie chaves fora das ferramentas aprovadas; comunique imediatamente chaves expostas. Rotule os dados sintéticos como tal em todos os documentos e materiais de treinamento.
No HHG, os testes de falha de tamanho foram feitos no laboratório isolado, não no firewall de produção do Summit. Se uma tarefa parecer exigir um teste ativo em produção, pare e peça primeiro a aprovação por escrito, e guarde a aprovação com as evidências. Comunique abertamente as violações dessas regras.
16.4 Mantendo os documentos atualizados
Revise os runbooks após cada incidente e cada mudança importante. Coloque no topo a data da "última revisão" e o responsável. Remova os passos que não se aplicam mais.
No HHG, o incidente do Summit deve levar a uma revisão do runbook de handshakes grandes. Registre cada mudança com um motivo, para que os leitores saibam por que um passo existe. Um documento que ninguém revisou por um ano deve ser tratado como pouco confiável até ser verificado. Atribua cada revisão a um responsável nomeado e registre a data em que foi feita.
16.5 Caso resolvido
Runbook do HHG "Queda da proporção híbrida num serviço TLS": sintomas — alerta do painel, proporção híbrida abaixo de 50 %; verificações — última mudança no serviço, perfil TLS atual versus a linha de base; ações — reaplicar o perfil da linha de base no listener afetado; reversão — perfil anterior do controle de versão; confirmação — a proporção híbrida se recupera em até 30 minutos; contatos — plantão do Web Ops, depois o líder de plataforma. Última revisão em 2 de outubro; responsável: Web Ops.
O runbook está completo: cada parte responde, em ordem, a uma pergunta que o operador de plantão terá. A confirmação em 30 minutos dá um ponto de parada claro.
16.6 Atividade prática
Escreva um runbook para "Nenhum grupo compartilhado no SFTP" usando o formato acima.
Use os mesmos títulos: sintomas, verificações, ações, reversão, confirmação e a quem ligar. Baseie as verificações no que você aprendeu: o KexAlgorithms do servidor contra a linha de base, a versão do cliente e a última mudança. Mantenha a ação estreita, por exemplo restaurar o fallback clássico apenas no servidor SFTP. Acrescente um responsável e uma data de revisão, e teste o runbook no laboratório antes de entregá-lo. Peça a um colega que o siga.
16.7 Escrevendo para o turno da noite
Os runbooks são lidos sob pressão, muitas vezes à noite. Use passos curtos e numerados, comandos exatos, saídas esperadas e pontos de parada claros ("se a proporção não tiver se recuperado após o passo 4, ligue para o líder de plataforma"). Evite explicações longas nos passos; vincule o contexto em outro lugar.
No HHG, o runbook de queda da proporção híbrida informa o ponto de confirmação de 30 minutos e nomeia a quem ligar em seguida. Teste cada runbook com alguém que não o escreveu, de preferência no laboratório ao fim de um turno, e corrija qualquer passo que tenha feito a pessoa hesitar.
16.8 Erros comuns e limites
- Runbooks sem reversão.
- Linhas de base guardadas apenas na cabeça de alguém.
- Documentos desatualizados.
Cada erro deixa a equipe exposta. Um runbook sem reversão deixa o operador de plantão sem saída quando uma correção falha. Uma linha de base guardada na cabeça de alguém desaparece quando a pessoa está ausente, e as configurações se desviam. Um documento desatualizado pode levar as pessoas a passos que não funcionam mais ou são inseguros. Confira cada runbook e cada linha de base quanto aos três a cada revisão. Corrija o que encontrar. Registre quando cada um foi verificado pela última vez e por quem.
16.9 Compartilhando a documentação
Guarde os runbooks e as linhas de base onde a equipe de plantão consiga alcançá-los durante uma indisponibilidade — não apenas num sistema que possa ele mesmo estar fora do ar. Muitas equipes mantêm uma cópia somente leitura num segundo local. Marque os documentos que contêm detalhes sensíveis de configuração e restrinja-os de acordo, mantendo os procedimentos gerais amplamente legíveis.
Revise o acesso aos documentos restritos quando as pessoas mudarem de função. No HHG, o runbook de queda da proporção híbrida seria necessário durante uma indisponibilidade do balanceador de carga, então uma cópia precisa ser alcançável sem ele. Teste o acesso ao segundo local duas vezes por ano.
Exercícios
- EX046 — Runbook. Escreva o runbook de "nenhum grupo compartilhado". Rubrica: 3 = sintomas, verificações, ações, reversão, confirmação, contatos.
- EX047 — Linha de base. Liste cinco itens de uma linha de base de TLS. Rubrica: 3 = versões, grupos/ordem, tipos de certificado, log, suítes de cifras.
- EX048 — Regra de segurança. Explique por que os testes de downgrade pertencem apenas ao laboratório. Rubrica: 3 = risco para as sessões de produção, autorização.
Síntese
Runbooks, linhas de base e regras de segurança transformam a habilidade individual em operações confiáveis da equipe; os documentos só continuam úteis quando têm responsável e são revisados.
Continue estudando — capítulo 16 de 18
← Capítulo 15 · Índice de capítulos do curso · Capítulo 17 →
Siga para a próxima lição escrita.