Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
195 changes: 195 additions & 0 deletions 6-homelab-docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
# Homelab Documentation / Homelab Dokumentáció

## Áttekintés / Overview

Professzionális dokumentáció a homelab infrastruktúrához, beleértve architektúra diagramokat, leltárt, runbook-okat és sablonokat.

Professional documentation for homelab infrastructure including architecture diagrams, inventory, runbooks, and templates.

## Dokumentáció Struktúra / Documentation Structure

```
6-homelab-docs/
├── README.md # Ez a dokumentum / This document
├── architecture/
│ └── network-architecture.md # Hálózati architektúra / Network architecture
├── inventory/
│ └── servers.md # Szerver leltár / Server inventory
├── runbooks/
│ └── incident-response.md # Incidenskezelési runbook / Incident response
└── templates/
└── change-request.md # Változtatási kérelem sablon / Change request
```

## Architektúra / Architecture

### Hálózati Architektúra / Network Architecture

A `architecture/network-architecture.md` dokumentum tartalmazza:
- Hálózati topológia diagram (Mermaid)
- VLAN konfiguráció
- IP címtartományok
- Tűzfal szabályok
- DNS konfiguráció
- Port kiosztások

**Fő komponensek / Key components:**
- 5 VLAN (Servers, Management, Clients, IoT, Quarantine)
- Szegmentált hálózati zónák / Segmented network zones
- Firewall szabályok zónák között / Firewall rules between zones

## Leltár / Inventory

### Szerver Leltár / Server Inventory

A `inventory/servers.md` dokumentum tartalmazza:
- Fizikai szerverek listája / Physical servers list
- Virtuális gépek / Virtual machines
- Docker containerek / Docker containers
- Hálózati eszközök / Network devices
- Szolgáltatások és portok / Services and ports

**Nyomon követett információk / Tracked information:**
- IP címek / IP addresses
- Hardware specifikációk / Hardware specifications
- Szoftver verziók / Software versions
- Állapot és elérhetőség / Status and availability

## Runbook-ok / Runbooks

### Incidenskezelés / Incident Response

A `runbooks/incident-response.md` runbook tartalmazza:

**Súlyossági szintek / Severity levels:**
- P0 (Critical) - 15 perc válaszidő / 15 min response
- P1 (High) - 1 óra válaszidő / 1 hour response
- P2 (Medium) - 4 óra válaszidő / 4 hour response
- P3 (Low) - 1 nap válaszidő / 1 day response

**Minden szinthez / For each level:**
- Jellemző problémák / Typical problems
- Diagnosztikai parancsok / Diagnostic commands
- Helyreállítási lépések / Recovery steps
- Eszkalációs útvonal / Escalation path

**Kommunikációs sablonok / Communication templates:**
- Incidensnyitás / Incident opening
- Státusz frissítés / Status update
- Incidenzárás / Incident closing
- Post-mortem riport / Post-mortem report

## Sablonok / Templates

### Változtatási Kérelem / Change Request

A `templates/change-request.md` sablon tartalmazza:

**Szakaszok / Sections:**
1. Változtatás információk / Change information
2. Leírás és indoklás / Description and justification
3. Implementációs terv / Implementation plan
4. Ellenőrzési pontok / Verification points
5. Visszaállítási terv / Rollback plan
6. Kockázat értékelés / Risk assessment
7. Ütemezés / Scheduling
8. Kommunikáció / Communication
9. Jóváhagyás / Approval

**Használat / Usage:**
1. Másold le a sablont / Copy the template
2. Töltsd ki a mezőket / Fill in the fields
3. Kérj jóváhagyást / Request approval
4. Implementáld / Implement
5. Dokumentáld az eredményt / Document the result

## Használati Útmutató / Usage Guide

### Új Szerver Hozzáadása / Adding a New Server

1. **Dokumentáld a szervert / Document the server**
- Frissítsd a `inventory/servers.md` fájlt
- Add hozzá az IP címet, hardvert, OS-t

