src/ceph/doc/cephfs/eviction.rst

   1
   2 ===============================
   3 Ceph filesystem client eviction
   4 ===============================
   5
   6 When a filesystem client is unresponsive or otherwise misbehaving, it
   7 may be necessary to forcibly terminate its access to the filesystem.  This
   8 process is called *eviction*.
   9
  10 Evicting a CephFS client prevents it from communicating further with MDS
  11 daemons and OSD daemons.  If a client was doing buffered IO to the filesystem,
  12 any un-flushed data will be lost.
  13
  14 Clients may either be evicted automatically (if they fail to communicate
  15 promptly with the MDS), or manually (by the system administrator).
  16
  17 The client eviction process applies to clients of all kinds, this includes
  18 FUSE mounts, kernel mounts, nfs-ganesha gateways, and any process using
  19 libcephfs.
  20
  21 Automatic client eviction
  22 =========================
  23
  24 There are two situations in which a client may be evicted automatically:
  25
  26 On an active MDS daemon, if a client has not communicated with the MDS for
  27 over ``mds_session_autoclose`` seconds (300 seconds by default), then it
  28 will be evicted automatically.
  29
  30 During MDS startup (including on failover), the MDS passes through a
  31 state called ``reconnect``.  During this state, it waits for all the
  32 clients to connect to the new MDS daemon.  If any clients fail to do
  33 so within the time window (``mds_reconnect_timeout``, 45 seconds by default)
  34 then they will be evicted.
  35
  36 A warning message is sent to the cluster log if either of these situations
  37 arises.
  38
  39 Manual client eviction
  40 ======================
  41
  42 Sometimes, the administrator may want to evict a client manually.  This
  43 could happen if a client is died and the administrator does not
  44 want to wait for its session to time out, or it could happen if
  45 a client is misbehaving and the administrator does not have access to
  46 the client node to unmount it.
  47
  48 It is useful to inspect the list of clients first:
  49
  50 ::
  51
  52     ceph tell mds.0 client ls
  53
  54     [
  55         {
  56             "id": 4305,
  57             "num_leases": 0,
  58             "num_caps": 3,
  59             "state": "open",
  60             "replay_requests": 0,
  61             "completed_requests": 0,
  62             "reconnecting": false,
  63             "inst": "client.4305 172.21.9.34:0/422650892",
  64             "client_metadata": {
  65                 "ceph_sha1": "ae81e49d369875ac8b569ff3e3c456a31b8f3af5",
  66                 "ceph_version": "ceph version 12.0.0-1934-gae81e49 (ae81e49d369875ac8b569ff3e3c456a31b8f3af5)",
  67                 "entity_id": "0",
  68                 "hostname": "senta04",
  69                 "mount_point": "/tmp/tmpcMpF1b/mnt.0",
  70                 "pid": "29377",
  71                 "root": "/"
  72             }
  73         }
  74     ]
  75
  76
  77
  78 Once you have identified the client you want to evict, you can
  79 do that using its unique ID, or various other attributes to identify it:
  80
  81 ::
  82
  83     # These all work
  84     ceph tell mds.0 client evict id=4305
  85     ceph tell mds.0 client evict client_metadata.=4305
  86
  87
  88 Advanced: Un-blacklisting a client
  89 ==================================
  90
  91 Ordinarily, a blacklisted client may not reconnect to the servers: it
  92 must be unmounted and then mounted anew.
  93
  94 However, in some situations it may be useful to permit a client that
  95 was evicted to attempt to reconnect.
  96
  97 Because CephFS uses the RADOS OSD blacklist to control client eviction,
  98 CephFS clients can be permitted to reconnect by removing them from
  99 the blacklist:
 100
 101 ::
 102
 103     ceph osd blacklist ls
 104     # ... identify the address of the client ...
 105     ceph osd blacklist rm <address>
 106
 107 Doing this may put data integrity at risk if other clients have accessed
 108 files that the blacklisted client was doing buffered IO to.  It is also not
 109 guaranteed to result in a fully functional client -- the best way to get
 110 a fully healthy client back after an eviction is to unmount the client
 111 and do a fresh mount.
 112
 113 If you are trying to reconnect clients in this way, you may also
 114 find it useful to set ``client_reconnect_stale`` to true in the
 115 FUSE client, to prompt the client to try to reconnect.
 116
 117 Advanced: Configuring blacklisting
 118 ==================================
 119
 120 If you are experiencing frequent client evictions, due to slow
 121 client hosts or an unreliable network, and you cannot fix the underlying
 122 issue, then you may want to ask the MDS to be less strict.
 123
 124 It is possible to respond to slow clients by simply dropping their
 125 MDS sessions, but permit them to re-open sessions and permit them
 126 to continue talking to OSDs.  To enable this mode, set
 127 ``mds_session_blacklist_on_timeout`` to false on your MDS nodes.
 128
 129 For the equivalent behaviour on manual evictions, set
 130 ``mds_session_blacklist_on_evict`` to false.
 131
 132 Note that if blacklisting is disabled, then evicting a client will
 133 only have an effect on the MDS you send the command to.  On a system
 134 with multiple active MDS daemons, you would need to send an
 135 eviction command to each active daemon.  When blacklisting is enabled
 136 (the default), sending an eviction command to just a single
 137 MDS is sufficient, because the blacklist propagates it to the others.
 138
 139 Advanced options
 140 ================
 141
 142 ``mds_blacklist_interval`` - this setting controls how many seconds
 143 entries will remain in the blacklist for.
 144
 145
 146 .. _background_blacklisting_and_osd_epoch_barrier:
 147
 148 Background: Blacklisting and OSD epoch barrier
 149 ==============================================
 150
 151 After a client is blacklisted, it is necessary to make sure that
 152 other clients and MDS daemons have the latest OSDMap (including
 153 the blacklist entry) before they try to access any data objects
 154 that the blacklisted client might have been accessing.
 155
 156 This is ensured using an internal "osdmap epoch barrier" mechanism.
 157
 158 The purpose of the barrier is to ensure that when we hand out any
 159 capabilities which might allow touching the same RADOS objects, the
 160 clients we hand out the capabilities to must have a sufficiently recent
 161 OSD map to not race with cancelled operations (from ENOSPC) or
 162 blacklisted clients (from evictions).
 163
 164 More specifically, the cases where an epoch barrier is set are:
 165
 166  * Client eviction (where the client is blacklisted and other clients
 167    must wait for a post-blacklist epoch to touch the same objects).
 168  * OSD map full flag handling in the client (where the client may
 169    cancel some OSD ops from a pre-full epoch, so other clients must
 170    wait until the full epoch or later before touching the same objects).
 171  * MDS startup, because we don't persist the barrier epoch, so must
 172    assume that latest OSD map is always required after a restart.
 173
 174 Note that this is a global value for simplicity. We could maintain this on
 175 a per-inode basis. But we don't, because:
 176
 177  * It would be more complicated.
 178  * It would use an extra 4 bytes of memory for every inode.
 179  * It would not be much more efficient as almost always everyone has the latest.
 180    OSD map anyway, in most cases everyone will breeze through this barrier
 181    rather than waiting.
 182  * This barrier is done in very rare cases, so any benefit from per-inode
 183    granularity would only very rarely be seen.
 184
 185 The epoch barrier is transmitted along with all capability messages, and
 186 instructs the receiver of the message to avoid sending any more RADOS
 187 operations to OSDs until it has seen this OSD epoch.  This mainly applies
 188 to clients (doing their data writes directly to files), but also applies
 189 to the MDS because things like file size probing and file deletion are
 190 done directly from the MDS.