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