Dokumentacja infrastruktury IT: co musi w niej być

Dokumentacja infrastruktury IT ma dokładnie jeden test jakości: czy osoba, która jej nie pisała, odtworzy z niej działającą usługę. Spis sprzętu tego testu nie przechodzi. Opisywaliśmy już sytuację, w której odchodzi jedyny administrator, i to właśnie wtedy okazuje się, ile z tej wiedzy było zapisane.

Sześć rzeczy, bez których to nie działa

Spis usług, nie tylko sprzętu. Serwer to nośnik. Liczy się lista tego, co na nim działa, kto z tego korzysta i co się stanie, gdy przestanie. Bez tej warstwy nie da się ustalić kolejności odtwarzania po awarii.

Schemat sieci z adresacją. Jakie adresy, jakie sieci, co gdzie wychodzi na zewnątrz, gdzie kończy się Twoja odpowiedzialność, a zaczyna dostawcy. Rysunek na kartce jest lepszy niż jego brak.

Mapa dostępów. Kto ma dostęp do czego i jakim sposobem: panel dostawcy, konsola zarządzania, konta systemowe, klucze. Ważniejsze od samych haseł jest to, gdzie one są przechowywane i kto może je odzyskać.

Procedura odtworzenia. Krok po kroku, od czystej maszyny do działającej usługi, z miejscem, z którego bierzesz kopię. To jedyna część dokumentacji, która ratuje sytuację w nocy.

Zależności zewnętrzne. Domeny, certyfikaty, licencje, integracje i daty ich wygaśnięcia. Usługa odtworzona bez ważnego certyfikatu nadal nie działa.

Kontakty i umowy. Numer do wsparcia dostawcy, numer umowy, zakres odpowiedzialności, ustalone czasy reakcji. Szukanie tego w skrzynce pocztowej w trakcie awarii kosztuje godziny.

Procedura odtworzenia jest ważniejsza niż schemat

Schematy sieci starzeją się wolno i są przyjemne do rysowania, więc powstają najczęściej. Procedury odtworzenia starzeją się szybko i pisze się je niechętnie, a to one decydują o czasie przestoju.

Dobra procedura zawiera trzy rzeczy, których zwykle brakuje: skąd dokładnie wziąć kopię, jak zweryfikować, że odtworzona usługa faktycznie działa, oraz ile całość zajmuje. Ostatni punkt jest wartością, którą można pokazać zarządowi, i jednocześnie liczbą, którą porównujesz z tym, co obiecałeś klientom.

Gdzie to trzymać

Dokumentacja opisująca, jak odtworzyć serwer, nie może leżeć wyłącznie na tym serwerze. Podobnie mapa dostępów w narzędziu, do którego dostęp wymaga działającej infrastruktury.

Sprawdza się prosty układ: podstawowe miejsce w systemie, którego używacie na co dzień, oraz kopia w innej formie i w innym miejscu, wystarczająca do uruchomienia odtwarzania. Warto też mieć wersję papierową albo lokalną najkrótszej ścieżki awaryjnej, obejmującej numery telefonów i sposób odzyskania dostępu.

Jak utrzymać to w aktualności

Dokumentacja nieaktualna jest gorsza od żadnej, bo prowadzi w złą stronę z pełnym przekonaniem. Osobny projekt „uporządkujmy dokumentację" kończy się zwykle jednorazowym zrywem.

Działa natomiast przypięcie aktualizacji do zdarzeń, które i tak zachodzą. Zmiana wchodzi w oknie serwisowym, więc opis zmieniasz w tym samym oknie. Nowa usługa rusza dopiero wtedy, gdy ma wpis w spisie. Raz na kwartał ktoś przechodzi procedurę odtworzenia i poprawia to, co się nie zgadza.

Część, która leży po stronie dostawcy

Przy usługach z centrum danych warto spisać także granicę odpowiedzialności, bo to ona wyznacza, do kogo dzwonisz. W kolokacji SDC dostęp fizyczny do serwera odbywa się w asyście specjalisty, a dostęp serwisowy działa w trybie 24/7/365 (źródło: sprintdatacenter.pl/kolokacja-serwerow-w-sdc). Jeśli utrzymanie systemu jest kupione na zewnątrz, w dokumentacji powinien znaleźć się zakres i deklarowany czas reakcji. W pakietach administracyjnych warianty Small Business i Full Business mają zadeklarowany czas reakcji 1 godziny (źródło: sprintdatacenter.pl/pakiety-administracyjne).

Podsumowanie

Zacznij od procedury odtworzenia jednej najważniejszej usługi i mapy dostępów, a resztę dopisuj przy okazji zmian. Dokumentacja, którą aktualizujesz przy każdym oknie serwisowym, nie wymaga potem osobnego projektu.

Planujesz infrastrukturę, którą da się przekazać innej osobie bez tygodnia wdrożenia? Zobacz ofertę serwerów dedykowanych lub napisz do nas.

FAQ – najczęściej zadawane pytania o dokumentację infrastruktury

Od czego zacząć, gdy nie ma żadnej dokumentacji?

Od spisu usług i procedury odtworzenia tej jednej, bez której firma nie pracuje. To zwykle jeden dzień pracy, a pokrywa największą część ryzyka. Schematy i szczegóły konfiguracji dopisujesz później, przy okazji zmian.

W jakim narzędziu prowadzić dokumentację?

W takim, do którego zespół już zagląda. Wewnętrzna baza wiedzy, repozytorium albo współdzielony dysk sprawdzają się lepiej niż dedykowany system, którego nikt nie otwiera. Warunkiem jest kopia dostępna wtedy, gdy podstawowe narzędzie nie działa.

Czy hasła powinny być w dokumentacji?

Nie w samym dokumencie. W dokumentacji zapisuje się, gdzie poświadczenia są przechowywane i kto ma do nich dostęp, a same hasła trzymane są w menedżerze haseł. Procedura odzyskania dostępu do tego menedżera powinna być opisana osobno i znana więcej niż jednej osobie.

Jak często weryfikować procedurę odtworzenia?

Raz na kwartał dla najważniejszych usług, a poza tym po każdej większej zmianie w architekturze. Weryfikacja polega na przejściu procedury, a nie na jej przeczytaniu. Dopiero wtedy widać kroki, które przestały pasować do rzeczywistości.

Artykuł powstał z wykorzystaniem narzędzi sztucznej inteligencji (AI) pod nadzorem zespołu Sprint Data Center. Grafika ilustracyjna została wygenerowana przez AI.