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