2021-03-05 13:14:29 +00:00
|
|
|
=======================
|
|
|
|
|
Mount CephFS on Windows
|
|
|
|
|
=======================
|
|
|
|
|
|
|
|
|
|
``ceph-dokan`` can be used for mounting CephFS filesystems on Windows.
|
|
|
|
|
It leverages Dokany, a Windows driver that allows implementing filesystems in
|
|
|
|
|
userspace, pretty much like FUSE.
|
|
|
|
|
|
2021-03-15 07:38:00 +00:00
|
|
|
Please check the `installation guide`_ to get started.
|
2021-03-05 13:14:29 +00:00
|
|
|
|
|
|
|
|
Usage
|
|
|
|
|
=====
|
|
|
|
|
|
|
|
|
|
In order to mount a ceph filesystem, the following command can be used::
|
|
|
|
|
|
|
|
|
|
ceph-dokan.exe -c c:\ceph.conf -l x
|
|
|
|
|
|
|
|
|
|
This will mount the default ceph filesystem using the drive letter ``x``.
|
|
|
|
|
If ``ceph.conf`` is placed at the default location, which is
|
|
|
|
|
``%ProgramData%\ceph\ceph.conf``, then this argument becomes optional.
|
|
|
|
|
|
|
|
|
|
The ``-l`` argument also allows using an empty folder as a mountpoint
|
|
|
|
|
instead of a drive letter.
|
|
|
|
|
|
|
|
|
|
The uid and gid used for mounting the filesystem default to 0 and may be
|
|
|
|
|
changed using the following ``ceph.conf`` options::
|
|
|
|
|
|
|
|
|
|
[client]
|
|
|
|
|
# client_permissions = true
|
|
|
|
|
client_mount_uid = 1000
|
|
|
|
|
client_mount_gid = 1000
|
|
|
|
|
|
|
|
|
|
Please use ``ceph-dokan --help`` for a full list of arguments.
|
|
|
|
|
|
|
|
|
|
Credentials
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
The ``--id`` option passes the name of the CephX user whose keyring we intend to
|
|
|
|
|
use for mounting CephFS. The following commands are equivalent::
|
|
|
|
|
|
|
|
|
|
ceph-dokan --id foo -l x
|
|
|
|
|
ceph-dokan --name client.foo -l x
|
|
|
|
|
|
|
|
|
|
Limitations
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
Be aware that Windows ACLs are ignored. Posix ACLs are supported but cannot be
|
|
|
|
|
modified using the current CLI. In the future, we may add some command actions
|
|
|
|
|
to change file ownership or permissions.
|
|
|
|
|
|
|
|
|
|
Another thing to note is that cephfs doesn't support mandatory file locks, which
|
|
|
|
|
Windows is heavily rely upon. At the moment, we're letting Dokan handle file
|
|
|
|
|
locks, which are only enforced locally.
|
|
|
|
|
|
|
|
|
|
Unlike ``rbd-wnbd``, ``ceph-dokan`` doesn't currently provide a ``service``
|
|
|
|
|
command. In order for the cephfs mount to survive host reboots, consider using
|
|
|
|
|
``NSSM``.
|
|
|
|
|
|
2021-03-15 07:38:00 +00:00
|
|
|
Troubleshooting
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
Please consult the `Windows troubleshooting`_ page.
|
|
|
|
|
|
|
|
|
|
.. _Windows troubleshooting: ../../install/windows-troubleshooting
|
|
|
|
|
.. _installation guide: ../../install/windows-install
|
