Skip to content

Latest commit

 

History

History
178 lines (142 loc) · 4.56 KB

Dokumentacja_LLD.md

File metadata and controls

178 lines (142 loc) · 4.56 KB
Raw

Dokumentacja LLD

Dokument ten jest prostym szablonem, zawierającym listę informacji, jakie powinny znleźć się w dokumentacji wdrożeniowej LLD. Dokładne omówienie go znajduje się w filmie Co powinna zawierać dokumentacja HLD na kanale YT Nowoczesny Sieciowiec

Kolejność rozdziałów i ich zakres są przykładowe, można dostosować do własnych wymagań

Część formalna

i. Strona tytułowa

  • Tytuł
  • Odbiorca
  • Autor
  • Data publikacji
  • Nagłówek
    • Nazwa aktualnego rozdziału
  • Stopka
    • Nazwa dokumentu
    • Informacje prawne
    • Numer strony

ii. Informacje formalne

  • Historia dokumentu
  • Zastrzeżenia, nota prawna
  • Stosowane oznaczenia
    • Ikony
    • Uzyte kroje fontów
  • Akcptacja klienta i wykonawcy

iii. Spisy treści

  • Spis treści
  • Spis tabel
  • Spis rysunków

1. Wstęp

  • Executive Summary
  • Inwestor
  • Osoby kontaktowe
  • Lokalizacje
  • Cel projektu
  • Co nie jest celem projektu
  • Wymgania i założenia
    • Odpowiedzialność klienta i dostawcy (kto, co dostarcza)
  • Dokumenty zależne
  • Przebieg projektu
  • Wstępnie oszacowane ryzyka
  • Odbiorcy dokumentu

3. Wymagania środowiskowe

  • Gabaryty
  • Zapas na kable
  • Pobór mocy
  • Sposób podłączenia zasilania
  • Przepływ powietrza
  • Podsumowanie
  • Ograniczenia sprzętu

4. Zestawienia

  • Fizyczne
    • Schemat nazewnictwa
    • Wersje oprogramowania
    • Lista urządzeń fizycznych (hostname, adres IP, model, przeznaczenie)
    • Diagram połączeń fizycznych
    • Zestawienie połączeń fizycznych (A, B, wkładka, typ kabla, długość)
    • Rozmieszczenie urządzeń w szafie
  • Logiczne
    • VLAN, VRF, IP, L2/L3
    • QoS (wymagania, markowanie, kolejki, wyliczenia pasma)
    • Lista urządzeń logicznych
    • Diagram połączeń logicznych i przepływów
    • Globalne parametry systeowe (DNS, NTP, domena, SMTP, syslog, netflow)
    • Użytkownicy i konta systemowe
    • Wymagana komunikacja sieciowa
    • Wzorce konfiguracji

5. Opis aktualnego środowiska

  • Elementy mające wpływ na obecny projekt
  • Utylizacja zasobów
  • Opis migrowanych środowisk

6. Instalacja fizyczna

  • Narzędzia i materiały
  • Szczególne elementy instalacji
  • Pierwsze uruchomienie
  • Czynności weryfikujące

7. Proces wdrożenia

  • Wytyczne konfiguracji i ich uzasadnienie
  • Przepływy danych
  • Inżynieria routingu
  • Proces migracji usług
  • Proces cofnięcia zmian

8. Automatyzacja

  • Jakie narzędzia
  • API
  • Przechowywanie skryptów
  • Proces CICD
  • Proces zatwierdzania zmian

9. Zabezpieczanie środowiska

  • Uwierzytelnianie dostępu (tacacs+, radius)
  • Integracja (AD)
  • Przdzielane profile
  • Uwierzytelnianie protokołów routingu
  • Szyfrowanie połączeń
  • Szyfrowanie dysków
  • Zasady zdalnego dostępu
  • Hardening

10. Zarządzanie

  • Monitoring (konfiguracje, syslog, trap, SNMP)
  • Kopie zapasowe i ich odtwarzanie
  • Procedury operacyjne
  • Proces wyłączania całego środowiska

11. Obsługa serwisowa

  • Jak zgłaszać, co zawierać w zgłoszeniu, gdzie wysyłać
  • Tryby serwisowania urządzeń, numery kontraktów serwisowych
  • Scenariusze awaryjne
    • Czynności weryfikujące, odtworzeniowe
    • Wpływ na pozostałe środowisko

12. Testy akceptacyjne

  • Ogólne założenia
  • Lista urządzeń
  • Dokładny opis testu
    • Data
    • Kto wykonał
    • Opis
    • Wykonywane polecenia
    • Wynik oczekiwany i obserwowany
    • Czasy przełączenia
    • Rezultat
    • Uwagi

13. Opisy technologiczne

  • Uzasadnienie użycia danej technologii

14. Dodatki

  • Spis urządzeń z numerami seryjnymi
  • Spis licencji
  • Słownik skrótów
  • Bibliografia