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

   1 ========================
   2  Client Config Reference
   3 ========================
   4
   5 ``client acl type``
   6
   7 :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``.
   8
   9 :Type: String
  10 :Default: ``""`` (no ACL enforcement)
  11
  12 ``client cache mid``
  13
  14 :Description: Set client cache midpoint. The midpoint splits the least recently used lists into a hot and warm list.
  15 :Type: Float
  16 :Default: ``0.75``
  17
  18 ``client_cache_size``
  19
  20 :Description: Set the number of inodes that the client keeps in the metadata cache.
  21 :Type: Integer
  22 :Default: ``16384``
  23
  24 ``client_caps_release_delay``
  25
  26 :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.
  27 :Type: Integer
  28 :Default: ``5`` (seconds)
  29
  30 ``client_debug_force_sync_read``
  31
  32 :Description: If set to ``true``, clients read data directly from OSDs instead of using a local page cache.
  33 :Type: Boolean
  34 :Default: ``false``
  35
  36 ``client_dirsize_rbytes``
  37
  38 :Description: If set to ``true``, use the recursive size of a directory (that is, total of all descendants).
  39 :Type: Boolean
  40 :Default: ``true``
  41
  42 ``client_max_inline_size``
  43
  44 :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.
  45 :Type: Integer
  46 :Default: ``4096``
  47
  48 ``client_metadata``
  49
  50 :Description: Comma-delimited strings for client metadata sent to each MDS, in addition to the automatically generated version, host name, and other metadata.
  51 :Type: String
  52 :Default: ``""`` (no additional metadata)
  53
  54 ``client_mount_gid``
  55
  56 :Description: Set the group ID of CephFS mount.
  57 :Type: Integer
  58 :Default: ``-1``
  59
  60 ``client_mount_timeout``
  61
  62 :Description: Set the timeout for CephFS mount in seconds.
  63 :Type: Float
  64 :Default: ``300.0``
  65
  66 ``client_mount_uid``
  67
  68 :Description: Set the user ID of CephFS mount.
  69 :Type: Integer
  70 :Default: ``-1``
  71
  72 ``client_mountpoint``
  73
  74 :Description: Directory to mount on the CephFS file system. An alternative to the ``-r`` option of the ``ceph-fuse`` command.
  75 :Type: String
  76 :Default: ``"/"``
  77
  78 ``client_oc``
  79
  80 :Description: Enable object caching.
  81 :Type: Boolean
  82 :Default: ``true``
  83
  84 ``client_oc_max_dirty``
  85
  86 :Description: Set the maximum number of dirty bytes in the object cache.
  87 :Type: Integer
  88 :Default: ``104857600`` (100MB)
  89
  90 ``client_oc_max_dirty_age``
  91
  92 :Description: Set the maximum age in seconds of dirty data in the object cache before writeback.
  93 :Type: Float
  94 :Default: ``5.0`` (seconds)
  95
  96 ``client_oc_max_objects``
  97
  98 :Description: Set the maximum number of objects in the object cache.
  99 :Type: Integer
 100 :Default: ``1000``
 101
 102 ``client_oc_size``
 103
 104 :Description: Set how many bytes of data will the client cache.
 105 :Type: Integer
 106 :Default: ``209715200`` (200 MB)
 107
 108 ``client_oc_target_dirty``
 109
 110 :Description: Set the target size of dirty data. We recommend to keep this number low.
 111 :Type: Integer
 112 :Default: ``8388608`` (8MB)
 113
 114 ``client_permissions``
 115
 116 :Description: Check client permissions on all I/O operations.
 117 :Type: Boolean
 118 :Default: ``true``
 119
 120 ``client_quota``
 121
 122 :Description: Enable client quota checking if set to ``true``.
 123 :Type: Boolean
 124 :Default: ``true``
 125
 126 ``client_quota_df``
 127
 128 :Description: Report root directory quota for the ``statfs`` operation.
 129 :Type: Boolean
 130 :Default: ``true``
 131
 132 ``client_readahead_max_bytes``
 133
 134 :Description: Set the maximum number of bytes that the kernel reads ahead for future read operations. Overridden by the ``client_readahead_max_periods`` setting.
 135 :Type: Integer
 136 :Default: ``0`` (unlimited)
 137
 138 ``client_readahead_max_periods``
 139
 140 :Description: Set the number of file layout periods (object size * number of stripes) that the kernel reads ahead. Overrides the ``client_readahead_max_bytes`` setting.
 141 :Type: Integer
 142 :Default: ``4``
 143
 144 ``client_readahead_min``
 145
 146 :Description: Set the minimum number bytes that the kernel reads ahead.
 147 :Type: Integer
 148 :Default: ``131072`` (128KB)
 149
 150 ``client_reconnect_stale``
 151
 152 :Description: Automatically reconnect stale session.
 153 :Type: Boolean
 154 :Default: ``false``
 155
 156 ``client_snapdir``
 157
 158 :Description: Set the snapshot directory name.
 159 :Type: String
 160 :Default: ``".snap"``
 161
 162 ``client_tick_interval``
 163
 164 :Description: Set the interval in seconds between capability renewal and other upkeep.
 165 :Type: Float
 166 :Default: ``1.0`` (seconds)
 167
 168 ``client_use_random_mds``
 169
 170 :Description: Choose random MDS for each request.
 171 :Type: Boolean
 172 :Default: ``false``
 173
 174 ``fuse_default_permissions``
 175
 176 :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.
 177 :Type: Boolean
 178 :Default: ``true``
 179
 180 Developer Options
 181 #################
 182
 183 .. important:: These options are internal. They are listed here only to complete the list of options.
 184
 185 ``client_debug_getattr_caps``
 186
 187 :Description: Check if the reply from the MDS contains required capabilities.
 188 :Type: Boolean
 189 :Default: ``false``
 190
 191 ``client_debug_inject_tick_delay``
 192
 193 :Description: Add artificial delay between client ticks.
 194 :Type: Integer
 195 :Default: ``0``
 196
 197 ``client_inject_fixed_oldest_tid``
 198
 199 :Description:
 200 :Type: Boolean
 201 :Default: ``false``
 202
 203 ``client_inject_release_failure``
 204
 205 :Description:
 206 :Type: Boolean
 207 :Default: ``false``
 208
 209 ``client_trace``
 210
 211 :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>`_.
 212 :Type: String
 213 :Default: ``""`` (disabled)
 214