Skip to content

Commit 55b4ea7

Browse files
committed
doc/cephfs: improve mount-using-fuse
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 <[email protected]>
1 parent b51b428 commit 55b4ea7

File tree

2 files changed

+18
-11
lines changed

2 files changed

+18
-11
lines changed

doc/cephfs/mount-using-fuse.rst

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,32 @@
22
Mount CephFS using FUSE
33
========================
44

5-
`ceph-fuse`_ is an alternate way of mounting CephFS, although it mounts it
6-
in userspace. Therefore, performance of FUSE can be relatively lower but FUSE
7-
clients can be more manageable, especially while upgrading CephFS.
5+
`ceph-fuse`_ can be used as an alternative to the :ref:`CephFS kernel
6+
driver<cephfs-mount-using-kernel-driver>` to mount CephFS file systems.
7+
`ceph-fuse`_ mounts are made in userspace. This means that `ceph-fuse`_ mounts
8+
are less performant than kernel driver mounts, but they are easier to manage
9+
and easier to upgrade.
810

911
Prerequisites
1012
=============
1113

12-
Go through the prerequisites required by both, kernel as well as FUSE mounts,
13-
in `Mount CephFS: Prerequisites`_ page.
14+
Ensure that you have all the prerequisites required by both kernel and FUSE
15+
mounts, as listed on the `Mount CephFS: Prerequisites`_ page.
1416

1517
.. note:: Mounting CephFS using FUSE requires superuser privileges (sudo/root).
16-
The libfuse interface does not provide a mechanism to trim cache entries in the
17-
kernel so a remount (``mount(2)``) system call is required to force the kernel
18-
to drop the cached metadata. ``ceph-fuse`` issues these remount system calls
19-
periodically in response to cache pressure in the MDS or due to metadata cache revocations.
18+
The libfuse interface does not provide a mechanism to trim cache entries in
19+
the kernel so a remount (``mount(2)``) system call is required to force the
20+
kernel to drop the cached metadata. ``ceph-fuse`` issues these remount
21+
system calls periodically in response to cache pressure in the MDS or due to
22+
metadata cache revocations.
2023

2124
Synopsis
2225
========
23-
In general, the command to mount CephFS via FUSE looks like this::
26+
This is the general form of the command for mounting CephFS via FUSE:
2427

25-
ceph-fuse {mountpoint} {options}
28+
.. prompt:: bash #
29+
30+
ceph-fuse {mountpoint} {options}
2631

2732
Mounting CephFS
2833
===============

doc/cephfs/mount-using-kernel-driver.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _cephfs-mount-using-kernel-driver:
2+
13
=================================
24
Mount CephFS using Kernel Driver
35
=================================

0 commit comments

Comments
 (0)