Merge pull request ceph#59478 from idryomov/wip-67752

rbd: amend "rbd {group,} rename" and "rbd mirror pool" command descriptions Reviewed-by: Ramana Raja <[email protected]> Reviewed-by: N Balachandran <[email protected]>
ArbitCode · Sep 2, 2024 · b0d8273 · b0d8273
2 parents a1cd410 + 7e02946
commit b0d8273
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 30 deletions.
diff --git a/src/test/cli/rbd/help.t b/src/test/cli/rbd/help.t
@@ -51,7 +51,8 @@
       group info                        Show information about a group.
       group list (group ls)             List rbd groups.
       group remove (group rm)           Delete a group.
-      group rename                      Rename a group within pool.
+      group rename                      Rename a group within its pool or
+                                        namespace.
       group snap create                 Make a snapshot of a group.
       group snap info                   Show information about a group snapshot.
       group snap list (... ls)          List snapshots of a group.
@@ -96,24 +97,25 @@
                                         mirroring.
       mirror image snapshot             Create RBD mirroring image snapshot.
       mirror image status               Show RBD mirroring status for an image.
-      mirror pool demote                Demote all primary images in the pool.
-      mirror pool disable               Disable RBD mirroring by default within a
-                                        pool.
-      mirror pool enable                Enable RBD mirroring by default within a
-                                        pool.
-      mirror pool info                  Show information about the pool mirroring
-                                        configuration.
+      mirror pool demote                Demote all primary images in a pool or
+                                        namespace.
+      mirror pool disable               Disable RBD mirroring in a pool or
+                                        namespace.
+      mirror pool enable                Enable RBD mirroring in a pool or
+                                        namespace.
+      mirror pool info                  Show mirroring configuration for a pool
+                                        or namespace.
       mirror pool peer add              Add a mirroring peer to a pool.
       mirror pool peer bootstrap create Create a peer bootstrap token to import
                                         in a remote cluster
       mirror pool peer bootstrap import Import a peer bootstrap token created
                                         from a remote cluster
       mirror pool peer remove           Remove a mirroring peer from a pool.
       mirror pool peer set              Update mirroring peer settings.
-      mirror pool promote               Promote all non-primary images in the
-                                        pool.
-      mirror pool status                Show status for all mirrored images in
-                                        the pool.
+      mirror pool promote               Promote all non-primary images in a pool
+                                        or namespace.
+      mirror pool status                Show status for all mirrored images in a
+                                        pool or namespace.
       mirror snapshot schedule add      Add mirror snapshot schedule.
       mirror snapshot schedule list (... ls)
                                         List mirror snapshot schedule.
@@ -133,7 +135,8 @@
       pool init                         Initialize pool for use by RBD.
       pool stats                        Display pool statistics.
       remove (rm)                       Delete an image.
-      rename (mv)                       Rename image within pool.
+      rename (mv)                       Rename an image within its pool or
+                                        namespace.
       resize                            Resize (expand or shrink) image.
       snap create (snap add)            Create a snapshot.
       snap limit clear                  Remove snapshot limit.
@@ -1034,7 +1037,7 @@
                           [--dest-group <dest-group>] 
                           <source-group-spec> <dest-group-spec> 
 
-  Rename a group within pool.
+  Rename a group within its pool or namespace.
 
   Positional arguments
     <source-group-spec>  source group specification
@@ -1802,7 +1805,7 @@
   usage: rbd mirror pool demote [--pool <pool>] [--namespace <namespace>] 
                                 <pool-spec> 
 
-  Demote all primary images in the pool.
+  Demote all primary images in a pool or namespace.
 
   Positional arguments
     <pool-spec>          pool specification
@@ -1816,7 +1819,7 @@
   usage: rbd mirror pool disable [--pool <pool>] [--namespace <namespace>] 
                                  <pool-spec> 
   
-  Disable RBD mirroring by default within a pool.
+  Disable RBD mirroring in a pool or namespace.
   
   Positional arguments
     <pool-spec>          pool specification
@@ -1831,7 +1834,7 @@
                                 [--site-name <site-name>] 
                                 <pool-spec> <mode> 
 
