[Pkg-libvirt-commits] [libguestfs] 133/266: v2v: Add some examples to the manual page.

[Hilko Bengen]

This is an automated email from the git hooks/post-receive script.

bengen pushed a commit to annotated tag debian/1%1.27.35-1
in repository libguestfs.

commit b6ba84499228bf9ee52d319f1b34631409f3a3f4
Author: Richard W.M. Jones <rjones at redhat.com>
Date:   Tue Aug 19 22:24:45 2014 +0100

    v2v: Add some examples to the manual page.
---
 v2v/virt-v2v.pod | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 88 insertions(+), 2 deletions(-)

diff --git a/v2v/virt-v2v.pod b/v2v/virt-v2v.pod
index e7fed70..9c4a0a5 100644
--- a/v2v/virt-v2v.pod
+++ b/v2v/virt-v2v.pod
@@ -4,10 +4,10 @@ virt-v2v - Convert a guest to use KVM
 
 =head1 SYNOPSIS
 
- virt-v2v -ic esx://esx.example.com/ -os imported esx_guest
+ virt-v2v -ic esx://esx.example.com/ esx_guest
 
  virt-v2v -ic esx://esx.example.com/ \
-   -o rhev -os rhev.nfs:/export_domain --network rhevm esx_guest
+   -o rhev -os rhev.nfs:/export_domain esx_guest
 
  virt-v2v -i libvirtxml -o local -os /tmp guest-domain.xml
 
@@ -26,6 +26,92 @@ as an ISO or CD image that can be booted on physical machines.
 This manual page documents the rewritten virt-v2v included in
 libguestfs E<ge> 1.28.
 
+=head1 INPUT AND OUTPUT MODES
+
+                         ┌────────────┐
+ -i disk ───────────┐    │            │   ┌───────> -o local
+                    │    │ virt-v2v   │   │
+                    └──> │ conversion │ ──┘
+ -i libvirt ───────────> │ server     │ ────────> -o libvirt
+  (default)         ┌──> │            │ ──┐        (default)
+                    │    │            │   │
+ -i libvirtxml ─────┘    │            │   └────────> -o rhev
+                         └────────────┘
+
+Virt-v2v has a number of possible input and output modes, selected
+using the I<-i> and I<-o> options.  Only one input and output mode can
+be selected for each run of virt-v2v.
+
+I<-i libvirt> is used for reading from any libvirt source.  Since
+libvirt can connect to many different hypervisors, it is used for
+reading guests from VMware ESX, RHEL 5 Xen and more.  The I<-ic>
+option selects the precise libvirt source.
+
+I<-i disk> is used for reading from local disk images (mainly for
+testing).
+
+I<-i libvirtxml> is used to read from libvirt XML files.  This is the
+method used by L<virt-p2v(1)> behind the scenes.
+
+I<-o libvirt> is used for writing to any libvirt target.  Libvirt can
+connect to local or remote KVM hypervisors.  The I<-oc> option selects
+the precise libvirt target.
+
+I<-o local> is used to write to a local disk image (mainly for testing).
+
+I<-o rhev> is used to write to a RHEV-M / oVirt target.
+
+=head1 EXAMPLES
+
+=head2 Convert from VMware ESX server to local libvirt
+
+You have a VMware ESX server called C<esx.example.com>.  You want to
+convert a guest called C<esx_guest> to run locally under libvirt.
+
+ virt-v2v -ic esx://example.com esx_guest
+
+In this case you will most likely have to run virt-v2v as C<root>,
+since it needs to talk to the system libvirt daemon and copy the guest
+disks to C</var/lib/libvirt/images>.
+
+=head2 Convert from ESX to RHEV-M/oVirt
+
+This is the same as the previous example, except you want to send the
+guest to a RHEV-M Export Storage Domain which is located remotely
+(over NFS) at C<rhev.nfs:/export_domain>.  If you are unclear about
+the location of the Export Storage Domain you should check the
+settings on your RHEV-M management console.
+
+ virt-v2v -ic esx://esx.example.com/ \
+   -o rhev -os rhev.nfs:/export_domain esx_guest
+
+In this case the host running virt-v2v acts as a B<conversion server>.
+
+Note that after conversion, the guest will appear in the RHEV-M Export
+Storage Domain, from where you will need to import it using the RHEV-M
+user interface.
+
+=head2 Convert disk image to disk image
+
+Given a disk image from another hypervisor that you want to convert to
+run on KVM, you have two options.  The simplest way is to try:
+
+ virt-v2v -i disk -o local -os /tmp disk.img
+
+where virt-v2v guesses everything about the input C<disk.img> and (in
+this case) writes the converted result to C</tmp>.
+
+A more complex method is to write some
+L<libvirt XML|http://libvirt.org/formatdomain.html> describing the
+input guest (if you can get the source hypervisor to provide you with
+libvirt XML, then so much the better).  You can then do:
+
+ virt-v2v -i libvirtxml -o local -os /tmp guest-domain.xml
+
+Since C<guest-domain.xml> contains the path(s) to the guest disk
+image(s) you do not need to specify the name of the disk image on the
+command line.
+
 =head1 OPTIONS
 
 =over 4

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-libvirt/libguestfs.git