From b0f47a87e9f73a4f6e0df3c7617be64caf983a15 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Fri, 13 Dec 2024 16:12:49 +1000 Subject: [PATCH] doc/cephfs: edit 3rd 3rd of mount-using-kernel-driver Edit the third third of doc/cephfs/mount-using-kernel-driver.rst in preparation for correcting mount commands that may not work in Reef as described in this documentation. This commit edits only English-language strings in doc/cephfs/mount-using-kernel-driver.rst. No technical content (that is, no commands and no settings) have been altered in this commit. Technical alterations to this file will be made only after the English is unambiguous. This PR follows the following two PRs: https://github.com/ceph/ceph/pull/61048 - 1st 3rd https://github.com/ceph/ceph/pull/61049 - 2nd 3rd Co-authored-by: Anthony D'Atri Signed-off-by: Zac Dover (cherry picked from commit 9c7580a2935511d009c9e66885e76635aa504ee8) --- doc/cephfs/mount-using-kernel-driver.rst | 44 +++++++++++++++--------- 1 file changed, 28 insertions(+), 16 deletions(-) diff --git a/doc/cephfs/mount-using-kernel-driver.rst b/doc/cephfs/mount-using-kernel-driver.rst index fd8293c020f89..1ce45f0dd1cc7 100644 --- a/doc/cephfs/mount-using-kernel-driver.rst +++ b/doc/cephfs/mount-using-kernel-driver.rst @@ -109,29 +109,40 @@ Backward Compatibility ====================== The old syntax is supported for backward compatibility. -To mount CephFS with the kernel driver:: +To mount CephFS with the kernel driver, run the following commands: - mkdir /mnt/mycephfs - mount -t ceph :/ /mnt/mycephfs -o name=admin +.. prompt:: bash # -The key-value argument right after option ``-o`` is CephX credential; -``name`` is the username of the CephX user we are using to mount CephFS. + mkdir /mnt/mycephfs + mount -t ceph :/ /mnt/mycephfs -o name=admin -To mount a non-default FS ``cephfs2``, in case the cluster has multiple FSs:: +The key-value argument right after the option ``-o`` is the CephX credential. +``name`` is the username of the CephX user that is mounting CephFS. - mount -t ceph :/ /mnt/mycephfs -o name=admin,fs=cephfs2 +To mount a non-default FS (in this example, ``cephfs2``), run commands of the following form. These commands are to be used in cases in which the cluster +has multiple file systems: - or +.. prompt:: bash # - mount -t ceph :/ /mnt/mycephfs -o name=admin,mds_namespace=cephfs2 + mount -t ceph :/ /mnt/mycephfs -o name=admin,fs=cephfs2 -.. note:: The option ``mds_namespace`` is deprecated. Use ``fs=`` instead when using the old syntax for mounting. +or + +.. prompt:: bash # + + mount -t ceph :/ /mnt/mycephfs -o name=admin,mds_namespace=cephfs2 + +.. note:: The option ``mds_namespace`` is deprecated. Use ``fs=`` instead when + using the old syntax for mounting. Unmounting CephFS ================= -To unmount the Ceph file system, use the ``umount`` command as usual:: +To unmount the Ceph file system, use the ``umount`` command, as in this +example: + +.. prompt:: bash # - umount /mnt/mycephfs + umount /mnt/mycephfs .. tip:: Ensure that you are not within the file system directories before executing this command. @@ -148,11 +159,12 @@ For example:: cephuser@.cephfs=/ /mnt/ceph ceph mon_addr=192.168.0.1:6789,noatime,_netdev 0 0 -If the ``secret`` or ``secretfile`` options are not specified then the mount helper -will attempt to find a secret for the given ``name`` in one of the configured keyrings. +If the ``secret`` or ``secretfile`` options are not specified, the mount +helper will attempt to find a secret for the given ``name`` in one of the +configured keyrings. -See `User Management`_ for details on CephX user management and mount.ceph_ -manual for more options it can take. For troubleshooting, see +See `User Management`_ for details on CephX user management and the mount.ceph_ +manual for a list of the options it recognizes. For troubleshooting, see :ref:`kernel_mount_debugging`. .. _fstab: ../fstab/#kernel-driver -- 2.39.5