Unità 7 / 11

Gestione della documentazione e delle informazioni: runbook, post-mortem e memoria aziendale

Guadagni:

  • Capacità di produrre runbook, documenti post mortem e architettura da note sparse con intelligenza artificiale
  • Capacità di imporre la disciplina di imporre un "divieto di fabbricazione" e di testare e contrassegnare accuratamente ogni runbook in un ambiente reale
  • Capacità di comprendere che un runbook sbagliato è più pericoloso di niente e di mantenere viva la documentazione durante il processo di modifica

Gestione della documentazione e delle informazioni: runbook, architettura e memoria istituzionale con l'intelligenza artificiale

Il compito più trascurato ma salvavita della gestione del sistema è la documentazione. Quando un sistema va in crash e la persona che lo ha costruito è in vacanza e non c'è una parola scritta su come ripristinarlo, è una lunga notte per tutti. La documentazione è la memoria istituzionale che rende scritto e disponibile come è impostato un sistema, come funziona e cosa fare se si verifica un problema. La tipologia più critica di questa memoria è il runbook: una guida operativa che ti dice passo dopo passo cosa fare in una determinata situazione (servizio andato in crash, disco pieno, backup fallito). Qui l'intelligenza artificiale risolve il problema della "pagina bianca" e della "pigrizia", ​​che sono i più grandi nemici della scrittura della documentazione: produce un runbook organizzato dalle tue note sparse, una procedura da una cronologia dei comandi, una descrizione da un'architettura. Ma il principio fondamentale: l’intelligenza artificiale produce progetti e scheletri; Sei tu a testare e convalidare ogni passaggio per verificare se è effettivamente corretto: un runbook sbagliato è più pericoloso dell'assenza totale di runbook.

In questa unità, runbook, post-mortem (rapporto di indagine post-evento), documentazione architetturale e scrittura della knowledge base; Generazione di bozze con l'intelligenza artificiale; e, soprattutto, imparerai i rischi della documentazione non verificata.

Perché il runbook sbagliato è peggiore dell'assenza di runbook?

Questo è il concetto più importante di questa unità. Una squadra senza runbook è cauta e sospettosa in tempi di panico; pensa due volte a ogni comando. Ma qualcuno con un runbook “ufficiale” si fida ciecamente – nel cuore della notte, sotto stress, eseguendo i passaggi senza fare domande. Se il runbook viene rilasciato senza essere prodotto e testato dall'intelligenza artificiale e contiene un passaggio sbagliato (un comando errato, un prerequisito mancante, un passaggio di fallback saltato), il risultato è disastroso. Ecco perché ogni runbook prodotto con l'intelligenza artificiale deve essere eseguito dall'inizio alla fine in un ambiente reale e ogni passaggio deve essere verificato prima di essere pubblicato. Un runbook non testato è come una promessa rassicurante ma vuota.

Attenzione: contrassegnare un runbook con "testato: [data], [persona]". Contrassegna chiaramente le bozze non testate con l'etichetta "BOZZA - NON VERIFICATA". Quindi nessuno applicherebbe in modo sicuro misure non verificate in una crisi reale.

Anatomia di un buon runbook

Un buon runbook è costituito da parti specifiche e l'intelligenza artificiale è brava a costruire quello scheletro: titolo e scopo (per quale situazione), prerequisiti (quale accesso, quale strumento è necessario), sintomi (quando utilizzare questo runbook), passaggi (con comandi numerati e copiabili), convalida (come riconoscere il successo dopo ogni passaggio), rollback (come annullare se un passaggio va male) ed escalation (chi chiamare se non riesco a capirlo). Puoi dare all'IA i tuoi appunti sparsi e chiedergli di inserirli in questa struttura; Garantisci solo l'accuratezza del contenuto.

