diff --git a/README.md b/README.md index 3ece30e..9c3fbe7 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,39 @@ This app provides a lightweight local interface to manage Kubernetes clusters vi - Backend: Python - Frontend: Lightweight JavaScript -## Plan -- Build Python backend to execute kubectl commands and serve API -- Create lightweight JavaScript frontend -- Implement context/namespace selection -- Add search and list views for pods, nodes, PVCs, etc. -- Add action interfaces (describe, delete, logs, etc.) +## Plan by Phases + +### Phase 1: Prototype +- Basic Python backend with kubectl wrapper +- Lightweight frontend with context/namespace selectors +- List pods and nodes +- Basic describe and delete actions + +### Phase 2: Search & Actions +- Search/filter pods, nodes, PVCs, and other resources +- Add logs viewer +- Expand actions: describe, delete, logs, and more +- Improve error handling and feedback + +### Phase 3: Polish & Safety +- Confirmation dialogs for destructive actions +- Better UI/UX and responsive layout +- Optional authentication or access controls +- Documentation and setup instructions + +## Roadmap / Checklist + +- [x] Add readme describing kubectl gui plan +- [ ] Phase 1: Prototype backend and basic frontend +- [ ] Phase 1: Context and namespace selection +- [ ] Phase 1: List pods and nodes +- [ ] Phase 2: Search pods, nodes, PVCs, and others +- [ ] Phase 2: Describe, delete, and logs actions +- [ ] Phase 3: Safety confirmations and error handling +- [ ] Phase 3: UI polish and documentation + +## Suggestions +- Use a lightweight Python framework (e.g., Flask or FastAPI) for the backend +- Keep frontend vanilla JS or minimal framework to stay lightweight +- Consider running kubectl via subprocess with proper input validation +- Add a simple status indicator for kubectl connectivity