summaryrefslogtreecommitdiffstats
path: root/doc/cephfs
diff options
context:
space:
mode:
Diffstat (limited to 'doc/cephfs')
-rw-r--r--doc/cephfs/administration.rst75
-rw-r--r--doc/cephfs/health-messages.rst17
2 files changed, 67 insertions, 25 deletions
diff --git a/doc/cephfs/administration.rst b/doc/cephfs/administration.rst
index cd912b42a..7244c41f0 100644
--- a/doc/cephfs/administration.rst
+++ b/doc/cephfs/administration.rst
@@ -258,31 +258,47 @@ Clients that are missing newly added features will be evicted automatically.
Here are the current CephFS features and first release they came out:
-+------------------+--------------+-----------------+
-| Feature | Ceph release | Upstream Kernel |
-+==================+==============+=================+
-| jewel | jewel | 4.5 |
-+------------------+--------------+-----------------+
-| kraken | kraken | 4.13 |
-+------------------+--------------+-----------------+
-| luminous | luminous | 4.13 |
-+------------------+--------------+-----------------+
-| mimic | mimic | 4.19 |
-+------------------+--------------+-----------------+
-| reply_encoding | nautilus | 5.1 |
-+------------------+--------------+-----------------+
-| reclaim_client | nautilus | N/A |
-+------------------+--------------+-----------------+
-| lazy_caps_wanted | nautilus | 5.1 |
-+------------------+--------------+-----------------+
-| multi_reconnect | nautilus | 5.1 |
-+------------------+--------------+-----------------+
-| deleg_ino | octopus | 5.6 |
-+------------------+--------------+-----------------+
-| metric_collect | pacific | N/A |
-+------------------+--------------+-----------------+
-| alternate_name | pacific | PLANNED |
-+------------------+--------------+-----------------+
++----------------------------+--------------+-----------------+
+| Feature | Ceph release | Upstream Kernel |
++============================+==============+=================+
+| jewel | jewel | 4.5 |
++----------------------------+--------------+-----------------+
+| kraken | kraken | 4.13 |
++----------------------------+--------------+-----------------+
+| luminous | luminous | 4.13 |
++----------------------------+--------------+-----------------+
+| mimic | mimic | 4.19 |
++----------------------------+--------------+-----------------+
+| reply_encoding | nautilus | 5.1 |
++----------------------------+--------------+-----------------+
+| reclaim_client | nautilus | N/A |
++----------------------------+--------------+-----------------+
+| lazy_caps_wanted | nautilus | 5.1 |
++----------------------------+--------------+-----------------+
+| multi_reconnect | nautilus | 5.1 |
++----------------------------+--------------+-----------------+
+| deleg_ino | octopus | 5.6 |
++----------------------------+--------------+-----------------+
+| metric_collect | pacific | N/A |
++----------------------------+--------------+-----------------+
+| alternate_name | pacific | 6.5 |
++----------------------------+--------------+-----------------+
+| notify_session_state | quincy | 5.19 |
++----------------------------+--------------+-----------------+
+| op_getvxattr | quincy | 6.0 |
++----------------------------+--------------+-----------------+
+| 32bits_retry_fwd | reef | 6.6 |
++----------------------------+--------------+-----------------+
+| new_snaprealm_info | reef | UNKNOWN |
++----------------------------+--------------+-----------------+
+| has_owner_uidgid | reef | 6.6 |
++----------------------------+--------------+-----------------+
+| client_mds_auth_caps | squid+bp | PLANNED |
++----------------------------+--------------+-----------------+
+
+..
+ Comment: use `git describe --tags --abbrev=0 <commit>` to lookup release
+
CephFS Feature Descriptions
@@ -340,6 +356,15 @@ Clients can send performance metric to MDS if MDS support this feature.
Clients can set and understand "alternate names" for directory entries. This is
to be used for encrypted file name support.
+::
+
+ client_mds_auth_caps
+
+To effectively implement ``root_squash`` in a client's ``mds`` caps, the client
+must understand that it is enforcing ``root_squash`` and other cap metadata.
+Clients without this feature are in danger of dropping updates to files. It is
+recommend to set this feature bit.
+
Global settings
---------------
diff --git a/doc/cephfs/health-messages.rst b/doc/cephfs/health-messages.rst
index 8fb23715d..0f171c6cc 100644
--- a/doc/cephfs/health-messages.rst
+++ b/doc/cephfs/health-messages.rst
@@ -252,3 +252,20 @@ other daemons, please see :ref:`health-checks`.
dirty data for cap revokes). If ``defer_client_eviction_on_laggy_osds`` is
set to true (default true), client eviction will not take place and thus
this health warning will be generated.
+
+``MDS_CLIENTS_BROKEN_ROOTSQUASH``
+---------------------------------
+ Message
+ "X client(s) with broken root_squash implementation (MDS_CLIENTS_BROKEN_ROOTSQUASH)"
+
+ Description
+ A bug was discovered in root_squash which would potentially lose changes made by a
+ client restricted with root_squash caps. The fix required a change to the protocol
+ and a client upgrade is required.
+
+ This is a HEALTH_ERR warning because of the danger of inconsistency and lost
+ data. It is recommended to either upgrade your clients, discontinue using
+ root_squash in the interim, or silence the warning if desired.
+
+ To evict and permanently block broken clients from connecting to the
+ cluster, set the ``required_client_feature`` bit ``client_mds_auth_caps``.