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