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