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