From: Sage Weil <sage@newdream.net>
Date: Tue, 2 Nov 2021 14:24:06 +0000 (-0400)
Subject: doc/cephadm/operations: document 'ceph orch daemon rotate-key'
X-Git-Tag: v17.2.6~187^2~6
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=44ddf40340015b9d4ecf52362acf86aedfa1f3d1;p=ceph.git

doc/cephadm/operations: document 'ceph orch daemon rotate-key'

Signed-off-by: Sage Weil <sage@newdream.net>
(cherry picked from commit 772e4265bda8668fe24b9aabb9ad29d3d0baf7bd)
---

diff --git a/doc/cephadm/operations.rst b/doc/cephadm/operations.rst
index a342ce983ad..adc795d21e4 100644
--- a/doc/cephadm/operations.rst
+++ b/doc/cephadm/operations.rst
@@ -87,6 +87,21 @@ file but will not trigger a restart of the daemon.
    ceph orch daemon reconfig <name>
 
 
+Rotating a daemon's authenticate key
+------------------------------------
+
+All Ceph and gateway daemons in the cluster have a secret key that is used to connect
+to and authenticate with the cluster.  This key can be rotated (i.e., replaced with a
+new key) with the following command:
+
+.. prompt:: bash #
+
+   ceph orch daemon rotate-key <name>
+
+For MDS, OSD, and MGR daemons, this does not require a daemon restart.  For other
+daemons, however (e.g., RGW), the daemon may be restarted to switch to the new key.
+
+
 Ceph daemon logs
 ================