diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3e44f35..b4609e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,9 @@ We chose a lean and minimal approach to make development on this project as simp - Infra is handled by a single Ansible playbook - The CLI and API are implemented respectively with Typer and FastAPI in Python, for simplicity. They both wrap over the same `core` module. +## Project Direction + +Check out the [ROADMAP.md](ROADMAP.md) to see planned features, current priorities, and long-term goals. It's a great starting point if you're looking for areas to contribute! ## Repo Layout - `src/k7/` CLI, core logic, API server diff --git a/README.md b/README.md index 9a36c20..92b1e91 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,8 @@ Coming Soon - πŸ” Cilium FQDN-based DNS resolution to safely whitelist domains, not just IP blocks - βš™οΈ Support other VMM such as Qemu for GPU workloads +πŸ“‹ **See [ROADMAP.md](ROADMAP.md) for the complete feature roadmap and project priorities.** +

Note: Katakate is currently in beta and under security review. Use with caution for highly sensitive workloads. diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 0000000..d1192c3 --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,62 @@ +# πŸ—ΊοΈ Project Roadmap + +This document outlines the upcoming milestones, goals, and long-term vision for **K7**. +It helps contributors and users understand where the project is heading. + +--- + +## πŸš€ Current Focus + +Core stability and foundational runtime improvements. + +- [ ] Add `--disk` argument to `k7 install` to specify external disk path explicitly for thin pool provisioning, and test it +- [ ] Test if removing DNS resolution completely doesn't break functionality (to protect against DNS exfiltration) +- [ ] Add pause/resume support for sandboxes +- [ ] Fix jailer functionality (known issue) +- [ ] Add multi-node support (currently single K3s node supported) + + + +--- + +## 🧩 Next Goals + +Broader compatibility and container integration. + +- [ ] Add ARM support for Linux Debian +- [ ] Add Docker build / run / compose capabilities in VM sandboxes (major feature!) +- [ ] Integrate Cilium networking +- [ ] Implement Docker pull deny/whitelist + +--- + +## βš™οΈ Future Work + +Cross-platform support and continuous delivery. + +- [ ] Add QEMU support (macOS ARM, GPU support) +- [ ] Add AppArmor integration +- [ ] Add CI/CD and deployment tests + +--- + +## πŸ” Advanced Features + +Security, customization, and extended runtime capabilities. + +- [ ] Add TEE (Trusted Execution Environment) support +- [ ] Add custom rootfs support (lighter, alternative images) + +--- + +## πŸ’¬ How to Contribute + +We welcome ideas and feedback! +If you'd like to suggest a feature or help with one listed above: +1. Open a [Discussion](https://github.com/katakate/k7/discussions) or [Issue](https://github.com/katakate/k7/issues) +2. Reference the relevant roadmap item +3. Let's collaborate on the design or implementation + +--- + +πŸ“… *Last updated: October 2025*