2. **Frissítsd a hálózati diagramot / Update network diagram**
- Módosítsd az `architecture/network-architecture.md` fájlt
- Adj hozzá új node-ot a Mermaid diagramhoz

3. **Konfiguráld a monitorozást / Configure monitoring**
- Add hozzá a Prometheus target-hez
- Készíts dashboard-ot Grafana-ban

### Incidens Kezelése / Handling an Incident

1. **Nyiss incidensriportot / Open incident report**
- Használd a kommunikációs sablont
- Azonosítsd a súlyossági szintet

2. **Kövesd a runbook-ot / Follow the runbook**
- Nézd meg a `runbooks/incident-response.md` fájlt
- Futtasd a diagnosztikai parancsokat

3. **Dokumentáld a megoldást / Document the solution**
- Készíts post-mortem riportot
- Frissítsd a runbook-ot ha szükséges

### Változtatás Kezdeményezése / Initiating a Change

1. **Töltsd ki a change request-et / Fill out change request**
- Használd a `templates/change-request.md` sablont
- Dokumentáld a változtatást részletesen

2. **Kérj jóváhagyást / Request approval**
- Küldd el áttekintésre
- Válaszolj a kérdésekre

3. **Implementáld / Implement**
- Kövesd az implementációs tervet
- Ellenőrizd minden lépésnél

4. **Zárás / Close**
- Dokumentáld az eredményt
- Frissítsd a leltárat ha szükséges

## Best Practices

### Dokumentáció Karbantartás / Documentation Maintenance

- **Rendszeres frissítés / Regular updates:** Minden változtatás után
- **Verziókezelés / Version control:** Git használata
- **Felülvizsgálat / Review:** Negyedévente
- **Pontosság / Accuracy:** Valós állapot tükrözése

### Diagram Karbantartás / Diagram Maintenance

- Használj Mermaid formátumot / Use Mermaid format
- Tartsd egyszerűnek / Keep it simple
- Frissítsd változtatások után / Update after changes
- Színkódolás konzisztens / Consistent color coding

### Runbook Karbantartás / Runbook Maintenance

- Teszteld a parancsokat / Test the commands
- Dokumentáld a változásokat / Document changes
- Add hozzá a tanulságokat / Add lessons learned
- Konkrét legyen / Be specific

## Referenciák / References

### Külső Dokumentáció / External Documentation

