From: Zac Dover <zac.dover@proton.me>
Date: Sun, 21 Apr 2024 12:46:18 +0000 (+1000)
Subject: doc/rados: add bucket rename command
X-Git-Tag: v20.0.0~2114^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=1030b572fa1680792b4c5843a6cf517bd31511ae;p=ceph.git

doc/rados: add bucket rename command

Add "ceph osd crush rename bucket" command. This commit is made in
response to a request from Michele Giacomoli.

Fixes: https://tracker.ceph.com/issues/65599

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
---

diff --git a/doc/rados/operations/crush-map.rst b/doc/rados/operations/crush-map.rst
index 1c68a2a181b82..1a8dc36cb0b93 100644
--- a/doc/rados/operations/crush-map.rst
+++ b/doc/rados/operations/crush-map.rst
@@ -514,6 +514,16 @@ For details on this command's parameters, see the following:
    :Required: No
    :Example: ``datacenter=dc1 room=room1 row=foo rack=bar host=foo-bar-1``
 
+Renaming a bucket
+-----------------
+
+To rename a bucket while maintaining its position in the CRUSH map hierarchy,
+run a command of the following form:
+
+.. prompt:: bash #
+
+   ceph osd crush rename-bucket {oldname} {newname}
+
 Removing a Bucket
 -----------------