Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TODO file created #274

Draft
wants to merge 4 commits into
base: gh-pages
Choose a base branch
from
Draft
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# TODO

## Structure Notes

I believe that the documentation needs to be restructured in the following way:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.



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
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploying via ssh actually is a special feature of imperative MicroVMs


Configuration options

8. configuration options for the **host**

9. configuration options for the **VMs**

Important

10. Conventions

11. Configuration examples

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.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the intended use-cases are:

  • Running from a package
  • Running from systemd, declarative
  • Running from systemd, imperative


* 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.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where? I am still open to actual functionality improvements. See #123


* 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.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Run the VM from package in screen/tmux/zellij, not through systemd

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like to declare everything in my nixos config, but sometimes I just want to login to the vm and make sure it's doing what I thought, maybe test some minor changes that I would backport into the config



- [ ] 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
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wish you added TODO notes in the existing docs at wherever you think there are knowledge gaps.