From: Ilya Dryomov <idryomov@gmail.com>
Date: Fri, 3 Sep 2021 16:12:40 +0000 (+0200)
Subject: doc: add some details about rbd-mirror site names
X-Git-Tag: v17.1.0~948^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=1fe44830b6565fdd4d5b120796373e6f1b43b3f9;p=ceph.git

doc: add some details about rbd-mirror site names

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
---

diff --git a/doc/rbd/rbd-mirroring.rst b/doc/rbd/rbd-mirroring.rst
index 5108ad0afcdb..ab78d53466e5 100644
--- a/doc/rbd/rbd-mirroring.rst
+++ b/doc/rbd/rbd-mirroring.rst
@@ -79,9 +79,10 @@ Enable Mirroring
 ----------------
 
 To enable mirroring on a pool with ``rbd``, issue the ``mirror pool enable``
-subcommand with the pool name, and the mirroring mode::
+subcommand with the pool name, the mirroring mode, and an optional friendly
+site name to describe the local cluster::
 
-        rbd mirror pool enable {pool-name} {mode}
+        rbd mirror pool enable [--site-name {local-site-name}] {pool-name} {mode}
 
 The mirroring mode can either be ``image`` or ``pool``:
 
@@ -92,8 +93,15 @@ The mirroring mode can either be ``image`` or ``pool``:
 
 For example::
 
-        $ rbd --cluster site-a mirror pool enable image-pool image
-        $ rbd --cluster site-b mirror pool enable image-pool image
+        $ rbd --cluster site-a mirror pool enable --site-name site-a image-pool image
+        $ rbd --cluster site-b mirror pool enable --site-name site-b image-pool image
+
+The site name can also be specified when creating or importing a new
+`bootstrap token`_.
+
+The site name can be changed later using the same ``mirror pool enable``
+subcommand but note that the local site name and the corresponding site name
+used by the remote cluster generally must match.
 
 Disable Mirroring
 -----------------
@@ -523,6 +531,7 @@ The ``rbd-mirror`` can also be run in foreground by ``rbd-mirror`` command::
 .. _rbd: ../../man/8/rbd
 .. _ceph-conf: ../../rados/configuration/ceph-conf/#running-multiple-clusters
 .. _explicitly enabled: #enable-image-mirroring
+.. _bootstrap token: #bootstrap-peers
 .. _force resync command: #force-image-resync
 .. _demote the image: #image-promotion-and-demotion
 .. _create a Ceph user: ../../rados/operations/user-management#add-a-user