From: Patrick Donnelly <pdonnell@redhat.com>
Date: Tue, 18 Jun 2024 18:07:31 +0000 (-0400)
Subject: doc: add documentation for `ceph auth rotate`
X-Git-Tag: v20.0.0~1680^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=b871bbebe0253d4c59a737b0d82992679a8baf02;p=ceph.git

doc: add documentation for `ceph auth rotate`

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
---

diff --git a/doc/rados/operations/user-management.rst b/doc/rados/operations/user-management.rst
index 130c02002daf..1cfab8016c2c 100644
--- a/doc/rados/operations/user-management.rst
+++ b/doc/rados/operations/user-management.rst
@@ -744,6 +744,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
 ==================