From 9cfcbcb4012011bb2199c3d1e882f5c15131d60e Mon Sep 17 00:00:00 2001 From: Christine Dodrill Date: Sun, 16 May 2021 17:27:09 -0400 Subject: [PATCH] add README Signed-off-by: Christine Dodrill --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d989bc8 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# mkvm + +Makes a virtual machine from a bunch of templates using +[cloud-init](https://cloudinit.readthedocs.io/en/latest/) userdata to customize +them. + +This is an experimental tool I made for testing [this Tailscale +PR](https://github.com/tailscale/tailscale/pull/1934). Normally I assume that +this kind of stuff is very unsupported, however in this case I want to make an +exception and mention this explicitly: this tool is an unsupported thing I made +only to scratch an itch I've been having. If you want this tool to be supported, +please [contact me](https://christine.website) and arrange for a license and +payment. + +This has only been tested on and assumes that it is running on NixOS with a zfs +root filesystem. You may need to create the parent zfs volume for VM disks with +a command like this: + +```console +$ sudo zfs create -o mountpoint=none rpool/mkvm-test +``` + +Do not be surprised if this misbehaves. You have been warned.