Fix nasty bug for debian images

Issue/glitch with kernel panic on first run seems to be fixed on Debian
Bookworm (12). Do not reset VM for that version (and hopefully
upcoming).

README.rst

@@ -2,8 +2,8 @@
 box.py
 ======
 
-Box.py is a simple automation tool meant to run Ubuntu, Fedora or Centos Stream
+Box.py is a simple automation tool meant to run Ubuntu, Fedora, Centos Stream
-cloud images on top of VirtualBox.
+or Debian cloud images on top of VirtualBox.
 
 What it does is simply download official cloud image, set up VM, tweak it up
 and do the initial pre-configuration using generated config drive.
@@ -16,7 +16,7 @@ weird named options for ``vboxmanage`` ;P)
 Requirements
 ------------
 
-- Python >=3.7
+- Python >=3.8
 
   - `pyyaml`_
   - `requests`_
@@ -24,7 +24,7 @@ Requirements
 - Virtualbox (obviously)
 - ``mkisofs`` or ``genisoimage`` command for generating ISO image
 - ``wget`` command for fetching images
-- ``sha256sum`` command for checksum check
+- ``sha256sum`` and ``sha512sum`` commands for checksum check
 - ``qemu-img`` from *qemu-utils* package command for converting between images
   formats
 
@@ -39,7 +39,7 @@ your operating system, or by using virtualenv for Python requirements, i.e.:
 
    $ python -m virtualenv .venv
    $ . .venv/bin/activate
-   (.venv) $ pip install requirements.txt
+   (.venv) $ pip install -r requirements.txt
 
 then you can issue:
 
@@ -55,7 +55,7 @@ or simply link it somewhere in the path:
    $ chmod +x ~/bin/boxpy
 
 and now you can issue some command. For example, to spin up a VM with Ubuntu
-18.04 with one CPU, 2GB of memory and 10GB of disk:
+18.04 with one CPU, 1GB of memory and 6GB of disk:
 
 .. code:: shell-session
 
@@ -91,17 +91,23 @@ use it ad-hoc, or place on your ``.bashrc`` or whatever:
 
 Currently, following commands are available:
 
-- ``list`` - for quickly listing all/running VMs
+- ``completion`` - as described above
-- ``info`` - to get summary about VM
-- ``destroy`` - that is probably obvious one
 - ``create`` - create new VM
+- ``destroy`` - that is probably obvious one
+- ``info`` - to get summary about VM
+- ``list`` - for quickly listing all/running VMs
 - ``rebuild`` - recreate specified VM
 - ``ssh`` - connect to the VM using ssh
-- ``completion`` - as described above
+- ``start`` - stop the running VM
+- ``stop`` - start stopped VM
 
 All of the commands have a range of options, and can be examined by using
 ``--help`` option.
 
+
+YAML Configuration
+------------------
+
 What is more interesting though, is the fact, that you can pass your own
 `cloud-init`_ yaml file, so that VM can be provisioned in easy way.
 
@@ -203,6 +209,19 @@ configuration additional NIC for virtual machine, i.e:
      advanced:
        nic2: intnet
 
+To select image from local file system, it is possible to set one by providing
+it under ``boxpy_data.image`` key:
+
+.. code:: yaml
+
+   …
+   boxpy_data:
+     image: /path/to/the/qcow2/image
+     default_user: cloud-user
+
+Note, that default_user is also needed to be provided, as there is no guess,
+what is the default username for cloud-init configured within provided image.
+
 
 License
 -------

box.py

@@ -18,14 +18,15 @@ import requests
 import yaml
 
 
-__version__ = "1.3"
+__version__ = "1.9.1"
 
 CACHE_DIR = os.environ.get('XDG_CACHE_HOME', os.path.expanduser('~/.cache'))
 CLOUD_IMAGE = "ci.iso"
 FEDORA_RELEASE_MAP = {'32': '1.6', '33': '1.2', '34': '1.2'}
