From a86b7bff587e2fa1360d4d27f591e8e841e29734 Mon Sep 17 00:00:00 2001 From: Milind Changire Date: Tue, 1 Oct 2019 12:41:32 +0530 Subject: [PATCH] doc: cleanup CephFS Landing Page Fixes: https://tracker.ceph.com/issues/41952 Signed-off-by: Milind Changire --- doc/cephfs/index.rst | 77 ++++++++++++++++++++++++++++++++------------ 1 file changed, 56 insertions(+), 21 deletions(-) diff --git a/doc/cephfs/index.rst b/doc/cephfs/index.rst index aed20343afa0c..93d4441345123 100644 --- a/doc/cephfs/index.rst +++ b/doc/cephfs/index.rst @@ -40,24 +40,25 @@ Block Devices) and RGW (Ceph Object Storage Gateway). Using CephFS -============ - -Using the Ceph File System requires at least one :term:`Ceph Metadata Server` in -your Ceph Storage Cluster. - +^^^^^^^^^^^^ +To run and use the Ceph File System, you must have a running Ceph Storage +Cluster with at least one :term:`Ceph Metadata Server` running. .. raw:: html - -

Step 1: Metadata Server

+ .. toctree:: - :maxdepth: 1 + :maxdepth: 1 + :hidden: Provision/Add/Remove MDS(s) MDS failover and standby configuration @@ -66,17 +67,26 @@ least one :term:`Ceph Metadata Server` running. Journaler Configuration Manpage ceph-mds <../../man/8/ceph-mds> -.. raw:: html - -

Step 2: Mount CephFS

Once you have a healthy Ceph Storage Cluster with at least one Ceph Metadata Server, you may create and mount your Ceph File System. Ensure that your client has network connectivity and the proper authentication keyring. +.. raw:: html + + + .. toctree:: - :maxdepth: 1 + :maxdepth: 1 + :hidden: Create a CephFS file system Mount CephFS with the Kernel Driver @@ -89,12 +99,20 @@ authentication keyring. Manpage mount.fuse.ceph <../../man/8/mount.fuse.ceph> -.. raw:: html +.. raw:: html + + .. toctree:: - :maxdepth: 1 + :maxdepth: 1 + :hidden: Deployment best practices MDS States @@ -122,20 +140,37 @@ authentication keyring. Distributed Metadata Cache FS volume and subvolumes +.. raw:: html + + + .. toctree:: :hidden: Advanced: Metadata repair + .. raw:: html -
+ .. toctree:: - :maxdepth: 1 + :maxdepth: 1 + :hidden: Client's Capabilities libcephfs <../../api/libcephfs-java/> -- 2.39.5