diff --git a/README.md b/README.md index d989bc8..23d26cf 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,10 @@ -# mkvm +# waifud -Makes a virtual machine from a bunch of templates using -[cloud-init](https://cloudinit.readthedocs.io/en/latest/) userdata to customize -them. +A few tools to help me manage and run virtual machines across a homelab cluster. -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. +waifud was made for my own personal use and I do not expect it to be very useful +outside that context. -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: +THIS IS EXPERIMENTAL! USE IT AT YOUR OWN PERIL! -```console -$ sudo zfs create -o mountpoint=none rpool/mkvm-test -``` - -Do not be surprised if this misbehaves. You have been warned. +TODO(Xe): Link to blogpost on the design/implementation once it is a thing. diff --git a/cmd/mkvm/README.md b/cmd/mkvm/README.md new file mode 100644 index 0000000..d989bc8 --- /dev/null +++ b/cmd/mkvm/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. diff --git a/data/data.go b/data/data.go index e4e8c93..b6a81d2 100644 --- a/data/data.go +++ b/data/data.go @@ -2,5 +2,5 @@ package data import "embed" -// go:embed names.json distros.dhall +//go:embed names.json distros.dhall var FS embed.FS diff --git a/templates/templates.go b/templates/templates.go index 63eedf3..2422fca 100644 --- a/templates/templates.go +++ b/templates/templates.go @@ -2,5 +2,5 @@ package templates import "embed" -// go:embed meta-data *.xml +//go:embed meta-data *.xml var FS embed.FS