From c4b86312afff428b21a2ea0c9a75bb201a1dc280 Mon Sep 17 00:00:00 2001 From: tdr Date: Wed, 11 Sep 2024 09:58:39 +0200 Subject: [PATCH 1/4] TODO file created --- TODO.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 TODO.md diff --git a/TODO.md b/TODO.md new file mode 100644 index 00000000..dc0f8ba6 --- /dev/null +++ b/TODO.md @@ -0,0 +1,6 @@ +# TODO + +## Declaring NixOS MicroVMs + + + From e0dc491f76ecd0a5aed5d3873489193965d4a81b Mon Sep 17 00:00:00 2001 From: tdr Date: Thu, 12 Sep 2024 03:54:26 +0200 Subject: [PATCH 2/4] documentation structure refactor todo --- TODO.md | 47 +++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 45 insertions(+), 2 deletions(-) diff --git a/TODO.md b/TODO.md index dc0f8ba6..3827cd52 100644 --- a/TODO.md +++ b/TODO.md @@ -1,6 +1,49 @@ # TODO -## Declaring NixOS MicroVMs +## Structure Notes + +I believe that the documentation needs to be restructured in the following way: + + +1. Intro + +Quick microvm configuration + + 2. microvm module + + 3. Running a MicroVM as a package + +Advanced microvm configuration + + 4. Preparing host for Declarative microvm + + 4.1. A simple network setup + + 4.2. Advanced network setup + + 4.3. Host systemd services + + 4.4. Host options reference + + 5. Declarative approach + + 6. Imperative approach + + 7. deploy via ssh + +Configuration options + + 8. configuration options for the **host** + + 9. configuration options for the **VMs** + +Important + + 10. Conventions + + 11. Configuration examples + + 12. Frequently Asked Questions + - From 354fd8f8c094f028b913be8985adfa6222248d57 Mon Sep 17 00:00:00 2001 From: tdr Date: Thu, 12 Sep 2024 04:30:45 +0200 Subject: [PATCH 3/4] first 3 notes added --- TODO.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/TODO.md b/TODO.md index 3827cd52..0f46c241 100644 --- a/TODO.md +++ b/TODO.md @@ -46,4 +46,25 @@ Important 12. Frequently Asked Questions +## General Notes + +- [ ] its important to include the intended use case of microvm, and how the user is meant to interact with it + + * (from what i understand) the recommended way of using microVMs is with declarative deployment, but imperative management. This needs to be clearly stated, and most documentation must be focused on that way of deployment. + + * an overview of the such setup and its workflow has to be described in great detail + +- [ ] ways of interacting with a declared VM. + + * Its uni intuitive that there is no easy way of directly interacting with a VM if its deployed in any way except for ```nix run .#my-microvm```, this must be explained. + + * In order to cover more use cases, an in detail explanation of how to connnect to tty of a declared vm must also be created, as most users will want this. + + +- [ ] all explanations should be made step by step, with an assumption that the reader is poorly familiar with nix. + + * This is important not only for new users, but for anyone trying to debug, or has gaps in knowledge + + + From d7f8d82c9669c54c26f445b27c344996449f97d4 Mon Sep 17 00:00:00 2001 From: tdr Date: Sat, 14 Sep 2024 17:30:55 +0200 Subject: [PATCH 4/4] last big bullet point added --- TODO.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/TODO.md b/TODO.md index 0f46c241..43e2034c 100644 --- a/TODO.md +++ b/TODO.md @@ -65,6 +65,11 @@ Important * This is important not only for new users, but for anyone trying to debug, or has gaps in knowledge +- [ ] An extensive page with configuration examples + + * this page should contain examples of how people set microvms up + + * I understand the complexity of making such page, but having one will be highly benefitial, as it will clearly demonstrate the full potential of this project