From: Neeraj Pratap Singh <neesingh@redhat.com>
Date: Fri, 6 May 2022 09:53:31 +0000 (+0530)
Subject: doc/cephfs-top: adding doc for menu options
X-Git-Tag: v16.2.11~296^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=c165bae5cc342b692f117d7a88b0cc58ed3b3b32;p=ceph.git

doc/cephfs-top: adding doc for menu options

Fixes: https://tracker.ceph.com/issues/54978
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
(cherry picked from commit e9d43d783829397bed054047d16ffee9f316f4fc)
---

diff --git a/doc/cephfs/cephfs-top.png b/doc/cephfs/cephfs-top.png
index 807029d00703..ca18abfd180e 100644
Binary files a/doc/cephfs/cephfs-top.png and b/doc/cephfs/cephfs-top.png differ
diff --git a/doc/cephfs/cephfs-top.rst b/doc/cephfs/cephfs-top.rst
index 780d7d2a8156..cecfa6c75f2f 100644
--- a/doc/cephfs/cephfs-top.rst
+++ b/doc/cephfs/cephfs-top.rst
@@ -9,7 +9,7 @@ in realtime. `cephfs-top` is a curses based python script which makes use of `st
 plugin in Ceph Manager to fetch (and display) metrics.
 
 Manager Plugin
---------------
+==============
 
 Ceph Filesystem clients periodically forward various metrics to Ceph Metadata Servers (MDS)
 which in turn get forwarded to Ceph Manager by MDS rank zero. Each active MDS forward its
@@ -53,7 +53,7 @@ To fetch metrics only for a subset of active MDSs (e.g., MDS rank 1 and 2)::
   $ ceph fs perf stats --mds_rank=1,2
 
 `cephfs-top`
-------------
+============
 
 `cephfs-top` utility relies on `stats` plugin to fetch performance metrics and display in
 `top(1)` like format. `cephfs-top` is available as part of `cephfs-top` package.
@@ -63,6 +63,9 @@ By default, `cephfs-top` uses `client.fstop` user to connect to a Ceph cluster::
   $ ceph auth get-or-create client.fstop mon 'allow r' mds 'allow r' osd 'allow r' mgr 'allow r'
   $ cephfs-top
 
+Command-Line Options
+--------------------
+
 To use a non-default user (other than `client.fstop`) use::
 
   $ cephfs-top --id <name>
@@ -77,8 +80,16 @@ By default, `cephfs-top` connects to cluster name `ceph`. To use a non-default c
 
 Interval should be greater or equal to 0.5 second. Fractional seconds are honoured.
 
-Sample screenshot running `cephfs-top` with 2 clients:
+Interactive Commands
+--------------------
 
-.. image:: cephfs-top.png
+1. m : Filesystem selection
+      Displays a menu of filesystems for selection.
+
+2. q : Quit
+      Exit the utility if you are at the home screen (all filesystem info),
+      otherwise escape back to the home screen.
 
-.. note:: As of now, `cephfs-top` does not reliably work with multiple Ceph Filesystems.
+Sample screenshot running `cephfs-top` with 2 filesystems:
+
+.. image:: cephfs-top.png