From: Venky Shankar <vshankar@redhat.com>
Date: Tue, 8 Dec 2020 07:09:47 +0000 (-0500)
Subject: doc, man: man page for `cephfs-top` utility
X-Git-Tag: v16.1.0~84^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F38108%2Fhead;p=ceph.git

doc, man: man page for `cephfs-top` utility

Fixes: http://tracker.ceph.com/issues/48602
Signed-off-by: Venky Shankar <vshankar@redhat.com>
---

diff --git a/doc/man/8/CMakeLists.txt b/doc/man/8/CMakeLists.txt
index fc28d84e7f24..5edd16b177fb 100644
--- a/doc/man/8/CMakeLists.txt
+++ b/doc/man/8/CMakeLists.txt
@@ -38,6 +38,7 @@ list(APPEND man_srcs
   ${osd_srcs}
   ${mon_srcs}
   ceph-mds.rst
+  cephfs-top.rst
   librados-config.rst
   cephadm.rst)
 
diff --git a/doc/man/8/cephfs-top.rst b/doc/man/8/cephfs-top.rst
new file mode 100644
index 000000000000..2ff8f7c5cac5
--- /dev/null
+++ b/doc/man/8/cephfs-top.rst
@@ -0,0 +1,50 @@
+:orphan:
+
+==========================================
+ cephfs-top -- Ceph Filesystem Top Utility
+==========================================
+
+.. program:: cephfs-top
+
+Synopsis
+========
+
+| **cephfs-top** [flags]
+
+
+Description
+===========
+
+**cephfs-top** provides top(1) like functionality for Ceph Filesystem.
+Various client metrics are displayed and updated in realtime.
+
+Ceph Metadata Servers periodically send client metrics to Ceph Manager.
+``Stats`` plugin in Ceph Manager provides an interface to fetch these metrics.
+
+Options
+=======
+
+.. option:: --cluster
+
+   Cluster: Ceph cluster to connect. Defaults to ``ceph``.
+
+.. option:: --id
+
+   Id: Client used to connect to Ceph cluster. Defaults to ``fstop``.
+
+.. option:: --selftest
+
+   Perform a selftest. This mode performs a sanity check of ``stats`` module.
+
+Availability
+============
+
+**cephfs-top** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at
+http://ceph.com/ for more information.
+
+
+See also
+========
+
+:doc:`ceph <ceph>`\(8),
+:doc:`ceph-mds <ceph-mds>`\(8)
diff --git a/doc/man_index.rst b/doc/man_index.rst
index ce29557bb9d7..61afac738c0b 100644
--- a/doc/man_index.rst
+++ b/doc/man_index.rst
@@ -23,6 +23,7 @@
    man/8/ceph-syn
    man/8/ceph
    man/8/cephadm
+   man/8/cephfs-top
    man/8/crushtool
    man/8/librados-config
    man/8/monmaptool