Manual page with centralised documentation.
[virt-p2v.git] / README
1 $Id$
2
3 virt-p2v : P2V ("physical to virtual") migration tool
4 ----------------------------------------------------------------------
5
6 Written by Richard W.M. Jones <rjones@redhat.com>
7
8 Copyright (C) 2007-2008 Red Hat Inc.
9
10         http://et.redhat.com/~rjones/virt-p2v/
11
12
13 Binaries
14 ----------------------------------------------------------------------
15
16 Binaries are available from the website (live CD images which can be
17 burned directly to a CD and booted on the p2v candidate machine).
18
19        http://et.redhat.com/~rjones/virt-p2v/download.html
20
21
22 Usage
23 ----------------------------------------------------------------------
24
25 Please read the manual page:
26
27        man virt-p2v
28 or     make man; nroff -man virt-p2v.1 | less
29 or     http://et.redhat.com/~rjones/virt-p2v/virt-p2v.1.html
30
31
32 Building
33 ----------------------------------------------------------------------
34
35 Requirements:
36
37  * livecd-creator (on Fedora the package is 'livecd-tools')
38  * ocaml, ocaml-extlib, ocaml-pcre, ocaml-xml-light (all in Fedora)
39  * qemu and/or KVM (only for testing)
40
41 (1) Edit Makefile - there is some general configuration at the
42     top which you may want to change.
43
44 (2) 'make build' will build an ISO image called virt-p2v-$VERSION.iso
45
46 (3) Burn the image on to a CD using standard tools.
47
48
49 Testing
50 ----------------------------------------------------------------------
51
52 If you want to test the live CD without actually P2V-ing a real
53 server, then you can run the ISO directly in qemu.  (To do any sort of
54 realistic testing you will also need an operating system image,
55 eg. from /var/lib/xen/images, to experiment with).  For example:
56
57   $ cp /var/lib/xen/images/rhel5gax32fv.img .
58   $ make boot HDA=rhel5gax32fv.img
59   qemu -m 512 -cdrom virt-p2v-0.1.iso -boot d -hda rhel5gax32fv.img