summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
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
+<https://cloud.debian.org/> 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