Webinar: Jak Flowmon może pomóc administratorom w tych trudnych czasach?
Dokumentacja IT w monitoringu infastruktury
O op5 Monitor
op5 Monitor jest rozwiązaniem monitoringu infrastruktury teleinformatycznej zbudowanym w oparciu o Nagiosa. Rozszerza jego funkcjonalność o intuicyjny interfejs użytkownika, wizualizację sieci, monitoring wydajności, REST API, generowanie bogatych i przejrzystych raportów, a także kładzie duży nacisk na skalowalność środowiska. Jednym z modułów uzupełniających system jest DokuWiki.
O DokuWiki
DokuWiki jest prostą w użyciu i bardzo wszechstronną platformą do tworzenia własnej „Wiki”. Cechują ją czytelna składnia, proste utrzymanie i tworzenie kopii, niskie wymagania i duża ilość rozszerzeń a tym samym łatwość dostosowania do potrzeb.
Integracja op5 Monitor i DokuWiki
Zintegrowanie Wiki w narzędzie op5 ma szerokie spektrum zastosowań. Nie tylko tworzenie dokumentacji poszczególnych środowisk, ale począwszy od pomagania w zrozumieniu historii pewnych problemów, poprzez przekazywanie danych kontaktowych do ludzi odpowiedzialnych za pewne usługi do tworzenia instrukcji postępowania w sytuacji awarii. Naturą Wiki w op5 Monitorze jest stale aktualizowany, szybki dostęp do niezbędnych informacji, co pomaga tobie i osobom z twojej organizacji zaoszczędzić czas.
Dostęp z poziomu op5 uzyskuje się wprowadzając do konfiguracji danych elementów systemu monitoringu „notes_url”:
[/vc_column_text]
Użycie przycisku „Use wiki” automatycznie uzupełnia pole. Po zapisaniu konfiguracji w przypadku hostów i serwisów pojawi się dodatkowy odnośnik kierujący do Wiki:
Dla pozostałych elementów systemu, takich jak host-grupy czy serwis-grupy odnośnik taki można dodać samemu. W przypadku, gdy mamy na pulpicie („dashboard”) widżet „listview” wyświetlający wszystkie host-grupy można do niego dodać nową kolumnę, w której będzie się on znajdował:
“DokuWiki” = “<a href=\”/dokuwiki/doku.php/hostgroups/” + urlencode(name) + “\”><span class=\”icon-16 x16-host-notes\” title=\”DokuWiki\”></span></a>”
Interfejs DokuWiki
Jako, że Wiki cechuje się prostotą interfejs użytkownika nie jest skomplikowany. W panelu bocznym dostępna jest mapa serwisu z odnośnikami do poszczególnych artykułów (tych, które są nam udostępnione), lista ostatnich zmian a także panel administratora. Po prawej stronie od góry znajduje się wyszukiwarka a także przyciski do modyfikacji strony jak i link do zarządzania historią wersji artykułu.
Po kliknięciu w odnośnik kierujący z op5 Monitor do Wiki po raz pierwszy przenosimy się na stronę, która najprawdopodobniej jeszcze nie istnieje:
Dopiero w tym momencie, jeśli mamy dostęp do modyfikowania zawartości poprzez kliknięcie w „Create this page” przechodzimy do kreatora dokumentu.
Wykorzystuje się w nim specjalną składnię będącą językiem znaczników. Nie jest ona skomplikowana, ale stosunkowo obszerna, dlatego przed rozpoczęciem tworzenia dokumentu warto się z nią zapoznać: https://www.dokuwiki.org/wiki:syntax.
Da się uzyskać również dodatkowe efekty ponad składnie opisaną w powyższym linku (np. kolorowanie tekstu itp.) poprzez zawarcie kodu HTML czy nawet PHP w treści pisanego dokumentu. Trzeba mieć oczywiście na uwadze wszelkie niebezpieczeństwa z ich wykorzystania wynikające – przez to parsowane ich składni jest standardowo wyłączone, gdy administrator może nie wyraża na to zgody.
Trzeba też wspomnieć o zakładce „Old revisions”, która kryje historię zmian i poprzednie wersje danego dokumentu, dzięki czemu można łatwo śledzić zmiany zachodzące dla na przykład danego środowiska jak i przywrócić w razie potrzeby poprzednią wersję wpisu. W celu przywrócenia, należy wyświetlić starszą wersję a następnie przejść do „Edit this page” i kliknąć „save”.
Rozszerzanie funkcji DokuWiki
Istnieje możliwość dodania dodatkowej ponad podstawową funkcjonalności w Wiki poprzez instalowanie rozszerzeń. W zakładce „Admin” -> „Menage plugins” można bezpośrednio pobrać rozszerzenie jak i zarządzać obecnymi.
Może się zdarzyć, że pobierana wtyczka nie jest w pełni kompatybilna z używaną wersją DokuWiki – bardzo pomocne w diagnozowaniu problemów jest przejrzenie logów Apache „ssl_error_log”.
Przydatnym dodatkiem może być możliwość generowania plików PDF na podstawie stworzonych dokumentów. Tę funkcjonalność daje dodatek DW2PDF (https://www.dokuwiki.org/plugin:dw2pdf). By go uruchomić po zainstalowaniu należy w pliku „renderer.php” (znajdującym się w katalogu wtyczki) po linii zawierającej:
if (!defined(‘DOKU_INC’)) die();
Dodać
require_once (DOKU_INC.’inc/parser/xhtml.php’);
Następnie wg instrukcji zawartej na stronie podanej wyżej do pliku „dokuwiki/lib/tpl/op5-lilas/main.php” dopisać kod w dogodnym dla siebie miejscu odpowiadający za ikonkę lub wpis, po naciśnięciu, którego generowany będzie plik PDF. Np.:
lub
Chociaż generowanie PDF to jeden z najpopularniejszych dodatków, dostępne są również takie generujące pliki ODT czy LaTeX, dodatki, które rozszerzają istniejącą składnię o np. kolorowanie tekstu bez potrzeby do uciekania się do pisania kodu HTML (wspomnianego wyżej), czy też takie, dzięki którym można mieć sekcje komentarzy pod artykułami.
Podsumowując
Uzupełnienie op5 Monitor o miejsce dla tworzenia dokumentacji, usprawnienia wymiany informacji, tworzenia historii rozwiązanych problemów wydaje się być oczywistą sprawą – korzystanie z tego rozwiązania już nie. Mimo wygody, jaką daje DokuWiki wiele osób pracujących z op5 nie jest świadomych istnienia tego rozwiązania czy też zwyczajnie go nie używa.
Inne wpisy