Bug 1703403 - Update nbdkit info for vddk in v2v man page
Summary: Update nbdkit info for vddk in v2v man page
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux Advanced Virtualization
Classification: Red Hat
Component: libguestfs
Version: 8.0
Hardware: x86_64
OS: Unspecified
high
high
Target Milestone: rc
: ---
Assignee: Pino Toscano
QA Contact: Virtualization Bugs
URL:
Whiteboard: V2V
Depends On: 1605242 1651115
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-04-26 10:50 UTC by Pino Toscano
Modified: 2020-11-14 05:49 UTC (History)
12 users (show)

Fixed In Version: libguestfs-1.40.2-4.module+el8.0.1+3188+cd3de524
Doc Type: If docs needed, set a value
Doc Text:
Clone Of: 1651115
Environment:
Last Closed: 2019-08-07 10:41:34 UTC
Type: Bug
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2019:2395 0 None None None 2019-08-07 10:42:45 UTC

Description Pino Toscano 2019-04-26 10:50:17 UTC
+++ This bug was initially created as a clone of Bug #1651115 +++

Can reproduce the bug with virt-v2v-1.38.4-5.module+el8+2173+537e5cb5.x86_64, so clone the bug from rhel7

+++ This bug was initially created as a clone of Bug #1605242 +++

Description of problem:
Update nbdkit info for vddk in v2v man page

Version-Release number of selected component (if applicable):
virt-v2v-1.38.2-8.el7.x86_64
libguestfs-1.38.2-8.el7.x86_64


How reproducible:
100%

Steps to Reproduce:
1.Check nbdkit info of vddk in v2v man page, it said you must compile nbdkit to enable the VDDK plugin

#man virt-v2v
....
INPUT FROM VDDK
       Virt-v2v is able to import guests using VMware’s proprietary VDDK
       library (a.k.a. VixDiskLib).

   VDDK: PREREQUISITES
....
       2.  You must also compile nbdkit, enabling the VDDK plugin.  nbdkit ≥
           1.1.25 is recommended, but it is usually best to compile from the
           git tree.

           ·   https://github.com/libguestfs/nbdkit

           ·   https://github.com/libguestfs/nbdkit/tree/master/plugins/vddk

           Compile nbdkit as described in the sources (see link above).

           You do not need to run "make install" because you can run nbdkit
           from its source directory.  The source directory has a shell script
           called nbdkit which runs the locally built copy of nbdkit and its
           plugins.  So set $PATH to point to the nbdkit top build directory
           (that is, the directory containing the shell script called nbdkit),
           eg:

            export PATH=/path/to/nbdkit-1.1.x:$PATH

    .....

Actual results:
Should update nbdkit info for vddk in downstream v2v man page because customers should use nbdkit-plugin-vddk rpm package directly rather than self-compiled 

Expected results:
Update nbdkit info for vddk in v2v man page


Additional info:

--- Additional comment from Pino Toscano on 2018-07-23 11:50:02 EDT ---