- [Prometheus Documentation](https://prometheus.io/docs/)
- [Grafana Documentation](https://grafana.com/docs/)
- [Microsoft Graph API](https://docs.microsoft.com/graph/)
- [Docker Documentation](https://docs.docker.com/)

### Belső Dokumentáció / Internal Documentation

- [Monitoring Stack README](../2-infra-monitoring/README.md)
- [Network Health Checker](../network_health_checker/README.md)
- [SysAdmin Toolkit](../1-sysadmin-toolkit/README.md)
- [Backup Automation](../5-backup-automation/README.md)

## Licenc / License

MIT License
126 changes: 126 additions & 0 deletions 6-homelab-docs/architecture/network-architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Network Architecture / Hálózati Architektúra

## Áttekintés / Overview

Ez a dokumentum a homelab hálózati architektúrát írja le.
This document describes the homelab network architecture.

## Hálózati Topológia / Network Topology

```mermaid
graph TB
subgraph Internet
ISP[ISP Router]
end

subgraph Core Network
FW[Firewall/Router<br/>192.168.1.1]
SW1[Core Switch<br/>Layer 3]
end

subgraph Server VLAN - 10
SRV1[Monitoring Server<br/>192.168.10.10]
SRV2[Docker Host<br/>192.168.10.20]
SRV3[Backup Server<br/>192.168.10.30]
end

subgraph Management VLAN - 20
MGT1[Management Workstation<br/>192.168.20.10]
MGT2[Jump Server<br/>192.168.20.20]
end

subgraph Client VLAN - 30
CLI1[Client Devices]
end

ISP --> FW
FW --> SW1
SW1 --> SRV1
SW1 --> SRV2
SW1 --> SRV3
SW1 --> MGT1
SW1 --> MGT2
SW1 --> CLI1
```

## IP Címtartományok / IP Address Ranges

| VLAN | Név / Name | Subnet | Gateway | Leírás / Description |
|------|------------|--------|---------|---------------------|
| 1 | Management | 192.168.1.0/24 | 192.168.1.1 | Alapértelmezett / Default |
| 10 | Servers | 192.168.10.0/24 | 192.168.10.1 | Szerverek / Servers |
| 20 | Management | 192.168.20.0/24 | 192.168.20.1 | Kezelési eszközök / Management tools |
| 30 | Clients | 192.168.30.0/24 | 192.168.30.1 | Kliens gépek / Client devices |
| 40 | IoT | 192.168.40.0/24 | 192.168.40.1 | IoT eszközök / IoT devices |
| 99 | Quarantine | 192.168.99.0/24 | 192.168.99.1 | Karantén / Quarantine |

## Tűzfal Szabályok / Firewall Rules

### Alapértelmezett Szabályok / Default Rules

| Forrás / Source | Cél / Destination | Port | Protokoll | Művelet / Action |
|----------------|------------------|------|-----------|-----------------|
| Any | Internet | 80, 443 | TCP | ALLOW |
| Servers | Internet | 80, 443, 53 | TCP/UDP | ALLOW |
| Management | Servers | 22, 3389, 9090, 3000 | TCP | ALLOW |
| Clients | Servers | 80, 443 | TCP | ALLOW |
| Internet | DMZ | 80, 443 | TCP | ALLOW (NAT) |
| IoT | Internet | 443 | TCP | ALLOW |
| IoT | Internal | * | * | DENY |

### Port Kiosztások / Port Assignments

| Szolgáltatás / Service | Port | Protokoll | Leírás / Description |
|------------------------|------|-----------|---------------------|
| SSH | 22 | TCP | Secure Shell |
| HTTP | 80 | TCP | Web traffic |
| HTTPS | 443 | TCP | Secure web traffic |
| Grafana | 3000 | TCP | Monitoring dashboard |
| Prometheus | 9090 | TCP | Metrics collection |
| Alertmanager | 9093 | TCP | Alert management |
| Node Exporter | 9100 | TCP | Host metrics |
| Blackbox Exporter | 9115 | TCP | Endpoint probes |

## DNS Konfiguráció / DNS Configuration

### DNS Szerverek / DNS Servers

| Típus / Type | IP Cím | Leírás / Description |
|--------------|--------|---------------------|
| Primary | 192.168.1.1 | Internal DNS |
| Secondary | 8.8.8.8 | Google DNS |
| Tertiary | 1.1.1.1 | Cloudflare DNS |

### DNS Zónák / DNS Zones

```
homelab.local (belső / internal)
├── monitoring.homelab.local → 192.168.10.10
├── docker.homelab.local → 192.168.10.20
├── backup.homelab.local → 192.168.10.30
└── jumpserver.homelab.local → 192.168.20.20
```

## Biztonság / Security

### Hálózati Szegmentálás / Network Segmentation
- VLAN izoláció különböző hálózati zónákhoz
- Firewall szabályok zónák között
- IoT hálózat izoláció

### Hozzáférés Szabályozás / Access Control
- Management VLAN csak autorizált eszközökről
- SSH kulcs alapú hitelesítés
- VPN hozzáférés távoli menedzsmenthez

### Monitorozás / Monitoring
- Prometheus + Grafana
- Blackbox Exporter endpoint ellenőrzéshez
- Alert szabályok kritikus eseményekhez

## Bővítési Lehetőségek / Expansion Options

- DMZ VLAN külső szolgáltatásokhoz
- Guest VLAN vendégeknek
- VPN VLAN távoli hozzáféréshez
- Backup VLAN dedikált mentési hálózat
Loading
Loading