-  Enable RBD mirroring by default within a pool.
+  Enable RBD mirroring in a pool or namespace.
 
   Positional arguments
     <pool-spec>          pool specification
@@ -1848,7 +1851,7 @@
                               [--format <format>] [--pretty-format] [--all] 
                               <pool-spec> 
   
-  Show information about the pool mirroring configuration.
+  Show mirroring configuration for a pool or namespace.
   
   Positional arguments
     <pool-spec>          pool specification
@@ -1956,7 +1959,7 @@
                                  [--namespace <namespace>] 
                                  <pool-spec> 
 
-  Promote all non-primary images in the pool.
+  Promote all non-primary images in a pool or namespace.
 
   Positional arguments
     <pool-spec>          pool specification
@@ -1972,7 +1975,7 @@
                                 [--format <format>] [--pretty-format] [--verbose] 
                                 <pool-spec> 
   
-  Show status for all mirrored images in the pool.
+  Show status for all mirrored images in a pool or namespace.
   
   Positional arguments
     <pool-spec>          pool specification
@@ -2262,7 +2265,7 @@
                     [--dest-namespace <dest-namespace>] [--dest <dest>] 
                     <source-image-spec> <dest-image-spec> 
 
-  Rename image within pool.
+  Rename an image within its pool or namespace.
 
   Positional arguments
     <source-image-spec>  source image specification

diff --git a/src/tools/rbd/action/Group.cc b/src/tools/rbd/action/Group.cc
@@ -1046,7 +1046,7 @@ Shell::Action action_list(
   {"group", "list"}, {"group", "ls"}, "List rbd groups.",
   "", &get_list_arguments, &execute_list);
 Shell::Action action_rename(
-  {"group", "rename"}, {}, "Rename a group within pool.",
+  {"group", "rename"}, {}, "Rename a group within its pool or namespace.",
   "", &get_rename_arguments, &execute_rename);
 Shell::Action action_info(
   {"group", "info"}, {}, "Show information about a group.",

diff --git a/src/tools/rbd/action/MirrorPool.cc b/src/tools/rbd/action/MirrorPool.cc
@@ -1744,27 +1744,27 @@ Shell::Action action_set(
 
 Shell::Action action_disable(
   {"mirror", "pool", "disable"}, {},
-  "Disable RBD mirroring by default within a pool.", "",
+  "Disable RBD mirroring in a pool or namespace.", "",
   &get_disable_arguments, &execute_disable);
 Shell::Action action_enable(
   {"mirror", "pool", "enable"}, {},
-  "Enable RBD mirroring by default within a pool.", "",
+  "Enable RBD mirroring in a pool or namespace.", "",
   &get_enable_arguments, &execute_enable);
 Shell::Action action_info(
   {"mirror", "pool", "info"}, {},
-  "Show information about the pool mirroring configuration.", {},
+  "Show mirroring configuration for a pool or namespace.", {},
   &get_info_arguments, &execute_info);
 Shell::Action action_status(
   {"mirror", "pool", "status"}, {},
-  "Show status for all mirrored images in the pool.", {},
+  "Show status for all mirrored images in a pool or namespace.", {},
   &get_status_arguments, &execute_status);
 Shell::Action action_promote(
   {"mirror", "pool", "promote"}, {},
-  "Promote all non-primary images in the pool.", {},
+  "Promote all non-primary images in a pool or namespace.", {},
   &get_promote_arguments, &execute_promote);
 Shell::Action action_demote(
   {"mirror", "pool", "demote"}, {},
-  "Demote all primary images in the pool.", {},
+  "Demote all primary images in a pool or namespace.", {},
   &get_demote_arguments, &execute_demote);
 
 } // namespace mirror_pool

diff --git a/src/tools/rbd/action/Rename.cc b/src/tools/rbd/action/Rename.cc
@@ -86,8 +86,8 @@ int execute(const po::variables_map &vm,
 }
 
 Shell::Action action(
-  {"rename"}, {"mv"}, "Rename image within pool.", "", &get_arguments,
-  &execute);
+  {"rename"}, {"mv"}, "Rename an image within its pool or namespace.", "",
+  &get_arguments, &execute);
 
 } // namespace rename
 } // namespace action