From: Patrick Donnelly <pdonnell@redhat.com>
Date: Mon, 14 Nov 2016 02:51:35 +0000 (-0500)
Subject: doc: clarify mds deactivate purpose
X-Git-Tag: v11.1.0~280^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=b9a63e49ea7fb1f7ed7ab2064aaaa21dd38d9a3f;p=ceph.git

doc: clarify mds deactivate purpose

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

diff --git a/doc/cephfs/administration.rst b/doc/cephfs/administration.rst
index 1e45bb3c199a..3569165fa0b5 100644
--- a/doc/cephfs/administration.rst
+++ b/doc/cephfs/administration.rst
@@ -51,6 +51,11 @@ These commands act on specific mds daemons or ranks.
 
     mds fail <gid/name/role
 
+This command deactivates an MDS causing it to flush its entire journal to
+backing RADOS objects and close all open client sessions. Deactivating an MDS
+is primarily intended for bringing down a rank after reducing the number of
+active MDS (max_mds).
+
 ::
 
     mds deactivate <role>