2021-03-15 07:38:00 +00:00
|
|
|
:orphan:
|
|
|
|
|
|
|
|
|
|
==========================
|
|
|
|
|
Installing Ceph on Windows
|
|
|
|
|
==========================
|
|
|
|
|
|
|
|
|
|
The Ceph client tools and libraries can be natively used on Windows. This avoids
|
2021-11-27 19:57:05 +00:00
|
|
|
the need for additional layers such as iSCSI gateways or SMB shares,
|
2021-03-15 07:38:00 +00:00
|
|
|
drastically improving the performance.
|
|
|
|
|
|
|
|
|
|
Prerequisites
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
Supported platforms
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
Windows Server 2019 and Windows Server 2016 are supported. Previous Windows
|
|
|
|
|
Server versions, including Windows client versions such as Windows 10, might
|
|
|
|
|
work but haven't been tested.
|
|
|
|
|
|
|
|
|
|
Windows Server 2016 does not provide Unix sockets, in which case some commands
|
|
|
|
|
might be unavailable.
|
|
|
|
|
|
|
|
|
|
Secure boot
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
The ``WNBD`` driver hasn't been signed by Microsoft, which means that Secure Boot
|
|
|
|
|
must be disabled.
|
|
|
|
|
|
|
|
|
|
Dokany
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
In order to mount Ceph filesystems, ``ceph-dokan`` requires Dokany to be
|
|
|
|
|
installed. You may fetch the installer as well as the source code from the
|
2022-06-26 03:09:51 +00:00
|
|
|
Dokany GitHub repository: https://github.com/dokan-dev/dokany/releases
|
2021-03-15 07:38:00 +00:00
|
|
|
|
2022-08-30 13:38:18 +00:00
|
|
|
Make sure to install Dokany 2.0.5 or later.
|
2021-03-15 07:38:00 +00:00
|
|
|
|
|
|
|
|
Unlike ``WNBD``, Dokany isn't included in the Ceph MSI installer.
|
|
|
|
|
|
|
|
|
|
MSI installer
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
Using the MSI installer is the recommended way of installing Ceph on Windows.
|
2021-03-17 10:38:55 +00:00
|
|
|
It can be downloaded from here: https://cloudbase.it/ceph-for-windows/
|
2021-03-15 07:38:00 +00:00
|
|
|
|
|
|
|
|
As mentioned earlier, the Ceph installer does not include Dokany, which has
|
|
|
|
|
to be installed separately.
|
|
|
|
|
|
|
|
|
|
A server reboot is required after uninstalling the driver, otherwise subsequent
|
|
|
|
|
install attempts may fail.
|
|
|
|
|
|
|
|
|
|
The following project allows building the MSI installer:
|
|
|
|
|
https://github.com/cloudbase/ceph-windows-installer. It can either use prebuilt
|
|
|
|
|
Ceph and WNBD binaries or compile them from scratch.
|
|
|
|
|
|
|
|
|
|
Manual installation
|
|
|
|
|
===================
|
|
|
|
|
|
|
|
|
|
The following document describes the build process and manual installation:
|
|
|
|
|
https://github.com/ceph/ceph/blob/master/README.windows.rst
|
|
|
|
|
|
|
|
|
|
Configuration
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
Please check the `Windows configuration sample`_ to get started.
|
|
|
|
|
|
|
|
|
|
You'll also need a keyring file. The `General CephFS Prerequisites`_ page provides a
|
|
|
|
|
simple example, showing how a new CephX user can be created and how its secret
|
|
|
|
|
key can be retrieved.
|
|
|
|
|
|
|
|
|
|
For more details on CephX user management, see the `Client Authentication`_
|
|
|
|
|
and :ref:`User Management <user-management>`.
|
|
|
|
|
|
|
|
|
|
Further reading
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
* `RBD Windows documentation`_
|
|
|
|
|
* `CephFS Windows documentation`_
|
|
|
|
|
* `Windows troubleshooting`_
|
|
|
|
|
|
|
|
|
|
.. _CephFS Windows documentation: ../../cephfs/ceph-dokan
|
|
|
|
|
.. _Windows configuration sample: ../windows-basic-config
|
|
|
|
|
.. _RBD Windows documentation: ../../rbd/rbd-windows/
|
|
|
|
|
.. _Windows troubleshooting: ../windows-troubleshooting
|
|
|
|
|
.. _General CephFS Prerequisites: ../../cephfs/mount-prerequisites
|
|
|
|
|
.. _Client Authentication: ../../cephfs/client-auth
|
2024-09-27 14:09:34 +00:00
|
|
|
.. _Windows testing: ../dev/tests-windows
|
