STRUKTUROVANÁ ICT DOKUMENTACE - CMDB

 

  Pro udržení přehledu nad ICT infrastrukturou je podle mého názoru nezbytná kvalitní dokumentace. Proti tomu však stojí, že právě na pořádnou dokumentaci již v projektu nezbývá čas, protože pokud vše začne fungovat, tak se začne pracovat na projektu novém. Toto nás, ale vždy doběhne a býval to i můj případ. Výsledkem pak je, že pokud není daná infrastruktura dobře zdokumentovaná hned na začátku, tak s postupem času pak mnohem obtížněji dohledáváte případné souvislosti nad tímto systémem. Jak z toho ven?

 

  Pro tento účel je vhodné sestavit tzv. konfigurační databázi (CMDB), která obsahuje potřebné informace. Možná si někteří z vás řeknou "co, jakou databázi, to musím mít na to nějaký systém". Ne ne, není potřeba v tom hledat nějakou vědu. Ano samozřejmně existují již vytvořené nástroje/systémy, které splňují nepřísnější kritéria konfigurační databáze. Já si však myslím, že to není až tak úplně potřeba mít nějaký sotisfikovaný systém. Uvedu zde takový malý příklad jak to řeším já a ve většině případů to je pro mě dostačující.

Základem mé konfigurační databáze k zajištění přehledu nad ICT infrastrukturou jsou následující témata:

  • definice obsahu dokumentace
  • definice templatu dokumentu
  • návrh formy obsahu dokumentů
  • definice sekcí dokumentů (kategorizace)
  • princip ukládání dokumentace do CMDB

Vycházel jsem z best practice, ITILu a vlastní zkušenosti.

Definice obsahu dokumentace:

SLA / OLA / Contracts

  • smlouva o dostupnosti služby, servisní smlouvy a
    kontakty s 3rd partnery, smluvní podmínky, rozsah podpory

DR

  • postupy jak se chovat v jednotlivých režimech DR procesu
  • definice úrovně DR procesu
  • testování, postupy, pravidelnost testů
  • akceptační protokoly
  • postupy
  • seznam lidí, kterých se DR proces týká, kontakty
  • emergency plán

BACKUP

  • backup joby/scripty/crony
  • popis
  • operační procesy
  • testy obnovy/perioda
  • strategie zálohování dané služby

MONITORING

  • co se monitoruje (jaké hodnoty, trasholds, atd..), čím a jak
  • výstupy/reporting, eskalace
  • performance analýzy/podklady pro kapacity management

TOPOLOGY

  • nákres stávajícího stavu (schéma, diagram)
  • parametry (nodesů a spojů)

HW

  • typy
  • parametry/konfigurace/nastavení/firmaware verze
  • odkaz na servisní smlouvy, maitenance, licence
  • přístupová jména a hesla do HW konzolí, apod...
  • připojit externí dokumentaci

SW - DSL

  • všechny použité software
  • parametry/konfigurace/nastavení/verze, dokumentace
  • odkaz na servisní smlouvy, maintenance, licence
  • přístupová jména a hesla do systémů, remote konzolí, atd...
  • fyzické umístění instalačních médií
  • instalační postup
  • připojit externí dokumentaci

 

Definice template dokumentu

Template dokumentu závisí na použitém softwárovém vybavení, který pro správu dokumentace použijeme. Jednou s možností může být template v programech MS Office či jednotný vzhled stránky v programu pro správu dokumentace.

Já jsem se ve své praxi setkal s několika řešeními systému dokumentace. Uvedu zde možné příklady:

Souborové:

Varianta 1:

  • Vytvoření adresářové struktury dle níže uvedené kategorizace
  • Naplnění adresářů obsahem dle kategorizace

 

Varianta 2:

  • Předpřipravené template v MS Word s atributy (souhrnné informace,hlavička dokumentu, definice fontů, „aktivní“ obsah dokumentu, číslování a jmenná konvence)
  • Systém pro ukládání dokumentů v systému MS SharePoint services

 

Aplikační:

  • Systém DokuWiki nebo MediaWiki
  • Systém Confluence

 

Definice sekcí dokumentů (kategorizace)

ICT Infrastructure strukturovana dokumentace kategorizace

Díky takto vedené dokumentaci je možné celkem jednoduše získat podklady pro případné vytvoření katalogu služeb o kterém se zmíním v nějakém článku příště. Tak se můžete těšit.