]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/cephfs: improve mount-using-fuse 58571/head
authorZac Dover <zac.dover@proton.me>
Sat, 13 Jul 2024 00:32:31 +0000 (10:32 +1000)
committerZac Dover <zac.dover@proton.me>
Wed, 17 Jul 2024 07:02:35 +0000 (17:02 +1000)
Improve the first twenty percent of doc/cephfs/mount-using-fuse.rst.
This commit changes the text so that it is clearer that FUSE is an
alternative to mounting CephFS with the kernel driver. This commit also
links to the kernel driver page from the "FUSE-mount" page.

Signed-off-by: Zac Dover <zac.dover@proton.me>
doc/cephfs/mount-using-fuse.rst
doc/cephfs/mount-using-kernel-driver.rst

index 31ef9e3472b5f322afb6811905079d624900d6ec..5058f3f3ba252cf37dee675e8b613e209d467318 100644 (file)
@@ -2,27 +2,32 @@
  Mount CephFS using FUSE
 ========================
 
-`ceph-fuse`_ is an alternate way of mounting CephFS, although it mounts it
-in userspace. Therefore, performance of FUSE can be relatively lower but FUSE
-clients can be more manageable, especially while upgrading CephFS.
+`ceph-fuse`_ can be used as an alternative to the :ref:`CephFS kernel
+driver<cephfs-mount-using-kernel-driver>` to mount CephFS file systems.
+`ceph-fuse`_ mounts are made in userspace. This means that `ceph-fuse`_ mounts
+are less performant than kernel driver mounts, but they are easier to manage
+and easier to upgrade.
 
 Prerequisites
 =============
 
-Go through the prerequisites required by both, kernel as well as FUSE mounts,
-in `Mount CephFS: Prerequisites`_ page.
+Ensure that you have all the prerequisites required by both kernel and FUSE
+mounts, as listed on the `Mount CephFS: Prerequisites`_ page.
 
 .. note:: Mounting CephFS using FUSE requires superuser privileges (sudo/root).
-          The libfuse interface does not provide a mechanism to trim cache entries in the
-          kernel so a remount (``mount(2)``) system call is required to force the kernel
-          to drop the cached metadata. ``ceph-fuse`` issues these remount system calls
-          periodically in response to cache pressure in the MDS or due to metadata cache revocations.
+   The libfuse interface does not provide a mechanism to trim cache entries in
+   the kernel so a remount (``mount(2)``) system call is required to force the
+   kernel to drop the cached metadata. ``ceph-fuse`` issues these remount
+   system calls periodically in response to cache pressure in the MDS or due to
+   metadata cache revocations.
 
 Synopsis
 ========
-In general, the command to mount CephFS via FUSE looks like this::
+This is the general form of the command for mounting CephFS via FUSE: 
 
-    ceph-fuse {mountpoint} {options}
+.. prompt:: bash #
+
+   ceph-fuse {mountpoint} {options}
 
 Mounting CephFS
 ===============
index 0b99733d31db9e3c0e59d6e086cb7d2ae608e0c5..22ede055d0b53e45b0aba87ea517595ea01cc294 100644 (file)
@@ -1,3 +1,5 @@
+.. _cephfs-mount-using-kernel-driver:
+
 =================================
  Mount CephFS using Kernel Driver
 =================================