]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: add documentation for `ceph auth rotate` 58236/head
authorPatrick Donnelly <pdonnell@redhat.com>
Tue, 18 Jun 2024 18:07:31 +0000 (14:07 -0400)
committerPatrick Donnelly <pdonnell@ibm.com>
Wed, 30 Apr 2025 18:00:09 +0000 (14:00 -0400)
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
(cherry picked from commit b871bbebe0253d4c59a737b0d82992679a8baf02)

doc/rados/operations/user-management.rst

index 62ad41feb55ea4a5e207dbb6cb89763fd5268188..cd8e378fa9d2d9cc79ddaf4d3aeb7f71f889b3e1 100644 (file)
@@ -748,6 +748,20 @@ You may also :ref:`Modify user capabilities<modify-user-capabilities>` directly
 results to a keyring file, and then import the keyring into your main
 ``ceph.keyring`` file.
 
+
+Key rotation
+------------
+
+To rotate the secret for an entity, use:
+
+.. prompt:: bash #
+
+    ceph auth rotate <entity>
+
+This avoids the need to delete and recreate the entity when its key is
+compromised, lost, or scheduled for rotation.
+
+
 Command Line Usage
 ==================