From 7c0a34c07d58721ebe3f087f6b716797b96fafa2 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sun, 14 Mar 2021 09:23:11 +0200 Subject: doc: explain about base images --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 7c56cec..930910d 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,15 @@ $ vmadm help $ vmadm --help ~~~ +A base image is an image with some operating system already installed. +It should use [cloud-init][] on first boot to configure hostname and +SSH keys, or at least not mind that there is an extra ISO disk with +cloud-init configuration attached to the VM. It should open an SSH +port when it has booted. Other than that, vmadm doesn't care what it +is. For Debian, the pre-made OpenStack cloud-image at + works well. You need to download the base +image yourself, vmadm doesn't do that for you. + ## Configuration The default configuration file is `vmadm/config.yaml` under the XDG -- cgit v1.2.1