Zanim zaczniesz
- Lista osób, które będą czytać, edytować i administrować wiki.
- Dokumentacja wybranej wiki i jej zamierzonej wersji.
- Miejsce na notatki operacyjne oraz osobna, kontrolowana lokalizacja na dane uwierzytelniające do odtwarzania.
1. Opisz zadanie, które będzie pełnić wiki.
Zacznij od jednego zdania: „Członkowie używają tej wiki, aby znaleźć aktualne instrukcje prowadzenia naszego wspólnego warsztatu”. Ten przykładowy cel jest węższy niż „umieść wszystko online”. Sugeruje możliwy do opanowania pierwszy zbiór: procedury otwierania, notatki o sprzęcie i decyzje z zebrań. Prywatne dane kontaktowe i dane uwierzytelniające wymagają osobnych decyzji; wygodne pole wyszukiwania nie jest powodem, by je gromadzić.
Wypisz, co czytelnik musi osiągnąć, na przykład znaleźć najnowszą procedurę, otworzyć wskazany diagram i wiedzieć, kto odpowiada za nieaktualną stronę. Wybierz małą próbkę rzeczywistej treści, aby później ocenić aplikację. Nie wnioskuj o wymaganiach pamięci wyłącznie z liczby członków: przesyłane pliki, indeksowanie, rozszerzenia i praca jednoczesna mogą zmienić obciążenie.
2. Utwórz jedną stronę dla zależności.
Użyj tego przykładu jako mapy startowej, a następnie zastąp każde założenie układem wybranej aplikacji. „Właściciel” oznacza osobę, która potrafi wyjaśnić i odtworzyć dany komponent, niekoniecznie osobę, która go zainstalowała.
| Część | Co należy do notatnika | Pytanie o odtwarzanie |
|---|---|---|
| Aplikacja webowa | Wersja, lokalizacja konfiguracji i właściciel usługi | Czy inny opiekun może odtworzyć tę samą wersję? |
| Baza danych | Silnik, wersja i metoda tworzenia kopii zapasowych | Który zrzut należy do tych plików? |
| Obrazy i załączniki | Ścieżki przechowywania i szacowany wzrost | Czy odtworzona strona otwiera swój diagram? |
| DNS i HTTPS | Właściciel konta domeny i metoda certyfikatu | Kto może naprawić dostęp bez wiki? |
| E-mail i zadania zaplanowane | Nadawca, harmonogram i osoba odpowiedzialna za awarię | Co nadal działa, gdy dostarczanie zawiedzie? |
Zapisz również wyszukiwanie: czy jest częścią aplikacji, indeksem możliwym do odbudowania, czy inną usługą? Nie zakładaj, że indeks można odrzucić, dopóki dokumentacja aplikacji nie potwierdzi, jak go odbudować.
3. Rozdziel czytanie, edytowanie i administrowanie.
W przykładzie warsztatu członkowie czytają procedury, mała grupa edytująca je zmienia, a dwóch upoważnionych opiekunów zarządza kontami. Administrowanie hostem to osobna odpowiedzialność. Zapisz, kto może publikować stronę, przesyłać pliki, eksportować treść i zmieniać uprawnienia. Zdecyduj, jak odchodzący członek traci dostęp i kto sprawdza strony, które utrzymywał.
Reguły uprawnień aplikacji mogą łączyć się w zaskakujący sposób. BookStack na przykład łączy uprawnienia z ról użytkownika i obsługuje nadpisania na poziomie treści; uprawnienia półki nie kaskadują automatycznie do jej książek. Sprawdź efekt końcowy za pomocą zwykłych kont członków, nie tylko konta administratora. Role i uprawnienia w BookStack.
4. Trzymaj zestaw do odtwarzania razem.
Każdemu zestawowi kopii zapasowych nadaj datę, wersję aplikacji i notatkę o tym, które kopie bazy danych i plików należą do siebie. Przechowuj instrukcje w miejscu dostępnym nawet w razie awarii wiki. Sekrety trzymaj w odpowiednim magazynie sekretów; notatnik powinien wskazywać, kto może je odzyskać i gdzie, bez powtarzania ich wartości.
Jako konkretny przykład aplikacji: wskazówki BookStack dotyczące kopii zapasowych obejmują rekordy bazy danych oraz konfigurację, przesłane obrazy, załączniki i wszelkie motywy. Konfiguracja zawiera klucz istotny dla zaszyfrowanych danych aplikacji, więc kopiowanie samych widocznych stron pomija ważny materiał do odtwarzania. Postępuj zgodnie z własną procedurą aplikacji dla twojej wersji. Tworzenie i odtwarzanie kopii zapasowych w BookStack.
Wybierz niezależne miejsce docelowe kopii i nazwij osobę, która sprawdzi, że pozostaje dostępne.
5. Ustal rutynę, którą grupa jest w stanie utrzymać.
Wybierz interwał przeglądu, który opiekunowie rzeczywiście utrzymają. Przy każdym przeglądzie sprawdzaj nieudane kopie zapasowe, oczekujące aktualizacje aplikacji, wzrost liczby załączników i konta, które nie potrzebują już dostępu. Pilne aktualizacje bezpieczeństwa trzymaj poza tą rutyną, gdy wymagają wcześniejszej uwagi. Zapisuj następne działanie i jego właściciela, zamiast gromadzić stale rosnącą listę niejasnych obaw.
W przykładzie grupa edytująca sprawdza też krótką listę „do przeglądu”. Procedura obsługi sprzętu bez właściciela powinna być wyraźnie oznaczona do przeglądu, zamiast cicho wyglądać na wiążącą. Przed istotną aktualizacją zapisz działającą wersję, instrukcje migracji aplikacji i punkt odtwarzania, którego zamierzasz użyć, jeśli walidacja się nie powiedzie.
6. Sprawdź użyteczną ścieżkę, a potem zapisz luki.
Na osobnej kopii testowej poproś drugiego opiekuna o znalezienie przykładowej strony, otwarcie jej załącznika, wykonanie upoważnionej zmiany i wypróbowanie działania, na które jego konto nie powinno pozwalać. Sprawdź wynik wyszukiwania po zmianie treści. Zapisz wyniki oczekiwane i zaobserwowane; samo udane logowanie nie dowodzi, że wiki jest użyteczna lub prawidłowo ograniczona.
Jeśli brakuje załącznika, porównaj jego lokalizację przechowywania i zestaw kopii zapasowych, zanim edytujesz rekordy bazy danych. Jeśli uprawnienia się różnią, sprawdź role kont i nadpisania treści, zanim rozszerzysz dostęp. Jeśli aplikacja nie może się uruchomić, przerwij ćwiczenie i zapisz niezgodność wersji lub konfiguracji. To kroki akceptacyjne do wykonania, a nie zgłoszone testy infrastruktury Hoszen.
7. Zostaw ścieżkę na zewnątrz.
Wybierz jeden reprezentatywny rozdział do wyeksportowania i zapytaj, czy ktoś mógłby go przeczytać bez oryginalnej wiki. Traktuj tę czytelną kopię jako osobny produkt niż zestaw do odtwarzania: może nie zachowywać kont, uprawnień ani ustawień aplikacji. Ustal, kto utrzymuje tę kopię wyjściową, gdy treść się zmienia.
Twój gotowy plan powinien pasować obok inwentarzem usług, a nie go zastępować. Kontynuuj z przenośny folder eksportu oraz próbne odtworzenie. Celem jest wiki, którą inna upoważniona osoba zrozumie i odtworzy; ten przewodnik nie instaluje żadnej aplikacji.
Dokumentacja stojąca za tą notatką
Korzystaj z dokumentacji dla wersji, którą faktycznie uruchamiasz. Te przykłady są materiałem planistycznym, a nie zapisem testu na Hoszen VPS.