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 1503710

Summary: vdo management command (vdo) description changes
Product: Red Hat Enterprise Linux 7 Reporter: Joe Shimkus <jshimkus>
Component: doc-Storage_Administration_GuideAssignee: Marek Suchánek <msuchane>
Status: CLOSED CURRENTRELEASE QA Contact: Zhang Kexin <kzhang>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.5CC: rhel-docs
Target Milestone: rcKeywords: Documentation
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-03-13 18:50:39 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:
Bug Depends On:    
Bug Blocks: 1495322, 1552784    

Description Joe Shimkus 2017-10-18 14:59:48 UTC
To provide complete and functional description/help the following changes have been made to the indicated vdo management command (vdo) help.  To the extent that the affected help is captured in documentation said documentation needs to be updated.

    --blockMapCacheSize=<megabytes>
                        Specifies the amount of memory allocated for caching
                        block map pages; the value must be a multiple of 4096.
                        Using a value with a B(ytes), K(ilobytes),
                        M(egabytes), G(igabytes), T(erabytes), P(etabytes) or
                        E(xabytes) suffix is optional. If no suffix is
                        supplied, the value will be interpreted as megabytes.
                        The default is 128M; the value must be at least 128M
                        and less than 16T. Note that there is a memory
                        overhead of 15%.

    --readCacheSize=<megabytes>
                        Specifies the extra VDO device read cache size in
                        megabytes. This space is in addition to a system-
                        defined minimum. Using a value with a B(ytes),
                        K(ilobytes), M(egabytes), G(igabytes), T(erabytes),
                        P(etabytes) or E(xabytes) suffix is optional. The
                        default is 0M. 1.12 MB of memory will be used per MB
                        of read cache specified.

    --vdoLogicalSize=<megabytes>
                        Specifies the logical VDO volume size in megabytes.
                        Using a value with a S(ectors), B(ytes), K(ilobytes),
                        M(egabytes), G(igabytes), T(erabytes), P(etabytes) or
                        E(xabytes) suffix is optional. Used for over-
                        provisioning volumes. This defaults to the size of the
                        storage device.

    --vdoSlabSize=<megabytes>
                        Specifies the size of the increment by which a VDO is
                        grown. Using a smaller size constrains the total
                        maximum physical size that can be accommodated. Must
                        be a power of two between 128M and 32G; the default is
                        2G. Using a value with a S(ectors), B(ytes),
                        K(ilobytes), M(egabytes), G(igabytes), T(erabytes),
                        P(etabytes) or E(xabytes) suffix is optional. If no
                        suffix is used, the value will be interpreted as
                        megabytes.

    --vdoAckThreads=<threadCount>
                        Specifies the number of threads to use for
                        acknowledging completion of requested VDO I/O
                        operations. The default is 1; the value must be at
                        least 0 and less than or equal to 100.

    --vdoBioRotationInterval=<ioCount>
                        Specifies the number of I/O operations to enqueue for
                        each bio-submission thread before directing work to
                        the next. The default is 64; the value must be at
                        least 1 and less than or equal to 1024.

    --vdoBioThreads=<threadCount>
                        Specifies the number of threads to use for submitting
                        I/O operations to the storage device. Minimum is 1;
                        maximum is 100. The default is 4; the value must be at
                        least 1 and less than or equal to 100.

    --vdoCpuThreads=<threadCount>
                        Specifies the number of threads to use for CPU-
                        intensive work such as hashing or compression. The
                        default is 2; the value must be at least 1 and less
                        than or equal to 100.

    --vdoHashZoneThreads=<threadCount>
                        Specifies the number of threads across which to
                        subdivide parts of the VDO processing based on the
                        hash value computed from the block data. The default
                        is 1; the value must be at least 0 and less than or
                        equal to 100. vdoHashZonesThreads, vdoLogicalThreads
                        and vdoPhysicalThreads must be either all zero or all
                        non-zero.

    --vdoLogicalThreads=<threadCount>
                        Specifies the number of threads across which to
                        subdivide parts of the VDO processing based on logical
                        block addresses. The default is 1; the value must be
                        at least 0 and less than or equal to 100.
                        vdoLogicalThreads, vdoHashZonesThreads and
                        vdoPhysicalThreads must be either all zero or all non-
                        zero.

    --vdoPhysicalThreads=<threadCount>
                        Specifies the number of threads across which to
                        subdivide parts of the VDO processing based on
                        physical block addresses. The default is 1; the value
                        must be at least 0 and less than or equal to 100.
                        vdoPhysicalThreads, vdoHashZonesThreads and
                        vdoLogicalThreads must be either all zero or all non-
                        zero.

Comment 2 Joe Shimkus 2017-10-19 21:13:04 UTC
Updated --readCacheSize to clarify the memory overhead is per bio thread.

    --readCacheSize=<megabytes>
                        Specifies the extra VDO device read cache size in
                        megabytes. This space is in addition to a system-
                        defined minimum. Using a value with a B(ytes),
                        K(ilobytes), M(egabytes), G(igabytes), T(erabytes),
                        P(etabytes) or E(xabytes) suffix is optional. The
                        default is 0M. 1.12 MB of memory will be used per MB
                        of read cache specified, per bio thread.

Comment 3 Marek Suchánek 2017-11-16 18:09:51 UTC
Thanks.

I'm setting this bug as a blocker for the VDO docs tracking bug.

Comment 4 Marek Suchánek 2018-02-08 12:57:06 UTC
The descriptions should now be updated:

* 29.7. VDO Commands
  https://access.qa.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/storage_administration_guide/commands

Comment 5 Marek Suchánek 2018-03-13 18:50:39 UTC
Content from the VDO Integration Guide has been published on the Customer Portal:
https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/storage_administration_guide/vdo-integration

Therefore, I'm closing this bug as CURRENTRELEASE.