Passo dopo passo: produzione di documentazione con l'intelligenza artificiale

  1. Raccogli la materia prima. La cronologia dei comandi, gli appunti, una vecchia e-mail, il registro delle chat: il materiale reale, anche se disordinato, è meglio della fabbricazione dell'intelligenza artificiale.
  2. Richiedi la struttura. "Rendi questo un runbook con i seguenti titoli: scopo, prerequisito, sintomo, passaggi, verifica, rollback, escalation."
  3. Divieto di fabbricazione. "Non aggiungere comandi, IP, versioni o passaggi che non ti ho fornito; contrassegna le parti mancanti come [DA RIEMPIRE]." Ciò impedisce l’errore più pericoloso: i passaggi inventati apparentemente plausibili.
  4. Maschera. Utilizza il segnaposto anziché l'host, l'IP e l'utente effettivi; Se il documento è condiviso, il segreto non dovrebbe essere divulgato.
  5. Provalo. Esegui il runbook dall'inizio alla fine in un ambiente reale (preferibilmente di test). Correggi tutti i passaggi che non funzionano, mancano o non sono chiari.
  6. Timbra e pubblica. Aggiungi la data del test, il tester e l'ultimo aggiornamento. La documentazione è vivace; Deve essere aggiornato quando il sistema cambia.

tre mini custodie

Caso 1 — 2 ore di lavoro, 15 minuti. Un amministratore rimandava da mesi la documentazione di una procedura di ripristino del backup. Ha fornito all'IA la cronologia dei comandi del terminale (mascherata) e alcune note sparse e l'ha inserita nel framework del runbook. L'intelligenza artificiale ha prodotto uno schema accurato in 15 minuti. L'amministratore ha trascorso i successivi 45 minuti eseguendo la bozza dall'inizio alla fine su un server di prova e correggendo i due passaggi mancanti. Il risultato: un runbook testato e affidabile.

Caso 2 – Colto in flagrante. Un team ha chiesto all'intelligenza artificiale di scrivere un runbook di riavvio del servizio ma si è dimenticato di vietare la "fabbricazione". YZ ha aggiunto un comando "svuota prima la cache", che sembra logico ma non esiste in quel servizio. Fortunatamente, l'ingegnere ha eseguito il runbook nell'ambiente di test; Quel comando ha dato un errore. La fase di prova ha catturato un passaggio inventato che avrebbe creato confusione in una crisi reale.

Caso 3: Autopsia accelerata. Dopo una grave interruzione, il team aveva bisogno di scrivere un'autopsia, ma nessuno poteva iniziare. Hanno consegnato la cronologia dell’evento e i registri mascherati all’intelligenza artificiale e hanno chiesto uno scheletro post mortem irreprensibile: riepilogo, impatto, sequenza temporale, causa principale, azioni correttive. Il progetto dell'intelligenza artificiale ha ridotto il lavoro di un'ora a dieci minuti; Il team ha dedicato le proprie energie alla verifica dei fatti e al chiarimento delle azioni da intraprendere.

Quattro modelli copiabili

1) Generazione dello scheletro di un runbook:

Il tuo ruolo: SRE senior. Creare un runbook dalle note mascherate/dalla cronologia dei comandi di seguito. Intestazioni: Scopo, Prerequisiti, Sintomi (quando utilizzare), Passaggi (numerati, possono essere copiati), Verifica ad ogni passaggio, Rollback, Escalation. REGOLA: Non inventare nessun comando/IP/versione/passo che non ti do; scrivere le parti mancanti [DA COMPILARE]. Materiale: [nota mascherata]

2) Autopsia senza colpa:

Il tuo ruolo: facilitatore delle indagini sugli incidenti. Scrivere uno schizzo post-mortem SENZA COLPA dalla seguente sequenza temporale mascherata e dai seguenti registri: riepilogo, impatto (durata/ambito), sequenza temporale, causa principale (se verificata), fattori che contribuiscono, azioni correttive (proprietario + priorità). Non incolpare la persona, concentrati sul sistema. Non scrivere la causa principale senza prove. Dati: [...]

3) Descrizione dell'architettura/servizio:

Scrivere un documento di servizio dalle seguenti informazioni mascherate sulla configurazione/diagramma: cosa fa il servizio, in quali componenti è costituito, quali sono le sue dipendenze, come fluiscono i dati, quali porte/protocolli. Mantienilo tecnico ma leggibile. Contrassegna la relazione di cui non sei sicuro come "necessita di verifica". Informazioni: [mascherato]

4) Audit di aggiornamento della documentazione:

Esaminare il seguente documento esistente e verificare la valuta: (1) quali sezioni mancano/oscure, (2) quali passaggi sembrano non testati, (3) quali informazioni potrebbero essere obsolete? Annotare cosa dovrei chiedere/verificare per ciascun risultato. Documento: [documento mascherato]

Prompt debole / Prompt forte

Suggerimento debole:

