update README

Signed-off-by: Christine Dodrill <me@christine.website>
This commit is contained in:
Cadey Ratio 2021-05-30 14:53:32 -04:00
parent 8f83aeb213
commit 288e4a67c4
4 changed files with 31 additions and 21 deletions

View File

@ -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:
<big>THIS IS EXPERIMENTAL! USE IT AT YOUR OWN PERIL!</big>
```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.

23
cmd/mkvm/README.md Normal file
View File

@ -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.

View File

@ -2,5 +2,5 @@ package data
import "embed"
// go:embed names.json distros.dhall
//go:embed names.json distros.dhall
var FS embed.FS

View File

@ -2,5 +2,5 @@ package templates
import "embed"
// go:embed meta-data *.xml
//go:embed meta-data *.xml
var FS embed.FS