From b66bbf136c60404616bdca768f3f6e84b442692c Mon Sep 17 00:00:00 2001 From: Lucian Petrut Date: Mon, 8 Mar 2021 15:25:30 +0000 Subject: [PATCH] cephfs: document using multiple fs on Windows This change updates the ceph-dokan documentation, showing how a non-default Ceph filesystem can be mounted. Fixes: https://tracker.ceph.com/issues/49662 Signed-off-by: Lucian Petrut (cherry picked from commit 5a1be89c5ac5fbde60332df8b008fcd5c6d0deb7) --- doc/cephfs/ceph-dokan.rst | 39 +++++++++++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 6 deletions(-) diff --git a/doc/cephfs/ceph-dokan.rst b/doc/cephfs/ceph-dokan.rst index 600650a8ed83c..8545c2c384163 100644 --- a/doc/cephfs/ceph-dokan.rst +++ b/doc/cephfs/ceph-dokan.rst @@ -11,6 +11,9 @@ Please check the `installation guide`_ to get started. Usage ===== +Mounting filesystems +-------------------- + In order to mount a ceph filesystem, the following command can be used:: ceph-dokan.exe -c c:\ceph.conf -l x @@ -30,15 +33,28 @@ changed using the following ``ceph.conf`` options:: client_mount_uid = 1000 client_mount_gid = 1000 -Please use ``ceph-dokan --help`` for a full list of arguments. +If you have more than one FS on your Ceph cluster, use the option +``--client_fs`` to mount the non-default FS:: -The mount can be removed by either issuing ctrl-c or using the unmap command, -like so:: + mkdir -Force C:\mnt\mycephfs2 + ceph-dokan.exe --mountpoint C:\mnt\mycephfs2 --client_fs mycephfs2 - ceph-dokan.exe unmap -l x +CephFS subdirectories can be mounted using the ``--root-path`` parameter:: -Note that when unmapping Ceph filesystems, the exact same mountpoint argument -must be used as when the mapping was created. + ceph-dokan -l y --root-path /a + +If the ``-o --removable`` flags are set, the mounts will show up in the +``Get-Volume`` results:: + + PS C:\> Get-Volume -FriendlyName "Ceph*" | ` + Select-Object -Property @("DriveLetter", "Filesystem", "FilesystemLabel") + + DriveLetter Filesystem FilesystemLabel + ----------- ---------- --------------- + Z Ceph Ceph + W Ceph Ceph - new_fs + +Please use ``ceph-dokan --help`` for a full list of arguments. Credentials ----------- @@ -49,6 +65,17 @@ use for mounting CephFS. The following commands are equivalent:: ceph-dokan --id foo -l x ceph-dokan --name client.foo -l x +Unmounting filesystems +---------------------- + +The mount can be removed by either issuing ctrl-c or using the unmap command, +like so:: + + ceph-dokan.exe unmap -l x + +Note that when unmapping Ceph filesystems, the exact same mountpoint argument +must be used as when the mapping was created. + Limitations ----------- -- 2.39.5