Skip to content

Commit 5e64748

Browse files
committed
doc/rbd: add namespace information for mirror commands
Updates the rbd man page to clarify that some mirror commands can apply to pools and namespaces. Signed-off-by: N Balachandran <[email protected]>
1 parent ee8354d commit 5e64748

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

doc/man/8/rbd.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -523,28 +523,28 @@ Commands
523523
Show RBD mirroring status for an image.
524524

525525
:command:`mirror pool demote` [*pool-name*]
526-
Demote all primary images within a pool to non-primary.
527-
Every mirror-enabled image in the pool will be demoted.
526+
Demote all primary images within a pool or namespace to non-primary.
527+
Every mirror-enabled image in the pool or namespace will be demoted.
528528

529529
:command:`mirror pool disable` [*pool-name*]
530-
Disable RBD mirroring by default within a pool. When mirroring
531-
is disabled on a pool in this way, mirroring will also be
532-
disabled on any images (within the pool) for which mirroring
533-
was enabled explicitly.
530+
Disable RBD mirroring within a pool or namespace. When mirroring
531+
is disabled on a pool or namespace in this way, mirroring will also be
532+
disabled on all images (within the pool or namespace) for which mirroring
533+
was enabled, whether by default or explicitly.
534534

535535
:command:`mirror pool enable` [*pool-name*] *mode*
536-
Enable RBD mirroring by default within a pool.
536+
Enable RBD mirroring within a pool or namespace.
537537
The mirroring mode can either be ``pool`` or ``image``.
538-
If configured in ``pool`` mode, all images in the pool
538+
If configured in ``pool`` mode, all images in the pool or namespace
539539
with the journaling feature enabled are mirrored.
540540
If configured in ``image`` mode, mirroring needs to be
541541
explicitly enabled (by ``mirror image enable`` command)
542542
on each image.
543543

544544
:command:`mirror pool info` [*pool-name*]
545-
Show information about the pool mirroring configuration.
546-
It includes mirroring mode, peer UUID, remote cluster name,
547-
and remote client name.
545+
Show information about the pool or namespace mirroring configuration.
546+
For a pool, it includes mirroring mode, peer UUID, remote cluster name,
547+
and remote client name. For a namespace, it includes only mirroring mode.
548548

549549
:command:`mirror pool peer add` [*pool-name*] *remote-cluster-spec*
550550
Add a mirroring peer to a pool.
@@ -564,13 +564,13 @@ Commands
564564
is corresponding to remote client name or remote cluster name.
565565

566566
:command:`mirror pool promote` [--force] [*pool-name*]
567-
Promote all non-primary images within a pool to primary.
568-
Every mirror-enabled image in the pool will be promoted.
567+
Promote all non-primary images within a pool or namespace to primary.
568+
Every mirror-enabled image in the pool or namespace will be promoted.
569569

570570
:command:`mirror pool status` [--verbose] [*pool-name*]
571-
Show status for all mirrored images in the pool.
571+
Show status for all mirrored images in the pool or namespace.
572572
With ``--verbose``, show additional output status
573-
details for every mirror-enabled image in the pool.
573+
details for every mirror-enabled image in the pool or namespace.
574574

575575
:command:`mirror snapshot schedule add` [-p | --pool *pool*] [--namespace *namespace*] [--image *image*] *interval* [*start-time*]
576576
Add mirror snapshot schedule.

0 commit comments

Comments
 (0)