Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 1986930

Summary: internal tool vdo2lvm name should change to something less appealing to the user
Product: Red Hat Enterprise Linux 8 Reporter: Corey Marthaler <cmarthal>
Component: lvm2Assignee: Marian Csontos <mcsontos>
lvm2 sub component: VDO QA Contact: cluster-qe <cluster-qe>
Status: CLOSED ERRATA Docs Contact:
Severity: low    
Priority: urgent CC: agk, awalsh, bjohnsto, heinzm, jbrassow, prajnoha, zkabelac
Version: 8.5Keywords: Triaged
Target Milestone: betaFlags: pm-rhel: mirror+
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: lvm2-2.03.12-8.el8 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2021-11-09 19:45:54 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 Corey Marthaler 2021-07-28 14:40:17 UTC
Description of problem:
If a user properly reads and follows the documentation, they will not have an issue with the tool names, however if they do not (like I didn't), and instead just type vdo[TAB] to see what options they have for converting their vdo volumes to be managed by LVM, the most appealing option is "vdo2lvm" instead of the correct tool "vdoimport". In fact, i'd argue that vdoimport should be named vdo2lvm.

[root@hayes-03 ~]# vdo
vdo              vdo2lvm          vdo-by-dev       vdodmeventd      vdodumpconfig    vdoforcerebuild  vdoformat        vdoimport        vdosetuuid       vdostats         


[root@hayes-03 ~]# vdo2lvm -h
vdo2lvm - Converts a VDO device for use with LVM

SYNOPSIS
  vdo2lvm <filename>

DESCRIPTION
  vdo2lvm converts the VDO block device named by <filename> for use with
  LVM. The VDO device to be converted must not be running, and should not
  already be an LVM VDO.

OPTIONS
    --help
       Print this help message and exit.

    --version
       Show the version of vdo2lvm.


[root@hayes-03 ~]# vdoimport -h
vdoimport: Utility to convert VDO volume to VDO LV.

        vdoimport [options] <vdo_device_path>

        Options:
          -f | --force        Bypass sanity checks
          -h | --help         Show this help message
          -n | --name         Specifies VG/LV name for converted VDO volume
          -v | --verbose      Be verbose
          -y | --yes          Answer "yes" at any prompts
               --dry-run      Print commands without running them

Version-Release number of selected component (if applicable):

lvm2-2.03.12-5.el8    BUILT: Tue Jul 13 11:50:03 CDT 2021
lvm2-libs-2.03.12-5.el8    BUILT: Tue Jul 13 11:50:03 CDT 2021
vdo-6.2.5.65-14.el8    BUILT: Thu Jul 22 12:56:43 CDT 2021
kmod-kvdo-6.2.5.65-79.el8    BUILT: Thu Jul 22 12:59:43 CDT 2021

Comment 1 Zdenek Kabelac 2021-07-30 08:32:33 UTC
Tool vdo2lvm might be better located in /usr/libexec  outside of reach of regular $PATH access - as it should be (ATM) used only by vdo manager through 'vdo convert' call.

Comment 2 bjohnsto 2021-08-17 14:10:46 UTC
(In reply to Zdenek Kabelac from comment #1)
> Tool vdo2lvm might be better located in /usr/libexec  outside of reach of
> regular $PATH access - as it should be (ATM) used only by vdo manager
> through 'vdo convert' call.

We could do this on our side. Corey would this work for you?

Comment 6 Andy Walsh 2021-08-23 14:14:06 UTC
A new build of vdo (NVR vdo-6.2.5.74-14.el8) is available that renames vdo2lvm to vdoprepareforlvm and moves it to /usr/libexec.  The functionality of 'vdo convert' is unchanged, so the vdoimport utility still continues to work as it did previously.

Comment 8 Marian Csontos 2021-08-26 16:25:59 UTC
After discussion in lvm team it was decided to rename vdoimport as well. The old name does not imply a volume is imported into lvm.

So this is now considered fixed by commit bbbd4fed69d88e67678994cb611d082d27bb774b - Rename vdoimport to lvm_import_vdo.

https://sourceware.org/git/?p=lvm2.git;a=commit;h=bbbd4fed69d88e67678994cb611d082d27bb774b

Comment 9 Corey Marthaler 2021-08-30 16:35:04 UTC
Marking Verified:Tested in the latest rpms.

kernel-4.18.0-339.el8    BUILT: Fri Aug 27 09:59:28 CDT 2021
lvm2-2.03.12-8.el8    BUILT: Thu Aug 26 15:49:15 CDT 2021
vdo-6.2.5.74-14.el8    BUILT: Fri Aug 20 17:56:40 CDT 2021
kmod-kvdo-6.2.5.72-80.el8    BUILT: Fri Aug 27 10:26:23 CDT 2021


[root@hayes-01 ~]# which vdo2lvm
/usr/bin/which: no vdo2lvm in (/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin)

[root@hayes-01 ~]#  ls -l /usr/libexec/vdoprepareforlvm
-rwxr-xr-x. 1 root root 549448 Aug 20 17:56 /usr/libexec/vdoprepareforlvm
[root@hayes-01 ~]#  /usr/libexec/vdoprepareforlvm -h
vdoprepareforlvm - Converts a VDO device for use with LVM

SYNOPSIS
  vdoprepareforlvm <filename>

DESCRIPTION
  vdoprepareforlvm converts the VDO block device named by <filename> for
  use with LVM. The VDO device to be converted must not be running, and
  should not already be an LVM VDO.

OPTIONS
    --help
       Print this help message and exit.

    --version
       Show the version of vdoprepareforlvm.

Comment 14 Corey Marthaler 2021-09-13 17:34:53 UTC
Marking verified with latest compose.

kernel-4.18.0-340.el8    BUILT: Thu Sep  2 16:16:14 CDT 2021
lvm2-2.03.12-8.el8    BUILT: Thu Aug 26 15:49:15 CDT 2021
lvm2-libs-2.03.12-8.el8    BUILT: Thu Aug 26 15:49:15 CDT 2021


[root@hayes-03 ~]# ls -l /usr/libexec/vdoprepareforlvm
-rwxr-xr-x. 1 root root 549448 Aug 20 17:56 /usr/libexec/vdoprepareforlvm
[root@hayes-03 ~]# which vdo2lvm
/usr/bin/which: no vdo2lvm in (/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin)

Comment 16 errata-xmlrpc 2021-11-09 19:45:54 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 (lvm2 bug fix and enhancement update), 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-2021:4431