Scrivimi un runbook di manutenzione del server.

Non c'è materiale reale. L'intelligenza artificiale produce un testo, interamente basato sulla sua conoscenza generale, che non si adatta al tuo ambiente o addirittura contiene passaggi inventati. Questa è una pericolosa fonte di falsa fiducia.

Suggerimento potente:

Il tuo ruolo: SRE senior. Di seguito è riportata la cronologia dei comandi mascherati e le mie note che ho implementato nell'evento "disco servizio di pagamento pieno". Crea un runbook da questi: Scopo, Prerequisito (accesso/strumento), Sintomo, Passaggi numerati (con i miei comandi), Verifica ad ogni passaggio, Rollback, Escalation. Non farmi eseguire un comando che non ho dato; Crea lo spazio vuoto [DA RIEMPIRE]. Metti un avviso "non testato" alla fine. Materiale: [cronologia dei comandi mascherati]

Tipo di documento

Contributo dell'intelligenza artificiale

Contributo obbligatorio dell'uomo

runbook

Scheletro + layout

Test in ambiente reale, precisione

Post mortem

Contorno + struttura

Verificare i fatti e la causa principale

documento architettonico

Descrizione + flusso

Confermare relazioni e dipendenze

Articolo della base di conoscenza

bozza veloce

Controllo dell'attualità e dell'accuratezza

Errori comuni

  • Pubblicazione di runbook non testati. I passaggi non verificati vengono implementati ciecamente in caso di crisi; Un runbook sbagliato è un disastro.
  • Non imporre il divieto di fabbricazione. Se non dici all'IA "non aggiungere ciò che non ho dato", produrrà passaggi ragionevoli ma irrealistici.
  • Saltare il mascheramento. Il segreto viene divulgato quando il documento contenente l'host, l'IP e l'utente reali viene condiviso.
  • Non aggiornare il documento. I documenti che non vengono aggiornati quando il sistema cambia diventa fuorviante nel tempo.
  • Pubblicazione senza timbro. Non è chiaro se un documento senza data e stato di prova sia affidabile o sia una bozza.
Suggerimento: il modo migliore per mantenere la documentazione "attiva" è collegarla al processo di modifica: quando un sistema cambia, lasciare che l'aggiornamento del runbook pertinente sia uno dei criteri di completamento della modifica. L'intelligenza artificiale accelera l'aggiornamento, ma sei tu il processo di attivazione.

In sintesi

La documentazione è memoria istituzionale; Il runbook è una guida operativa che salva vite umane in tempi di crisi. L'intelligenza artificiale produce bozze organizzate dai tuoi appunti disordinati, risolvendo il problema delle pagine bianche e della pigrizia. Ma la verità più importante è questa: un runbook sbagliato è più pericoloso di niente perché viene applicato ciecamente durante una crisi. Quindi vieta all'intelligenza artificiale di "fabbricare", mascherala e testa e timbra accuratamente ogni runbook in un ambiente reale. Mantieni vivo il documento mentre il sistema cambia. L’intelligenza artificiale costruisce il quadro; Sei tu quello che garantisce accuratezza e test.

Compito dell'applicazione

Scegli una procedura che non sia documentata nel tuo team (ad esempio, riavviare un servizio o ripristinare un backup). Maschera la cronologia dei comandi e le note pertinenti e chiedi all'IA di creare una bozza utilizzando il modello "Generazione scheletro runbook" sopra; Assicurati di imporre un divieto di fabbricazione. Esegui la bozza in un ambiente di test e contrassegna e correggi eventuali passaggi interrotti/mancanti. Aggiungere la data del test e le informazioni sul tester al runbook. Annota le differenze prodotte dall'intelligenza artificiale e correggi nel processo in 5 elementi.

lista di controllo

  • [ ] Ho creato il runbook da materiale reale (nota, cronologia dei comandi), non l'ho inventato da zero?
  • [ ] Ho vietato all'IA di "aggiungere comandi/IP/passaggi che non ho fornito"?
  • [ ] Ho mascherato informazioni sensibili come host, IP e utente?
  • [ ] Ho eseguito e convalidato il runbook in un ambiente reale/di test?
  • [ ] Ho aggiunto la data del test, il tester e le informazioni sull'ultimo aggiornamento?
  • [ ] Ho pianificato di collegare il documento al processo di modifica del sistema e di mantenerlo aggiornato?