From 6ccb983f10b2e93f8d3d9e799362da956a75c944 Mon Sep 17 00:00:00 2001 From: Finn Date: Mon, 2 Dec 2024 23:01:17 -0800 Subject: [PATCH] Add note about config file to README --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f27dc68..c3ced7b 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,20 @@ Usage: mkvm name [name [name]] [flags] Flags: - -c, --cpu int the number of vCPU cores to assign to the VM (default 2) - -d, --disk int disk size (in GB) (default 25) - -h, --help help for mkvm - --image string URL of the image to download (default "https://cloud.debian.org/images/cloud/bookworm/latest/debian-12-generic-amd64.qcow2") - -m, --memory int amount of memory (in MB) to assign to the VM (default 1024) - -p, --packages stringArray packages to install on the VM - -s, --ssh-keys stringArray SSH key(s) authorzed to access the VM + -c, --cpu int the number of vCPU cores to assign to the VM (default 2) + -d, --disk int disk size (in GB) (default 25) + -h, --help help for mkvm + --image string URL of the image to download (default "https://cloud.debian.org/images/cloud/bookworm/latest/debian-12-generic-amd64.qcow2") + -m, --memory int amount of memory (in MB) to assign to the VM (default 1024) + -p, --packages stringArray packages to install on the VM + -s, --ssh-key-urls stringArray URL(s) to SSH key(s) authorzed to access the VM. Expected in authorized_keys format. + --ssh-keys stringArray SSH key(s) authorzed to access the VM +``` + +The default storage pool and network are used, unless overwridden by a config file at `~/.config/mkvm.yaml`. The following options are available: + +```yaml +storage_pool: default # must match an active libvirt storage pool +network: default # the libvirt network to use +bridge: br0 # bridge interface to configure VMs to use instead of a libvirt network. Ignored if network is set. ```