(In reply to mxie from comment #0)
> Actual results:
> Should update nbdkit info for vddk in downstream v2v man page because
> customers should use nbdkit-plugin-vddk rpm package directly rather than
> self-compiled 

There is no nbdkit-plugin-vddk RPM, and it cannot exist.

--- Additional comment from Tomáš Golembiovský on 2018-07-23 16:58:33 EDT ---

(In reply to Pino Toscano from comment #2)
> (In reply to mxie from comment #0)
> > Actual results:
> > Should update nbdkit info for vddk in downstream v2v man page because
> > customers should use nbdkit-plugin-vddk rpm package directly rather than
> > self-compiled 
> 
> There is no nbdkit-plugin-vddk RPM, and it cannot exist.

I believe he's talking about the self-build RPM from the spec file that exists.

Also, it is not necessary to build your own nbdkit as it will be available in RHEL 7.6.

--- Additional comment from Richard W.M. Jones on 2018-09-11 05:15:48 EDT ---

This still needs to be done, but we've missed 7.6 at this point,
so moving to 7.7.

--- Additional comment from Richard W.M. Jones on 2018-11-19 10:07:49 CET ---

I didn't set Internal Target on this because I don't know when we
want to deliver this fix.  It's not very important so could be
pushed back easily to 8.1.

--- Additional comment from mxie on 2018-11-19 10:10:55 CET ---

Found another mistake in virt-v2v man page for VDDK,I think should correct " nbdkit-vddk-plugin" as nbdkit-plugin-vddk"

#man virt-v2v
....
 -io vddk-vimapiver=APIVER
           When using VDDK mode, these options are passed unmodified to the
           nbdkit(1) VDDK plugin.  Please refer to nbdkit-vddk-plugin(1).
           These are all optional.
....
  3.  You must find the SSL "thumbprint" of your VMware server.  How to
           do this is explained in nbdkit-vddk-plugin(1), also available at
           the link above.
...

--- Additional comment from Pino Toscano on 2018-11-19 10:32:28 CET ---

(In reply to Richard W.M. Jones from comment #1)
> I didn't set Internal Target on this because I don't know when we
> want to deliver this fix.  It's not very important so could be
> pushed back easily to 8.1.

It's a small documentation fix, and this kind of changes is generally accepted in testing phase (even on RHEL 7).

Once fixed upstream, I will backport it to 8.0.0, in case we are not in blockers/exceptions phase.

--- Additional comment from Pino Toscano on 2018-11-19 13:59:15 CET ---

(In reply to mxie from comment #2)
> Found another mistake in virt-v2v man page for VDDK,I think should correct "
> nbdkit-vddk-plugin" as nbdkit-plugin-vddk"
> 
> #man virt-v2v
> ....
>  -io vddk-vimapiver=APIVER
>            When using VDDK mode, these options are passed unmodified to the
>            nbdkit(1) VDDK plugin.  Please refer to nbdkit-vddk-plugin(1).
>            These are all optional.
> ....
>   3.  You must find the SSL "thumbprint" of your VMware server.  How to
>            do this is explained in nbdkit-vddk-plugin(1), also available at
>            the link above.
> ...

The package nbdkit-plugin-vddk installs a man page called nbdkit-vddk-plugin, so the references are correct.

--- Additional comment from Pino Toscano on 2019-04-12 16:23:48 CEST ---

Simple patch posted upstream:
https://www.redhat.com/archives/libguestfs/2019-April/msg00102.html

--- Additional comment from Pino Toscano on 2019-04-12 16:52:49 CEST ---

Fixed upstream with
https://github.com/libguestfs/libguestfs/commit/0704d8eb0bcc8139886eb4291f75a3ca49a91e58
which is in libguestfs >= 1.41.1.

Comment 2 liuzi 2019-05-15 06:55:31 UTC
Verify bug with builds:
virt-v2v-1.40.2-4.module+el8+3201+fd6ac632.x86_64
libguestfs-1.40.2-4.module+el8+3201+fd6ac632.x86_64

Steps:
1.Install the latest virt-v2v package and check the manual page about nbdkit info for vddk

2.Check the nbdkit-vddk-plugin manual page
# man nbdkit-vddk-plugin
...
DESCRIPTION
       "nbdkit-vddk-plugin" is an nbdkit(1) plugin that serves files from local VMware VMDK files, VMware ESXi servers, VMware VCenter servers, and other sources.  It requires VMware's proprietary VDDK library that you must download yourself separately.

       The plugin can serve read-only (if the -r option is used) or read/write.

3. Check the virt-v2v-input-vmware manual page
# man virt-v2v-input-vmware
...
INPUT FROM VDDK
       Virt-v2v is able to import guests using VMware’s proprietary VDDK library (a.k.a.VixDiskLib).

   VDDK: Prerequisites
       1.  As the VDDK library is not open source, and the license of this library does not permit redistribution or commercial use, you must obtain VDDK yourself and satisfy yourself that your usage of the library is permitted by the license.

       2.  nbdkit ≥ 1.6 is recommended, as it ships with the VDDK plugin enabled unconditionally.

       3.  You must find the SSL "thumbprint" of your VMware server.  How to do this is explained in nbdkit-vddk-plugin(1), also available at the link above.

       4.  VDDK imports require a feature added in libvirt ≥ 3.7.

...

Result:Virt-v2v updated nbdkit info for vddk in downstream manual pages,so change bug from ON_QA to VERIFIED.

Comment 4 errata-xmlrpc 2019-08-07 10:41:34 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2019:2395


Note You need to log in before you can comment on or make changes to this bug.