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 Requirements
  29 ----------------------------------------------------------------------
  30
  31 - recent QEMU >= 0.10 with vmchannel support
  32   http://lists.gnu.org/archive/html/qemu-devel/2009-02/msg01042.html
  33
  34 - febootstrap >= 2.0
  35
  36 - fakeroot
  37
  38 - fakechroot >= 2.9
  39
  40 - XDR, rpcgen (on Linux these are provided by glibc)
  41
  42 - (Optional) Augeas (http://augeas.net/)
  43
  44 - perldoc (pod2man, pod2text) to generate the manual pages and
  45 other documentation.
  46
  47 - (Optional) Readline to have nicer command-line editing in guestfish.
  48
  49 - (Optional) OCaml if you want to rebuild the generated files, and
  50 also to build the OCaml bindings
  51
  52 - (Optional) local Fedora mirror
  53
  54 - (Optional) Perl if you want to build the perl bindings
  55
  56 - (Optional) Python if you want to build the python bindings
  57
  58 - (Optional) Ruby, rake if you want to build the ruby bindings
  59
  60 - (Optional) Java, JNI, jpackage-utils if you want to build the java
  61 bindings
  62
  63 - (Optional) GHC if you want to build the Haskell bindings
  64
  65 Running ./configure will check you have all the requirements installed
  66 on your machine.
  67
  68
  69 Building
  70 ----------------------------------------------------------------------
  71
  72 Then make the daemon, library and root filesystem:
  73
  74   ./configure [--with-mirror=URI]
  75   make
  76
  77 Use the optional --with-mirror parameter to specify the URI of a local
  78 Fedora mirror.  See the discussion of the MIRROR parameter in the
  79 febootstrap(8) manpage.
  80
  81 Finally run the tests:
  82
  83   make check
  84
  85 If everything works, you can install the library and tools by running
  86 this command as root:
  87
  88   make install
  89
  90
  91 Fedora
  92 ----------------------------------------------------------------------
  93
  94 We provide packages for Fedora >= 11 in Fedora.  Use those, or build
  95 from our source RPMs - it's far simpler that way.
  96
  97 You can compile libguestfs on Fedora 10 but you cannot use it with the
  98 version of qemu in Fedora 10.  You need to compile your own qemu, see
  99 section 'qemu' below.
 100
 101
 102 RHEL / EPEL / CentOS etc
 103 ----------------------------------------------------------------------
 104
 105 We provide packages in EPEL which cover RHEL/CentOS >= 5.  Use those
 106 or build from our source RPMs.
 107
 108
 109 Debian
 110 ----------------------------------------------------------------------
 111
 112 libguestfs should build and run on Debian.  At the moment we don't
 113 provide Debian packages, and because of the appliance it's rather
 114 complicated to provide a package which could be accepted into the
 115 Debian repositories.  Want to help?  Please contact us.
 116
 117
 118 qemu
 119 ----------------------------------------------------------------------
 120
 121 By far the most common problem is with broken or incompatible
 122 qemu releases.
 123
 124 First of all, you need qemu >= 0.10.4, which contains a vmchannel
 125 implementation.  There are several, conflicting, incompatible things
 126 called 'vmchannel' which at one time or another have been added or
 127 proposed for qemu/KVM.  The _only_ one we support is this one:
 128
 129   http://lists.gnu.org/archive/html/qemu-devel/2009-02/msg01042.html
 130
 131 Secondly, different versions of qemu have problems booting the
 132 appliance for different reasons.  This varies between versions of
 133 qemu, and Linux distributions which add their own patches.
 134
 135 If you find a problem, you could try using your own qemu built from
 136 source (qemu is very easy to build from source), with a 'qemu
 137 wrapper'.  Qemu wrappers are described in the guestfs(3) manpage.
 138
 139
 140 Note on using KVM
 141 ----------------------------------------------------------------------
 142
 143 By default the configure script will look for qemu-kvm (KVM support).
 144 You will need a reasonably recent processor for this to work.  KVM is
 145 much faster than using plain Qemu.
 146
 147 You may also need to enable KVM support for non-root users, by following
 148 these instructions:
 149
 150   http://www.linux-kvm.org/page/FAQ#How_can_I_use_kvm_with_a_non-privileged_user.3F
 151
 152 On some systems, this will work too:
 153
 154   chmod o+rw /dev/kvm
 155
 156 On some systems, the chmod will not survive a reboot, and you will
 157 need to make edits to the udev configuration.
 158
 159
 160 Notes on cross-architecture support
 161 ----------------------------------------------------------------------
 162
 163 At the moment we basically don't support cross-architecture or
 164 32-on-64.  This limits what is possible for some guests.  Filesystem
 165 operations and FTP export will work fine, but running commands in
 166 guests may not be possible.
 167
 168 To enable this requires work for cross-architecture and 32-on-64
 169 support in febootstrap, fakeroot and fakechroot.
 170
 171 The daemon/ directory contains its own configure script.  This is so
 172 that in future we will be able to cross-compile the daemon.
 173
 174
 175 Mirroring tip
 176 ----------------------------------------------------------------------
 177
 178 On my machines I can usually rebuild the appliance in around 3
 179 minutes.  If it takes much longer for you, use a local Fedora mirror
 180 or squid.
 181
 182 To use squid to cache yum downloads, read this first:
 183 https://lists.dulug.duke.edu/pipermail/yum/2006-August/009041.html
 184 (In brief, because yum chooses random mirrors each time, squid doesn't
 185 work very well with default yum configuration.  To get around this,
 186 choose a Fedora mirror which is close to you, set this with
 187 './configure --with-mirror=[...]', and then proxy the whole lot
 188 through squid by setting http_proxy environment variable).
 189
 190 You will also need to substantially increase the squid configuration
 191 limits:
 192 http://fedoraproject.org/wiki/Using_Mock_to_test_package_builds#Using_Squid_to_Speed_Up_Mock_package_downloads
 193
 194
 195 Porting to other Linux distros / non-Linux
 196 ----------------------------------------------------------------------
 197
 198 libguestfs itself should be fairly portable to other Linux
 199 distributions.  Non-Linux ports are trickier, but we will accept
 200 patches if they aren't too invasive.
 201
 202 The main porting issues are with the dependencies needed to build the
 203 appliance.  You will need to find or port the following packages
 204 first:
 205
 206  - fakeroot
 207  - fakechroot
 208  - python
 209  - rpm-python    http://www.rpm.org/
 210  - yum           http://yum.baseurl.org/
 211  - febootstrap   http://et.redhat.com/~rjones/febootstrap/
 212
 213
 214 Copyright and license information
 215 ----------------------------------------------------------------------
 216
 217 Copyright (C) 2009 Red Hat Inc.
 218
 219 The library is distributed under the LGPLv2+.  The programs are
 220 distributed under the GPLv2+.  Please see the files COPYING and
 221 COPYING.LIB for full license information.