vmdebootstrap.8.in

   1 .\" Copyright 2011 Lars Wirzenius <liw@liw.fi>
   2 .\"
   3 .\" This program is free software: you can redistribute it and/or modify
   4 .\" it under the terms of the GNU General Public License as published by
   5 .\" the Free Software Foundation, either version 3 of the License, or
   6 .\" (at your option) any later version.
   7 .\"
   8 .\" This program is distributed in the hope that it will be useful,
   9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 .\" GNU General Public License for more details.
  12 .\"
  13 .\" You should have received a copy of the GNU General Public License
  14 .\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15 .\"
  16 .TH VMDEBOOTSTRAP 8
  17 .SH NAME
  18 vmdebootstrap \- install basic Debian system into virtual disk image
  19 .SH SYNOPSIS
  20 .B vmdebootstrap
  21 \-\-image=FILE \-\-size=SIZE [\-\-mirror=URL] [\-\-distribution=NAME]
  22 .PP
  23 .B vmdebootstrap
  24 [\-\-output=FILE] [\-\-verbose |\-\-no-verbose] \-\-image=FILE \-\-size=SIZE
  25 [\-\-tarball=FILE] [\-\-mirror=URL] [\-\-arch=ARCH] [\-\-distribution=NAME]
  26 [\-\-package=PACKAGE] [\-\-custom-package=DEB] [\-\-no-kernel]
  27 [\-\-enable-dhcp | \-\-no-enable-dhcp] [\-\-root-password=PASSWORD]
  28 [\-\-customize=SCRIPT] [\-\-hostname=HOSTNAME] [\-\-user=USER/PASSWORD]
  29 [\-\-serial-console | \-\-no-serial-console] [\-\-sudo |\-\-no-sudo] [\-\-owner=OWNER]
  30 [\-\-bootsize=BOOTSIZE] [\-\-boottype=FSTYPE] [\-\-roottype=FSTYPE] [\-\-foreign=PATH]
  31 [\-\-variant=VARIANT] [\-\-no-extlinux] [\-\-squash] [\-\-configure-apt]
  32 [\-\-grub] [\-\-apt-mirror] [\-\-pkglist]
  33 .SH DESCRIPTION
  34 .B vmdebootstrap
  35 installs a basic Debian system into a virtual disk image,
  36 for use with virtual machines,
  37 such as KVM, Qemu, or VirtualBox.
  38 It is like
  39 .BR debootstrap (8),
  40 which does the same thing, but puts the system into a directory,
  41 for use with
  42 .BR chroot (8).
  43 (In fact,
  44 .B vmdebootstrap
  45 is a wrapper around
  46 .BR debootstrap ).
  47 .PP
  48 You need to run
  49 .B vmdebootstrap
  50 as root. If the \-\-verbose option is not used, no output will be
  51 sent to the command line. If the \-\-log option is not used, no
  52 output will be sent to any log files either.
  53 .PP
  54 To use the image,
  55 you probably want to create a virtual machine using your preferred
  56 virtualization technology, such as
  57 .BR kvm (1),
  58 or
  59 .BR qemu (1).
  60 Configure the virtual machine to use the image you've created.
  61 Then start the virtual machine, (see
  62 .B EXAMPLES
  63 )
  64 and log into it via its console to configure it.
  65 The image has an empty root password and will not have networking
  66 configured by default. Set the root password before you configure
  67 networking.
  68 .SH BOOTLOADERS
  69 Unless the \-\-no\-extlinux or \-\-grub options are specified, the
  70 image will use
  71 .BR extlinux (1)
  72 as a boot loader.
  73 .B bootsize
  74 is not recommended when using
  75 .B extlinux
  76 \- use grub instead.
  77 Versions of grub2 in wheezy
  78 can fail to install in the VM, at which point vmdebootstrap will fall back to
  79 extlinux. It may still be possible to complete the installation of grub2 after
  80 booting the VM as the problem may be related to the need to use loopback
  81 devices during the grub-install operation. Details of the error will appear in the
  82 vmdebootstrap log file, if enabled with the \-\-log option. Note that
  83 .B grub-legacy
  84 is not supported.
  85 .SH INSTALLATION IMAGES AND VIRTUAL MACHINES
  86 .B vmdebootstrap
  87 is aimed principally at creating virtual machines, not installers or prebuilt
  88 installation images. It is possible to create prebuilt installation images
  89 for some devices but this depends on the specific device. (A 'prebuilt
  90 installation image' is a single image file which can be written to physical
  91 media in a single operation and which allows the device to boot directly
  92 into a fully installed system \- in a similar way to how a virtual machine
  93 would behave.)
  94 .PP
  95 .B vmdebootstrap
  96 assumes that all operations take place on a local image file, not a
  97 physical block device / removable media.
  98 .PP
  99 .B vmdebootstrap
 100 is intended to be used with tools like qemu on the command line to launch
 101 a new virtual machine. Not all devices have virtualisation support in hardware.
 102 .PP
 103 This has implications for
 104 .B u-boot
 105 support in some cases. If the device can support reading the bootloader
 106 from a known partition, like the beaglebone-black, then
 107 .B vmdebootstrap
 108 can provide space for the bootloader and the image will work as a prebuilt
 109 installation image. If the device expects that the bootloader exists at a
 110 specific offset and therefore requires that the bootloader is written as
 111 an image not as a binary which can be copied into an existing partition,
 112 .B vmdebootstrap
 113 is unable to include that bootloader image into the virtual machine image.
 114 .PP
 115 The beagleboneblack.sh script in the examples/ directory provides a worked
 116 example to create a prebuilt installation image. However, the beagleboneblack
 117 itself does not support virtualisation in hardware, so is unable to launch
 118 a virtual machine. Other devices, like the Cubietruck or Wandboard need
 119 .B u-boot
 120 at a predefined offset but can launch a virtual machine using qemu, so
 121 the cubietruck and wandboard6q scripts in the examples/ directory relate
 122 to building images for virtual machines once the device is already
 123 installed and booted into a suitable kernel.
 124 .PP
 125 It is possible to wrap
 126 .B vmdebootstrap
 127 in such a way as to prepare a
 128 .B physical block device
 129 with a bootloader image and then deploy the bootstrap on top. However,
 130 this does require physical media to be inserted and removed each time
 131 the wrapper is executed. To do this, use the \-\-tarball option instead
 132 of the \-\-image option. Then setup the physical media and bootloader
 133 image manually, as required for the device, redefine the partitions to
 134 make space for the rootfs, create a filesystem on the physical media and
 135 unpack the
 136 .B vmdebootstrap
 137 tarball onto that filesystem. Once you have working media, an image can be
 138 created using dd to read back from the media to an image file, allowing
 139 other media to be written with a single image file.
 140 .SH OPTIONS
 141 .IP \-\-output=FILE
 142 write output to FILE, instead of standard output
 143 .IP \-\-verbose
 144 report what is going on
 145 .IP \-\-image=FILE
 146 put created disk image in FILE
 147 .IP \-\-size=SIZE
 148 create a disk image of size SIZE (1000000000)
 149 .IP \-\-tarball=FILE
 150 tar up the disk's contents in FILE
 151 .IP \-\-mirror=URL
 152 use MIRROR as package source (http://http.debian.net/debian/)
 153 .IP \-\-arch=ARCH
 154 architecture to use (amd64)
 155 .IP \-\-distribution=NAME
 156 release to use (stable)
 157 .IP \-\-package=PACKAGE
 158 install PACKAGE onto system
 159 .IP \-\-custom-package=DEB
 160 install package in DEB file onto system (not from mirror)
 161 .IP \-\-no-kernel
 162 do not install a linux package
 163 .IP \-\-enable-dhcp
 164 enable DHCP on eth0
 165 .IP \-\-root-password=PASSWORD
 166 set root password
 167 .IP \-\-customize=SCRIPT
 168 run SCRIPT after setting up system. If the script does not exist in the current
 169 working directory, /usr/share/vmdebootstrap/examples/ will be checked as a
 170 fallback. The script needs to be executable and is passed the root directory of
 171 the debootstrap as the only argument. Use chroot if you need to execute binaries
 172 within the debootstrap.
 173 .IP \-\-hostname=HOSTNAME
 174 set name to HOSTNAME (debian)
 175 .IP \-\-user=USER/PASSWORD
 176 create USER with PASSWORD
 177 .IP \-\-owner=OWNER
 178 change the owner of the final image from root to the specified user.
 179 .IP \-\-serial\-console
 180 configure image to use a serial console
 181 .IP \-\-serial-console-command
 182 set the command to manage the serial console which will be appended to
 183 /etc/inittab. Default is "/sbin/getty \-L ttyS0 115200 vt100", resulting in a line
 184 .BR "S0:23:respawn:/sbin/getty \-L ttyS0 115200 vt100"
 185 .IP \-\-sudo
 186 install sudo, and if user is created, add them to sudo group
 187 .IP \-\-bootsize=BOOTSIZE
 188 If specified, create a /boot partition of the given size within the image.
 189 Debootstrapping will fail if this is too small for the selected kernel package.
 190 .IP \-\-boottype=FSTYPE
 191 Filesystem to use for the /boot partition. (default ext2)
 192 .IP \-\-roottype=FSTYPE
 193 Filesystem to use for the / (root) partition. (default ext4)
 194 .IP \-\-swap=SWAPSIZE
 195 If specified, create a swap partition of the given size within the image.
 196 Debootstrapping will fail if this results in a root partition which is
 197 too small for the selected packages. The minimum swap space is 256Mb as
 198 the default memory allocation of QEMU is 128Mb. A default 1Gb image is
 199 not likely to have enough space for a swap partition as well.
 200 .IP \-\-foreign=PATH
 201 Path to the binfmt_handler to enable foreign support in debootstrap.
 202 e.g. /usr/bin/qemu-arm-static \- note foreign debootstraps may take a signficant
 203 amount of time to complete and that debootstrap will retry five times if
 204 packages fail to install by default.
 205 .IP \-\-no\-extlinux
 206 Skip installation of extlinux. needs a customize script to make the image
 207 bootable. Useful for architectures where extlinux is not supportable.
 208 Depending on how the image is to be booted, the \-\-mbr option may also be
 209 necessary with extlinux.
 210 .IP \-\-squash
 211 Run mksquashfs against the final image using xz compression \- requires
 212 squashfs-tools to be installed. The final file will have the .squashfs suffix.
 213 By default, mksquashfs is allowed to use all processors which may result
 214 in high load. Run mksquashfs separately if you need to control the number
 215 of processors used per run.
 216 .IP \-\-configure\-apt
 217 Use the specified mirror and distribution to create a suitable apt source inside
 218 the VM. Can be useful if debootstrap fails to create it automatically.
 219 .IP \-\-apt\-mirror
 220 Use the specified mirror inside the image instead of the mirror used to
 221 build the image. This is useful if you have a local mirror to make building
 222 the image quicker but the image needs to run even if that mirror is not
 223 available.
 224 .IP \-\-grub
 225 Disable extlinux installation and configure grub2 instead. grub2 will be added to
 226 the list of packages to install. update-grub will be called once the debootstrap is
 227 complete and grub-install will be called in the image.
 228 .IP \-\-pkglist
 229 Output a list of package names installed inside the image. Useful if you
 230 need to track the relevant source packages used inside the image for
 231 licence compliance.
 232 .SH Configuration files and settings:
 233 .IP \-\-dump-config
 234 write out the entire current configuration
 235 .IP \-\-no-default-configs
 236 clear list of configuration files to read
 237 .IP \-\-config=FILE
 238 add FILE to config files
 239 .SH Logging:
 240 .IP \-\-log=FILE
 241 write log entries to FILE (default is to not write log files at all);
 242 use "syslog" to log to system log, or "none" to disable logging
 243 .IP \-\-log-level=LEVEL
 244 log at LEVEL, one of debug, info, warning, error, critical, fatal (default: debug)
 245 .IP \-\-log-max=SIZE
 246 rotate logs larger than SIZE, zero for never (default: 0)
 247 .IP \-\-log-keep=N
 248 keep last N logs (10)
 249 .IP \-\-log-mode=MODE
 250 set permissions of new log files to MODE (octal;  default 0600)
 251 .SH Peformance:
 252 .IP \-\-dump-memory-profile=METHOD
 253 make memory profiling dumps using METHOD, which is one of:
 254 none, simple, meliae, or heapy (default: simple)
 255 .IP \-\-memory-dump-interval=SECONDS
 256 make memory profiling dumps at least SECONDS apart
 257 .SH EXAMPLE
 258 To create an image for the stable release of Debian:
 259 .nf
 260 .IP
 261 sudo vmdebootstrap \-\-image test.img \-\-size 1g \\
 262     \-\-log test.log \-\-log-level debug \-\-verbose \\
 263     \-\-mirror http://mirror.lan/debian/
 264 .PP
 265 To run the test image, make sure it is writeable. Use the \-\-owner
 266 option to set mode 0644 for the specified user or use chmod manually:
 267 .IP
 268 sudo chmod a+w ./test.img
 269 .PP
 270 Execute using qemu, e.g. on amd64 using qemu-system-x86_64:
 271 .IP
 272 qemu-system-x86_64 ./test.img
 273 .PP
 274 (This loads the image in a new window.)
 275 .PP
 276 For further examples, including u-boot support for beaglebone-black,
 277 see /usr/share/vmdebootstrap/examples
 278 .SH NOTES
 279 If you get problems with the bootstrap process, run a similar bootstrap
 280 call directly and chroot into the directory to investigate the failure.
 281 The actual debootstrap call is part of the vmdebootstrap logfile. The
 282 debootstrap logfile, if any, will be copied into your current working
 283 directory on error.
 284 .PP
 285 .B debootstrap
 286 will download all the apt archive files into the apt cache and does not
 287 remove them before starting the configuration of the packages. This can
 288 mean that debootstrap can fail due to a lack of space on the device if
 289 the VM size is small. vmdebootstrap cleans up the apt cache once debootstrap
 290 has finished but this doesn't help if the package unpack or configuration
 291 steps use up all of the space in the meantime. Avoid this problem by
 292 specifying a larger size for the image.
 293 .PP
 294 Note that if you are also using a separate /boot partition in your options to
 295 .B vmdebootstrap
 296 it may well be the boot partition which needs to be enlarged rather than
 297 the entire image.
 298 .PP
 299 It is advisable to change the mirror in the example scripts to a mirror
 300 closer to your location, particularly if you need to do repeated builds.
 301 Use the \-\-apt\-mirror option to specify the apt mirror to be used inside
 302 the image, after boot.
 303 .PP
 304 There are two types of examples for ARM devices available with
 305 .B vmdebootstrap:
 306 prebuilt installation images (like the beaglebone-black) and virtual
 307 machine images (cubietruck and wandboard). ARM devices which do not
 308 support hypervisor mode and which also rely on the bootloader being at
 309 a specific offset instead of using a normal partition will
 310 .B not
 311 be supportable by vmdebootstrap. Similarly, devices which support
 312 hypervisor will only be supported using virtual machine images, unless
 313 the bootloader can be executed from a normal partition.
 314 .PP
 315 .SH "SEE ALSO"
 316 .BR debootstrap (8)
 317 ,
 318 .BR qemu-system-x86_64 (1)
 319 ,
 320 .BR grub-install (8)
 321 .
 322 .SH BUGS
 323 Please provide the config section of the logfile when reporting bugs, as well as the complete command line.