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