Lucas Berger
150 lines
6.7 KiB
Markdown
150 lines
6.7 KiB
Markdown
# Roadmap — Unraid Docker Manager
|
|
|
|
## Milestones
|
|
|
|
- ✅ **v1.0 Docker Control via Telegram** — Phases 1-5 (shipped 2026-02-02) -> [Archive](milestones/v1.0-ROADMAP.md)
|
|
- ✅ **v1.1 n8n Integration & Polish** — Phases 6-9 (shipped 2026-02-04) -> [Archive](milestones/v1.1-ROADMAP.md)
|
|
- ✅ **v1.2 Modularization & Polish** — Phases 10-13 + 10.1, 10.2 (shipped 2026-02-08) -> [Archive](milestones/v1.2-ROADMAP.md)
|
|
- ✅ **v1.3 Unraid Update Status Sync** — Phase 14 (shipped 2026-02-09, descoped) -> [Archive](milestones/v1.3-ROADMAP.md)
|
|
- 🚧 **v1.4 Unraid API Native** — Phases 15-18 (in progress)
|
|
|
|
## Phases
|
|
|
|
<details>
|
|
<summary>✅ v1.0 Docker Control via Telegram (Phases 1-5) — SHIPPED 2026-02-02</summary>
|
|
|
|
- [x] Phase 1: Foundation (2/2 plans)
|
|
- [x] Phase 2: Container Actions (2/2 plans)
|
|
- [x] Phase 3: Core Operations (4/4 plans)
|
|
- [x] Phase 4: Container Logs (1/1 plan)
|
|
- [x] Phase 5: Polish & Ship (3/3 plans)
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>✅ v1.1 n8n Integration & Polish (Phases 6-9) — SHIPPED 2026-02-04</summary>
|
|
|
|
- [x] Phase 6: n8n API Access (1/1 plan)
|
|
- [x] Phase 7: Socket Security (3/3 plans)
|
|
- [x] Phase 8: Inline Keyboard Infrastructure (3/3 plans)
|
|
- [x] Phase 9: Batch Operations (4/4 plans)
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>✅ v1.2 Modularization & Polish (Phases 10-13 + 10.1, 10.2) — SHIPPED 2026-02-08</summary>
|
|
|
|
- [x] Phase 10: Workflow Modularization (7/7 plans)
|
|
- [x] Phase 10.1: Aggressive Workflow Modularization (9/9 plans) (INSERTED)
|
|
- [x] Phase 10.2: Better Logging & Log Management (4/4 plans) (INSERTED)
|
|
- [x] Phase 11: Update All & Callback Limits (2/2 plans)
|
|
- [x] Phase 12: Polish & Audit (2/2 plans)
|
|
- [x] Phase 13: Documentation Overhaul (1/1 plan)
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>✅ v1.3 Unraid Update Status Sync (Phase 14) — SHIPPED 2026-02-09 (descoped)</summary>
|
|
|
|
- [x] Phase 14: Unraid API Access (2/2 plans)
|
|
- ~~Phase 15: Single Container Sync~~ (dropped — superseded by v1.4)
|
|
- ~~Phase 16: Batch Sync & Documentation~~ (dropped — superseded by v1.4)
|
|
|
|
</details>
|
|
|
|
### 🚧 v1.4 Unraid API Native (In Progress)
|
|
|
|
**Milestone Goal:** Replace Docker socket proxy with Unraid's GraphQL API for all container operations, remove container logs feature, and clean up all proxy artifacts.
|
|
|
|
#### Phase 15: Infrastructure Foundation
|
|
**Goal**: Data transformation layers ready for Unraid API integration
|
|
**Depends on**: Phase 14
|
|
**Requirements**: INFRA-01, INFRA-02, INFRA-03, INFRA-04, INFRA-05
|
|
**Success Criteria** (what must be TRUE):
|
|
1. Container ID translation layer maps container names to Unraid PrefixedID format (129-char)
|
|
2. Callback data encoding works with PrefixedIDs within Telegram's 64-byte limit
|
|
3. GraphQL response normalization transforms Unraid API shape to workflow contract
|
|
4. GraphQL error handling standardized (checks response.errors[], handles HTTP 304)
|
|
5. Timeout configuration accounts for myunraid.net cloud relay latency (200-500ms)
|
|
**Plans**: 2 plans
|
|
|
|
Plans:
|
|
- [x] 15-01-PLAN.md — Container ID Registry and Callback Token Encoding/Decoding
|
|
- [x] 15-02-PLAN.md — GraphQL Response Normalizer, Error Handler, and HTTP Template
|
|
|
|
#### Phase 16: API Migration
|
|
**Goal**: All container operations work via Unraid GraphQL API
|
|
**Depends on**: Phase 15
|
|
**Requirements**: API-01, API-02, API-03, API-04, API-05, API-06, API-07, API-08
|
|
**Success Criteria** (what must be TRUE):
|
|
1. User can view container status via Unraid API (same UX as before)
|
|
2. User can start, stop, restart containers via Unraid API
|
|
3. User can update single container via Unraid API (single mutation replaces 5-step Docker flow)
|
|
4. User can batch update multiple containers via Unraid API
|
|
5. User can "update all :latest" via Unraid API
|
|
6. Unraid update badges clear automatically after bot-initiated updates (no manual sync)
|
|
**Plans**: 6 plans
|
|
|
|
Plans:
|
|
- [x] 16-01-PLAN.md -- Container Status workflow migration (n8n-status.json)
|
|
- [x] 16-02-PLAN.md -- Container Actions workflow migration (n8n-actions.json)
|
|
- [x] 16-03-PLAN.md -- Container Update workflow migration (n8n-update.json)
|
|
- [x] 16-04-PLAN.md -- Batch UI workflow migration (n8n-batch-ui.json)
|
|
- [x] 16-05-PLAN.md -- Main workflow routing migration (n8n-workflow.json)
|
|
- [x] 16-06-PLAN.md -- Gap closure: text command entry points migration + dead code removal
|
|
|
|
#### Phase 17: Cleanup
|
|
**Goal**: All Docker socket proxy artifacts removed from codebase
|
|
**Depends on**: Phase 16
|
|
**Requirements**: CLN-01, CLN-02, CLN-03, CLN-04, CLN-05, CLN-06
|
|
**Success Criteria** (what must be TRUE):
|
|
1. Container logs feature removed from workflows (text command, inline keyboard, sub-workflow)
|
|
2. Docker socket proxy references removed from all workflow JSON files
|
|
3. docker-socket-proxy container can be safely removed (no dependencies)
|
|
4. n8n container config cleaned (no proxy network, no socket-related env vars)
|
|
5. "unraid" test command updated or removed (v1.3 connectivity test)
|
|
**Plans**: TBD
|
|
|
|
Plans:
|
|
- [ ] 17-01: TBD
|
|
|
|
#### Phase 18: Documentation
|
|
**Goal**: Documentation fully updated for Unraid API-native architecture
|
|
**Depends on**: Phase 17
|
|
**Requirements**: DOC-01, DOC-02, DOC-03, DOC-04
|
|
**Success Criteria** (what must be TRUE):
|
|
1. README.md reflects Unraid API-native architecture (no proxy references)
|
|
2. ARCHITECTURE.md documents Unraid GraphQL API contracts and patterns
|
|
3. CLAUDE.md updated with Unraid API patterns (proxy recipes removed)
|
|
4. Cleanup instructions documented for removing docker-socket-proxy container
|
|
**Plans**: TBD
|
|
|
|
Plans:
|
|
- [ ] 18-01: TBD
|
|
|
|
## Progress
|
|
|
|
**Execution Order:**
|
|
Phases execute in numeric order: 1-14 (complete) → 15 → 16 → 17 → 18
|
|
|
|
| Phase | Name | Milestone | Plans Complete | Status | Completed |
|
|
|-------|------|-----------|----------------|--------|-----------|
|
|
| 1-5 | Foundation through Polish | v1.0 | 12/12 | Complete | 2026-02-02 |
|
|
| 6-9 | API, Security, Keyboard, Batch | v1.1 | 11/11 | Complete | 2026-02-04 |
|
|
| 10 | Workflow Modularization | v1.2 | 7/7 | Complete | 2026-02-05 |
|
|
| 10.1 | Aggressive Modularization | v1.2 | 9/9 | Complete | 2026-02-06 |
|
|
| 10.2 | Better Logging & Log Management | v1.2 | 4/4 | Complete | 2026-02-07 |
|
|
| 11 | Update All & Callback Limits | v1.2 | 2/2 | Complete | 2026-02-08 |
|
|
| 12 | Polish & Audit | v1.2 | 2/2 | Complete | 2026-02-08 |
|
|
| 13 | Documentation Overhaul | v1.2 | 1/1 | Complete | 2026-02-08 |
|
|
| 14 | Unraid API Access | v1.3 | 2/2 | Complete | 2026-02-08 |
|
|
| 15 | Infrastructure Foundation | v1.4 | 2/2 | Complete | 2026-02-09 |
|
|
| 16 | API Migration | v1.4 | 6/6 | Complete | 2026-02-09 |
|
|
| 17 | Cleanup | v1.4 | 0/? | Not started | - |
|
|
| 18 | Documentation | v1.4 | 0/? | Not started | - |
|
|
|
|
**Total: 4 milestones shipped (14 phases, 50 plans), v1.4 in progress (Phase 15-16 complete, 8/10 plans)**
|
|
|
|
---
|
|
*Updated: 2026-02-09 — Phase 16 complete (6/6 plans, all container operations use GraphQL)*
|