doc: Clarify the status of MS Windows client support

Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
(cherry picked from commit 89eabfc3f0c8db3501b3ea3097e2983617c5234a)

diff --git a/doc/cephfs/ceph-dokan.rst b/doc/cephfs/ceph-dokan.rst
index 4146761869cca65e37a18f087105a7e484991bfc..d731599ebbb1a849324099bad44435caf9927820 100644 (file)
--- a/doc/cephfs/ceph-dokan.rst
+++ b/doc/cephfs/ceph-dokan.rst
@@ -1,5 +1,4 @@
 .. _ceph-dokan:
-
 =======================
 Mount CephFS on Windows
 =======================
@@ -8,7 +7,9 @@ Mount CephFS on Windows
 It leverages Dokany, a Windows driver that allows implementing filesystems in
 userspace, pretty much like FUSE.
 
-Please check the `installation guide`_ to get started.
+Please see the `installation guide`_ to get started.
+
+Please see the `OS recommendations`_ regarding client support.
 
 Usage
 =====
@@ -85,8 +86,8 @@ 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
+Another thing to note is that CephFS doesn't support mandatory file locks, which
+Windows relies heavily upon. At present Ceph lets Dokan handle file
 locks, which are only enforced locally.
 
 Unlike ``rbd-wnbd``, ``ceph-dokan`` doesn't currently provide a ``service``
@@ -100,3 +101,4 @@ Please consult the `Windows troubleshooting`_ page.
 
 .. _Windows troubleshooting: ../../install/windows-troubleshooting
 .. _installation guide: ../../install/windows-install
+.. _OS recommendations: ../../start/os-recommendations

diff --git a/doc/install/windows-install.rst b/doc/install/windows-install.rst
index 7cc99472c0b50fe61d0b571661d3249c4e079bea..0768a36a6305a6d018ead61422fb6b7102cc22e6 100644 (file)
--- a/doc/install/windows-install.rst
+++ b/doc/install/windows-install.rst
@@ -13,6 +13,9 @@ Prerequisites
 
 Supported platforms
 -------------------
+.. note::
+
+  Please see the `OS recommendations`_ regarding client package support.
 
 Windows Server 2019 and Windows Server 2016 are supported. Previous Windows
 Server versions, including Windows client versions such as Windows 10, might
@@ -86,3 +89,4 @@ Further reading
 .. _General CephFS Prerequisites: ../../cephfs/mount-prerequisites
 .. _Client Authentication: ../../cephfs/client-auth
 .. _Windows testing: ../dev/tests-windows
+.. _OS recommendations: ../../start/os-recommendations

diff --git a/doc/rbd/rbd-windows.rst b/doc/rbd/rbd-windows.rst
index df4bd172ead57764c4febadd79d3f1dbc355b6ca..e1841d2b6b944e8cb29bc623e347be9e84bc009d 100644 (file)
--- a/doc/rbd/rbd-windows.rst
+++ b/doc/rbd/rbd-windows.rst
@@ -10,9 +10,11 @@ unmap images exactly like it would on Linux. Make sure to check the
 
 Please check the `installation guide`_ to get started.
 
+Please see the `OS recommendations`_ regarding client package support.
+
 Windows service
 ===============
-On Windows, ``rbd-wnbd`` daemons are managed by a centralized service. This allows
+On MS Windows, ``rbd-wnbd`` daemons are managed by a centralized service. This allows
 decoupling the daemons from the Windows session from which they originate. At
 the same time, the service is responsible of recreating persistent mappings,
 usually when the host boots.
@@ -233,3 +235,4 @@ Please consult the `Windows troubleshooting`_ page.
 .. _san command: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/san
 .. _StorageSetting command: https://learn.microsoft.com/en-us/powershell/module/storage/set-storagesetting?view=windowsserver2022-ps
 .. _SAN policy reference: https://learn.microsoft.com/en-us/windows-hardware/customize/desktop/unattend/microsoft-windows-partitionmanager-sanpolicy
+.. _OS recommendations: ../../start/os-recommendations

diff --git a/doc/start/os-recommendations.rst b/doc/start/os-recommendations.rst
index 4ba914f93bf26dde2e9fc70c5a326c7461b2a090..bade87653a6229164a86f07b176fa2d5979e451d 100644 (file)
--- a/doc/start/os-recommendations.rst
+++ b/doc/start/os-recommendations.rst
@@ -31,12 +31,17 @@ Linux Kernel
   or CentOS 8.2 is the minimum necessary for reasonable support for RBD image
   features.
 
+- **Ceph MS Windows Client**
+
+  Ceph's MS Windows native client support is "best effort".  There is no
+  full-time maintainer. As of July 2025 there are no plans to remove this
+  client but the future is uncertain.
 
 Platforms
 =========
 
-The chart below shows which Linux platforms Ceph provides packages for, and
-which platforms Ceph has been tested on. 
+The chart below shows the platforms for which Ceph provides packages, and
+the platforms on which Ceph has been tested. 
 
 Ceph does not require a specific Linux distribution. Ceph can run on any
 distribution that includes a supported kernel and supported system startup
@@ -68,10 +73,13 @@ non-Linux systems but these are not supported by the core Ceph effort.
 +---------------+----------------+---------------+------------------+------------------+------------------+
 | Ubuntu 22.04  | A              |    A          |                  |                  |                  |
 +---------------+----------------+---------------+------------------+------------------+------------------+
+| MS Windows    | D              | D             | D                | D                |                  |
++---------------+----------------+---------------+------------------+------------------+------------------+
 
 - **A**: Ceph provides packages and has done comprehensive tests on the software in them.
 - **B**: Ceph provides packages and has done basic tests on the software in them.
 - **C**: Ceph provides packages only. No tests have been done on these releases.
+- **D**: Client packages are available from an external site but are not maintained or tested by the core Ceph team.
 - **1**: Testing has been done on Centos 9 starting on version 17.2.8 for Quincy.
 
 Container Hosts