ceph/doc/cephfs/client-config-ref.rst

   1 Client Configuration
   2 ====================
   3
   4 Updating Client Configuration
   5 -----------------------------
   6
   7 Certain client configurations can be applied at runtime. To check if a configuration option can be applied (taken into affect by a client) at runtime, use the `config help` command::
   8
   9    ceph config help debug_client
  10     debug_client - Debug level for client
  11     (str, advanced)                                                                                                                      Default: 0/5
  12     Can update at runtime: true
  13
  14     The value takes the form 'N' or 'N/M' where N and M are values between 0 and 99.  N is the debug level to log (all values below this are included), and M is the level to gather and buffer in memory.  In the event of a crash, the most recent items <= M are dumped to the log file.
  15
  16 `config help` tells if a given configuration can be applied at runtime along with the defaults and a description of the configuration option.
  17
  18 To update a configuration option at runtime, use the `config set` command::
  19
  20    ceph config set client debug_client 20/20
  21
  22 Note that this changes a given configuration for all clients.
  23
  24 To check configured options use the `config get` command::
  25
  26    ceph config get client
  27     WHO    MASK LEVEL    OPTION                    VALUE     RO
  28     client      advanced debug_client              20/20
  29     global      advanced osd_pool_default_min_size 1
  30     global      advanced osd_pool_default_size     3
  31
  32 Client Config Reference
  33 ------------------------
  34
  35 ``client acl type``
  36
  37 :Description: Set the ACL type. Currently, only possible value is ``"posix_acl"`` to enable POSIX ACL, or an empty string. This option only takes effect when the ``fuse_default_permissions`` is set to ``false``.
  38
  39 :Type: String
  40 :Default: ``""`` (no ACL enforcement)
  41
  42 ``client cache mid``
  43
  44 :Description: Set client cache midpoint. The midpoint splits the least recently used lists into a hot and warm list.
  45 :Type: Float
  46 :Default: ``0.75``
  47
  48 ``client cache size``
  49
  50 :Description: Set the number of inodes that the client keeps in the metadata cache.
  51 :Type: Integer
  52 :Default: ``16384``
  53
  54 ``client caps release delay``
  55
  56 :Description: Set the delay between capability releases in seconds. The delay sets how many seconds a client waits to release capabilities that it no longer needs in case the capabilities are needed for another user space operation.
  57 :Type: Integer
  58 :Default: ``5`` (seconds)
  59
  60 ``client debug force sync read``
  61
  62 :Description: If set to ``true``, clients read data directly from OSDs instead of using a local page cache.
  63 :Type: Boolean
  64 :Default: ``false``
  65
  66 ``client dirsize rbytes``
  67
  68 :Description: If set to ``true``, use the recursive size of a directory (that is, total of all descendants).
  69 :Type: Boolean
  70 :Default: ``true``
  71
  72 ``client max inline size``
  73
  74 :Description: Set the maximum size of inlined data stored in a file inode rather than in a separate data object in RADOS. This setting only applies if the ``inline_data`` flag is set on the MDS map.
  75 :Type: Integer
  76 :Default: ``4096``
  77
  78 ``client metadata``
  79
  80 :Description: Comma-delimited strings for client metadata sent to each MDS, in addition to the automatically generated version, host name, and other metadata.
  81 :Type: String
  82 :Default: ``""`` (no additional metadata)
  83
  84 ``client mount gid``
  85
  86 :Description: Set the group ID of CephFS mount.
  87 :Type: Integer
  88 :Default: ``-1``
  89
  90 ``client mount timeout``
  91
  92 :Description: Set the timeout for CephFS mount in seconds.
  93 :Type: Float
  94 :Default: ``300.0``
  95
  96 ``client mount uid``
  97
  98 :Description: Set the user ID of CephFS mount.
  99 :Type: Integer
 100 :Default: ``-1``
 101
 102 ``client mountpoint``
 103
 104 :Description: Directory to mount on the CephFS file system. An alternative to the ``-r`` option of the ``ceph-fuse`` command.
 105 :Type: String
 106 :Default: ``"/"``
 107
 108 ``client oc``
 109
 110 :Description: Enable object caching.
 111 :Type: Boolean
 112 :Default: ``true``
 113
 114 ``client oc max dirty``
 115
 116 :Description: Set the maximum number of dirty bytes in the object cache.
 117 :Type: Integer
 118 :Default: ``104857600`` (100MB)
 119
 120 ``client oc max dirty age``
 121
 122 :Description: Set the maximum age in seconds of dirty data in the object cache before writeback.
 123 :Type: Float
 124 :Default: ``5.0`` (seconds)
 125
 126 ``client oc max objects``
 127
 128 :Description: Set the maximum number of objects in the object cache.
 129 :Type: Integer
 130 :Default: ``1000``
 131
 132 ``client oc size``
 133
 134 :Description: Set how many bytes of data will the client cache.
 135 :Type: Integer
 136 :Default: ``209715200`` (200 MB)
 137
 138 ``client oc target dirty``
 139
 140 :Description: Set the target size of dirty data. We recommend to keep this number low.
 141 :Type: Integer
 142 :Default: ``8388608`` (8MB)
 143
 144 ``client permissions``
 145
 146 :Description: Check client permissions on all I/O operations.
 147 :Type: Boolean
 148 :Default: ``true``
 149
 150 ``client quota``
 151
 152 :Description: Enable client quota checking if set to ``true``.
 153 :Type: Boolean
 154 :Default: ``true``
 155
 156 ``client quota df``
 157
 158 :Description: Report root directory quota for the ``statfs`` operation.
 159 :Type: Boolean
 160 :Default: ``true``
 161
 162 ``client readahead max bytes``
 163
 164 :Description: Set the maximum number of bytes that the client reads ahead for future read operations. Overridden by the ``client_readahead_max_periods`` setting.
 165 :Type: Integer
 166 :Default: ``0`` (unlimited)
 167
 168 ``client readahead max periods``
 169
 170 :Description: Set the number of file layout periods (object size * number of stripes) that the client reads ahead. Overrides the ``client_readahead_max_bytes`` setting.
 171 :Type: Integer
 172 :Default: ``4``
 173
 174 ``client readahead min``
 175
 176 :Description: Set the minimum number bytes that the client reads ahead.
 177 :Type: Integer
 178 :Default: ``131072`` (128KB)
 179
 180 ``client reconnect stale``
 181
 182 :Description: Automatically reconnect stale session.
 183 :Type: Boolean
 184 :Default: ``false``
 185
 186 ``client snapdir``
 187
 188 :Description: Set the snapshot directory name.
 189 :Type: String
 190 :Default: ``".snap"``
 191
 192 ``client tick interval``
 193
 194 :Description: Set the interval in seconds between capability renewal and other upkeep.
 195 :Type: Float
 196 :Default: ``1.0`` (seconds)
 197
 198 ``client use random mds``
 199
 200 :Description: Choose random MDS for each request.
 201 :Type: Boolean
 202 :Default: ``false``
 203
 204 ``fuse default permissions``
 205
 206 :Description: When set to ``false``, ``ceph-fuse`` utility checks does its own permissions checking, instead of relying on the permissions enforcement in FUSE. Set to ``false`` together with the ``client acl type=posix_acl`` option to enable POSIX ACL.
 207 :Type: Boolean
 208 :Default: ``true``
 209
 210 ``fuse max write``
 211
 212 :Description: Set the maximum number of bytes in a single write operation.  Because the FUSE default is 128kbytes, SO fuse_max_write default set to 0(The default does not take effect)
 213 :Type: Integer
 214 :Default: ``0``
 215
 216 ``fuse disable pagecache``
 217
 218 :Description: If set to ``true``, kernel page cache is disabled for ceph-fuse mount. Because when multiple clients read/write to a file at the same time, reader may get stale data from page cache. (Due to limitation of fuse, ceph-fuse can't disable page cache dynamically)
 219 :Type: Boolean
 220 :Default: ``false``
 221
 222 Developer Options
 223 #################
 224
 225 .. important:: These options are internal. They are listed here only to complete the list of options.
 226
 227 ``client debug getattr caps``
 228
 229 :Description: Check if the reply from the MDS contains required capabilities.
 230 :Type: Boolean
 231 :Default: ``false``
 232
 233 ``client debug inject tick delay``
 234
 235 :Description: Add artificial delay between client ticks.
 236 :Type: Integer
 237 :Default: ``0``
 238
 239 ``client inject fixed oldest tid``
 240
 241 :Description:
 242 :Type: Boolean
 243 :Default: ``false``
 244
 245 ``client inject release failure``
 246
 247 :Description:
 248 :Type: Boolean
 249 :Default: ``false``
 250
 251 ``client trace``
 252
 253 :Description: The path to the trace file for all file operations. The output is designed to be used by the Ceph `synthetic client <../../man/8/ceph-syn>`_.
 254 :Type: String
 255 :Default: ``""`` (disabled)
 256