+DEBIAN_CODENAME_MAP = {'12': 'bookworm', '11': 'bullseye', '10': 'buster'}
 TYPE_MAP = {'HardDisk': 'disk', 'DVD': 'dvd', 'Floppy': 'floppy'}
 DISTRO_MAP = {'ubuntu': 'Ubuntu', 'fedora': 'Fedora',
-              'centos': 'Centos Stream'}
+              'centos': 'Centos Stream', 'debian': 'Debian'}
 META_DATA_TPL = string.Template('''\
 instance-id: $instance_id
 local-hostname: $vmhostname
@@ -46,9 +47,9 @@ ssh:
   emit_keys_to_console: false
 boxpy_data:
   cpus: 1
-  disk_size: 10240
+  disk_size: 6144
   key: ~/.ssh/id_rsa
-  memory: 2048
+  memory: 1024
 '''
 COMPLETIONS = {'bash': '''\
 _boxpy() {
@@ -125,7 +126,7 @@ _boxpy() {
         fi
     fi
 
-    opts="create destroy rebuild info list completion ssh"
+    opts="create destroy rebuild info list completion ssh start stop"
     if [[ ${cur} == "-q" || ${cur} == "-v" || ${COMP_CWORD} -eq 1 ]] ; then
         COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
         return 0
@@ -137,11 +138,36 @@ _boxpy() {
                 COMPREPLY=( $(compgen -W "bash" -- ${cur}) )
             fi
             ;;
-        create|rebuild)
+        start)
-            items=(--cpus --disable-nested --disk-size --distro --forwarding
+            items=(--type)
-                --key --memory --hostname --port --config --version --type)
             if [[ ${prev} == ${cmd} ]]; then
-                if [[ ${cmd} = "rebuild" ]]; then
+                if [[ ${cmd} = "start" ]]; then
+                    _vms_comp vms
+                else
+                    COMPREPLY=( $(compgen -W "${items[*]}" -- ${cur}) )
+                fi
+            else
+                _get_excluded_items "${items[@]}"
+                COMPREPLY=( $(compgen -W "$result" -- ${cur}) )
+
+                case "${prev}" in
+                    --type)
+                        COMPREPLY=( $(compgen -W "gui headless sdl separate" \
+                            -- ${cur}) )
+                        ;;
+                    --*)
+                        COMPREPLY=( )
+                        ;;
+                esac
+            fi
+
+            ;;
+        create|rebuild)
+            items=(--cpus --disable-nested --disk-size --default-user --distro
+                --forwarding --image --key --memory --hostname --port --config
+                --version --type)
+            if [[ ${prev} == ${cmd} ]]; then
+                if [[ ${cmd} = "rebuild" || ${cmd} == "start" ]]; then
                     _vms_comp vms
                 else
                     COMPREPLY=( $(compgen -W "${items[*]}" -- ${cur}) )
@@ -159,8 +185,8 @@ _boxpy() {
                         _ssh_identityfile
                         ;;
                     --distro)
-                        COMPREPLY=( $(compgen -W "ubuntu fedora centos" \
+                        COMPREPLY=( $(compgen -W "ubuntu fedora centos
-                                -- ${cur}) )
+                            debian" -- ${cur}) )
                         ;;
                     --type)
                         COMPREPLY=( $(compgen -W "gui headless sdl separate" \
@@ -193,6 +219,11 @@ _boxpy() {
                 _vms_comp runningvms
             fi
             ;;
+        stop)
+            if [[ ${prev} == ${cmd} ]]; then
+                _vms_comp runningvms
+            fi
+            ;;
     esac
 
 }
@@ -257,6 +288,10 @@ class BoxVBoxFailure(BoxError):
     pass
 
 
+class BoxConfError(BoxError):
+    pass
+
+
 class FakeLogger:
     """
     print based "logger" class. I like to use 'end' parameter of print
@@ -348,23 +383,26 @@ class FakeLogger:
 
 class Config:
     ATTRS = ('cpus', 'config', 'creator', 'disable_nested', 'disk_size',
-             'distro', 'forwarding', 'hostname', 'key', 'memory', 'name',
+             'distro', 'default_user', 'forwarding', 'hostname', 'image',
-             'port', 'version')
+             'key', 'memory', 'name', 'port', 'version', 'username')
 
     def __init__(self, args, vbox=None):
         self.advanced = None
         self.distro = None
+        self.default_user = None
         self.cpus = None
         self.creator = None
         self.disable_nested = 'False'
         self.disk_size = None
         self.forwarding = {}
         self.hostname = None
+        self.image = None
         self.key = None
         self.memory = None
         self.name = args.name  # this one is not stored anywhere
         self.port = None       # at least is not even tried to be retrieved
         self.version = None
+        self.username = None
         self._conf = {}
 
         # set defaults stored in hard coded yaml
@@ -401,6 +439,10 @@ class Config:
                 continue
             setattr(self, attr, str(val))
 
+        # sort out case, where there is image/default-user provided
+        if self.image:
+            self._update_distros_with_custom_image()
+
         # set distribution and version if not specified by user
         if not self.distro:
             self.distro = 'ubuntu'
@@ -487,7 +529,7 @@ class Config:
             self.ssh_key_path = os.path.join(os.path.expanduser("~/.ssh"),
                                              self.ssh_key_path)
         if not os.path.exists(self.ssh_key_path):
-            raise BoxNotFound(f'Cannot find ssh public key: {self.key}')
+            raise BoxConfError(f'Cannot find ssh public key: {self.key}')
 
     def _set_defaults(self):
         conf = yaml.safe_load(USER_DATA)
@@ -542,6 +584,18 @@ class Config:
 
         self._conf = conf
 
+    def _update_distros_with_custom_image(self):
+        self.image = os.path.abspath(self.image)
+        self.distro = 'custom'
+        if not self.username:
+            self.username = self.default_user
+        DISTROS['custom'] = {'username': self.default_user,
+                             'realname': 'custom os',
+                             'img_class': CustomImage,
+                             'amd64': 'x86_64',
+                             'image': self.image,
+                             'default_version': '0'}
+
     def _update(self, source, update):
         for key, val in update.items():
             if isinstance(val, collections.abc.Mapping):
@@ -551,6 +605,50 @@ class Config:
         return source
 
 
+class OsTypes:
+    def __init__(self, conf):
+        self._conf = conf
+        self._ostypes = []
+
+        self._gather_os_types()
+
+    def _gather_os_types(self):
+        out = Run(['vboxmanage', 'list', 'ostypes']).stdout
+        for line in out.split('\n'):
+            if not line.startswith('ID:'):
+                continue
+            self._ostypes.append(line.split(':')[1].strip())
+
+    def ubuntu(self):
+        lts = ''
+        major, minor = [int(x) for x in self._conf.version.split('.')]
+
+        if major % 2 == 0 and minor == 4:
+            lts = '_LTS'
+        name = "Ubuntu%s%s_64" % (major, lts)
+
+        if name not in self._ostypes:
+            return 'Ubuntu_64'
+
+        return name
+
+    def fedora(self):
+        return "Fedora_64"
+
+    def debian(self):
+        name = "Debian%s_64" % self._conf.version
+        if name not in self._ostypes:
+            return 'Debian_64'
+
+        return name
+
+    def get(self):
+        if not hasattr(self, self._conf.distro):
+            return "Linux_64"
+
+        return getattr(self, self._conf.distro)()
+
+
 class VBoxManage:
     """
     Class for dealing with vboxmanage commands
@@ -559,6 +657,7 @@ class VBoxManage:
         self.name_or_uuid = name_or_uuid
         self.vm_info = {}
         self.uuid = None
+        self.running = False
 
     def get_vm_base_path(self):
         path = self._get_vm_config()
@@ -610,6 +709,9 @@ class VBoxManage:
             if line.startswith('Config file:'):
                 self.vm_info['config_file'] = line.split('Config '
                                                          'file:')[1].strip()
+
+            if line.startswith('State:'):
+                self.running = line.split(':')[1].strip().startswith('running')
                 break
 
         dom = xml.dom.minidom.parse(self.vm_info['config_file'])
@@ -653,6 +755,9 @@ class VBoxManage:
     def poweroff(self):
         Run(['vboxmanage', 'controlvm', self.name_or_uuid, 'poweroff'])
 
+    def acpipowerbutton(self):
+        Run(['vboxmanage', 'controlvm', self.name_or_uuid, 'acpipowerbutton'])
+
     def vmlist(self, only_running=False, long_list=False, only_boxpy=False):
         subcommand = 'runningvms' if only_running else 'vms'
         machines = {}
@@ -702,6 +807,12 @@ class VBoxManage:
             LOG.fatal('Failed to create VM:\n%s', out.stderr)
             return None
 
+        if out.stdout.startswith('WARNING:'):
+            LOG.fatal('Created crippled VM:\n%s\nFix the issue with '
+                      'VirtualBox, remove the dead VM and start over.',
+                      out.stdout)
+            return None
+
         for line in out.stdout.split('\n'):
             if line.startswith('UUID:'):
                 self.uuid = line.split('UUID:')[1].strip()
@@ -718,7 +829,11 @@ class VBoxManage:
                '--acpi', 'on',
                '--audio', 'none',
                '--nic1', 'nat',
-               '--natpf1', f'boxpyssh,tcp,,{port},,22']
+               '--natpf1', f'boxpyssh,tcp,,{port},,22',
+               '--graphicscontroller', 'vmsvga',
+               '--vram', '16',
+               '--ostype', OsTypes(conf).get()]
+
         for count, (hostport, vmport) in enumerate(conf.forwarding.items(),
                                                    start=1):
             cmd.extend(['--natpf1', f'custom-pf-{count},tcp,,{hostport},'
@@ -867,11 +982,12 @@ class VBoxManage:
 class Image:
     URL = ""
     IMG = ""
+    CHECKSUMTOOL = 'sha256sum'
 
-    def __init__(self, vbox, version, arch, release):
+    def __init__(self, vbox, version, arch, release, fname=None):
         self.vbox = vbox
         self._tmp = tempfile.mkdtemp(prefix='boxpy_')
-        self._img_fname = None
+        self._img_fname = fname
 
     def convert_to_vdi(self, disk_img, size):
         LOG.info('Converting and resizing "%s", new size: %s', disk_img, size)
@@ -917,7 +1033,7 @@ class Image:
             return False
 
         if os.path.exists(os.path.join(CACHE_DIR, self._img_fname)):
-            cmd = ['sha256sum', os.path.join(CACHE_DIR, self._img_fname)]
+            cmd = [self.CHECKSUMTOOL, os.path.join(CACHE_DIR, self._img_fname)]
             calulated_sum = Run(cmd).stdout.split(' ')[0]
             LOG.details('Checksum for image: %s, expected: %s', calulated_sum,
                         expected_sum)
@@ -931,7 +1047,8 @@ class Image:
             return True
 
         fname = os.path.join(CACHE_DIR, self._img_fname)
-        LOG.header('Downloading image %s', self._img_fname)
+        LOG.header('Downloading image %s from %s', self._img_fname,
+                   self._img_url)
         Run(['wget', '-q', self._img_url, '-O', fname])
 
         if not self._checksum():
@@ -950,7 +1067,7 @@ class Ubuntu(Image):
     URL = "https://cloud-images.ubuntu.com/releases/%s/release/%s"
     IMG = "ubuntu-%s-server-cloudimg-%s.img"
 
-    def __init__(self, vbox, version, arch, release):
+    def __init__(self, vbox, version, arch, release, fname=None):
         super().__init__(vbox, version, arch, release)
         self._img_fname = self.IMG % (version, arch)
         self._img_url = self.URL % (version, self._img_fname)
@@ -969,13 +1086,37 @@ class Ubuntu(Image):
         return expected_sum
 
 
+class Debian(Image):
+    URL = "https://cloud.debian.org/images/cloud/%s/daily/latest/%s"
+    IMG = "debian-%s-generic-%s-daily.qcow2"
+    CHECKSUMTOOL = 'sha512sum'
+
+    def __init__(self, vbox, version, arch, release, fname=None):
+        super().__init__(vbox, version, arch, release)
+        self._img_fname = self.IMG % (version, arch)
+        self._img_url = self.URL % (release, self._img_fname)
+        self._checksum_file = 'SHA512SUMS'
+        self._checksum_url = self.URL % (release, self._checksum_file)
+
+    def _get_checksum(self, fname):
+        expected_sum = None
+        Run(['wget', self._checksum_url, '-q', '-O', fname])
+        with open(fname) as fobj:
+            for line in fobj.readlines():
+                if self._img_fname in line:
+                    expected_sum = line.split(' ')[0]
+                    break
+
+        return expected_sum
+
+
 class Fedora(Image):
     URL = ("https://download.fedoraproject.org/pub/fedora/linux/releases/%s/"
            "Cloud/%s/images/%s")
     IMG = "Fedora-Cloud-Base-%s-%s.%s.qcow2"
     CHKS = "Fedora-Cloud-%s-%s-%s-CHECKSUM"
 
-    def __init__(self, vbox, version, arch, release):
+    def __init__(self, vbox, version, arch, release, fname=None):
         super().__init__(vbox, version, arch, release)
         self._img_fname = self.IMG % (version, release, arch)
         self._img_url = self.URL % (version, arch, self._img_fname)
@@ -998,10 +1139,10 @@ class Fedora(Image):
 
 class CentosStream(Image):
     URL = "https://cloud.centos.org/centos/%s-stream/%s/images/%s"
-    IMG = '.*(CentOS-Stream-GenericCloud-%s-[0-9]+\.[0-9].%s.qcow2).*'
+    IMG = '.*(CentOS-Stream-GenericCloud-%s-[0-9]+.[0-9].%s.qcow2).*'
     CHKS = "CHECKSUM"
 
-    def __init__(self, vbox, version, arch, release):
+    def __init__(self, vbox, version, arch, release, fname=None):
         super().__init__(vbox, version, arch, release)
         self._checksum_file = '%s-centos-stream-%s-%s' % (self.CHKS, version,
                                                           arch)
@@ -1012,12 +1153,13 @@ class CentosStream(Image):
         self._img_url = self.URL % (version, arch, self._img_fname)
 
     def _get_image_name(self, version, arch):
-        Run(['wget', self._checksum_url, '-q', '-O', self._checksum_file])
+        fname = os.path.join(self._tmp, self._checksum_file)
+        Run(['wget', self._checksum_url, '-q', '-O', fname])
 
         pat = re.compile(self.IMG % (version, arch))
 
         images = []
-        with open(self._checksum_file) as fobj:
+        with open(fname) as fobj:
             for line in fobj.read().strip().split('\n'):
                 line = line.strip()
                 if line.startswith('#'):
@@ -1026,6 +1168,7 @@ class CentosStream(Image):
                 if match and match.groups():
                     images.append(match.groups()[0])
 
+        Run(['rm', fname])
         images.reverse()
         if images:
             return images[0]
@@ -1044,11 +1187,18 @@ class CentosStream(Image):
         return expected_sum
 
 
+class CustomImage(Image):
+
+    def _download_image(self):
+        # just use provided image
+        return True
+
+
 DISTROS = {'ubuntu': {'username': 'ubuntu',
                       'realname': 'ubuntu',
                       'img_class': Ubuntu,
                       'amd64': 'amd64',
-                      'default_version': '20.04'},
+                      'default_version': '22.04'},
            'fedora': {'username': 'fedora',
                       'realname': 'fedora',
                       'img_class': Fedora,
@@ -1058,15 +1208,22 @@ DISTROS = {'ubuntu': {'username': 'ubuntu',
                       'realname': 'centos',
                       'img_class': CentosStream,
                       'amd64': 'x86_64',
-                      'default_version': '8'}}
+                      'default_version': '8'},
+           'debian': {'username': 'debian',
+                      'realname': 'debian',
+                      'img_class': Debian,
+                      'amd64': 'amd64',
+                      'default_version': '11'}}
 
 
 def get_image_object(vbox, version, image='ubuntu', arch='amd64'):
     release = None
     if image == 'fedora':
         release = FEDORA_RELEASE_MAP[version]
+    if image == 'debian':
+        release = DEBIAN_CODENAME_MAP[version]
     return DISTROS[image]['img_class'](vbox, version, DISTROS[image]['amd64'],
-                                       release)
+                                       release, DISTROS[image].get('image'))
 
 
 class IsoImage:
@@ -1117,7 +1274,8 @@ def vmcreate(args, conf=None):
     if not conf:
         try:
             conf = Config(args)
-        except BoxNotFound:
+        except BoxConfError as err:
+            LOG.fatal(f'Configuration error: {err.args[0]}.')
             return 7
         except yaml.YAMLError:
             LOG.fatal(f'Cannot read or parse file `{args.config}` as YAML '
@@ -1141,7 +1299,9 @@ def vmcreate(args, conf=None):
     if not vbox.create_controller('SATA', 'sata'):
         return 4
 
-    for key in ('distro', 'hostname', 'key', 'version'):
+    for key in ('distro', 'hostname', 'key', 'version', 'image', 'username'):
+        if getattr(conf, key) is None:
+            continue
         if not vbox.setextradata(key, getattr(conf, key)):
             return 5
 
@@ -1179,34 +1339,69 @@ def vmcreate(args, conf=None):
 
     # than, let's try to see if boostraping process has finished
     LOG.info('Waiting for cloud init to finish ', end='')
+    username = DISTROS[conf.distro]["username"]
     cmd = ['ssh', '-o', 'StrictHostKeyChecking=no',
            '-o', 'UserKnownHostsFile=/dev/null',
            '-o', 'ConnectTimeout=2',
            '-i', conf.ssh_key_path[:-4],
-           f'ssh://{DISTROS[conf.distro]["username"]}'
+           f'ssh://{username}@localhost:{vbox.vm_info["port"]}',
-           f'@localhost:{vbox.vm_info["port"]}', 'sudo cloud-init status']
+           'sudo cloud-init status']
     try:
+        counter = 0
         while True:
-            out = Run(cmd).stdout
+            out = Run(cmd)
-            LOG.debug('Out: %s', out)
+            LOG.debug('Out: %s', out.stdout)
 
-            if (not out) or ('status' in out and 'running' in out):
+            if (not out.stdout) or ('status' in out.stdout and
+                                    'running' in out.stdout):
                 LOG.info('.', end='')
                 sys.stdout.flush()
+                if 'Permission denied (publickey)' in out.stderr:
+                    if conf.username and conf.username != username:
+                        username = conf.username
+                        vbox.setextradata('username', username)
+                        cmd[9] = (f'ssh://{username}'
+                                  f'@localhost:{vbox.vm_info["port"]}')
+                        continue
+                    raise PermissionError(f'There is an issue with accessing '
+                                          f'VM with ssh for user {username}. '
+                                          f'Check output in debug mode.')
                 time.sleep(3)
+                counter += 1
+
+                # TODO: there is something odd with debian cloud images prior
+                # to 12 (bookworm), as on first run system crashes. In that
+                # case after ~20 seconds there should already be panic, reset
+                # machine as a workaround. Remove this after debian 12
+                # stabilization later this year.
+                if (counter == 8 and conf.distro == 'debian'
+                        and conf.version != '12'):
+                    LOG.debug('Resetting `%s`, due to the issue with kernel '
+                              'panic on Debian %s the first run', conf.name,
+                              conf.version)
+                    counter += 1
+                    vbox.poweroff()
+                    time.sleep(3)
+                    vbox.poweron(args.type)
                 continue
 
             LOG.info(' done')
             break
-        out = out.split(':')[1].strip()
+        out = out.stdout.split(':')[1].strip()
         if out != 'done':
             cmd = cmd[:-1]
             cmd.append('cloud-init status -l')
             LOG.warning('Cloud init finished with "%s" status:\n%s', out,
                         Run(cmd).stdout)
 
+    except PermissionError:
+        LOG.info('\n')
+        iso.cleanup()
+        image.cleanup()
+        vbox.destroy()
+        raise
     except KeyboardInterrupt:
-        LOG.warning('\nIterrupted, cleaning up')
+        LOG.warning('\nInterrupted, cleaning up')
         iso.cleanup()
         image.cleanup()
         vbox.destroy()
@@ -1218,9 +1413,14 @@ def vmcreate(args, conf=None):
 
     # reread config to update fields
     conf = Config(args, vbox)
+    username = DISTROS[conf.distro]["username"]
     LOG.info('You can access your VM by issuing:')
+    if conf.username and conf.username != username:
         LOG.info(f'ssh -p {conf.port} -i {conf.ssh_key_path[:-4]} '
-             f'{DISTROS[conf.distro]["username"]}@localhost')
+                 f'{conf.username}@localhost')
+    else:
+        LOG.info(f'ssh -p {conf.port} -i {conf.ssh_key_path[:-4]} '
+                 f'{username}@localhost')
     LOG.info('or simply:')
     LOG.info(f'boxpy ssh {conf.name}')
     return 0
@@ -1337,7 +1537,8 @@ def vmrebuild(args):
 
     try:
         conf = Config(args, vbox)
-    except BoxNotFound:
+    except BoxNotFound as ex:
+        LOG.fatal(f'Error with parsing config: {ex}')
         return 8
     except yaml.YAMLError:
         LOG.fatal(f'Cannot read or parse file `{args.config}` as YAML '
@@ -1361,6 +1562,13 @@ def vmrebuild(args):
         conf.disk_size = vbox.get_media_size(disk_path)
 
     vmdestroy(args)
+
+    # Wait till VM is gone
+    while True:
+        vbox = VBoxManage(args.name)
+        if not vbox.get_vm_info():
+            break
+
     vmcreate(args, conf)
     return 0
 
@@ -1385,11 +1593,44 @@ def connect(args):
                   f'file.')
         return 16
 
-    return Run(['ssh', '-o', 'StrictHostKeyChecking=no',
+    username = conf.username or DISTROS[conf.distro]["username"]
+    cmd = ['ssh', '-o', 'StrictHostKeyChecking=no',
            '-o', 'UserKnownHostsFile=/dev/null',
            '-i', conf.ssh_key_path[:-4],
-                f'ssh://{DISTROS[conf.distro]["username"]}'
+           f'ssh://{username}'
-                f'@localhost:{conf.port}'], False).returncode
+           f'@localhost:{conf.port}']
+    LOG.debug('Connecting to vm `%s` using command:\n%s', args.name,
+              ' '.join(cmd))
+    return Run(cmd, False).returncode
+
+
+def _set_vmstate(name, state, guitype=None):
+
+    vbox = VBoxManage(name)
+    if not vbox.get_vm_info():
+        LOG.fatal(f'No machine has been found with a name `{name}`.')
+        return 20
+
+    if vbox.running and state == "start":
+        LOG.info(f'VM "{name}" is already running.')
+        return
+
+    if not vbox.running and state == "stop":
+        LOG.info(f'VM "{name}" is already stopped.')
+        return
+
+    if state == "start":
+        vbox.poweron(guitype)
+    else:
+        vbox.acpipowerbutton()
+
+
+def vmstart(args):
+    _set_vmstate(args.name, 'start', args.type)
+
+
+def vmstop(args):
+    _set_vmstate(args.name, 'stop')
 
 
 def main():
@@ -1419,10 +1660,16 @@ def main():
                         help="Alternative user-data template filepath")
     create.add_argument('-d', '--distro', help="Image name. 'ubuntu' is "
                         "default")
+    create.add_argument('-e', '--default-user', help="Default cloud-init user "
+                        "to be used with custom image (--image param). "
+                        "Without image it will make no effect.")
     create.add_argument('-f', '--forwarding', action='append', help="expose "
                         "port from VM to the host. It should be in format "
                         "'hostport:vmport'. this option can be used multiple "
                         "times for multiple ports.")
+    create.add_argument('-i', '--image', help="custom qcow2 image filepath. "
+                        "Note, that it requires to provide --default-user as "
+                        "well.")
     create.add_argument('-k', '--key', help="SSH key to be add to the config "
                         "drive. Default ~/.ssh/id_rsa")
     create.add_argument('-m', '--memory', help="amount of memory in "
@@ -1457,17 +1704,23 @@ def main():
                           help='show only running VMs')
     list_vms.set_defaults(func=vmlist)
 
-    rebuild = subparsers.add_parser('rebuild', help='Rebuild VM, all options '
+    rebuild = subparsers.add_parser('rebuild', help='rebuild VM, all options '
                                     'besides vm name are optional, and their '
                                     'values will be taken from vm definition.')
     rebuild.add_argument('name', help='name or UUID of the VM')
     rebuild.add_argument('-c', '--config',
                          help="Alternative user-data template filepath")
     rebuild.add_argument('-d', '--distro', help="Image name.")
+    rebuild.add_argument('-e', '--default-user', help="Default cloud-init "
+                         "user to be used with custom image (--image param). "
+                         "Without image it will make no effect.")
     rebuild.add_argument('-f', '--forwarding', action='append', help="expose "
                          "port from VM to the host. It should be in format "
                          "'hostport:vmport'. this option can be used multiple "
                          "times for multiple ports.")
+    rebuild.add_argument('-i', '--image', help="custom qcow2 image filepath. "
+                         "Note, that it requires to provide --default-user as "
+                         "well.")
     rebuild.add_argument('-k', '--key',
                          help='SSH key to be add to the config drive')
     rebuild.add_argument('-m', '--memory', help='amount of memory in '
@@ -1486,13 +1739,24 @@ def main():
     rebuild.add_argument('-v', '--version', help='distribution version')
     rebuild.set_defaults(func=vmrebuild)
 
+    start = subparsers.add_parser('start', help='start VM')
+    start.add_argument('name', help='name or UUID of the VM')
+    start.add_argument('-t', '--type', default='headless',
+                       help="VM run type, headless by default.",
+                       choices=['gui', 'headless', 'sdl', 'separate'])
+    start.set_defaults(func=vmstart)
+
+    stop = subparsers.add_parser('stop', help='stop VM')
+    stop.add_argument('name', help='name or UUID of the VM')
+    stop.set_defaults(func=vmstop)
+
     completion = subparsers.add_parser('completion', help='generate shell '
                                        'completion')
     completion.add_argument('shell', choices=['bash'],
                             help="pick shell to generate completions for")
     completion.set_defaults(func=shell_completion)
 
-    ssh = subparsers.add_parser('ssh', help='Connect to the machine via SSH')
+    ssh = subparsers.add_parser('ssh', help='connect to the machine via SSH')
     ssh.add_argument('name', help='name or UUID of the VM')
     ssh.set_defaults(func=connect)
 
@@ -1502,6 +1766,10 @@ def main():
 
     args = parser.parse_args()
 
+    if 'image' in args and 'default_user' not in args:
+        parser.error('Parameter --image requires --default-user')
+        return 22
+
     LOG.set_verbose(args.verbose, args.quiet)
 
     if 'func' not in args and args.version:

examples/devstack-ubuntu-20.04.yaml

@@ -29,7 +29,7 @@ runcmd:
   - [apt, purge, '-y', python3-pyasn1-modules]
   - [apt, purge, '-y', python3-simplejson]
   - [su, -, ubuntu, -c, "git clone https://github.com/gryf/vmstrap"]
-  - [su, -, ubuntu, -c, "vmstrap/bootstrap.sh"]
+  - [su, -, ubuntu, -c, "vmstrap/bootstrap.sh -c"]
   - [rm, -fr, /home/ubuntu/vmstrap]
   - [su, -, ubuntu, -c, "cp /tmp/local.conf /home/ubuntu/devstack/"]
   - [su, -, ubuntu, -c, "echo 'export HOST_IP=10.0.2.15' >> .bashrc"]

examples/kuryr_multinode_master.yaml

@@ -174,7 +174,7 @@ runcmd:
   - [apt, purge, '-y', python3-pyasn1-modules]
   - [apt, purge, '-y', python3-simplejson]
   - [su, -, ubuntu, -c, "git clone https://github.com/gryf/vmstrap"]
-  - [su, -, ubuntu, -c, "vmstrap/bootstrap.sh"]
+  - [su, -, ubuntu, -c, "vmstrap/bootstrap.sh -c"]
   - [rm, -fr, /home/ubuntu/vmstrap]
   - [su, -, ubuntu, -c, "echo 'export HOST_IP=192.168.10.10' >> .bashrc"]
   - [su, -, ubuntu, -c, "cp /tmp/local.conf /home/ubuntu/devstack/"]
@@ -186,3 +186,4 @@ boxpy_data:
   disk_size: 50GB
   advanced:
     nic2: intnet
+  version: 20.04

examples/kuryr_multinode_worker.yaml

@@ -123,7 +123,7 @@ runcmd:
   - [apt, purge, '-y', python3-pyasn1-modules]
   - [apt, purge, '-y', python3-simplejson]
   - [su, -, ubuntu, -c, "git clone https://github.com/gryf/vmstrap"]
-  - [su, -, ubuntu, -c, "vmstrap/bootstrap.sh"]
+  - [su, -, ubuntu, -c, "vmstrap/bootstrap.sh -c"]
   - [rm, -fr, /home/ubuntu/vmstrap]
   - [su, -, ubuntu, -c, "echo 'export HOST_IP=192.168.10.11' >> .bashrc"]
   - [su, -, ubuntu, -c, "cp /tmp/local.conf /home/ubuntu/devstack/"]
@@ -135,3 +135,4 @@ boxpy_data:
   disk_size: 50GB
   advanced:
     nic2: intnet
+  version: 20.04

examples/wmaker.yaml

@@ -1,5 +1,6 @@
 packages:
   - build-essential
+  - exuberant-ctags
   - gettext
   - libfontconfig1-dev
   - libgif-dev
@@ -21,12 +22,16 @@ packages:
   - libxrender-dev
   - libxt-dev
   - make
+  - mc
   - sharutils
+  - silversearcher-ag
+  - tmux
+  - vim-nox
   - xinit
 runcmd:
   - [su, -, ubuntu, -c, "git clone https://github.com/gryf/wmaker -b experimental"]
   - [su, -, ubuntu, -c, "git clone https://github.com/gryf/vmstrap"]
-  - [su, -, ubuntu, -c, "vmstrap/bootstrap.sh"]
+  - [su, -, ubuntu, -c, "vmstrap/bootstrap.sh -c"]
   - [rm, -fr, /home/ubuntu/vmstrap]
 boxpy_data:
   key: vm