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

   1 ======================
   2  MDS Config Reference
   3 ======================
   4
   5 ``mon force standby active``
   6
   7 :Description: If ``true`` monitors force standby-replay to be active. Set
   8               under ``[mon]`` or ``[global]``.
   9
  10 :Type: Boolean
  11 :Default: ``true``
  12
  13
  14 ``mds max file size``
  15
  16 :Description: The maximum allowed file size to set when creating a
  17               new file system.
  18
  19 :Type:  64-bit Integer Unsigned
  20 :Default:  ``1ULL << 40``
  21
  22 ``mds cache memory limit``
  23
  24 :Description: The memory limit the MDS should enforce for its cache.
  25               Administrators should use this instead of ``mds cache size``.
  26 :Type:  64-bit Integer Unsigned
  27 :Default: ``1073741824``
  28
  29 ``mds cache reservation``
  30
  31 :Description: The cache reservation (memory or inodes) for the MDS cache to maintain.
  32               Once the MDS begins dipping into its reservation, it will recall
  33               client state until its cache size shrinks to restore the
  34               reservation.
  35 :Type:  Float
  36 :Default: ``0.05``
  37
  38 ``mds cache size``
  39
  40 :Description: The number of inodes to cache. A value of 0 indicates an
  41               unlimited number. It is recommended to use
  42               ``mds_cache_memory_limit`` to limit the amount of memory the MDS
  43               cache uses.
  44 :Type:  32-bit Integer
  45 :Default: ``0``
  46
  47 ``mds cache mid``
  48
  49 :Description: The insertion point for new items in the cache LRU
  50               (from the top).
  51
  52 :Type:  Float
  53 :Default: ``0.7``
  54
  55
  56 ``mds dir commit ratio``
  57
  58 :Description: The fraction of directory that is dirty before Ceph commits using
  59               a full update (instead of partial update).
  60
  61 :Type:  Float
  62 :Default: ``0.5``
  63
  64
  65 ``mds dir max commit size``
  66
  67 :Description: The maximum size of a directory update before Ceph breaks it into
  68               smaller transactions) (MB).
  69
  70 :Type:  32-bit Integer
  71 :Default: ``90``
  72
  73
  74 ``mds decay halflife``
  75
  76 :Description: The half-life of MDS cache temperature.
  77 :Type:  Float
  78 :Default: ``5``
  79
  80 ``mds beacon interval``
  81
  82 :Description: The frequency (in seconds) of beacon messages sent
  83               to the monitor.
  84
  85 :Type:  Float
  86 :Default: ``4``
  87
  88
  89 ``mds beacon grace``
  90
  91 :Description: The interval without beacons before Ceph declares an MDS laggy
  92               (and possibly replace it).
  93
  94 :Type:  Float
  95 :Default: ``15``
  96
  97
  98 ``mds blacklist interval``
  99
 100 :Description: The blacklist duration for failed MDSs in the OSD map.
 101 :Type:  Float
 102 :Default: ``24.0*60.0``
 103
 104
 105 ``mds session timeout``
 106
 107 :Description: The interval (in seconds) of client inactivity before Ceph
 108               times out capabilities and leases.
 109
 110 :Type:  Float
 111 :Default: ``60``
 112
 113
 114 ``mds session autoclose``
 115
 116 :Description: The interval (in seconds) before Ceph closes
 117               a laggy client's session.
 118
 119 :Type:  Float
 120 :Default: ``300``
 121
 122
 123 ``mds reconnect timeout``
 124
 125 :Description: The interval (in seconds) to wait for clients to reconnect
 126               during MDS restart.
 127
 128 :Type:  Float
 129 :Default: ``45``
 130
 131
 132 ``mds tick interval``
 133
 134 :Description: How frequently the MDS performs internal periodic tasks.
 135 :Type:  Float
 136 :Default: ``5``
 137
 138
 139 ``mds dirstat min interval``
 140
 141 :Description: The minimum interval (in seconds) to try to avoid propagating
 142               recursive stats up the tree.
 143
 144 :Type:  Float
 145 :Default: ``1``
 146
 147 ``mds scatter nudge interval``
 148
 149 :Description: How quickly dirstat changes propagate up.
 150 :Type:  Float
 151 :Default: ``5``
 152
 153
 154 ``mds client prealloc inos``
 155
 156 :Description: The number of inode numbers to preallocate per client session.
 157 :Type:  32-bit Integer
 158 :Default: ``1000``
 159
 160
 161 ``mds early reply``
 162
 163 :Description: Determines whether the MDS should allow clients to see request
 164               results before they commit to the journal.
 165
 166 :Type:  Boolean
 167 :Default: ``true``
 168
 169
 170 ``mds use tmap``
 171
 172 :Description: Use trivialmap for directory updates.
 173 :Type:  Boolean
 174 :Default: ``true``
 175
 176
 177 ``mds default dir hash``
 178
 179 :Description: The function to use for hashing files across directory fragments.
 180 :Type:  32-bit Integer
 181 :Default: ``2`` (i.e., rjenkins)
 182
 183
 184 ``mds log skip corrupt events``
 185
 186 :Description: Determines whether the MDS should try to skip corrupt journal
 187               events during journal replay.
 188
 189 :Type:  Boolean
 190 :Default:  ``false``
 191
 192
 193 ``mds log max events``
 194
 195 :Description: The maximum events in the journal before we initiate trimming.
 196               Set to ``-1`` to disable limits.
 197
 198 :Type:  32-bit Integer
 199 :Default: ``-1``
 200
 201
 202 ``mds log max segments``
 203
 204 :Description: The maximum number of segments (objects) in the journal before
 205               we initiate trimming. Set to ``-1`` to disable limits.
 206
 207 :Type:  32-bit Integer
 208 :Default: ``30``
 209
 210
 211 ``mds log max expiring``
 212
 213 :Description: The maximum number of segments to expire in parallels
 214 :Type:  32-bit Integer
 215 :Default: ``20``
 216
 217
 218 ``mds log eopen size``
 219
 220 :Description: The maximum number of inodes in an EOpen event.
 221 :Type:  32-bit Integer
 222 :Default: ``100``
 223
 224
 225 ``mds bal sample interval``
 226
 227 :Description: Determines how frequently to sample directory temperature
 228               (for fragmentation decisions).
 229
 230 :Type:  Float
 231 :Default: ``3``
 232
 233
 234 ``mds bal replicate threshold``
 235
 236 :Description: The maximum temperature before Ceph attempts to replicate
 237               metadata to other nodes.
 238
 239 :Type:  Float
 240 :Default: ``8000``
 241
 242
 243 ``mds bal unreplicate threshold``
 244
 245 :Description: The minimum temperature before Ceph stops replicating
 246               metadata to other nodes.
 247
 248 :Type:  Float
 249 :Default: ``0``
 250
 251
 252 ``mds bal frag``
 253
 254 :Description: Determines whether the MDS will fragment directories.
 255 :Type:  Boolean
 256 :Default:  ``false``
 257
 258
 259 ``mds bal split size``
 260
 261 :Description: The maximum directory size before the MDS will split a directory
 262               fragment into smaller bits.
 263
 264 :Type:  32-bit Integer
 265 :Default: ``10000``
 266
 267
 268 ``mds bal split rd``
 269
 270 :Description: The maximum directory read temperature before Ceph splits
 271               a directory fragment.
 272
 273 :Type:  Float
 274 :Default: ``25000``
 275
 276
 277 ``mds bal split wr``
 278
 279 :Description: The maximum directory write temperature before Ceph splits
 280               a directory fragment.
 281
 282 :Type:  Float
 283 :Default: ``10000``
 284
 285
 286 ``mds bal split bits``
 287
 288 :Description: The number of bits by which to split a directory fragment.
 289 :Type:  32-bit Integer
 290 :Default: ``3``
 291
 292
 293 ``mds bal merge size``
 294
 295 :Description: The minimum directory size before Ceph tries to merge
 296               adjacent directory fragments.
 297
 298 :Type:  32-bit Integer
 299 :Default: ``50``
 300
 301
 302 ``mds bal interval``
 303
 304 :Description: The frequency (in seconds) of workload exchanges between MDSs.
 305 :Type:  32-bit Integer
 306 :Default: ``10``
 307
 308
 309 ``mds bal fragment interval``
 310
 311 :Description: The delay (in seconds) between a fragment being elegible for split
 312               or merge and executing the fragmentation change.
 313 :Type:  32-bit Integer
 314 :Default: ``5``
 315
 316
 317 ``mds bal fragment fast factor``
 318
 319 :Description: The ratio by which frags may exceed the split size before
 320               a split is executed immediately (skipping the fragment interval)
 321 :Type:  Float
 322 :Default: ``1.5``
 323
 324 ``mds bal fragment size max``
 325
 326 :Description: The maximum size of a fragment before any new entries
 327               are rejected with ENOSPC.
 328 :Type:  32-bit Integer
 329 :Default: ``100000``
 330
 331 ``mds bal idle threshold``
 332
 333 :Description: The minimum temperature before Ceph migrates a subtree
 334               back to its parent.
 335
 336 :Type:  Float
 337 :Default: ``0``
 338
 339
 340 ``mds bal max``
 341
 342 :Description: The number of iterations to run balancer before Ceph stops.
 343               (used for testing purposes only)
 344
 345 :Type:  32-bit Integer
 346 :Default: ``-1``
 347
 348
 349 ``mds bal max until``
 350
 351 :Description: The number of seconds to run balancer before Ceph stops.
 352               (used for testing purposes only)
 353
 354 :Type:  32-bit Integer
 355 :Default: ``-1``
 356
 357
 358 ``mds bal mode``
 359
 360 :Description: The method for calculating MDS load.
 361
 362               - ``0`` = Hybrid.
 363               - ``1`` = Request rate and latency.
 364               - ``2`` = CPU load.
 365
 366 :Type:  32-bit Integer
 367 :Default: ``0``
 368
 369
 370 ``mds bal min rebalance``
 371
 372 :Description: The minimum subtree temperature before Ceph migrates.
 373 :Type:  Float
 374 :Default: ``0.1``
 375
 376
 377 ``mds bal min start``
 378
 379 :Description: The minimum subtree temperature before Ceph searches a subtree.
 380 :Type:  Float
 381 :Default: ``0.2``
 382
 383
 384 ``mds bal need min``
 385
 386 :Description: The minimum fraction of target subtree size to accept.
 387 :Type:  Float
 388 :Default: ``0.8``
 389
 390
 391 ``mds bal need max``
 392
 393 :Description: The maximum fraction of target subtree size to accept.
 394 :Type:  Float
 395 :Default: ``1.2``
 396
 397
 398 ``mds bal midchunk``
 399
 400 :Description: Ceph will migrate any subtree that is larger than this fraction
 401               of the target subtree size.
 402
 403 :Type:  Float
 404 :Default: ``0.3``
 405
 406
 407 ``mds bal minchunk``
 408
 409 :Description: Ceph will ignore any subtree that is smaller than this fraction
 410               of the target subtree size.
 411
 412 :Type:  Float
 413 :Default: ``0.001``
 414
 415
 416 ``mds bal target removal min``
 417
 418 :Description: The minimum number of balancer iterations before Ceph removes
 419               an old MDS target from the MDS map.
 420
 421 :Type:  32-bit Integer
 422 :Default: ``5``
 423
 424
 425 ``mds bal target removal max``
 426
 427 :Description: The maximum number of balancer iteration before Ceph removes
 428               an old MDS target from the MDS map.
 429
 430 :Type:  32-bit Integer
 431 :Default: ``10``
 432
 433
 434 ``mds replay interval``
 435
 436 :Description: The journal poll interval when in standby-replay mode.
 437               ("hot standby")
 438
 439 :Type:  Float
 440 :Default: ``1``
 441
 442
 443 ``mds shutdown check``
 444
 445 :Description: The interval for polling the cache during MDS shutdown.
 446 :Type:  32-bit Integer
 447 :Default: ``0``
 448
 449
 450 ``mds thrash exports``
 451
 452 :Description: Ceph will randomly export subtrees between nodes (testing only).
 453 :Type:  32-bit Integer
 454 :Default: ``0``
 455
 456
 457 ``mds thrash fragments``
 458
 459 :Description: Ceph will randomly fragment or merge directories.
 460 :Type:  32-bit Integer
 461 :Default: ``0``
 462
 463
 464 ``mds dump cache on map``
 465
 466 :Description: Ceph will dump the MDS cache contents to a file on each MDSMap.
 467 :Type:  Boolean
 468 :Default:  ``false``
 469
 470
 471 ``mds dump cache after rejoin``
 472
 473 :Description: Ceph will dump MDS cache contents to a file after
 474               rejoining the cache (during recovery).
 475
 476 :Type:  Boolean
 477 :Default:  ``false``
 478
 479
 480 ``mds verify scatter``
 481
 482 :Description: Ceph will assert that various scatter/gather invariants
 483               are ``true`` (developers only).
 484
 485 :Type:  Boolean
 486 :Default:  ``false``
 487
 488
 489 ``mds debug scatterstat``
 490
 491 :Description: Ceph will assert that various recursive stat invariants
 492               are ``true`` (for developers only).
 493
 494 :Type:  Boolean
 495 :Default:  ``false``
 496
 497
 498 ``mds debug frag``
 499
 500 :Description: Ceph will verify directory fragmentation invariants
 501               when convenient (developers only).
 502
 503 :Type:  Boolean
 504 :Default:  ``false``
 505
 506
 507 ``mds debug auth pins``
 508
 509 :Description: The debug auth pin invariants (for developers only).
 510 :Type:  Boolean
 511 :Default:  ``false``
 512
 513
 514 ``mds debug subtrees``
 515
 516 :Description: The debug subtree invariants (for developers only).
 517 :Type:  Boolean
 518 :Default:  ``false``
 519
 520
 521 ``mds kill mdstable at``
 522
 523 :Description: Ceph will inject MDS failure in MDSTable code
 524               (for developers only).
 525
 526 :Type:  32-bit Integer
 527 :Default: ``0``
 528
 529
 530 ``mds kill export at``
 531
 532 :Description: Ceph will inject MDS failure in the subtree export code
 533               (for developers only).
 534
 535 :Type:  32-bit Integer
 536 :Default: ``0``
 537
 538
 539 ``mds kill import at``
 540
 541 :Description: Ceph will inject MDS failure in the subtree import code
 542               (for developers only).
 543
 544 :Type:  32-bit Integer
 545 :Default: ``0``
 546
 547
 548 ``mds kill link at``
 549
 550 :Description: Ceph will inject MDS failure in hard link code
 551               (for developers only).
 552
 553 :Type:  32-bit Integer
 554 :Default: ``0``
 555
 556
 557 ``mds kill rename at``
 558
 559 :Description: Ceph will inject MDS failure in the rename code
 560               (for developers only).
 561
 562 :Type:  32-bit Integer
 563 :Default: ``0``
 564
 565
 566 ``mds wipe sessions``
 567
 568 :Description: Ceph will delete all client sessions on startup
 569               (for testing only).
 570
 571 :Type:  Boolean
 572 :Default: ``0``
 573
 574
 575 ``mds wipe ino prealloc``
 576
 577 :Description: Ceph will delete ino preallocation metadata on startup
 578               (for testing only).
 579
 580 :Type:  Boolean
 581 :Default: ``0``
 582
 583
 584 ``mds skip ino``
 585
 586 :Description: The number of inode numbers to skip on startup
 587               (for testing only).
 588
 589 :Type:  32-bit Integer
 590 :Default: ``0``
 591
 592
 593 ``mds standby for name``
 594
 595 :Description: An MDS daemon will standby for another MDS daemon of the name
 596               specified in this setting.
 597
 598 :Type:  String
 599 :Default: N/A
 600
 601
 602 ``mds standby for rank``
 603
 604 :Description: An MDS daemon will standby for an MDS daemon of this rank.
 605 :Type:  32-bit Integer
 606 :Default: ``-1``
 607
 608
 609 ``mds standby replay``
 610
 611 :Description: Determines whether a ``ceph-mds`` daemon should poll and replay
 612               the log of an active MDS (hot standby).
 613
 614 :Type:  Boolean
 615 :Default:  ``false``
 616
 617
 618 ``mds min caps per client``
 619
 620 :Description: Set the minimum number of capabilities a client may hold.
 621 :Type: Integer
 622 :Default: ``100``
 623
 624
 625 ``mds max ratio caps per client``
 626
 627 :Description: Set the maximum ratio of current caps that may be recalled during MDS cache pressure.
 628 :Type: Float
 629 :Default: ``0.8``