ceph/src/common/options/mds-client.yaml.in

   1 # -*- mode: YAML -*-
   2 ---
   3
   4 options:
   5 - name: client_cache_size
   6   type: size
   7   level: basic
   8   desc: soft maximum number of directory entries in client cache
   9   fmt_desc: Set the number of inodes that the client keeps in the metadata cache.
  10   default: 16_K
  11   services:
  12   - mds_client
  13   with_legacy: true
  14 - name: client_cache_mid
  15   type: float
  16   level: advanced
  17   desc: mid-point of client cache LRU
  18   fmt_desc: Set client cache midpoint. The midpoint splits the least recently used
  19     lists into a hot and warm list.
  20   default: 0.75
  21   services:
  22   - mds_client
  23   with_legacy: true
  24 - name: client_use_random_mds
  25   type: bool
  26   level: dev
  27   desc: issue new requests to a random active MDS
  28   fmt_desc: Choose random MDS for each request.
  29   default: false
  30   services:
  31   - mds_client
  32   with_legacy: true
  33 - name: client_mount_timeout
  34   type: float
  35   level: advanced
  36   desc: timeout for mounting CephFS (seconds)
  37   fmt_desc: Set the timeout for CephFS mount in seconds.
  38   default: 5_min
  39   services:
  40   - mds_client
  41   with_legacy: true
  42 - name: client_tick_interval
  43   type: secs
  44   level: dev
  45   desc: seconds between client upkeep ticks
  46   fmt_desc: Set the interval in seconds between capability renewal and other upkeep.
  47   default: 1
  48   services:
  49   - mds_client
  50 - name: client_trace
  51   type: str
  52   level: dev
  53   desc: file containing trace of client operations
  54   services:
  55   - mds_client
  56   with_legacy: true
  57 - name: client_readahead_min
  58   type: size
  59   level: advanced
  60   desc: minimum bytes to readahead in a file
  61   fmt_desc: Set the minimum number bytes that the client reads ahead.
  62   default: 128_K
  63   services:
  64   - mds_client
  65   with_legacy: true
  66 - name: client_readahead_max_bytes
  67   type: size
  68   level: advanced
  69   desc: maximum bytes to readahead in a file (zero is unlimited)
  70   fmt_desc: Set the maximum number of bytes that the client reads ahead for
  71     future read operations. Overridden by the ``client_readahead_max_periods``
  72     setting.
  73   default: 0
  74   services:
  75   - mds_client
  76   with_legacy: true
  77 # as multiple of file layout period (object size * num stripes)
  78 - name: client_readahead_max_periods
  79   type: int
  80   level: advanced
  81   desc: maximum stripe periods to readahead in a file
  82   fmt_desc: Set the number of file layout periods (object size * number of
  83     stripes) that the client reads ahead. Overrides the
  84     ``client_readahead_max_bytes`` setting.
  85   default: 4
  86   services:
  87   - mds_client
  88   with_legacy: true
  89 - name: client_reconnect_stale
  90   type: bool
  91   level: advanced
  92   desc: reconnect when the session becomes stale
  93   default: false
  94   services:
  95   - mds_client
  96 - name: client_snapdir
  97   type: str
  98   level: advanced
  99   desc: pseudo directory for snapshot access to a directory
 100   fmt_desc: Set the snapshot directory name.
 101   default: .snap
 102   services:
 103   - mds_client
 104   with_legacy: true
 105 - name: client_mountpoint
 106   type: str
 107   level: advanced
 108   desc: default mount-point
 109   fmt_desc: Directory to mount on the CephFS file system. An alternative to the
 110     ``-r`` option of the ``ceph-fuse`` command.
 111   default: /
 112   services:
 113   - mds_client
 114 - name: client_mount_uid
 115   type: int
 116   level: advanced
 117   desc: uid to mount as
 118   default: -1
 119   services:
 120   - mds_client
 121   fmt_desc: Set the user ID of CephFS mount.
 122   with_legacy: true
 123 - name: client_mount_gid
 124   type: int
 125   level: advanced
 126   desc: gid to mount as
 127   fmt_desc: Set the group ID of CephFS mount.
 128   default: -1
 129   services:
 130   - mds_client
 131   with_legacy: true
 132 - name: client_notify_timeout
 133   type: int
 134   level: dev
 135   default: 10
 136   services:
 137   - mds_client
 138   with_legacy: true
 139 - name: osd_client_watch_timeout
 140   type: int
 141   level: dev
 142   default: 30
 143   services:
 144   - mds_client
 145   with_legacy: true
 146 - name: client_caps_release_delay
 147   type: int
 148   level: dev
 149   default: 5
 150   services:
 151   - mds_client
 152   fmt_desc: Set the delay between capability releases in seconds. The delay
 153     sets how many   seconds a client waits to release capabilities that it no
 154     longer needs in case the capabilities are needed for another user space
 155     operation.
 156   with_legacy: true
 157 - name: client_quota_df
 158   type: bool
 159   level: advanced
 160   desc: show quota usage for statfs (df)
 161   fmt_desc: Report root directory quota for the ``statfs`` operation.
 162   default: true
 163   services:
 164   - mds_client
 165   with_legacy: true
 166 - name: client_oc
 167   type: bool
 168   level: advanced
 169   desc: enable object caching
 170   default: true
 171   services:
 172   - mds_client
 173   with_legacy: true
 174 - name: client_oc_size
 175   type: size
 176   level: advanced
 177   desc: maximum size of object cache
 178   fmt_desc: Set how many bytes of data will the client cache.
 179   default: 200_M
 180   services:
 181   - mds_client
 182   flags:
 183   - runtime
 184   with_legacy: true
 185 # MB * n  (dirty OR tx.. bigish)
 186 - name: client_oc_max_dirty
 187   type: size
 188   level: advanced
 189   desc: maximum size of dirty pages in object cache
 190   fmt_desc: Set the maximum number of dirty bytes in the object cache.
 191   default: 100_M
 192   services:
 193   - mds_client
 194   flags:
 195   - runtime
 196   with_legacy: true
 197 # target dirty (keep this smallish)
 198 - name: client_oc_target_dirty
 199   type: size
 200   level: advanced
 201   desc: target size of dirty pages object cache
 202   fmt_desc: Set the target size of dirty data. We recommend to keep this number low.
 203   default: 8_M
 204   services:
 205   - mds_client
 206   flags:
 207   - runtime
 208   with_legacy: true
 209 - name: client_oc_max_dirty_age
 210   type: float
 211   level: advanced
 212   desc: maximum age of dirty pages in object cache (seconds)
 213   fmt_desc: Set the maximum age in seconds of dirty data in the object cache
 214     before writeback.
 215   default: 5
 216   services:
 217   - mds_client
 218   flags:
 219   - runtime
 220   with_legacy: true
 221 - name: client_oc_max_objects
 222   type: int
 223   level: advanced
 224   desc: maximum number of objects in cache
 225   fmt_desc: Set the maximum number of objects in the object cache.
 226   default: 1000
 227   services:
 228   - mds_client
 229   flags:
 230   - runtime
 231   with_legacy: true
 232 # check if MDS reply contains wanted caps
 233 - name: client_debug_getattr_caps
 234   type: bool
 235   level: dev
 236   default: false
 237   services:
 238   - mds_client
 239   with_legacy: true
 240 # always read synchronously (go to osds)
 241 - name: client_debug_force_sync_read
 242   type: bool
 243   level: dev
 244   default: false
 245   services:
 246   - mds_client
 247   fmt_desc: If set to ``true``, clients read data directly from OSDs instead
 248     of using a local page cache.
 249   with_legacy: true
 250 - name: client_debug_inject_tick_delay
 251   type: secs
 252   level: dev
 253   default: 0
 254   services:
 255   - mds_client
 256 - name: client_max_inline_size
 257   type: size
 258   level: dev
 259   default: 4_K
 260   services:
 261   - mds_client
 262   fmt_desc: Set the maximum size of inlined data stored in a file inode rather
 263     than in a separate data object in RADOS. This setting only applies if the
 264     ``inline_data`` flag is set on the MDS map.
 265   with_legacy: true
 266 # synthetic client bug for testing
 267 - name: client_inject_release_failure
 268   type: bool
 269   level: dev
 270   default: false
 271   services:
 272   - mds_client
 273   with_legacy: true
 274 # synthetic client bug for testing
 275 - name: client_inject_fixed_oldest_tid
 276   type: bool
 277   level: dev
 278   default: false
 279   services:
 280   - mds_client
 281   with_legacy: true
 282 - name: client_metadata
 283   type: str
 284   level: advanced
 285   desc: metadata key=value comma-delimited pairs appended to session metadata
 286   fmt_desc: Comma-delimited strings for client metadata sent to each MDS, in addition
 287     to the automatically generated version, host name, and other metadata.
 288   services:
 289   - mds_client
 290   with_legacy: true
 291 - name: client_acl_type
 292   type: str
 293   level: advanced
 294   desc: ACL type to enforce (none or "posix_acl")
 295   fmt_desc: Set the ACL type. Currently, only possible value is ``"posix_acl"`` to
 296     enable POSIX ACL, or an empty string. This option only takes effect when the
 297     ``fuse_default_permissions`` is set to ``false``.
 298   services:
 299   - mds_client
 300   with_legacy: true
 301 - name: client_permissions
 302   type: bool
 303   level: advanced
 304   desc: client-enforced permission checking
 305   fmt_desc: Check client permissions on all I/O operations.
 306   default: true
 307   services:
 308   - mds_client
 309   with_legacy: true
 310 - name: client_dirsize_rbytes
 311   type: bool
 312   level: advanced
 313   desc: set the directory size as the number of file bytes recursively used
 314   long_desc: This option enables a CephFS feature that stores the recursive directory
 315     size (the bytes used by files in the directory and its descendents) in the st_size
 316     field of the stat structure.
 317   default: true
 318   services:
 319   - mds_client
 320   with_legacy: true
 321 - name: client_force_lazyio
 322   type: bool
 323   level: advanced
 324   default: false
 325   services:
 326   - mds_client
 327 - name: fuse_use_invalidate_cb
 328   type: bool
 329   level: advanced
 330   desc: use fuse 2.8+ invalidate callback to keep page cache consistent
 331   default: true
 332   services:
 333   - mds_client
 334 - name: fuse_disable_pagecache
 335   type: bool
 336   level: advanced
 337   desc: disable page caching in the kernel for this FUSE mount
 338   fmt_desc: If set to ``true``, kernel page cache is disabled for ``ceph-fuse``
 339     mounts. When multiple clients read/write to a file at the same
 340     time, readers may get stale data from page cache. Due to
 341     limitations of FUSE, ``ceph-fuse`` can't disable page cache dynamically.
 342   default: false
 343   services:
 344   - mds_client
 345 - name: fuse_allow_other
 346   type: bool
 347   level: advanced
 348   desc: pass allow_other to FUSE on mount
 349   default: true
 350   services:
 351   - mds_client
 352 - name: fuse_default_permissions
 353   type: bool
 354   level: advanced
 355   desc: pass default_permisions to FUSE on mount
 356   fmt_desc: When set to ``false``, ``ceph-fuse`` utility checks does its own
 357     permissions checking, instead of relying on the permissions enforcement in
 358     FUSE. Set to ``false`` together with the ``client acl type=posix_acl``
 359     option to enable POSIX ACL.
 360   default: false
 361   services:
 362   - mds_client
 363   flags:
 364   - startup
 365 - name: fuse_splice_read
 366   type: bool
 367   level: advanced
 368   desc: enable splice read to reduce the memory copies
 369   default: true
 370   services:
 371   - mds_client
 372 - name: fuse_splice_write
 373   type: bool
 374   level: advanced
 375   desc: enable splice write to reduce the memory copies
 376   default: true
 377   services:
 378   - mds_client
 379 - name: fuse_splice_move
 380   type: bool
 381   level: advanced
 382   desc: enable splice move to reduce the memory copies
 383   default: true
 384   services:
 385   - mds_client
 386 - name: fuse_big_writes
 387   type: bool
 388   level: advanced
 389   desc: big_writes is deprecated in libfuse 3.0.0
 390   default: true
 391   services:
 392   - mds_client
 393 - name: fuse_max_write
 394   type: size
 395   level: advanced
 396   desc: set the maximum number of bytes in a single write operation
 397   long_desc: Set the maximum number of bytes in a single write operation that may
 398     pass atomically through FUSE. The FUSE default is 128kB and may be indicated by
 399     setting this option to 0.
 400   fmt_desc: Set the maximum number of bytes in a single write operation. A value of
 401     0 indicates no change; the FUSE default of 128 kbytes remains in force.
 402   default: 0
 403   services:
 404   - mds_client
 405 - name: fuse_atomic_o_trunc
 406   type: bool
 407   level: advanced
 408   desc: pass atomic_o_trunc flag to FUSE on mount
 409   default: true
 410   services:
 411   - mds_client
 412 - name: fuse_debug
 413   type: bool
 414   level: advanced
 415   desc: enable debugging for the libfuse
 416   default: false
 417   services:
 418   - mds_client
 419   flags:
 420   - no_mon_update
 421   - startup
 422 - name: fuse_multithreaded
 423   type: bool
 424   level: advanced
 425   desc: allow parallel processing through FUSE library
 426   default: true
 427   services:
 428   - mds_client
 429 - name: fuse_require_active_mds
 430   type: bool
 431   level: advanced
 432   desc: require active MDSs in the file system when mounting
 433   default: true
 434   services:
 435   - mds_client
 436 - name: fuse_syncfs_on_mksnap
 437   type: bool
 438   level: advanced
 439   desc: synchronize all local metadata/file changes after snapshot
 440   default: true
 441   services:
 442   - mds_client
 443 - name: fuse_set_user_groups
 444   type: bool
 445   level: advanced
 446   desc: check for ceph-fuse to consider supplementary groups for permissions
 447   default: true
 448   services:
 449   - mds_client
 450 # the client should try to use dentry invaldation instead of remounting, on kernels it believes that will work for
 451 - name: client_try_dentry_invalidate
 452   type: bool
 453   level: dev
 454   default: false
 455   services:
 456   - mds_client
 457   with_legacy: true
 458 - name: client_die_on_failed_remount
 459   type: bool
 460   level: dev
 461   default: false
 462   services:
 463   - mds_client
 464 - name: client_die_on_failed_dentry_invalidate
 465   type: bool
 466   level: advanced
 467   desc: kill the client when no dentry invalidation options are available
 468   long_desc: The CephFS client requires a mechanism to invalidate dentries in the
 469     caller (e.g. the kernel for ceph-fuse) when capabilities must be recalled. If
 470     the client cannot do this then the MDS cache cannot shrink which can cause the
 471     MDS to fail.
 472   default: true
 473   services:
 474   - mds_client
 475 - name: client_check_pool_perm
 476   type: bool
 477   level: advanced
 478   desc: confirm access to inode's data pool/namespace described in file layout
 479   default: true
 480   services:
 481   - mds_client
 482   with_legacy: true
 483 - name: client_use_faked_inos
 484   type: bool
 485   level: dev
 486   default: false
 487   services:
 488   - mds_client
 489   with_legacy: true
 490 - name: client_fs
 491   type: str
 492   level: advanced
 493   desc: CephFS file system name to mount
 494   long_desc: Use this with ceph-fuse, or with any process that uses libcephfs.  Programs
 495     using libcephfs may also pass the filesystem name into mount(), which will override
 496     this setting. If no filesystem name is given in mount() or this setting, the default
 497     filesystem will be mounted (usually the first created).
 498   services:
 499   - mds_client
 500   flags:
 501   - startup
 502 - name: client_mds_namespace
 503   type: str
 504   level: dev
 505   services:
 506   - mds_client
 507   flags:
 508   - startup
 509 - name: fake_statfs_for_testing
 510   type: int
 511   level: dev
 512   desc: Set a value for kb and compute kb_used from total of num_bytes
 513   default: 0
 514   services:
 515   - mds_client
 516   with_legacy: true
 517 # XXX: mon
 518 - name: debug_allow_any_pool_priority
 519   type: bool
 520   level: dev
 521   desc: Allow any pool priority to be set to test conversion to new range
 522   default: false
 523   services:
 524   - mds_client
 525   with_legacy: true
 526 - name: client_asio_thread_count
 527   type: uint
 528   level: advanced
 529   desc: Size of thread pool for ASIO completions
 530   default: 2
 531   tags:
 532   - client
 533   services:
 534   - mds_client
 535   min: 1
 536 - name: client_shutdown_timeout
 537   type: secs
 538   level: advanced
 539   desc: timeout for shutting down CephFS
 540   long_desc: Timeout for shutting down CephFS via unmount or shutdown.
 541   default: 30
 542   tags:
 543   - client
 544   services:
 545   - mds_client
 546   min: 0
 547   flags:
 548   - runtime