Bug 2356552

Summary: [Usability]: Correct Typo in MAN Pages for group mirroring
Product: [Red Hat Storage] Red Hat Ceph Storage Reporter: aarsharm
Component: RBD-MirrorAssignee: Ilya Dryomov <idryomov>
Status: CLOSED ERRATA QA Contact: aarsharm
Severity: low Docs Contact:
Priority: unspecified    
Version: 8.1CC: ceph-eng-bugs, cephqe-warriors, sangadi, tserlin
Target Milestone: ---   
Target Release: 8.1   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: ceph-19.2.1-74.el9cp Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2025-06-26 12:21:53 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 aarsharm 2025-04-01 12:37:41 UTC
Kindly find rbd help snippet for each of the 4 API's below:

1) rbd help mirror group enable
[ceph: root@ceph-rbd1-cg-ds-tf74dn-node1-installer /]# rbd help mirror group enable
usage: rbd mirror group enable [--pool <pool>] [--namespace <namespace>]
                               [--group <group>] [--skip-quiesce]
                               [--ignore-quiesce-error]
                               <group-spec> <mode>

Enable RBD mirroring for an group. <<<<<<<< "It should be 'a' instead of 'an'"

Positional arguments
  <group-spec>            group specification
                          (example: [<pool-name>/[<namespace>/]]<group-name>)
  <mode>                  mirror group mode [default: snapshot]

Optional arguments
  -p [ --pool ] arg       pool name
  --namespace arg         namespace name
  --group arg             group name
  --skip-quiesce          do not run quiesce hooks
  --ignore-quiesce-error  ignore quiesce hook error

[ceph: root@ceph-rbd1-cg-ds-tf74dn-node1-installer /]#

2) rbd help mirror group disable
[ceph: root@ceph-rbd1-cg-ds-tf74dn-node1-installer /]# rbd help mirror group disable
usage: rbd mirror group disable [--force] [--pool <pool>]
                                [--namespace <namespace>] [--group <group>]
                                <group-spec>

Disable RBD mirroring for an group. <<<<<<<< "It should be 'a' instead of 'an'"

Positional arguments
  <group-spec>         group specification
                       (example: [<pool-name>/[<namespace>/]]<group-name>)

Optional arguments
  --force              disable even if not primary
  -p [ --pool ] arg    pool name
  --namespace arg      namespace name
  --group arg          group name

[ceph: root@ceph-rbd1-cg-ds-tf74dn-node1-installer /]#

3) rbd help mirror group promote
[ceph: root@ceph-rbd1-cg-ds-tf74dn-node1-installer /]# rbd help mirror group promote
usage: rbd mirror group promote [--force] [--pool <pool>]
                                [--namespace <namespace>] [--group <group>]
                                [--skip-quiesce] [--ignore-quiesce-error]
                                <group-spec>

Promote an group to primary for RBD mirroring. <<<<<< "It should be 'a' instead of 'an'"

Positional arguments
  <group-spec>            group specification
                          (example: [<pool-name>/[<namespace>/]]<group-name>)

Optional arguments
  --force                 promote even if not cleanly demoted by remote cluster
  -p [ --pool ] arg       pool name
  --namespace arg         namespace name
  --group arg             group name
  --skip-quiesce          do not run quiesce hooks
  --ignore-quiesce-error  ignore quiesce hook error

[ceph: root@ceph-rbd1-cg-ds-tf74dn-node1-installer /]#

4) rbd help mirror group demote
[ceph: root@ceph-rbd1-cg-ds-tf74dn-node1-installer /]# rbd help mirror group demote
usage: rbd mirror group demote [--pool <pool>] [--namespace <namespace>]
                               [--group <group>] [--skip-quiesce]
                               [--ignore-quiesce-error]
                               <group-spec>

Demote an group to non-primary for RBD mirroring. <<<<<<<< "It should be 'a' instead of 'an'"

Positional arguments
  <group-spec>            group specification
                          (example: [<pool-name>/[<namespace>/]]<group-name>)

Optional arguments
  -p [ --pool ] arg       pool name
  --namespace arg         namespace name
  --group arg             group name
  --skip-quiesce          do not run quiesce hooks
  --ignore-quiesce-error  ignore quiesce hook error

[ceph: root@ceph-rbd1-cg-ds-tf74dn-node1-installer /]#


This bz is to correct the typo in 'rbd help' pages for above four API's
instead of 'an group', it should be 'a group'

Comment 6 errata-xmlrpc 2025-06-26 12:21:53 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 (Important: Red Hat Ceph Storage 8.1 security, bug fix, and enhancement updates), 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/RHSA-2025:9775