README

   1 Libguestfs is a library for accessing and modifying guest disk images.
   2 Amongst the things this is good for: making batch configuration
   3 changes to guests, getting disk used/free statistics (see also:
   4 virt-df), migrating between virtualization systems (see also:
   5 virt-p2v), performing partial backups, performing partial guest
   6 clones, cloning guests and changing registry/UUID/hostname info, and
   7 much else besides.
   8
   9 Libguestfs uses Linux kernel and qemu code, and can access any type of
  10 guest filesystem that Linux and qemu can, including but not limited
  11 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
  12 schemes, qcow, qcow2, vmdk.
  13
  14 Libguestfs provides ways to enumerate guest storage (eg. partitions,
  15 LVs, what filesystem is in each LV, etc.).  It can also run commands
  16 in the context of the guest.  Also you can access filesystems over
  17 FUSE.
  18
  19 Libguestfs is a library that can be linked with C and C++ management
  20 programs (or management programs written in OCaml, Perl, Python, Ruby,
  21 Java, PHP, Haskell or C#).  You can also use it from shell scripts or the
  22 command line.
  23
  24 Libguestfs was written by Richard W.M. Jones (rjones@redhat.com) and
  25 hacked on by lots of other people.  For discussion, development,
  26 patches, etc. please use the mailing list:
  27
  28   http://www.redhat.com/mailman/listinfo/libguestfs
  29
  30
  31 Home page
  32 ----------------------------------------------------------------------
  33
  34   http://libguestfs.org/
  35
  36
  37 Requirements
  38 ----------------------------------------------------------------------
  39
  40 - recent QEMU >= 0.12 with virtio-serial support
  41
  42 - febootstrap >= 2.10
  43
  44 - fakeroot
  45
  46 - fakechroot >= 2.9
  47
  48 - XDR, rpcgen (on Linux these are provided by glibc)
  49
  50 - pcre (Perl Compatible Regular Expressions C library) (optional)
  51
  52 - libmagic (the library that corresponds to the 'file' command) (optional)
  53
  54 - libvirt
  55
  56 - libxml2
  57
  58 - Augeas (http://augeas.net/) (optional)
  59
  60 - squashfs-tools (mksquashfs only)
  61
  62 - genisoimage / mkisofs
  63
  64 - hivex >= 1.2.1 (http://libguestfs.org/download)
  65
  66 - (Optional) FUSE to build the FUSE module
  67
  68 - perldoc (pod2man, pod2text) to generate the manual pages and
  69   other documentation.
  70
  71 - (Optional) Readline to have nicer command-line editing in guestfish.
  72
  73 - (Optional) xmllint to validate virt-inspector RELAX NG schema
  74
  75 - (Optional) OCaml if you want to rebuild the generated files, and
  76   also to build the OCaml bindings
  77
  78 - (Optional) local Fedora mirror
  79
  80 - (Optional) Perl if you want to build the perl bindings
  81
  82 - (Optional) Python if you want to build the python bindings
  83
  84 - (Optional) Ruby, rake if you want to build the ruby bindings
  85
  86 - (Optional) Java, JNI, jpackage-utils if you want to build the java
  87 bindings
  88
  89 - (Optional) GHC if you want to build the Haskell bindings
  90
  91 - (Optional) Perl XML::XPath, Sys::Virt modules (for libvirt support
  92 in virt-inspector).
  93
  94 - (Optional, but highly recommended) perl-libintl for translating perl code.
  95
  96 - (Optional) po4a for translating manpages and POD files.
  97
  98 - (Optional) PHP, phpize if you want to build the PHP bindings
  99
 100 Running ./configure will check you have all the requirements installed
 101 on your machine.
 102
 103
 104 Building
 105 ----------------------------------------------------------------------
 106
 107 Then make the daemon, library and root filesystem:
 108
 109   ./configure [--with-mirror=URI]
 110   make
 111
 112 Use the optional --with-mirror parameter to specify the URI of a local
 113 Fedora mirror.  See the discussion of the MIRROR parameter in the
 114 febootstrap(8) manpage.
 115
 116 Finally run the tests:
 117
 118   make check
 119
 120 If everything works, you can install the library and tools by running
 121 this command as root:
 122
 123   make install
 124
 125
 126 Fedora
 127 ----------------------------------------------------------------------
 128
 129 We provide packages for Fedora >= 11 in Fedora.  Use those, or build
 130 from our source RPMs - it's far simpler that way.
 131
 132 You can compile libguestfs on Fedora 10 but you cannot use it with the
 133 version of qemu in Fedora 10.  You need to compile your own qemu, see
 134 section 'qemu' below.
 135
 136
 137 RHEL / EPEL / CentOS etc
 138 ----------------------------------------------------------------------
 139
 140 We provide packages in EPEL which cover RHEL/CentOS >= 5.  Use those
 141 or build from our source RPMs.
 142
 143
 144 Debian
 145 ----------------------------------------------------------------------
 146
 147 libguestfs is now built as a package in Debian by Guido Gunther and
 148 the other Debian libvirt maintainers.  See:
 149
 150 http://wiki.debian.org/Teams/DebianLibvirtTeam#Packages
 151
 152 You can build for Debian in two different ways, either building a
 153 Fedora-based appliance using febootstrap, yum, rpm, fakeroot,
 154 fakechroot (all packaged in Debian).  However the recommended way is
 155 to build a Debian-based appliance using debootstrap and debirf.
 156
 157 Both ways are supported by the configure script.
 158
 159
 160 qemu
 161 ----------------------------------------------------------------------
 162
 163 By far the most common problem is with broken or incompatible
 164 qemu releases.
 165
 166 Different versions of qemu have problems booting the appliance for
 167 different reasons.  This varies between versions of qemu, and Linux
 168 distributions which add their own patches.
 169
 170 If you find a problem, you could try using your own qemu built from
 171 source (qemu is very easy to build from source), with a 'qemu
 172 wrapper'.  Qemu wrappers are described in the guestfs(3) manpage.
 173
 174
 175 Note on using KVM
 176 ----------------------------------------------------------------------
 177
 178 By default the configure script will look for qemu-kvm (KVM support).
 179 You will need a reasonably recent processor for this to work.  KVM is
 180 much faster than using plain Qemu.
 181
 182 You may also need to enable KVM support for non-root users, by following
 183 these instructions:
 184
 185   http://www.linux-kvm.org/page/FAQ#How_can_I_use_kvm_with_a_non-privileged_user.3F
 186
 187 On some systems, this will work too:
 188
 189   chmod o+rw /dev/kvm
 190
 191 On some systems, the chmod will not survive a reboot, and you will
 192 need to make edits to the udev configuration.
 193
 194
 195 vmchannel
 196 ----------------------------------------------------------------------
 197
 198 Previous versions of libguestfs required something called "vmchannel".
 199 Vmchannel is a special device given to virtual machines which allows
 200 them to communicate in some way with the host, often (but not always)
 201 without using a traditional network device.  In reality, there is no
 202 one thing called "vmchannel".  This idea has been reimplemented
 203 several times under the name vmchannel, and other hypervisors have
 204 their own incompatible implementation(s) too.
 205
 206 In libguestfs <= 1.0.71, we required a specific vmchannel which is
 207 properly known as "guestfwd" and has been upstream in qemu since here:
 208
 209   http://lists.gnu.org/archive/html/qemu-devel/2009-02/msg01042.html
 210
 211 In libguestfs >= 1.0.71 we don't require any vmchannel implementation,
 212 as long as qemu has been compiled with support for SLIRP (user mode
 213 networking, or "-net user"), which is almost always the case.
 214
 215 In libguestfs >= 1.5.4 we switched again to using qemu's virtio-serial
 216 and removed all the other vmchannels and the SLIRP channel.
 217
 218
 219 Supermin appliance
 220 ----------------------------------------------------------------------
 221
 222 If you configure with --enable-supermin then we will build a supermin
 223 appliance (supermin = super-minimized).  This is a very specialized
 224 appliance which is built on-the-fly at runtime (specifically, when you
 225 call guestfs_launch).
 226
 227 The normal appliance is a self-contained Linux operating system, based
 228 on the Fedora/RHEL/CentOS Linux distro.  So it contains a complete
 229 copy of all the libraries and programs needed, like kernel, libc,
 230 bash, coreutils etc etc.
 231
 232 The supermin appliance removes the kernel and all the executable
 233 libraries and programs from the appliance.  That just leaves a
 234 skeleton of config files and some data files, which is obviously
 235 massively smaller than the normal appliance.  At runtime we rebuild
 236 the appliance on-the-fly from the libraries and programs on the host
 237 (eg. pulling in the real /lib/libc.so, the real /bin/bash etc.)
 238
 239 Although this process of rebuilding the appliance each time sounds
 240 slow, it turns out to be faster than using the prebuilt appliance.
 241 (Most of the saving comes from not compressing the appliance - it
 242 transpires that decompressing the appliance is the slowest part of the
 243 whole boot sequence).  On my machine, a new appliance can be built in
 244 under a fifth of a second, and the boot time is several seconds
 245 shorter.
 246
 247 The big advantage of the supermin appliance for distributions like
 248 Fedora is that it gets security fixes automatically from the host, so
 249 there is no need to rebuild the whole of libguestfs for a security
 250 update in some underlying library.
 251
 252 There are several DISADVANTAGES:
 253
 254 It won't work at all except in very narrow, controlled cases like the
 255 Fedora packaging case.  We control the dependencies of the libguestfs
 256 RPM tightly to ensure that the required binaries are actually present
 257 on the host.
 258
 259 Furthermore there are certain unlikely changes in the packages on the
 260 host which could break a supermin appliance, eg. an updated library
 261 which depends on an additional data file.
 262
 263 Also supermin appliances are subjected to changes in the host kernel
 264 which might break compatibility with qemu -- these are, of course,
 265 real bugs in any case.
 266
 267 Lastly, supermin appliances really can't be moved between branches of
 268 distributions (eg. built on Fedora 12 and moved to Fedora 10) because
 269 they are not self-contained and they rely on certain libraries being
 270 around.  You shouldn't do this anyway.
 271
 272 Use supermin appliances with caution.
 273
 274
 275 Notes on cross-architecture support
 276 ----------------------------------------------------------------------
 277
 278 At the moment we basically don't support cross-architecture or
 279 32-on-64.  This limits what is possible for some guests.  Filesystem
 280 operations and FUSE will work fine, but running commands in guests may
 281 not be possible.
 282
 283 To enable this requires work for cross-architecture and 32-on-64
 284 support in febootstrap, fakeroot and fakechroot.
 285
 286 The daemon/ directory contains its own configure script.  This is so
 287 that in future we will be able to cross-compile the daemon.
 288
 289
 290 Mirroring tip
 291 ----------------------------------------------------------------------
 292
 293 On my machines I can usually rebuild the appliance in around 3
 294 minutes.  If it takes much longer for you, use a local Fedora mirror
 295 or squid.
 296
 297 To use squid to cache yum downloads, read this first:
 298 https://lists.dulug.duke.edu/pipermail/yum/2006-August/009041.html
 299 (In brief, because yum chooses random mirrors each time, squid doesn't
 300 work very well with default yum configuration.  To get around this,
 301 choose a Fedora mirror which is close to you, set this with
 302 './configure --with-mirror=[...]', and then proxy the whole lot
 303 through squid by setting http_proxy environment variable).
 304
 305 You will also need to substantially increase the squid configuration
 306 limits:
 307 http://fedoraproject.org/wiki/Using_Mock_to_test_package_builds#Using_Squid_to_Speed_Up_Mock_package_downloads
 308
 309
 310 Porting to other Linux distros / non-Linux
 311 ----------------------------------------------------------------------
 312
 313 libguestfs itself should be fairly portable to other Linux
 314 distributions.  Non-Linux ports are trickier, but we will accept
 315 patches if they aren't too invasive.
 316
 317 The main porting issues are with the dependencies needed to build the
 318 appliance.  You will need to find or port the following packages
 319 first:
 320
 321  - fakeroot
 322  - fakechroot
 323  - python
 324  - rpm-python    http://www.rpm.org/
 325  - yum           http://yum.baseurl.org/
 326  - febootstrap   http://people.redhat.com/~rjones/febootstrap/
 327
 328
 329 Copyright and license information
 330 ----------------------------------------------------------------------
 331
 332 Copyright (C) 2009-2010 Red Hat Inc.
 333
 334 The library is distributed under the LGPLv2+.  The programs are
 335 distributed under the GPLv2+.  Please see the files COPYING and
 336 COPYING.LIB for full license information.