Bug 1212677

Summary: guestfish fails to add a remote image with ssh protocol
Product: Red Hat Enterprise Linux 7 Reporter: Hu Zhang <huzhan>
Component: libguestfsAssignee: Richard W.M. Jones <rjones>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: low Docs Contact:
Priority: low    
Version: 7.1CC: leiwang, ptoscano, wshi
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: libguestfs-1.28.1-1.27.el7 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
: 1326531 (view as bug list) Environment:
Last Closed: 2015-11-19 07:00:52 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Hu Zhang 2015-04-17 04:52:11 UTC
Description of problem:
guestfish fails to add a remote image with ssh protocol. If the rhel7.1 does not support this feature, we need to modify the man page.
In man page, 
-----------------------
...
   Remote drives
       Access a remote disk using ssh:

        guestfish -a ssh://example.com/path/to/disk.img
...
-----------------------
...
ADDING REMOTE STORAGE
       For API-level documentation on this topic, see "guestfs_add_drive_opts" in guestfs(3) and "REMOTE STORAGE" in guestfs(3).

       On the command line, you can use the -a option to add network block devices using a URI-style format, for example:

        guestfish -a ssh://root/disk.img

       URIs cannot be used with the "add" command.  The equivalent command using the API directly is:

        ><fs> add /disk.img protocol:ssh server:tcp:example.com username:root

       The possible -a URI formats are described below.
...
----------------------

Version-Release number of selected component (if applicable):
kernel-3.10.0-229.el7.x86_64
libguestfs-1.28.1-1.18.el7.x86_64

How reproducible:
Always

Steps to Reproduce:
1. guestfish -a ssh://root/disk.img

Actual results:
Step 1:
libguestfs: error: unknown protocol 'ssh'.                                                                                         

Usage:                                                                                                                                                                      
 sfdisk [options] <dev> [[-N] <part>]                                                                                                                                       
 sfdisk [options] <command>
...

Expected results:
If rhel7.1 does not support this feature, we need to modify the man page.

Additional info:

Comment 1 Richard W.M. Jones 2015-04-17 09:06:36 UTC
Thanks - this is indeed a bug in the documentation.

In RHEL 7 we disable many of the remote storage drivers.  The ssh:
driver is in fact not disabled, but is hidden from users (it's
only usable by virt-v2v, and only in a special case).  The
documentation needs to remove these references to adding images
with ssh:...

Comment 3 Hu Zhang 2015-05-05 09:44:29 UTC
Verified with libguestfs-1.28.1-1.31.el7.

Step to verify:
1.# man guestfish
-------------------------
   Remote drives
       Access a remote disk using NBD:

        guestfish -a nbd://example.com

-------------------------
       On the command line, you can use the -a option to add network block devices using a URI-style format, for
       example:

        guestfish -a nbd://example.com

       URIs cannot be used with the "add" command.  The equivalent command using the API directly is:
-------------------------

No references to adding images with ssh exits in the man page. So fixed.

Comment 5 errata-xmlrpc 2015-11-19 07:00:52 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://rhn.redhat.com/errata/RHBA-2015-2183.html