docs: add README, API reference, quickstart guide, and cluster summary

- README.md: project landing page with cluster overview and doc index
- API.md: comprehensive Proxmox VE API endpoint reference
- QUICKSTART.md: 5-minute guide with copy-paste examples
- SUMMARY.md: cluster health, resource usage, and service inventory
- CLAUDE.md: Claude Code project context

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-04-10 11:12:15 +08:00
parent d30bf61a76
commit 1990d5a011
5 changed files with 603 additions and 0 deletions

130
SUMMARY.md Normal file
View File

@@ -0,0 +1,130 @@
# PVECluster 狀態摘要
> 快照日期2026-04-10
## 叢集健康狀態
| 指標 | 狀態 |
|---|---|
| 叢集 Quorum | 正常3/3 節點在線) |
| HA | 未啟用 |
| 備份排程 | 全部停用3 個排程 enabled=0 |
| 儲存 | 全部可用 |
## 節點資源
| 節點 | CPU | 記憶體 | 系統碟 | Running |
|---|---|---|---|---|
| pve (.38) | 7% (4C) | 6.7 / 16 GB (43%) | 12.2 / 68 GB | 9 |
| pve-02 (.39) | 12% (4C) | 10.9 / 16 GB (70%) | 12.1 / 68 GB | 7 |
| pve-03 (.40) | 15% (4C) | 10.1 / 16 GB (64%) | 11.0 / 68 GB | 6 |
| **合計** | **12C (4C x3)** | **27.7 / 48 GB (58%)** | **35.3 / 204 GB** | **22** |
## 儲存使用
| 儲存 | 類型 | 容量 | 已用 | 使用率 |
|---|---|---|---|---|
| syno-lvm | iSCSI LVM共享 | 1.00 TB | 0.90 TB | 90% |
| synology-backup | CIFS共享 | 2.75 TB | 2.37 TB | 86% |
| pbs | PBS共享 | 294 GB | 16 GB | 5% |
| local-lvm (pve) | LVM thin | 157 GB | 3.7 GB | 2% |
| local-lvm (pve-02) | LVM thin | 160 GB | — | — |
| local-lvm (pve-03) | LVM thin | 160 GB | 12.8 GB | 8% |
> **注意**syno-lvm 使用率 90%synology-backup 使用率 86%,需關注空間。
## 服務分類總覽
### 基礎設施
| 服務 | VMID | IP | 節點 | 狀態 |
|---|---|---|---|---|
| OpenWRT 路由器 | VM 110 | .42.10 (GW) | pve | running |
| Caddy 反向代理 | CT 104 | .42.104 | pve | running |
| Nginx Proxy Manager | CT 124 | .42.124 | pve-03 | running |
| Proxmox Backup Server | VM 111 | .42.30 | pve-02 | running |
### 遠端存取 / VPN
| 服務 | VMID | IP | 節點 | 狀態 |
|---|---|---|---|---|
| SSH Jump + Bore Tunnel | CT 100 | .42.100 | pve-02 | running |
| Headscale + RustDesk | CT 101 | .42.101 | pve-02 | running |
| Tailscale | CT 102 | .42.102 | pve | running |
| Headscale | CT 126 | .42.126 | pve | running |
### 認證
| 服務 | VMID | IP | 節點 | 狀態 |
|---|---|---|---|---|
| Keycloak SSO | CT 124 | .42.124 | pve-03 | running |
### 應用程式
| 服務 | VMID | IP | 節點 | 狀態 |
|---|---|---|---|---|
| Lydia (Production) | CT 115 | .42.115 | pve-02 | running |
| Lydia (Test) | CT 117 | .42.117 | pve-02 | running |
| OpenClaw | CT 112 | .42.112 | pve-03 | running |
| Karakeep 書籤管理 | CT 124 | .42.124 | pve-03 | running |
### Kubernetes (K3s)
| 服務 | VMID | IP | 節點 | 狀態 |
|---|---|---|---|---|
| K3s Worker | VM 120 | — | pve-02 | running |
| K3s Worker | VM 121 | — | pve | running |
| K3s Worker | VM 122 | — | pve-03 | running |
> 3 節點各 1 個 K3s Worker VM8GB RAM / 82-83GB 磁碟),跨節點分佈。
### 開發 / 工具
| 服務 | VMID | IP | 節點 | 狀態 |
|---|---|---|---|---|
| Python 開發環境 | CT 108 | .42.108 | pve-03 | running |
| PostgreSQL | CT 118 | .42.118 | pve-03 | running |
| Podman | CT 114 | .42.114 | pve-03 | running |
### 通知 / 郵件
| 服務 | VMID | IP | 節點 | 狀態 |
|---|---|---|---|---|
| Bark 推播 | CT 116 | .42.116 | pve | running |
| MailPit 郵件測試 | CT 107 | .42.107 | pve-02 | running |
| MyIP Server | CT 105 | .42.105 | pve | running |
| Gotify 推播 | CT 119 | .42.119 | pve | **stopped** |
### 已停用服務
| 服務 | VMID | IP | 節點 | 備註 |
|---|---|---|---|---|
| N8N 自動化 | CT 103 | .42.103 | pve | 曾用 Docker 跑 N8N |
| Podman閒置 | CT 106 | .42.106 | pve | 空容器 |
| Stirling PDF | CT 109 | .42.109 | pve-02 | PDF 處理工具 |
| (閒置) | CT 113 | — | pve | 空容器DHCP |
| Gotify 推播 | CT 119 | .42.119 | pve | 已被 Bark 取代 |
| (閒置) | CT 123 | .42.123 | pve | 空容器 |
### 模板
| 名稱 | VMID | 節點 |
|---|---|---|
| Ubuntu 24.04 Cloud-init | VM 9000 | pve |
## 備份排程狀態
全部排程目前皆為**停用狀態**enabled=0
| 排程 | 對象 | 儲存 | 保留策略 |
|---|---|---|---|
| 每日 03:00 | CT115, CT117Lydia | pbs | keep-daily=7 |
| 02:30, 22:30 | CT103, CT106, CT108, CT124 | pbs | keep-daily=7 |
| 每日 02:00 | VM110OpenWRT | pbs | keep-daily=3 |
## 需注意事項
1. **儲存空間緊張** — syno-lvm 使用率 90%、synology-backup 86%,建議清理或擴容
2. **備份全停用** — 三個排程都是 enabled=0重要服務Lydia、OpenWRT目前無自動備份
3. **HA 未啟用** — 單節點故障時 VM/CT 不會自動遷移
4. **pve-02 記憶體較吃緊** — 70% 使用率,跑了 PBS + K3s (8GB) + Lydia prod/test