ceph/doc/install/windows-install.rst

   1 :orphan:
   2
   3 ==========================
   4 Installing Ceph on Windows
   5 ==========================
   6
   7 The Ceph client tools and libraries can be natively used on Windows. This avoids
   8 the need for additional layers such as iSCSI gateways or SMB shares,
   9 drastically improving the performance.
  10
  11 Prerequisites
  12 =============
  13
  14 Supported platforms
  15 -------------------
  16
  17 Windows Server 2019 and Windows Server 2016 are supported. Previous Windows
  18 Server versions, including Windows client versions such as Windows 10, might
  19 work but haven't been tested.
  20
  21 Windows Server 2016 does not provide Unix sockets, in which case some commands
  22 might be unavailable.
  23
  24 Secure boot
  25 -----------
  26
  27 The ``WNBD`` driver hasn't been signed by Microsoft, which means that Secure Boot
  28 must be disabled.
  29
  30 Dokany
  31 ------
  32
  33 In order to mount Ceph filesystems, ``ceph-dokan`` requires Dokany to be
  34 installed. You may fetch the installer as well as the source code from the
  35 Dokany GitHub repository: https://github.com/dokan-dev/dokany/releases
  36
  37 Make sure to install Dokany 2.0.5 or later.
  38
  39 Unlike ``WNBD``, Dokany isn't included in the Ceph MSI installer.
  40
  41 MSI installer
  42 =============
  43
  44 Using the MSI installer is the recommended way of installing Ceph on Windows.
  45 It can be downloaded from here: https://cloudbase.it/ceph-for-windows/
  46
  47 As mentioned earlier, the Ceph installer does not include Dokany, which has
  48 to be installed separately.
  49
  50 A server reboot is required after uninstalling the driver, otherwise subsequent
  51 install attempts may fail.
  52
  53 The following project allows building the MSI installer:
  54 https://github.com/cloudbase/ceph-windows-installer. It can either use prebuilt
  55 Ceph and WNBD binaries or compile them from scratch.
  56
  57 Manual installation
  58 ===================
  59
  60 The following document describes the build process and manual installation:
  61 https://github.com/ceph/ceph/blob/master/README.windows.rst
  62
  63 Configuration
  64 =============
  65
  66 Please check the `Windows configuration sample`_ to get started.
  67
  68 You'll also need a keyring file. The `General CephFS Prerequisites`_ page provides a
  69 simple example, showing how a new CephX user can be created and how its secret
  70 key can be retrieved.
  71
  72 For more details on CephX user management, see the `Client Authentication`_
  73 and :ref:`User Management <user-management>`.
  74
  75 Further reading
  76 ===============
  77
  78 * `RBD Windows documentation`_
  79 * `CephFS Windows documentation`_
  80 * `Windows troubleshooting`_
  81
  82 .. _CephFS Windows documentation: ../../cephfs/ceph-dokan
  83 .. _Windows configuration sample: ../windows-basic-config
  84 .. _RBD Windows documentation: ../../rbd/rbd-windows/
  85 .. _Windows troubleshooting: ../windows-troubleshooting
  86 .. _General CephFS Prerequisites: ../../cephfs/mount-prerequisites
  87 .. _Client Authentication: ../../cephfs/client-auth