ceph/src/common/options.cc

   1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
   2 // vim: ts=8 sw=2 smarttab
   3
   4 #include "acconfig.h"
   5 #include "options.h"
   6 #include "common/Formatter.h"
   7
   8 // Helpers for validators
   9 #include "include/stringify.h"
  10 #include <boost/algorithm/string.hpp>
  11 #include <boost/lexical_cast.hpp>
  12 #include <boost/regex.hpp>
  13
  14 // Definitions for enums
  15 #include "common/perf_counters.h"
  16
  17
  18 void Option::dump_value(const char *field_name,
  19     const Option::value_t &v, Formatter *f) const
  20 {
  21   if (boost::get<boost::blank>(&v)) {
  22     // This should be nil but Formatter doesn't allow it.
  23     f->dump_string(field_name, "");
  24   } else if (type == TYPE_UINT) {
  25     f->dump_unsigned(field_name, boost::get<uint64_t>(v));
  26   } else if (type == TYPE_INT) {
  27     f->dump_int(field_name, boost::get<int64_t>(v));
  28   } else if (type == TYPE_STR) {
  29     f->dump_string(field_name, boost::get<std::string>(v));
  30   } else if (type == TYPE_FLOAT) {
  31     f->dump_float(field_name, boost::get<double>(v));
  32   } else if (type == TYPE_BOOL) {
  33     f->dump_bool(field_name, boost::get<bool>(v));
  34   } else {
  35     f->dump_stream(field_name) << v;
  36   }
  37 }
  38
  39 int Option::pre_validate(std::string *new_value, std::string *err) const
  40 {
  41   if (validator) {
  42     return validator(new_value, err);
  43   } else {
  44     return 0;
  45   }
  46 }
  47
  48 int Option::validate(const Option::value_t &new_value, std::string *err) const
  49 {
  50   // Generic validation: min
  51   if (!boost::get<boost::blank>(&(min))) {
  52     if (new_value < min) {
  53       std::ostringstream oss;
  54       oss << "Value '" << new_value << "' is below minimum " << min;
  55       *err = oss.str();
  56       return -EINVAL;
  57     }
  58   }
  59
  60   // Generic validation: max
  61   if (!boost::get<boost::blank>(&(max))) {
  62     if (new_value > max) {
  63       std::ostringstream oss;
  64       oss << "Value '" << new_value << "' exceeds maximum " << max;
  65       *err = oss.str();
  66       return -EINVAL;
  67     }
  68   }
  69
  70   // Generic validation: enum
  71   if (!enum_allowed.empty() && type == Option::TYPE_STR) {
  72     auto found = std::find(enum_allowed.begin(), enum_allowed.end(),
  73                            boost::get<std::string>(new_value));
  74     if (found == enum_allowed.end()) {
  75       std::ostringstream oss;
  76       oss << "'" << new_value << "' is not one of the permitted "
  77                  "values: " << joinify(enum_allowed.begin(),
  78                                        enum_allowed.end(),
  79                                        std::string(", "));
  80       *err = oss.str();
  81       return -EINVAL;
  82     }
  83   }
  84
  85   return 0;
  86 }
  87
  88 void Option::dump(Formatter *f) const
  89 {
  90   f->open_object_section("option");
  91   f->dump_string("name", name);
  92
  93   f->dump_string("type", type_to_str(type));
  94
  95   f->dump_string("level", level_to_str(level));
  96
  97   f->dump_string("desc", desc);
  98   f->dump_string("long_desc", long_desc);
  99
 100   dump_value("default", value, f);
 101   dump_value("daemon_default", daemon_value, f);
 102
 103   f->open_array_section("tags");
 104   for (const auto t : tags) {
 105     f->dump_string("tag", t);
 106   }
 107   f->close_section();
 108
 109   f->open_array_section("services");
 110   for (const auto s : services) {
 111     f->dump_string("service", s);
 112   }
 113   f->close_section();
 114
 115   f->open_array_section("see_also");
 116   for (const auto sa : see_also) {
 117     f->dump_string("see_also", sa);
 118   }
 119   f->close_section();
 120
 121   if (type == TYPE_STR) {
 122     f->open_array_section("enum_values");
 123     for (const auto &ea : enum_allowed) {
 124       f->dump_string("enum_value", ea);
 125     }
 126     f->close_section();
 127   }
 128
 129   dump_value("min", min, f);
 130   dump_value("max", max, f);
 131
 132   f->close_section();
 133 }
 134
 135 constexpr unsigned long long operator"" _min (unsigned long long min) {
 136   return min * 60;
 137 }
 138 constexpr unsigned long long operator"" _hr (unsigned long long hr) {
 139   return hr * 60 * 60;
 140 }
 141 constexpr unsigned long long operator"" _day (unsigned long long day) {
 142   return day * 60 * 60 * 24;
 143 }
 144 constexpr unsigned long long operator"" _K (unsigned long long n) {
 145   return n << 10;
 146 }
 147 constexpr unsigned long long operator"" _M (unsigned long long n) {
 148   return n << 20;
 149 }
 150 constexpr unsigned long long operator"" _G (unsigned long long n) {
 151   return n << 30;
 152 }
 153
 154 std::vector<Option> get_global_options() {
 155   return std::vector<Option>({
 156     Option("host", Option::TYPE_STR, Option::LEVEL_BASIC)
 157     .set_description("local hostname")
 158     .set_long_description("if blank, ceph assumes the short hostname (hostname -s)")
 159     .add_service("common")
 160     .add_tag("network"),
 161
 162     Option("fsid", Option::TYPE_UUID, Option::LEVEL_BASIC)
 163     .set_description("cluster fsid (uuid)")
 164     .add_service("common")
 165     .add_tag("service"),
 166
 167     Option("public_addr", Option::TYPE_ADDR, Option::LEVEL_BASIC)
 168     .set_description("public-facing address to bind to")
 169     .add_service({"mon", "mds", "osd", "mgr"}),
 170
 171     Option("public_bind_addr", Option::TYPE_ADDR, Option::LEVEL_ADVANCED)
 172     .set_default(entity_addr_t())
 173     .add_service("mon")
 174     .set_description(""),
 175
 176     Option("cluster_addr", Option::TYPE_ADDR, Option::LEVEL_BASIC)
 177     .set_description("cluster-facing address to bind to")
 178     .add_service("osd")
 179     .add_tag("network"),
 180
 181     Option("public_network", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 182     .add_service({"mon", "mds", "osd", "mgr"})
 183     .add_tag("network")
 184     .set_description("Network(s) from which to choose a public address to bind to"),
 185
 186     Option("public_network_interface", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 187     .add_service({"mon", "mds", "osd", "mgr"})
 188     .add_tag("network")
 189     .set_description("Interface name(s) from which to choose an address from a public_network to bind to; public_network must also be specified.")
 190     .add_see_also("public_network"),
 191
 192     Option("cluster_network", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 193     .add_service("osd")
 194     .add_tag("network")
 195     .set_description("Network(s) from which to choose a cluster address to bind to"),
 196
 197     Option("cluster_network_interface", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 198     .add_service({"mon", "mds", "osd", "mgr"})
 199     .add_tag("network")
 200     .set_description("Interface name(s) from which to choose an address from a cluster_network to bind to; cluster_network must also be specified.")
 201     .add_see_also("cluster_network"),
 202
 203     Option("monmap", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 204     .set_description("path to MonMap file")
 205     .set_long_description("This option is normally used during mkfs, but can also "
 206                         "be used to identify which monitors to connect to.")
 207     .add_service("mon")
 208     .add_tag("mkfs"),
 209
 210     Option("mon_host", Option::TYPE_STR, Option::LEVEL_BASIC)
 211     .set_description("list of hosts or addresses to search for a monitor")
 212     .set_long_description("This is a comma, whitespace, or semicolon separated "
 213                         "list of IP addresses or hostnames. Hostnames are "
 214                         "resolved via DNS and all A or AAAA records are "
 215                         "included in the search list.")
 216     .add_service("common"),
 217
 218     Option("mon_dns_srv_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 219     .set_default("ceph-mon")
 220     .set_description("name of DNS SRV record to check for monitor addresses")
 221     .add_service("common")
 222     .add_tag("network")
 223     .add_see_also("mon_host"),
 224
 225     // lockdep
 226     Option("lockdep", Option::TYPE_BOOL, Option::LEVEL_DEV)
 227     .set_description("enable lockdep lock dependency analyzer")
 228     .add_service("common"),
 229
 230     Option("lockdep_force_backtrace", Option::TYPE_BOOL, Option::LEVEL_DEV)
 231     .set_description("always gather current backtrace at every lock")
 232     .add_service("common")
 233     .add_see_also("lockdep"),
 234
 235     Option("run_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 236     .set_default("/var/run/ceph")
 237     .set_description("path for the 'run' directory for storing pid and socket files")
 238     .add_service("common")
 239     .add_see_also("admin_socket"),
 240
 241     Option("admin_socket", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 242     .set_default("")
 243     .set_daemon_default("$run_dir/$cluster-$name.asok")
 244     .set_description("path for the runtime control socket file, used by the 'ceph daemon' command")
 245     .add_service("common"),
 246
 247     Option("admin_socket_mode", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 248     .set_description("file mode to set for the admin socket file, e.g, '0755'")
 249     .add_service("common")
 250     .add_see_also("admin_socket"),
 251
 252     Option("crushtool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 253     .set_description("name of the 'crushtool' utility")
 254     .add_service("mon"),
 255
 256     // daemon
 257     Option("daemonize", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 258     .set_default(false)
 259     .set_daemon_default(true)
 260     .set_description("whether to daemonize (background) after startup")
 261     .add_service({"mon", "mgr", "osd", "mds"})
 262     .add_tag("service")
 263     .add_see_also({"pid_file", "chdir"}),
 264
 265     Option("setuser", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 266     .set_description("uid or user name to switch to on startup")
 267     .set_long_description("This is normally specified by the systemd unit file.")
 268     .add_service({"mon", "mgr", "osd", "mds"})
 269     .add_tag("service")
 270     .add_see_also("setgroup"),
 271
 272     Option("setgroup", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 273     .set_description("gid or group name to switch to on startup")
 274     .set_long_description("This is normally specified by the systemd unit file.")
 275     .add_service({"mon", "mgr", "osd", "mds"})
 276     .add_tag("service")
 277     .add_see_also("setuser"),
 278
 279     Option("setuser_match_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 280     .set_description("if set, setuser/setgroup is condition on this path matching ownership")
 281     .set_long_description("If setuser or setgroup are specified, and this option is non-empty, then the uid/gid of the daemon will only be changed if the file or directory specified by this option has a matching uid and/or gid.  This exists primarily to allow switching to user ceph for OSDs to be conditional on whether the osd data contents have also been chowned after an upgrade.  This is normally specified by the systemd unit file.")
 282     .add_service({"mon", "mgr", "osd", "mds"})
 283     .add_tag("service")
 284     .add_see_also({"setuser", "setgroup"}),
 285
 286     Option("pid_file", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 287     .set_description("path to write a pid file (if any)")
 288     .add_service({"mon", "mgr", "osd", "mds"})
 289     .add_tag("service"),
 290
 291     Option("chdir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 292     .set_description("path to chdir(2) to after daemonizing")
 293     .add_service({"mon", "mgr", "osd", "mds"})
 294     .add_tag("service")
 295     .add_see_also("daemonize"),
 296
 297     Option("fatal_signal_handlers", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 298     .set_default(true)
 299     .set_description("whether to register signal handlers for SIGABRT etc that dump a stack trace")
 300     .set_long_description("This is normally true for daemons and values for libraries.")
 301     .add_service({"mon", "mgr", "osd", "mds"})
 302     .add_tag("service"),
 303
 304     // restapi
 305     Option("restapi_log_level", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 306     .set_description("default set by python code"),
 307
 308     Option("restapi_base_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 309     .set_description("default set by python code"),
 310
 311     Option("erasure_code_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 312     .set_default(CEPH_PKGLIBDIR"/erasure-code")
 313     .set_description("directory where erasure-code plugins can be found")
 314     .add_service({"mon", "osd"})
 315     .set_safe(),
 316
 317     // logging
 318     Option("log_file", Option::TYPE_STR, Option::LEVEL_BASIC)
 319     .set_default("")
 320     .set_daemon_default("/var/log/ceph/$cluster-$name.log")
 321     .set_description("path to log file")
 322     .add_see_also({"log_to_stderr",
 323                    "err_to_stderr",
 324                    "log_to_syslog",
 325                    "err_to_syslog"}),
 326
 327     Option("log_max_new", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 328     .set_default(1000)
 329     .set_description("max unwritten log entries to allow before waiting to flush to the log")
 330     .add_see_also("log_max_recent"),
 331
 332     Option("log_max_recent", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 333     .set_default(500)
 334     .set_daemon_default(10000)
 335     .set_description("recent log entries to keep in memory to dump in the event of a crash")
 336     .set_long_description("The purpose of this option is to log at a higher debug level only to the in-memory buffer, and write out the detailed log messages only if there is a crash.  Only log entries below the lower log level will be written unconditionally to the log.  For example, debug_osd=1/5 will write everything <= 1 to the log unconditionally but keep entries at levels 2-5 in memory.  If there is a seg fault or assertion failure, all entries will be dumped to the log."),
 337
 338     Option("log_to_stderr", Option::TYPE_BOOL, Option::LEVEL_BASIC)
 339     .set_default(true)
 340     .set_daemon_default(false)
 341     .set_description("send log lines to stderr"),
 342
 343     Option("err_to_stderr", Option::TYPE_BOOL, Option::LEVEL_BASIC)
 344     .set_default(false)
 345     .set_daemon_default(true)
 346     .set_description("send critical error log lines to stderr"),
 347
 348     Option("log_stderr_prefix", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 349     .set_description("String to prefix log messages with when sent to stderr"),
 350
 351     Option("log_to_syslog", Option::TYPE_BOOL, Option::LEVEL_BASIC)
 352     .set_default(false)
 353     .set_description("send log lines to syslog facility"),
 354
 355     Option("err_to_syslog", Option::TYPE_BOOL, Option::LEVEL_BASIC)
 356     .set_default(false)
 357     .set_description("send critical error log lines to syslog facility"),
 358
 359     Option("log_flush_on_exit", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 360     .set_default(false)
 361     .set_description("set a process exit handler to ensure the log is flushed on exit"),
 362
 363     Option("log_stop_at_utilization", Option::TYPE_FLOAT, Option::LEVEL_BASIC)
 364     .set_default(.97)
 365     .set_min_max(0.0, 1.0)
 366     .set_description("stop writing to the log file when device utilization reaches this ratio")
 367     .add_see_also("log_file"),
 368
 369     Option("log_to_graylog", Option::TYPE_BOOL, Option::LEVEL_BASIC)
 370     .set_default(false)
 371     .set_description("send log lines to remote graylog server")
 372     .add_see_also({"err_to_graylog",
 373                    "log_graylog_host",
 374                    "log_graylog_port"}),
 375
 376     Option("err_to_graylog", Option::TYPE_BOOL, Option::LEVEL_BASIC)
 377     .set_default(false)
 378     .set_description("send critical error log lines to remote graylog server")
 379     .add_see_also({"log_to_graylog",
 380                    "log_graylog_host",
 381                    "log_graylog_port"}),
 382
 383     Option("log_graylog_host", Option::TYPE_STR, Option::LEVEL_BASIC)
 384     .set_default("127.0.0.1")
 385     .set_description("address or hostname of graylog server to log to")
 386     .add_see_also({"log_to_graylog",
 387                    "err_to_graylog",
 388                    "log_graylog_port"}),
 389
 390     Option("log_graylog_port", Option::TYPE_INT, Option::LEVEL_BASIC)
 391     .set_default(12201)
 392     .set_description("port number for the remote graylog server")
 393     .add_see_also("log_graylog_host"),
 394
 395
 396
 397     // unmodified
 398     Option("clog_to_monitors", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 399     .set_default("default=true")
 400     .set_description(""),
 401
 402     Option("clog_to_syslog", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 403     .set_default("false")
 404     .set_description(""),
 405
 406     Option("clog_to_syslog_level", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 407     .set_default("info")
 408     .set_description(""),
 409
 410     Option("clog_to_syslog_facility", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 411     .set_default("default=daemon audit=local0")
 412     .set_description(""),
 413
 414     Option("clog_to_graylog", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 415     .set_default("false")
 416     .set_description(""),
 417
 418     Option("clog_to_graylog_host", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 419     .set_default("127.0.0.1")
 420     .set_description(""),
 421
 422     Option("clog_to_graylog_port", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 423     .set_default("12201")
 424     .set_description(""),
 425
 426     Option("mon_cluster_log_to_stderr", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 427     .set_default(false)
 428     .set_description("Send cluster log messages to stderr (prefixed by channel)"),
 429
 430     Option("mon_cluster_log_to_syslog", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 431     .set_default("default=false")
 432     .set_description(""),
 433
 434     Option("mon_cluster_log_to_syslog_level", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 435     .set_default("info")
 436     .set_description(""),
 437
 438     Option("mon_cluster_log_to_syslog_facility", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 439     .set_default("daemon")
 440     .set_description(""),
 441
 442     Option("mon_cluster_log_file", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 443     .set_default("default=/var/log/ceph/$cluster.$channel.log cluster=/var/log/ceph/$cluster.log")
 444     .set_description(""),
 445
 446     Option("mon_cluster_log_file_level", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 447     .set_default("info")
 448     .set_description(""),
 449
 450     Option("mon_cluster_log_to_graylog", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 451     .set_default("false")
 452     .set_description(""),
 453
 454     Option("mon_cluster_log_to_graylog_host", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 455     .set_default("127.0.0.1")
 456     .set_description(""),
 457
 458     Option("mon_cluster_log_to_graylog_port", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 459     .set_default("12201")
 460     .set_description(""),
 461
 462     Option("enable_experimental_unrecoverable_data_corrupting_features", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 463     .set_default("")
 464     .set_description(""),
 465
 466     Option("plugin_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 467     .set_default(CEPH_PKGLIBDIR)
 468     .set_description("")
 469     .set_safe(),
 470
 471     Option("xio_trace_mempool", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 472     .set_default(false)
 473     .set_description(""),
 474
 475     Option("xio_trace_msgcnt", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 476     .set_default(false)
 477     .set_description(""),
 478
 479     Option("xio_trace_xcon", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 480     .set_default(false)
 481     .set_description(""),
 482
 483     Option("xio_queue_depth", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 484     .set_default(128)
 485     .set_description(""),
 486
 487     Option("xio_mp_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 488     .set_default(128)
 489     .set_description(""),
 490
 491     Option("xio_mp_max_64", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 492     .set_default(65536)
 493     .set_description(""),
 494
 495     Option("xio_mp_max_256", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 496     .set_default(8192)
 497     .set_description(""),
 498
 499     Option("xio_mp_max_1k", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 500     .set_default(8192)
 501     .set_description(""),
 502
 503     Option("xio_mp_max_page", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 504     .set_default(4096)
 505     .set_description(""),
 506
 507     Option("xio_mp_max_hint", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 508     .set_default(4096)
 509     .set_description(""),
 510
 511     Option("xio_portal_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 512     .set_default(2)
 513     .set_description(""),
 514
 515     Option("xio_max_conns_per_portal", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 516     .set_default(32)
 517     .set_description(""),
 518
 519     Option("xio_transport_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 520     .set_default("rdma")
 521     .set_description(""),
 522
 523     Option("xio_max_send_inline", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 524     .set_default(512)
 525     .set_description(""),
 526
 527     Option("compressor_zlib_isal", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 528     .set_default(false)
 529     .set_description(""),
 530
 531     Option("compressor_zlib_level", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 532     .set_default(5)
 533     .set_description(""),
 534
 535     Option("async_compressor_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 536     .set_default(false)
 537     .set_description(""),
 538
 539     Option("async_compressor_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 540     .set_default("snappy")
 541     .set_description(""),
 542
 543     Option("async_compressor_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 544     .set_default(2)
 545     .set_description(""),
 546
 547     Option("async_compressor_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 548     .set_default(5)
 549     .set_description(""),
 550
 551     Option("async_compressor_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 552     .set_default(30)
 553     .set_description(""),
 554
 555     Option("plugin_crypto_accelerator", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 556     .set_default("crypto_isal")
 557     .set_description(""),
 558
 559     Option("mempool_debug", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 560     .set_default(false)
 561     .set_description(""),
 562
 563     Option("key", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 564     .set_default("")
 565     .set_description("Authentication key")
 566     .set_long_description("A CephX authentication key, base64 encoded.  It normally looks something like 'AQAtut9ZdMbNJBAAHz6yBAWyJyz2yYRyeMWDag=='.")
 567     .add_see_also("keyfile")
 568     .add_see_also("keyring"),
 569
 570     Option("keyfile", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 571     .set_default("")
 572     .set_description("Path to a file containing a key")
 573     .set_long_description("The file should contain a CephX authentication key and optionally a trailing newline, but nothing else.")
 574     .add_see_also("key"),
 575
 576     Option("keyring", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 577     .set_default(
 578       "/etc/ceph/$cluster.$name.keyring,/etc/ceph/$cluster.keyring,"
 579       "/etc/ceph/keyring,/etc/ceph/keyring.bin,"
 580   #if defined(__FreeBSD)
 581       "/usr/local/etc/ceph/$cluster.$name.keyring,"
 582       "/usr/local/etc/ceph/$cluster.keyring,"
 583       "/usr/local/etc/ceph/keyring,/usr/local/etc/ceph/keyring.bin,"
 584   #endif
 585     )
 586     .set_description("Path to a keyring file.")
 587     .set_long_description("A keyring file is an INI-style formatted file where the section names are client or daemon names (e.g., 'osd.0') and each section contains a 'key' property with CephX authentication key as the value.")
 588     .add_see_also("key")
 589     .add_see_also("keyfile"),
 590
 591     Option("heartbeat_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 592     .set_default(5)
 593     .set_description(""),
 594
 595     Option("heartbeat_file", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 596     .set_default("")
 597     .set_description(""),
 598
 599     Option("heartbeat_inject_failure", Option::TYPE_INT, Option::LEVEL_DEV)
 600     .set_default(0)
 601     .set_description(""),
 602
 603     Option("perf", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 604     .set_default(true)
 605     .set_description(""),
 606
 607     Option("ms_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 608     .set_default("async+posix")
 609     .set_description("")
 610     .set_safe(),
 611
 612     Option("ms_public_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 613     .set_default("")
 614     .set_description(""),
 615
 616     Option("ms_cluster_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 617     .set_default("")
 618     .set_description(""),
 619
 620     Option("ms_tcp_nodelay", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 621     .set_default(true)
 622     .set_description(""),
 623
 624     Option("ms_tcp_rcvbuf", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 625     .set_default(0)
 626     .set_description(""),
 627
 628     Option("ms_tcp_prefetch_max_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 629     .set_default(4_K)
 630     .set_description(""),
 631
 632     Option("ms_initial_backoff", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
 633     .set_default(.2)
 634     .set_description(""),
 635
 636     Option("ms_max_backoff", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
 637     .set_default(15.0)
 638     .set_description(""),
 639
 640     Option("ms_crc_data", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 641     .set_default(true)
 642     .set_description(""),
 643
 644     Option("ms_crc_header", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 645     .set_default(true)
 646     .set_description(""),
 647
 648     Option("ms_die_on_bad_msg", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 649     .set_default(false)
 650     .set_description(""),
 651
 652     Option("ms_die_on_unhandled_msg", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 653     .set_default(false)
 654     .set_description(""),
 655
 656     Option("ms_die_on_old_message", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 657     .set_default(false)
 658     .set_description(""),
 659
 660     Option("ms_die_on_skipped_message", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 661     .set_default(false)
 662     .set_description(""),
 663
 664     Option("ms_dispatch_throttle_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 665     .set_default(100 << 20)
 666     .set_description(""),
 667
 668     Option("ms_bind_ipv6", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 669     .set_default(false)
 670     .set_description(""),
 671
 672     Option("ms_bind_port_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 673     .set_default(6800)
 674     .set_description(""),
 675
 676     Option("ms_bind_port_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 677     .set_default(7300)
 678     .set_description(""),
 679
 680     Option("ms_bind_retry_count", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 681   #if !defined(__FreeBSD__)
 682     .set_default(3)
 683   #else
 684     // FreeBSD does not use SO_REAUSEADDR so allow for a bit more time per default
 685     .set_default(6)
 686   #endif
 687     .set_description(""),
 688
 689     Option("ms_bind_retry_delay", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 690   #if !defined(__FreeBSD__)
 691     .set_default(5)
 692   #else
 693     // FreeBSD does not use SO_REAUSEADDR so allow for a bit more time per default
 694     .set_default(6)
 695   #endif
 696     .set_description(""),
 697
 698     Option("ms_bind_before_connect", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 699     .set_default(false)
 700     .set_description(""),
 701
 702     Option("ms_tcp_listen_backlog", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 703     .set_default(512)
 704     .set_description(""),
 705
 706     Option("ms_rwthread_stack_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 707     .set_default(1_M)
 708     .set_description(""),
 709
 710     Option("ms_tcp_read_timeout", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 711     .set_default(900)
 712     .set_description(""),
 713
 714     Option("ms_pq_max_tokens_per_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 715     .set_default(16777216)
 716     .set_description(""),
 717
 718     Option("ms_pq_min_cost", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 719     .set_default(65536)
 720     .set_description(""),
 721
 722     Option("ms_inject_socket_failures", Option::TYPE_UINT, Option::LEVEL_DEV)
 723     .set_default(0)
 724     .set_description(""),
 725
 726     Option("ms_inject_delay_type", Option::TYPE_STR, Option::LEVEL_DEV)
 727     .set_default("")
 728     .set_description("")
 729     .set_safe(),
 730
 731     Option("ms_inject_delay_msg_type", Option::TYPE_STR, Option::LEVEL_DEV)
 732     .set_default("")
 733     .set_description(""),
 734
 735     Option("ms_inject_delay_max", Option::TYPE_FLOAT, Option::LEVEL_DEV)
 736     .set_default(1)
 737     .set_description(""),
 738
 739     Option("ms_inject_delay_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
 740     .set_default(0)
 741     .set_description(""),
 742
 743     Option("ms_inject_internal_delays", Option::TYPE_FLOAT, Option::LEVEL_DEV)
 744     .set_default(0)
 745     .set_description(""),
 746
 747     Option("ms_dump_on_send", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 748     .set_default(false)
 749     .set_description(""),
 750
 751     Option("ms_dump_corrupt_message_level", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 752     .set_default(1)
 753     .set_description(""),
 754
 755     Option("ms_async_op_threads", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 756     .set_default(3)
 757     .set_description(""),
 758
 759     Option("ms_async_max_op_threads", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 760     .set_default(5)
 761     .set_description(""),
 762
 763     Option("ms_async_set_affinity", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 764     .set_default(true)
 765     .set_description(""),
 766
 767     Option("ms_async_affinity_cores", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 768     .set_default("")
 769     .set_description(""),
 770
 771     Option("ms_async_rdma_device_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 772     .set_default("")
 773     .set_description(""),
 774
 775     Option("ms_async_rdma_enable_hugepage", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 776     .set_default(false)
 777     .set_description(""),
 778
 779     Option("ms_async_rdma_buffer_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 780     .set_default(128_K)
 781     .set_description(""),
 782
 783     Option("ms_async_rdma_send_buffers", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 784     .set_default(1_K)
 785     .set_description(""),
 786
 787     Option("ms_async_rdma_receive_buffers", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 788     .set_default(1024)
 789     .set_description(""),
 790
 791     Option("ms_async_rdma_port_num", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 792     .set_default(1)
 793     .set_description(""),
 794
 795     Option("ms_async_rdma_polling_us", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
 796     .set_default(1000)
 797     .set_description(""),
 798
 799     Option("ms_async_rdma_local_gid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 800     .set_default("")
 801     .set_description(""),
 802
 803     Option("ms_async_rdma_roce_ver", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 804     .set_default(1)
 805     .set_description(""),
 806
 807     Option("ms_async_rdma_sl", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 808     .set_default(3)
 809     .set_description(""),
 810
 811     Option("ms_async_rdma_dscp", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 812     .set_default(96)
 813     .set_description(""),
 814
 815     Option("ms_dpdk_port_id", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 816     .set_default(0)
 817     .set_description(""),
 818
 819     Option("ms_dpdk_coremask", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 820     .set_default("1")
 821     .set_description("")
 822     .set_safe(),
 823
 824     Option("ms_dpdk_memory_channel", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 825     .set_default("4")
 826     .set_description(""),
 827
 828     Option("ms_dpdk_hugepages", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 829     .set_default("")
 830     .set_description(""),
 831
 832     Option("ms_dpdk_pmd", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 833     .set_default("")
 834     .set_description(""),
 835
 836     Option("ms_dpdk_host_ipv4_addr", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 837     .set_default("")
 838     .set_description("")
 839     .set_safe(),
 840
 841     Option("ms_dpdk_gateway_ipv4_addr", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 842     .set_default("")
 843     .set_description("")
 844     .set_safe(),
 845
 846     Option("ms_dpdk_netmask_ipv4_addr", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 847     .set_default("")
 848     .set_description("")
 849     .set_safe(),
 850
 851     Option("ms_dpdk_lro", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 852     .set_default(true)
 853     .set_description(""),
 854
 855     Option("ms_dpdk_hw_flow_control", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 856     .set_default(true)
 857     .set_description(""),
 858
 859     Option("ms_dpdk_hw_queue_weight", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
 860     .set_default(1)
 861     .set_description(""),
 862
 863     Option("ms_dpdk_debug_allow_loopback", Option::TYPE_BOOL, Option::LEVEL_DEV)
 864     .set_default(false)
 865     .set_description(""),
 866
 867     Option("ms_dpdk_rx_buffer_count_per_core", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 868     .set_default(8192)
 869     .set_description(""),
 870
 871     Option("inject_early_sigterm", Option::TYPE_BOOL, Option::LEVEL_DEV)
 872     .set_default(false)
 873     .set_description(""),
 874
 875     Option("mon_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 876     .set_default("/var/lib/ceph/mon/$cluster-$id")
 877     .set_description(""),
 878
 879     Option("mon_initial_members", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 880     .set_default("")
 881     .set_description(""),
 882
 883     Option("mon_compact_on_start", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 884     .set_default(false)
 885     .set_description(""),
 886
 887     Option("mon_compact_on_bootstrap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 888     .set_default(false)
 889     .set_description(""),
 890
 891     Option("mon_compact_on_trim", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 892     .set_default(true)
 893     .set_description(""),
 894
 895     Option("mon_osd_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 896     .set_default(10)
 897     .set_description(""),
 898
 899     Option("mon_cpu_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 900     .set_default(4)
 901     .set_description(""),
 902
 903     Option("mon_osd_mapping_pgs_per_chunk", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 904     .set_default(4096)
 905     .set_description(""),
 906
 907     Option("mon_osd_max_creating_pgs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 908     .set_default(1024)
 909     .set_description(""),
 910
 911     Option("mon_tick_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 912     .set_default(5)
 913     .set_description(""),
 914
 915     Option("mon_session_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 916     .set_default(300)
 917     .set_description(""),
 918
 919     Option("mon_subscribe_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
 920     .set_default(1_day)
 921     .set_description(""),
 922
 923     Option("mon_delta_reset_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
 924     .set_default(10)
 925     .set_description(""),
 926
 927     Option("mon_osd_laggy_halflife", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 928     .set_default(1_hr)
 929     .set_description(""),
 930
 931     Option("mon_osd_laggy_weight", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
 932     .set_default(.3)
 933     .set_description(""),
 934
 935     Option("mon_osd_laggy_max_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 936     .set_default(300)
 937     .set_description(""),
 938
 939     Option("mon_osd_adjust_heartbeat_grace", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 940     .set_default(true)
 941     .set_description(""),
 942
 943     Option("mon_osd_adjust_down_out_interval", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 944     .set_default(true)
 945     .set_description(""),
 946
 947     Option("mon_osd_auto_mark_in", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 948     .set_default(false)
 949     .set_description(""),
 950
 951     Option("mon_osd_auto_mark_auto_out_in", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 952     .set_default(true)
 953     .set_description(""),
 954
 955     Option("mon_osd_auto_mark_new_in", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 956     .set_default(true)
 957     .set_description(""),
 958
 959     Option("mon_osd_destroyed_out_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 960     .set_default(600)
 961     .set_description(""),
 962
 963     Option("mon_osd_down_out_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 964     .set_default(600)
 965     .set_description(""),
 966
 967     Option("mon_osd_down_out_subtree_limit", Option::TYPE_STR, Option::LEVEL_ADVANCED)
 968     .set_default("rack")
 969     .set_description(""),
 970
 971     Option("mon_osd_min_up_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
 972     .set_default(.3)
 973     .set_description(""),
 974
 975     Option("mon_osd_min_in_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
 976     .set_default(.75)
 977     .set_description(""),
 978
 979     Option("mon_osd_warn_op_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
 980     .set_default(32)
 981     .set_description(""),
 982
 983     Option("mon_osd_err_op_age_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
 984     .set_default(128)
 985     .set_description(""),
 986
 987     Option("mon_osd_max_split_count", Option::TYPE_INT, Option::LEVEL_ADVANCED)
 988     .set_default(32)
 989     .set_description(""),
 990
 991     Option("mon_osd_allow_primary_temp", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 992     .set_default(false)
 993     .set_description(""),
 994
 995     Option("mon_osd_allow_primary_affinity", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
 996     .set_default(false)
 997     .set_description(""),
 998
 999     Option("mon_osd_prime_pg_temp", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1000     .set_default(true)
1001     .set_description(""),
1002
1003     Option("mon_osd_prime_pg_temp_max_time", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1004     .set_default(.5)
1005     .set_description(""),
1006
1007     Option("mon_osd_prime_pg_temp_max_estimate", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1008     .set_default(.25)
1009     .set_description(""),
1010
1011     Option("mon_osd_pool_ec_fast_read", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1012     .set_default(false)
1013     .set_description(""),
1014
1015     Option("mon_stat_smooth_intervals", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1016     .set_default(6)
1017     .set_min(1)
1018     .add_service("mgr")
1019     .set_description("number of PGMaps stats over which we calc the average read/write throughput of the whole cluster"),
1020
1021     Option("mon_election_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1022     .set_default(5)
1023     .set_description(""),
1024
1025     Option("mon_lease", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1026     .set_default(5)
1027     .set_description(""),
1028
1029     Option("mon_lease_renew_interval_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1030     .set_default(.6)
1031     .set_description(""),
1032
1033     Option("mon_lease_ack_timeout_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1034     .set_default(2.0)
1035     .set_description(""),
1036
1037     Option("mon_accept_timeout_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1038     .set_default(2.0)
1039     .set_description(""),
1040
1041     Option("mon_clock_drift_allowed", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1042     .set_default(.050)
1043     .set_description(""),
1044
1045     Option("mon_clock_drift_warn_backoff", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1046     .set_default(5)
1047     .set_description(""),
1048
1049     Option("mon_timecheck_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1050     .set_default(300.0)
1051     .set_description(""),
1052
1053     Option("mon_timecheck_skew_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1054     .set_default(30.0)
1055     .set_description(""),
1056
1057     Option("mon_pg_stuck_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1058     .set_default(60)
1059     .set_description("number of seconds after which pgs can be considered stuck inactive, unclean, etc")
1060     .set_long_description("see doc/control.rst under dump_stuck for more info")
1061     .add_service("mgr"),
1062
1063     Option("mon_pg_min_inactive", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1064     .set_default(1)
1065     .set_description(""),
1066
1067     Option("mon_pg_warn_min_per_osd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1068     .set_default(30)
1069     .set_description("minimal number PGs per (in) osd before we warn the admin"),
1070
1071     Option("mon_max_pg_per_osd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1072     .set_default(200)
1073     .set_description("Max number of PGs per OSD the cluster will allow"),
1074
1075     Option("mon_pg_warn_max_object_skew", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1076     .set_default(10.0)
1077     .set_description("max skew few average in objects per pg")
1078     .add_service("mgr"),
1079
1080     Option("mon_pg_warn_min_objects", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1081     .set_default(10000)
1082     .set_description("do not warn below this object #")
1083     .add_service("mgr"),
1084
1085     Option("mon_pg_warn_min_pool_objects", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1086     .set_default(1000)
1087     .set_description("do not warn on pools below this object #")
1088     .add_service("mgr"),
1089
1090     Option("mon_pg_check_down_all_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1091     .set_default(.5)
1092     .set_description("threshold of down osds after which we check all pgs")
1093     .add_service("mgr"),
1094
1095     Option("mon_cache_target_full_warn_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1096     .set_default(.66)
1097     .set_description(""),
1098
1099     Option("mon_osd_full_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1100     .set_default(.95)
1101     .set_description(""),
1102
1103     Option("mon_osd_backfillfull_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1104     .set_default(.90)
1105     .set_description(""),
1106
1107     Option("mon_osd_nearfull_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1108     .set_default(.85)
1109     .set_description(""),
1110
1111     Option("mon_osd_initial_require_min_compat_client", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1112     .set_default("jewel")
1113     .set_description(""),
1114
1115     Option("mon_allow_pool_delete", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1116     .set_default(false)
1117     .set_description(""),
1118
1119     Option("mon_fake_pool_delete", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1120     .set_default(false)
1121     .set_description(""),
1122
1123     Option("mon_globalid_prealloc", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1124     .set_default(10000)
1125     .set_description(""),
1126
1127     Option("mon_osd_report_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1128     .set_default(900)
1129     .set_description(""),
1130
1131     Option("mon_force_standby_active", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1132     .set_default(true)
1133     .set_description(""),
1134
1135     Option("mon_warn_on_legacy_crush_tunables", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1136     .set_default(true)
1137     .set_description(""),
1138
1139     Option("mon_crush_min_required_version", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1140     .set_default("firefly")
1141     .set_description(""),
1142
1143     Option("mon_warn_on_crush_straw_calc_version_zero", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1144     .set_default(true)
1145     .set_description(""),
1146
1147     Option("mon_warn_on_osd_down_out_interval_zero", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1148     .set_default(true)
1149     .set_description(""),
1150
1151     Option("mon_warn_on_cache_pools_without_hit_sets", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1152     .set_default(true)
1153     .set_description(""),
1154
1155     Option("mon_warn_on_pool_no_app", Option::TYPE_BOOL, Option::LEVEL_DEV)
1156     .set_default(true)
1157     .set_description("Enable POOL_APP_NOT_ENABLED health check"),
1158
1159     Option("mon_min_osdmap_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1160     .set_default(500)
1161     .set_description(""),
1162
1163     Option("mon_max_pgmap_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1164     .set_default(500)
1165     .set_description(""),
1166
1167     Option("mon_max_log_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1168     .set_default(500)
1169     .set_description(""),
1170
1171     Option("mon_max_mdsmap_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1172     .set_default(500)
1173     .set_description(""),
1174
1175     Option("mon_max_mgrmap_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1176     .set_default(500)
1177     .set_description(""),
1178
1179     Option("mon_max_osd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1180     .set_default(10000)
1181     .set_description(""),
1182
1183     Option("mon_probe_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1184     .set_default(2.0)
1185     .set_description(""),
1186
1187     Option("mon_client_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1188     .set_default(100ul << 20)
1189     .set_description(""),
1190
1191     Option("mon_mgr_proxy_client_bytes_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1192     .set_default(.3)
1193     .set_description("ratio of mon_client_bytes that can be consumed by "
1194                      "proxied mgr commands before we error out to client"),
1195
1196     Option("mon_log_max_summary", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1197     .set_default(50)
1198     .set_description(""),
1199
1200     Option("mon_daemon_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1201     .set_default(400ul << 20)
1202     .set_description(""),
1203
1204     Option("mon_max_log_entries_per_event", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1205     .set_default(4096)
1206     .set_description(""),
1207
1208     Option("mon_reweight_min_pgs_per_osd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1209     .set_default(10)
1210     .set_description(""),
1211
1212     Option("mon_reweight_min_bytes_per_osd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1213     .set_default(100_M)
1214     .set_description(""),
1215
1216     Option("mon_reweight_max_osds", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1217     .set_default(4)
1218     .set_description(""),
1219
1220     Option("mon_reweight_max_change", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1221     .set_default(0.05)
1222     .set_description(""),
1223
1224     Option("mon_health_data_update_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1225     .set_default(60.0)
1226     .set_description(""),
1227
1228     Option("mon_health_to_clog", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1229     .set_default(true)
1230     .set_description(""),
1231
1232     Option("mon_health_to_clog_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1233     .set_default(1_hr)
1234     .set_description(""),
1235
1236     Option("mon_health_to_clog_tick_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1237     .set_default(60.0)
1238     .set_description(""),
1239
1240     Option("mon_health_preluminous_compat", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1241     .set_default(false)
1242     .set_description("Include health warnings in preluminous JSON fields"),
1243
1244     Option("mon_health_preluminous_compat_warning", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1245     .set_default(true)
1246     .set_description("Warn about the health JSON format change in preluminous JSON fields"),
1247
1248     Option("mon_health_max_detail", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1249     .set_default(50)
1250     .set_description("max detailed pgs to report in health detail"),
1251
1252     Option("mon_health_log_update_period", Option::TYPE_INT, Option::LEVEL_DEV)
1253     .set_default(5)
1254     .set_description("Minimum time in seconds between log messages about "
1255                      "each health check")
1256     .set_min(0),
1257
1258     Option("mon_data_avail_crit", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1259     .set_default(5)
1260     .set_description(""),
1261
1262     Option("mon_data_avail_warn", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1263     .set_default(30)
1264     .set_description(""),
1265
1266     Option("mon_data_size_warn", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1267     .set_default(15_G)
1268     .set_description(""),
1269
1270     Option("mon_warn_not_scrubbed", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1271     .set_default(0)
1272     .set_description(""),
1273
1274     Option("mon_warn_not_deep_scrubbed", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1275     .set_default(0)
1276     .set_description(""),
1277
1278     Option("mon_scrub_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1279     .set_default(1_day)
1280     .set_description(""),
1281
1282     Option("mon_scrub_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1283     .set_default(5_min)
1284     .set_description(""),
1285
1286     Option("mon_scrub_max_keys", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1287     .set_default(100)
1288     .set_description(""),
1289
1290     Option("mon_scrub_inject_crc_mismatch", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1291     .set_default(0.0)
1292     .set_description(""),
1293
1294     Option("mon_scrub_inject_missing_keys", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1295     .set_default(0.0)
1296     .set_description(""),
1297
1298     Option("mon_config_key_max_entry_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1299     .set_default(4_K)
1300     .set_description(""),
1301
1302     Option("mon_sync_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1303     .set_default(60.0)
1304     .set_description(""),
1305
1306     Option("mon_sync_max_payload_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1307     .set_default(1_M)
1308     .set_description(""),
1309
1310     Option("mon_sync_debug", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1311     .set_default(false)
1312     .set_description(""),
1313
1314     Option("mon_inject_sync_get_chunk_delay", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1315     .set_default(0)
1316     .set_description(""),
1317
1318     Option("mon_osd_min_down_reporters", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1319     .set_default(2)
1320     .set_description(""),
1321
1322     Option("mon_osd_reporter_subtree_level", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1323     .set_default("host")
1324     .set_description(""),
1325
1326     Option("mon_osd_snap_trim_queue_warn_on", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1327     .set_default(32768)
1328     .set_description("Warn when snap trim queue is that large (or larger).")
1329     .set_long_description("Warn when snap trim queue length for at least one PG crosses this value, as this is indicator of snap trimmer not keeping up, wasting disk space"),
1330
1331     Option("mon_osd_force_trim_to", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1332     .set_default(0)
1333     .set_description(""),
1334
1335     Option("mon_mds_force_trim_to", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1336     .set_default(0)
1337     .set_description(""),
1338
1339     Option("mon_mds_skip_sanity", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1340     .set_default(false)
1341     .set_description(""),
1342
1343     Option("mon_fixup_legacy_erasure_code_profiles", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1344     .set_default(true)
1345     .set_description("Automatically adjust ruleset-* to crush-* so that legacy apps can set modern erasure code profiles without modification"),
1346
1347     Option("mon_debug_deprecated_as_obsolete", Option::TYPE_BOOL, Option::LEVEL_DEV)
1348     .set_default(false)
1349     .set_description(""),
1350
1351     Option("mon_debug_dump_transactions", Option::TYPE_BOOL, Option::LEVEL_DEV)
1352     .set_default(false)
1353     .set_description(""),
1354
1355     Option("mon_debug_dump_json", Option::TYPE_BOOL, Option::LEVEL_DEV)
1356     .set_default(false)
1357     .set_description(""),
1358
1359     Option("mon_debug_dump_location", Option::TYPE_STR, Option::LEVEL_DEV)
1360     .set_default("/var/log/ceph/$cluster-$name.tdump")
1361     .set_description(""),
1362
1363     Option("mon_debug_no_require_luminous", Option::TYPE_BOOL, Option::LEVEL_DEV)
1364     .set_default(false)
1365     .set_description(""),
1366
1367     Option("mon_debug_no_require_bluestore_for_ec_overwrites", Option::TYPE_BOOL, Option::LEVEL_DEV)
1368     .set_default(false)
1369     .set_description(""),
1370
1371     Option("mon_debug_no_initial_persistent_features", Option::TYPE_BOOL, Option::LEVEL_DEV)
1372     .set_default(false)
1373     .set_description(""),
1374
1375     Option("mon_inject_transaction_delay_max", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1376     .set_default(10.0)
1377     .set_description(""),
1378
1379     Option("mon_inject_transaction_delay_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1380     .set_default(0)
1381     .set_description(""),
1382
1383     Option("mon_sync_provider_kill_at", Option::TYPE_INT, Option::LEVEL_DEV)
1384     .set_default(0)
1385     .set_description(""),
1386
1387     Option("mon_sync_requester_kill_at", Option::TYPE_INT, Option::LEVEL_DEV)
1388     .set_default(0)
1389     .set_description(""),
1390
1391     Option("mon_force_quorum_join", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1392     .set_default(false)
1393     .set_description(""),
1394
1395     Option("mon_keyvaluedb", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1396     .set_default("rocksdb")
1397     .set_description(""),
1398
1399     Option("mon_debug_unsafe_allow_tier_with_nonempty_snaps", Option::TYPE_BOOL, Option::LEVEL_DEV)
1400     .set_default(false)
1401     .set_description(""),
1402
1403     Option("mon_osd_blacklist_default_expire", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1404     .set_default(1_hr)
1405     .set_description("Duration in seconds that blacklist entries for clients "
1406                      "remain in the OSD map"),
1407
1408     Option("mon_mds_blacklist_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1409     .set_default(1_day)
1410     .set_min(1_hr)
1411     .set_description("Duration in seconds that blacklist entries for MDS "
1412                      "daemons remain in the OSD map"),
1413
1414     Option("mon_osd_crush_smoke_test", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1415     .set_default(true)
1416     .set_description(""),
1417
1418     Option("paxos_stash_full_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1419     .set_default(25)
1420     .set_description(""),
1421
1422     Option("paxos_max_join_drift", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1423     .set_default(10)
1424     .set_description(""),
1425
1426     Option("paxos_propose_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1427     .set_default(1.0)
1428     .set_description(""),
1429
1430     Option("paxos_min_wait", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1431     .set_default(0.05)
1432     .set_description(""),
1433
1434     Option("paxos_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1435     .set_default(500)
1436     .set_description(""),
1437
1438     Option("paxos_trim_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1439     .set_default(250)
1440     .set_description(""),
1441
1442     Option("paxos_trim_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1443     .set_default(500)
1444     .set_description(""),
1445
1446     Option("paxos_service_trim_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1447     .set_default(250)
1448     .set_description(""),
1449
1450     Option("paxos_service_trim_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1451     .set_default(500)
1452     .set_description(""),
1453
1454     Option("paxos_kill_at", Option::TYPE_INT, Option::LEVEL_DEV)
1455     .set_default(0)
1456     .set_description(""),
1457
1458     Option("auth_cluster_required", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1459     .set_default("cephx")
1460     .set_description(""),
1461
1462     Option("auth_service_required", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1463     .set_default("cephx")
1464     .set_description(""),
1465
1466     Option("auth_client_required", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1467     .set_default("cephx, none")
1468     .set_description(""),
1469
1470     Option("auth_supported", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1471     .set_default("")
1472     .set_description(""),
1473
1474     Option("max_rotating_auth_attempts", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1475     .set_default(10)
1476     .set_description(""),
1477
1478     Option("cephx_require_signatures", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1479     .set_default(false)
1480     .set_description(""),
1481
1482     Option("cephx_require_version", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1483     .set_default(1)
1484     .set_description("Cephx version required (1 = pre-mimic, 2 = mimic+)"),
1485
1486     Option("cephx_cluster_require_signatures", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1487     .set_default(false)
1488     .set_description(""),
1489
1490     Option("cephx_cluster_require_version", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1491     .set_default(1)
1492     .set_description("Cephx version required by the cluster from clients (1 = pre-mimic, 2 = mimic+)"),
1493
1494     Option("cephx_service_require_signatures", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1495     .set_default(false)
1496     .set_description(""),
1497
1498     Option("cephx_service_require_version", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1499     .set_default(1)
1500     .set_description("Cephx version required from ceph services (1 = pre-mimic, 2 = mimic+)"),
1501
1502     Option("cephx_sign_messages", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1503     .set_default(true)
1504     .set_description(""),
1505
1506     Option("auth_mon_ticket_ttl", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1507     .set_default(12_hr)
1508     .set_description(""),
1509
1510     Option("auth_service_ticket_ttl", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1511     .set_default(1_hr)
1512     .set_description(""),
1513
1514     Option("auth_debug", Option::TYPE_BOOL, Option::LEVEL_DEV)
1515     .set_default(false)
1516     .set_description(""),
1517
1518     Option("mon_client_hunt_parallel", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1519     .set_default(2)
1520     .set_description(""),
1521
1522     Option("mon_client_hunt_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1523     .set_default(3.0)
1524     .set_description(""),
1525
1526     Option("mon_client_ping_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1527     .set_default(10.0)
1528     .set_description(""),
1529
1530     Option("mon_client_ping_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1531     .set_default(30.0)
1532     .set_description(""),
1533
1534     Option("mon_client_hunt_interval_backoff", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1535     .set_default(2.0)
1536     .set_description(""),
1537
1538     Option("mon_client_hunt_interval_min_multiple", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1539     .set_default(1.0)
1540     .set_description(""),
1541
1542     Option("mon_client_hunt_interval_max_multiple", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1543     .set_default(10.0)
1544     .set_description(""),
1545
1546     Option("mon_client_max_log_entries_per_message", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1547     .set_default(1000)
1548     .set_description(""),
1549
1550     Option("mon_max_pool_pg_num", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1551     .set_default(65536)
1552     .set_description(""),
1553
1554     Option("mon_pool_quota_warn_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1555     .set_default(0)
1556     .set_description("percent of quota at which to issue warnings")
1557     .add_service("mgr"),
1558
1559     Option("mon_pool_quota_crit_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1560     .set_default(0)
1561     .set_description("percent of quota at which to issue errors")
1562     .add_service("mgr"),
1563
1564     Option("crush_location", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1565     .set_default("")
1566     .set_description(""),
1567
1568     Option("crush_location_hook", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1569     .set_default("")
1570     .set_description(""),
1571
1572     Option("crush_location_hook_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1573     .set_default(10)
1574     .set_description(""),
1575
1576     Option("objecter_tick_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1577     .set_default(5.0)
1578     .set_description(""),
1579
1580     Option("objecter_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1581     .set_default(10.0)
1582     .set_description(""),
1583
1584     Option("objecter_inflight_op_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1585     .set_default(100_M)
1586     .set_description(""),
1587
1588     Option("objecter_inflight_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1589     .set_default(1024)
1590     .set_description(""),
1591
1592     Option("objecter_completion_locks_per_session", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1593     .set_default(32)
1594     .set_description(""),
1595
1596     Option("objecter_inject_no_watch_ping", Option::TYPE_BOOL, Option::LEVEL_DEV)
1597     .set_default(false)
1598     .set_description(""),
1599
1600     Option("objecter_retry_writes_after_first_reply", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1601     .set_default(false)
1602     .set_description(""),
1603
1604     Option("objecter_debug_inject_relock_delay", Option::TYPE_BOOL, Option::LEVEL_DEV)
1605     .set_default(false)
1606     .set_description(""),
1607
1608     Option("filer_max_purge_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1609     .set_default(10)
1610     .set_description(""),
1611
1612     Option("filer_max_truncate_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1613     .set_default(128)
1614     .set_description(""),
1615
1616     Option("journaler_write_head_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1617     .set_default(15)
1618     .set_description(""),
1619
1620     Option("journaler_prefetch_periods", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1621     .set_default(10)
1622     .set_description(""),
1623
1624     Option("journaler_prezero_periods", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1625     .set_default(5)
1626     .set_description(""),
1627
1628     Option("osd_check_max_object_name_len_on_startup", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1629     .set_default(true)
1630     .set_description(""),
1631
1632     Option("osd_max_backfills", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1633     .set_default(1)
1634     .set_description(""),
1635
1636     Option("osd_min_recovery_priority", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1637     .set_default(0)
1638     .set_description(""),
1639
1640     Option("osd_backfill_retry_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1641     .set_default(30.0)
1642     .set_description(""),
1643
1644     Option("osd_recovery_retry_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1645     .set_default(30.0)
1646     .set_description(""),
1647
1648     Option("osd_agent_max_ops", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1649     .set_default(4)
1650     .set_description(""),
1651
1652     Option("osd_agent_max_low_ops", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1653     .set_default(2)
1654     .set_description(""),
1655
1656     Option("osd_agent_min_evict_effort", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1657     .set_default(.1)
1658     .set_description(""),
1659
1660     Option("osd_agent_quantize_effort", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1661     .set_default(.1)
1662     .set_description(""),
1663
1664     Option("osd_agent_delay_time", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1665     .set_default(5.0)
1666     .set_description(""),
1667
1668     Option("osd_find_best_info_ignore_history_les", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1669     .set_default(false)
1670     .set_description(""),
1671
1672     Option("osd_agent_hist_halflife", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1673     .set_default(1000)
1674     .set_description(""),
1675
1676     Option("osd_agent_slop", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1677     .set_default(.02)
1678     .set_description(""),
1679
1680     Option("osd_uuid", Option::TYPE_UUID, Option::LEVEL_ADVANCED)
1681     .set_default(uuid_d())
1682     .set_description(""),
1683
1684     Option("osd_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1685     .set_default("/var/lib/ceph/osd/$cluster-$id")
1686     .set_description(""),
1687
1688     Option("osd_journal", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1689     .set_default("/var/lib/ceph/osd/$cluster-$id/journal")
1690     .set_description(""),
1691
1692     Option("osd_journal_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1693     .set_default(5120)
1694     .set_description(""),
1695
1696     Option("osd_journal_flush_on_shutdown", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1697     .set_default(true)
1698     .set_description(""),
1699
1700     Option("osd_os_flags", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1701     .set_default(0)
1702     .set_description(""),
1703
1704     Option("osd_max_write_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1705     .set_default(90)
1706     .set_description(""),
1707
1708     Option("osd_max_pgls", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1709     .set_default(1024)
1710     .set_description(""),
1711
1712     Option("osd_client_message_size_cap", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1713     .set_default(500_M)
1714     .set_description(""),
1715
1716     Option("osd_client_message_cap", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1717     .set_default(100)
1718     .set_description(""),
1719
1720     Option("osd_pg_bits", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1721     .set_default(6)
1722     .set_description(""),
1723
1724     Option("osd_pgp_bits", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1725     .set_default(6)
1726     .set_description(""),
1727
1728     Option("osd_crush_update_weight_set", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1729     .set_default(true)
1730     .set_description(""),
1731
1732     Option("osd_crush_chooseleaf_type", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1733     .set_default(1)
1734     .set_description(""),
1735
1736     Option("osd_pool_use_gmt_hitset", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1737     .set_default(true)
1738     .set_description(""),
1739
1740     Option("osd_crush_update_on_start", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1741     .set_default(true)
1742     .set_description(""),
1743
1744     Option("osd_class_update_on_start", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1745     .set_default(true)
1746     .set_description(""),
1747
1748     Option("osd_crush_initial_weight", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1749     .set_default(-1)
1750     .set_description(""),
1751
1752     Option("osd_pool_default_crush_rule", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1753     .set_default(-1)
1754     .set_description(""),
1755
1756     Option("osd_pool_erasure_code_stripe_unit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1757     .set_default(4_K)
1758     .set_description(""),
1759
1760     Option("osd_pool_default_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1761     .set_default(3)
1762     .set_description(""),
1763
1764     Option("osd_pool_default_min_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1765     .set_default(0)
1766     .set_description(""),
1767
1768     Option("osd_pool_default_pg_num", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1769     .set_default(8)
1770     .set_description(""),
1771
1772     Option("osd_pool_default_pgp_num", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1773     .set_default(8)
1774     .set_description(""),
1775
1776     Option("osd_pool_default_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1777     .set_default("replicated")
1778     .set_description(""),
1779
1780     Option("osd_pool_default_erasure_code_profile", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1781     .set_default("plugin=jerasure technique=reed_sol_van k=2 m=1")
1782     .set_description(""),
1783
1784     Option("osd_erasure_code_plugins", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1785     .set_default("jerasure lrc"
1786   #ifdef HAVE_BETTER_YASM_ELF64
1787          " isa"
1788   #endif
1789         )
1790     .set_description(""),
1791
1792     Option("osd_allow_recovery_below_min_size", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1793     .set_default(true)
1794     .set_description(""),
1795
1796     Option("osd_pool_default_flags", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1797     .set_default(0)
1798     .set_description(""),
1799
1800     Option("osd_pool_default_flag_hashpspool", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1801     .set_default(true)
1802     .set_description(""),
1803
1804     Option("osd_pool_default_flag_nodelete", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1805     .set_default(false)
1806     .set_description(""),
1807
1808     Option("osd_pool_default_flag_nopgchange", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1809     .set_default(false)
1810     .set_description(""),
1811
1812     Option("osd_pool_default_flag_nosizechange", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1813     .set_default(false)
1814     .set_description(""),
1815
1816     Option("osd_pool_default_hit_set_bloom_fpp", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1817     .set_default(.05)
1818     .set_description(""),
1819
1820     Option("osd_pool_default_cache_target_dirty_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1821     .set_default(.4)
1822     .set_description(""),
1823
1824     Option("osd_pool_default_cache_target_dirty_high_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1825     .set_default(.6)
1826     .set_description(""),
1827
1828     Option("osd_pool_default_cache_target_full_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1829     .set_default(.8)
1830     .set_description(""),
1831
1832     Option("osd_pool_default_cache_min_flush_age", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1833     .set_default(0)
1834     .set_description(""),
1835
1836     Option("osd_pool_default_cache_min_evict_age", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1837     .set_default(0)
1838     .set_description(""),
1839
1840     Option("osd_pool_default_cache_max_evict_check_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1841     .set_default(10)
1842     .set_description(""),
1843
1844     Option("osd_hit_set_min_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1845     .set_default(1000)
1846     .set_description(""),
1847
1848     Option("osd_hit_set_max_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1849     .set_default(100000)
1850     .set_description(""),
1851
1852     Option("osd_hit_set_namespace", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1853     .set_default(".ceph-internal")
1854     .set_description(""),
1855
1856     Option("osd_tier_promote_max_objects_sec", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1857     .set_default(25)
1858     .set_description(""),
1859
1860     Option("osd_tier_promote_max_bytes_sec", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1861     .set_default(5_M)
1862     .set_description(""),
1863
1864     Option("osd_tier_default_cache_mode", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1865     .set_default("writeback")
1866     .set_description(""),
1867
1868     Option("osd_tier_default_cache_hit_set_count", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1869     .set_default(4)
1870     .set_description(""),
1871
1872     Option("osd_tier_default_cache_hit_set_period", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1873     .set_default(1200)
1874     .set_description(""),
1875
1876     Option("osd_tier_default_cache_hit_set_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1877     .set_default("bloom")
1878     .set_description(""),
1879
1880     Option("osd_tier_default_cache_min_read_recency_for_promote", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1881     .set_default(1)
1882     .set_description(""),
1883
1884     Option("osd_tier_default_cache_min_write_recency_for_promote", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1885     .set_default(1)
1886     .set_description(""),
1887
1888     Option("osd_tier_default_cache_hit_set_grade_decay_rate", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1889     .set_default(20)
1890     .set_description(""),
1891
1892     Option("osd_tier_default_cache_hit_set_search_last_n", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1893     .set_default(1)
1894     .set_description(""),
1895
1896     Option("osd_map_dedup", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1897     .set_default(true)
1898     .set_description(""),
1899
1900     Option("osd_map_max_advance", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1901     .set_default(40)
1902     .set_description(""),
1903
1904     Option("osd_map_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1905     .set_default(50)
1906     .set_description(""),
1907
1908     Option("osd_map_message_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1909     .set_default(40)
1910     .set_description(""),
1911
1912     Option("osd_map_share_max_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1913     .set_default(40)
1914     .set_description(""),
1915
1916     Option("osd_inject_bad_map_crc_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1917     .set_default(0)
1918     .set_description(""),
1919
1920     Option("osd_inject_failure_on_pg_removal", Option::TYPE_BOOL, Option::LEVEL_DEV)
1921     .set_default(false)
1922     .set_description(""),
1923
1924     Option("osd_max_markdown_period", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1925     .set_default(600)
1926     .set_description(""),
1927
1928     Option("osd_max_markdown_count", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1929     .set_default(5)
1930     .set_description(""),
1931
1932     Option("osd_peering_wq_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1933     .set_default(2)
1934     .set_description(""),
1935
1936     Option("osd_peering_wq_batch_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1937     .set_default(20)
1938     .set_description(""),
1939
1940     Option("osd_op_pq_max_tokens_per_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1941     .set_default(4194304)
1942     .set_description(""),
1943
1944     Option("osd_op_pq_min_cost", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1945     .set_default(65536)
1946     .set_description(""),
1947
1948     Option("osd_disk_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1949     .set_default(1)
1950     .set_description(""),
1951
1952     Option("osd_disk_thread_ioprio_class", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1953     .set_default("")
1954     .set_description(""),
1955
1956     Option("osd_disk_thread_ioprio_priority", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1957     .set_default(-1)
1958     .set_description(""),
1959
1960     Option("osd_recover_clone_overlap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1961     .set_default(true)
1962     .set_description(""),
1963
1964     Option("osd_op_num_threads_per_shard", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1965     .set_default(0)
1966     .set_description(""),
1967
1968     Option("osd_op_num_threads_per_shard_hdd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1969     .set_default(1)
1970     .set_description(""),
1971
1972     Option("osd_op_num_threads_per_shard_ssd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1973     .set_default(2)
1974     .set_description(""),
1975
1976     Option("osd_op_num_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1977     .set_default(0)
1978     .set_description(""),
1979
1980     Option("osd_op_num_shards_hdd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1981     .set_default(5)
1982     .set_description(""),
1983
1984     Option("osd_op_num_shards_ssd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1985     .set_default(8)
1986     .set_description(""),
1987
1988     Option("osd_skip_data_digest", Option::TYPE_BOOL, Option::LEVEL_DEV)
1989     .set_default(false)
1990     .set_description("Do not store full-object checksums if the backend (bluestore) does its own checksums.  Do not ever turn this off if it has ever been turned on."),
1991
1992     Option("osd_distrust_data_digest", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1993     .set_default(false)
1994     .set_description("Do not trust stored data_digest (due to previous bug or corruption)"),
1995
1996     Option("osd_op_queue", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1997     .set_default("wpq")
1998     .set_enum_allowed( { "wpq", "prioritized", "mclock_opclass", "mclock_client", "debug_random" } )
1999     .set_description("which operation queue algorithm to use")
2000     .set_long_description("which operation queue algorithm to use; mclock_opclass and mclock_client are currently experimental")
2001     .add_see_also("osd_op_queue_cut_off"),
2002
2003     Option("osd_op_queue_cut_off", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2004     .set_default("low")
2005     .set_enum_allowed( { "low", "high", "debug_random" } )
2006     .set_description("the threshold between high priority ops and low priority ops")
2007     .set_long_description("the threshold between high priority ops that use strict priority ordering and low priority ops that use a fairness algorithm that may or may not incorporate priority")
2008     .add_see_also("osd_op_queue"),
2009
2010     Option("osd_op_queue_mclock_client_op_res", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2011     .set_default(1000.0)
2012     .set_description("mclock reservation of client operator requests")
2013     .set_long_description("mclock reservation of client operator requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the reservation")
2014     .add_see_also("osd_op_queue")
2015     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2016     .add_see_also("osd_op_queue_mclock_client_op_lim")
2017     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2018     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2019     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2020     .add_see_also("osd_op_queue_mclock_snap_res")
2021     .add_see_also("osd_op_queue_mclock_snap_wgt")
2022     .add_see_also("osd_op_queue_mclock_snap_lim")
2023     .add_see_also("osd_op_queue_mclock_recov_res")
2024     .add_see_also("osd_op_queue_mclock_recov_wgt")
2025     .add_see_also("osd_op_queue_mclock_recov_lim")
2026     .add_see_also("osd_op_queue_mclock_scrub_res")
2027     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2028     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2029
2030     Option("osd_op_queue_mclock_client_op_wgt", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2031     .set_default(500.0)
2032     .set_description("mclock weight of client operator requests")
2033     .set_long_description("mclock weight of client operator requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the weight")
2034     .add_see_also("osd_op_queue")
2035     .add_see_also("osd_op_queue_mclock_client_op_res")
2036     .add_see_also("osd_op_queue_mclock_client_op_lim")
2037     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2038     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2039     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2040     .add_see_also("osd_op_queue_mclock_snap_res")
2041     .add_see_also("osd_op_queue_mclock_snap_wgt")
2042     .add_see_also("osd_op_queue_mclock_snap_lim")
2043     .add_see_also("osd_op_queue_mclock_recov_res")
2044     .add_see_also("osd_op_queue_mclock_recov_wgt")
2045     .add_see_also("osd_op_queue_mclock_recov_lim")
2046     .add_see_also("osd_op_queue_mclock_scrub_res")
2047     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2048     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2049
2050     Option("osd_op_queue_mclock_client_op_lim", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2051     .set_default(0.0)
2052     .set_description("mclock limit of client operator requests")
2053     .set_long_description("mclock limit of client operator requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the limit")
2054     .add_see_also("osd_op_queue")
2055     .add_see_also("osd_op_queue_mclock_client_op_res")
2056     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2057     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2058     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2059     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2060     .add_see_also("osd_op_queue_mclock_snap_res")
2061     .add_see_also("osd_op_queue_mclock_snap_wgt")
2062     .add_see_also("osd_op_queue_mclock_snap_lim")
2063     .add_see_also("osd_op_queue_mclock_recov_res")
2064     .add_see_also("osd_op_queue_mclock_recov_wgt")
2065     .add_see_also("osd_op_queue_mclock_recov_lim")
2066     .add_see_also("osd_op_queue_mclock_scrub_res")
2067     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2068     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2069
2070     Option("osd_op_queue_mclock_osd_subop_res", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2071     .set_default(1000.0)
2072     .set_description("mclock reservation of osd sub-operation requests")
2073     .set_long_description("mclock reservation of osd sub-operation requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the reservation")
2074     .add_see_also("osd_op_queue")
2075     .add_see_also("osd_op_queue_mclock_client_op_res")
2076     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2077     .add_see_also("osd_op_queue_mclock_client_op_lim")
2078     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2079     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2080     .add_see_also("osd_op_queue_mclock_snap_res")
2081     .add_see_also("osd_op_queue_mclock_snap_wgt")
2082     .add_see_also("osd_op_queue_mclock_snap_lim")
2083     .add_see_also("osd_op_queue_mclock_recov_res")
2084     .add_see_also("osd_op_queue_mclock_recov_wgt")
2085     .add_see_also("osd_op_queue_mclock_recov_lim")
2086     .add_see_also("osd_op_queue_mclock_scrub_res")
2087     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2088     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2089
2090     Option("osd_op_queue_mclock_osd_subop_wgt", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2091     .set_default(500.0)
2092     .set_description("mclock weight of osd sub-operation requests")
2093     .set_long_description("mclock weight of osd sub-operation requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the weight")
2094     .add_see_also("osd_op_queue")
2095     .add_see_also("osd_op_queue_mclock_client_op_res")
2096     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2097     .add_see_also("osd_op_queue_mclock_client_op_lim")
2098     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2099     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2100     .add_see_also("osd_op_queue_mclock_snap_res")
2101     .add_see_also("osd_op_queue_mclock_snap_wgt")
2102     .add_see_also("osd_op_queue_mclock_snap_lim")
2103     .add_see_also("osd_op_queue_mclock_recov_res")
2104     .add_see_also("osd_op_queue_mclock_recov_wgt")
2105     .add_see_also("osd_op_queue_mclock_recov_lim")
2106     .add_see_also("osd_op_queue_mclock_scrub_res")
2107     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2108     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2109
2110     Option("osd_op_queue_mclock_osd_subop_lim", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2111     .set_default(0.0)
2112     .set_description("mclock limit of osd sub-operation requests")
2113     .set_long_description("mclock limit of osd sub-operation requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the limit")
2114     .add_see_also("osd_op_queue")
2115     .add_see_also("osd_op_queue_mclock_client_op_res")
2116     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2117     .add_see_also("osd_op_queue_mclock_client_op_lim")
2118     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2119     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2120     .add_see_also("osd_op_queue_mclock_snap_res")
2121     .add_see_also("osd_op_queue_mclock_snap_wgt")
2122     .add_see_also("osd_op_queue_mclock_snap_lim")
2123     .add_see_also("osd_op_queue_mclock_recov_res")
2124     .add_see_also("osd_op_queue_mclock_recov_wgt")
2125     .add_see_also("osd_op_queue_mclock_recov_lim")
2126     .add_see_also("osd_op_queue_mclock_scrub_res")
2127     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2128     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2129
2130     Option("osd_op_queue_mclock_snap_res", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2131     .set_default(0.0)
2132     .set_description("mclock reservation of snaptrim requests")
2133     .set_long_description("mclock reservation of snaptrim requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the reservation")
2134     .add_see_also("osd_op_queue")
2135     .add_see_also("osd_op_queue_mclock_client_op_res")
2136     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2137     .add_see_also("osd_op_queue_mclock_client_op_lim")
2138     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2139     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2140     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2141     .add_see_also("osd_op_queue_mclock_snap_wgt")
2142     .add_see_also("osd_op_queue_mclock_snap_lim")
2143     .add_see_also("osd_op_queue_mclock_recov_res")
2144     .add_see_also("osd_op_queue_mclock_recov_wgt")
2145     .add_see_also("osd_op_queue_mclock_recov_lim")
2146     .add_see_also("osd_op_queue_mclock_scrub_res")
2147     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2148     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2149
2150     Option("osd_op_queue_mclock_snap_wgt", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2151     .set_default(1.0)
2152     .set_description("mclock weight of snaptrim requests")
2153     .set_long_description("mclock weight of snaptrim requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the weight")
2154     .add_see_also("osd_op_queue")
2155     .add_see_also("osd_op_queue_mclock_client_op_res")
2156     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2157     .add_see_also("osd_op_queue_mclock_client_op_lim")
2158     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2159     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2160     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2161     .add_see_also("osd_op_queue_mclock_snap_res")
2162     .add_see_also("osd_op_queue_mclock_snap_lim")
2163     .add_see_also("osd_op_queue_mclock_recov_res")
2164     .add_see_also("osd_op_queue_mclock_recov_wgt")
2165     .add_see_also("osd_op_queue_mclock_recov_lim")
2166     .add_see_also("osd_op_queue_mclock_scrub_res")
2167     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2168     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2169
2170     Option("osd_op_queue_mclock_snap_lim", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2171     .set_default(0.001)
2172     .set_description("")
2173     .set_description("mclock limit of snaptrim requests")
2174     .set_long_description("mclock limit of snaptrim requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the limit")
2175     .add_see_also("osd_op_queue_mclock_client_op_res")
2176     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2177     .add_see_also("osd_op_queue_mclock_client_op_lim")
2178     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2179     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2180     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2181     .add_see_also("osd_op_queue_mclock_snap_res")
2182     .add_see_also("osd_op_queue_mclock_snap_wgt")
2183     .add_see_also("osd_op_queue_mclock_recov_res")
2184     .add_see_also("osd_op_queue_mclock_recov_wgt")
2185     .add_see_also("osd_op_queue_mclock_recov_lim")
2186     .add_see_also("osd_op_queue_mclock_scrub_res")
2187     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2188     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2189
2190     Option("osd_op_queue_mclock_recov_res", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2191     .set_default(0.0)
2192     .set_description("mclock reservation of recovery requests")
2193     .set_long_description("mclock reservation of recovery requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the reservation")
2194     .add_see_also("osd_op_queue")
2195     .add_see_also("osd_op_queue_mclock_client_op_res")
2196     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2197     .add_see_also("osd_op_queue_mclock_client_op_lim")
2198     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2199     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2200     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2201     .add_see_also("osd_op_queue_mclock_snap_res")
2202     .add_see_also("osd_op_queue_mclock_snap_wgt")
2203     .add_see_also("osd_op_queue_mclock_snap_lim")
2204     .add_see_also("osd_op_queue_mclock_recov_wgt")
2205     .add_see_also("osd_op_queue_mclock_recov_lim")
2206     .add_see_also("osd_op_queue_mclock_scrub_res")
2207     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2208     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2209
2210     Option("osd_op_queue_mclock_recov_wgt", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2211     .set_default(1.0)
2212     .set_description("mclock weight of recovery requests")
2213     .set_long_description("mclock weight of recovery requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the weight")
2214     .add_see_also("osd_op_queue")
2215     .add_see_also("osd_op_queue_mclock_client_op_res")
2216     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2217     .add_see_also("osd_op_queue_mclock_client_op_lim")
2218     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2219     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2220     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2221     .add_see_also("osd_op_queue_mclock_snap_res")
2222     .add_see_also("osd_op_queue_mclock_snap_wgt")
2223     .add_see_also("osd_op_queue_mclock_snap_lim")
2224     .add_see_also("osd_op_queue_mclock_recov_res")
2225     .add_see_also("osd_op_queue_mclock_recov_lim")
2226     .add_see_also("osd_op_queue_mclock_scrub_res")
2227     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2228     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2229
2230     Option("osd_op_queue_mclock_recov_lim", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2231     .set_default(0.001)
2232     .set_description("mclock limit of recovery requests")
2233     .set_long_description("mclock limit of recovery requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the limit")
2234     .add_see_also("osd_op_queue")
2235     .add_see_also("osd_op_queue_mclock_client_op_res")
2236     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2237     .add_see_also("osd_op_queue_mclock_client_op_lim")
2238     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2239     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2240     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2241     .add_see_also("osd_op_queue_mclock_snap_res")
2242     .add_see_also("osd_op_queue_mclock_snap_wgt")
2243     .add_see_also("osd_op_queue_mclock_snap_lim")
2244     .add_see_also("osd_op_queue_mclock_recov_res")
2245     .add_see_also("osd_op_queue_mclock_recov_wgt")
2246     .add_see_also("osd_op_queue_mclock_scrub_res")
2247     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2248     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2249
2250     Option("osd_op_queue_mclock_scrub_res", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2251     .set_default(0.0)
2252     .set_description("mclock reservation of scrub requests")
2253     .set_long_description("mclock reservation of scrub requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the reservation")
2254     .add_see_also("osd_op_queue")
2255     .add_see_also("osd_op_queue_mclock_client_op_res")
2256     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2257     .add_see_also("osd_op_queue_mclock_client_op_lim")
2258     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2259     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2260     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2261     .add_see_also("osd_op_queue_mclock_snap_res")
2262     .add_see_also("osd_op_queue_mclock_snap_wgt")
2263     .add_see_also("osd_op_queue_mclock_snap_lim")
2264     .add_see_also("osd_op_queue_mclock_recov_res")
2265     .add_see_also("osd_op_queue_mclock_recov_wgt")
2266     .add_see_also("osd_op_queue_mclock_recov_lim")
2267     .add_see_also("osd_op_queue_mclock_scrub_wgt")
2268     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2269
2270     Option("osd_op_queue_mclock_scrub_wgt", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2271     .set_default(1.0)
2272     .set_description("mclock weight of scrub requests")
2273     .set_long_description("mclock weight of scrub requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the weight")
2274     .add_see_also("osd_op_queue")
2275     .add_see_also("osd_op_queue_mclock_client_op_res")
2276     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2277     .add_see_also("osd_op_queue_mclock_client_op_lim")
2278     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2279     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2280     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2281     .add_see_also("osd_op_queue_mclock_snap_res")
2282     .add_see_also("osd_op_queue_mclock_snap_wgt")
2283     .add_see_also("osd_op_queue_mclock_snap_lim")
2284     .add_see_also("osd_op_queue_mclock_recov_res")
2285     .add_see_also("osd_op_queue_mclock_recov_wgt")
2286     .add_see_also("osd_op_queue_mclock_recov_lim")
2287     .add_see_also("osd_op_queue_mclock_scrub_res")
2288     .add_see_also("osd_op_queue_mclock_scrub_lim"),
2289
2290     Option("osd_op_queue_mclock_scrub_lim", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2291     .set_default(0.001)
2292     .set_description("mclock weight of limit requests")
2293     .set_long_description("mclock weight of limit requests when osd_op_queue is either 'mclock_opclass' or 'mclock_client'; higher values increase the limit")
2294     .add_see_also("osd_op_queue")
2295     .add_see_also("osd_op_queue_mclock_client_op_res")
2296     .add_see_also("osd_op_queue_mclock_client_op_wgt")
2297     .add_see_also("osd_op_queue_mclock_client_op_lim")
2298     .add_see_also("osd_op_queue_mclock_osd_subop_res")
2299     .add_see_also("osd_op_queue_mclock_osd_subop_wgt")
2300     .add_see_also("osd_op_queue_mclock_osd_subop_lim")
2301     .add_see_also("osd_op_queue_mclock_snap_res")
2302     .add_see_also("osd_op_queue_mclock_snap_wgt")
2303     .add_see_also("osd_op_queue_mclock_snap_lim")
2304     .add_see_also("osd_op_queue_mclock_recov_res")
2305     .add_see_also("osd_op_queue_mclock_recov_wgt")
2306     .add_see_also("osd_op_queue_mclock_recov_lim")
2307     .add_see_also("osd_op_queue_mclock_scrub_res")
2308     .add_see_also("osd_op_queue_mclock_scrub_wgt"),
2309
2310     Option("osd_ignore_stale_divergent_priors", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2311     .set_default(false)
2312     .set_description(""),
2313
2314     Option("osd_read_ec_check_for_errors", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2315     .set_default(false)
2316     .set_description(""),
2317
2318     Option("osd_recover_clone_overlap_limit", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2319     .set_default(10)
2320     .set_description(""),
2321
2322     Option("osd_backfill_scan_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2323     .set_default(64)
2324     .set_description(""),
2325
2326     Option("osd_backfill_scan_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2327     .set_default(512)
2328     .set_description(""),
2329
2330     Option("osd_op_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2331     .set_default(15)
2332     .set_description(""),
2333
2334     Option("osd_op_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2335     .set_default(150)
2336     .set_description(""),
2337
2338     Option("osd_recovery_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2339     .set_default(30)
2340     .set_description(""),
2341
2342     Option("osd_recovery_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2343     .set_default(300)
2344     .set_description(""),
2345
2346     Option("osd_recovery_sleep", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2347     .set_default(0)
2348     .set_description("Time in seconds to sleep before next recovery or backfill op"),
2349
2350     Option("osd_recovery_sleep_hdd", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2351     .set_default(0.1)
2352     .set_description("Time in seconds to sleep before next recovery or backfill op for HDDs"),
2353
2354     Option("osd_recovery_sleep_ssd", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2355     .set_default(0)
2356     .set_description("Time in seconds to sleep before next recovery or backfill op for SSDs"),
2357
2358     Option("osd_recovery_sleep_hybrid", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2359     .set_default(0.025)
2360     .set_description("Time in seconds to sleep before next recovery or backfill op when data is on HDD and journal is on SSD"),
2361
2362     Option("osd_snap_trim_sleep", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2363     .set_default(0)
2364     .set_description(""),
2365
2366     Option("osd_scrub_invalid_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2367     .set_default(true)
2368     .set_description(""),
2369
2370     Option("osd_remove_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2371     .set_default(1_hr)
2372     .set_description(""),
2373
2374     Option("osd_remove_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2375     .set_default(10_hr)
2376     .set_description(""),
2377
2378     Option("osd_command_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2379     .set_default(10_min)
2380     .set_description(""),
2381
2382     Option("osd_command_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2383     .set_default(15_min)
2384     .set_description(""),
2385
2386     Option("osd_heartbeat_addr", Option::TYPE_ADDR, Option::LEVEL_ADVANCED)
2387     .set_default(entity_addr_t())
2388     .set_description(""),
2389
2390     Option("osd_heartbeat_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2391     .set_default(6)
2392     .set_description(""),
2393
2394     Option("osd_heartbeat_grace", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2395     .set_default(20)
2396     .set_description(""),
2397
2398     Option("osd_heartbeat_min_peers", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2399     .set_default(10)
2400     .set_description(""),
2401
2402     Option("osd_heartbeat_use_min_delay_socket", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2403     .set_default(false)
2404     .set_description(""),
2405
2406     Option("osd_heartbeat_min_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2407     .set_default(2000)
2408     .set_description(""),
2409
2410     Option("osd_pg_max_concurrent_snap_trims", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2411     .set_default(2)
2412     .set_description(""),
2413
2414     Option("osd_max_trimming_pgs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2415     .set_default(2)
2416     .set_description(""),
2417
2418     Option("osd_heartbeat_min_healthy_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2419     .set_default(.33)
2420     .set_description(""),
2421
2422     Option("osd_mon_heartbeat_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2423     .set_default(30)
2424     .set_description(""),
2425
2426     Option("osd_mon_report_interval_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2427     .set_default(600)
2428     .set_description(""),
2429
2430     Option("osd_mon_report_interval_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2431     .set_default(5)
2432     .set_description(""),
2433
2434     Option("osd_mon_report_max_in_flight", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2435     .set_default(2)
2436     .set_description(""),
2437
2438     Option("osd_beacon_report_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2439     .set_default(300)
2440     .set_description(""),
2441
2442     Option("osd_pg_stat_report_interval_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2443     .set_default(500)
2444     .set_description(""),
2445
2446     Option("osd_mon_ack_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2447     .set_default(30.0)
2448     .set_description(""),
2449
2450     Option("osd_stats_ack_timeout_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2451     .set_default(2.0)
2452     .set_description(""),
2453
2454     Option("osd_stats_ack_timeout_decay", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2455     .set_default(.9)
2456     .set_description(""),
2457
2458     Option("osd_default_data_pool_replay_window", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2459     .set_default(45)
2460     .set_description(""),
2461
2462     Option("osd_auto_mark_unfound_lost", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2463     .set_default(false)
2464     .set_description(""),
2465
2466     Option("osd_recovery_delay_start", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2467     .set_default(0)
2468     .set_description(""),
2469
2470     Option("osd_recovery_max_active", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2471     .set_default(3)
2472     .set_description(""),
2473
2474     Option("osd_recovery_max_single_start", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2475     .set_default(1)
2476     .set_description(""),
2477
2478     Option("osd_recovery_max_chunk", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2479     .set_default(8<<20)
2480     .set_description(""),
2481
2482     Option("osd_recovery_max_omap_entries_per_chunk", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2483     .set_default(8096)
2484     .set_description(""),
2485
2486     Option("osd_copyfrom_max_chunk", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2487     .set_default(8<<20)
2488     .set_description(""),
2489
2490     Option("osd_push_per_object_cost", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2491     .set_default(1000)
2492     .set_description(""),
2493
2494     Option("osd_max_push_cost", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2495     .set_default(8<<20)
2496     .set_description(""),
2497
2498     Option("osd_max_push_objects", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2499     .set_default(10)
2500     .set_description(""),
2501
2502     Option("osd_recovery_forget_lost_objects", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2503     .set_default(false)
2504     .set_description(""),
2505
2506     Option("osd_max_scrubs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2507     .set_default(1)
2508     .set_description("Maximum concurrent scrubs on a single OSD"),
2509
2510     Option("osd_scrub_during_recovery", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2511     .set_default(false)
2512     .set_description("Allow scrubbing when PGs on the OSD are undergoing recovery"),
2513
2514     Option("osd_scrub_begin_hour", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2515     .set_default(0)
2516     .set_description("Restrict scrubbing to this hour of the day or later")
2517     .add_see_also("osd_scrub_end_hour"),
2518
2519     Option("osd_scrub_end_hour", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2520     .set_default(24)
2521     .set_description("Restrict scrubbing to hours of the day earlier than this")
2522     .add_see_also("osd_scrub_begin_hour"),
2523
2524     Option("osd_scrub_begin_week_day", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2525     .set_default(0)
2526     .set_description("Restrict scrubbing to this day of the week or later")
2527     .set_long_description("0 or 7 = Sunday, 1 = Monday, etc.")
2528     .add_see_also("osd_scrub_end_week_day"),
2529
2530     Option("osd_scrub_end_week_day", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2531     .set_default(7)
2532     .set_description("Restrict scrubbing to days of the week earlier than this")
2533     .set_long_description("0 or 7 = Sunday, 1 = Monday, etc.")
2534     .add_see_also("osd_scrub_begin_week_day"),
2535
2536     Option("osd_scrub_load_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2537     .set_default(0.5)
2538     .set_description("Allow scrubbing when system load divided by number of CPUs is below this value"),
2539
2540     Option("osd_scrub_min_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2541     .set_default(1_day)
2542     .set_description("Scrub each PG no more often than this interval")
2543     .add_see_also("osd_scrub_max_interval"),
2544
2545     Option("osd_scrub_max_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2546     .set_default(7_day)
2547     .set_description("Scrub each PG no less often than this interval")
2548     .add_see_also("osd_scrub_min_interval"),
2549
2550     Option("osd_scrub_interval_randomize_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2551     .set_default(0.5)
2552     .set_description("Ratio of scrub interval to randomly vary")
2553     .set_long_description("This prevents a scrub 'stampede' by randomly varying the scrub intervals so that they are soon uniformly distributed over the week")
2554     .add_see_also("osd_scrub_min_interval"),
2555
2556     Option("osd_scrub_backoff_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2557     .set_default(.66)
2558     .set_description("Backoff ratio after a failed scrub scheduling attempt"),
2559
2560     Option("osd_scrub_chunk_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2561     .set_default(5)
2562     .set_description("Minimum number of objects to scrub in a single chunk")
2563     .add_see_also("osd_scrub_chunk_max"),
2564
2565     Option("osd_scrub_chunk_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2566     .set_default(25)
2567     .set_description("Maximum number of object to scrub in a single chunk")
2568     .add_see_also("osd_scrub_chunk_min"),
2569
2570     Option("osd_scrub_sleep", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2571     .set_default(0)
2572     .set_description("Duration to inject a delay during scrubbing"),
2573
2574     Option("osd_scrub_auto_repair", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2575     .set_default(false)
2576     .set_description("Automatically repair damaged objects detected during scrub"),
2577
2578     Option("osd_scrub_auto_repair_num_errors", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2579     .set_default(5)
2580     .set_description("Maximum number of detected errors to automatically repair")
2581     .add_see_also("osd_scrub_auto_repair"),
2582
2583     Option("osd_scrub_max_preemptions", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2584     .set_default(5)
2585     .set_description("Set the maximum number of times we will preempt a deep scrub due to a client operation before blocking client IO to complete the scrub"),
2586
2587     Option("osd_deep_scrub_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2588     .set_default(7_day)
2589     .set_description("Deep scrub each PG (i.e., verify data checksums) at least this often"),
2590
2591     Option("osd_deep_scrub_randomize_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2592     .set_default(0.15)
2593     .set_description("Ratio of deep scrub interval to randomly vary")
2594     .set_long_description("This prevents a deep scrub 'stampede' by randomly varying the scrub intervals so that they are soon uniformly distributed over the week")
2595     .add_see_also("osd_deep_scrub_interval"),
2596
2597     Option("osd_deep_scrub_stride", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2598     .set_default(524288)
2599     .set_description("Number of bytes to read from an object at a time during deep scrub"),
2600
2601     Option("osd_deep_scrub_keys", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2602     .set_default(1024)
2603     .set_description("Number of keys to read from an object at a time during deep scrub"),
2604
2605     Option("osd_deep_scrub_update_digest_min_age", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2606     .set_default(2_hr)
2607     .set_description("Update overall object digest only if object was last modified longer ago than this"),
2608
2609     Option("osd_deep_scrub_large_omap_object_key_threshold", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2610     .set_default(2000000)
2611     .set_description("Warn when we encounter an object with more omap keys than this")
2612     .add_service("osd")
2613     .add_see_also("osd_deep_scrub_large_omap_object_value_sum_threshold"),
2614
2615     Option("osd_deep_scrub_large_omap_object_value_sum_threshold", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2616     .set_default(1_G)
2617     .set_description("Warn when we encounter an object with more omap key bytes than this")
2618     .add_service("osd")
2619     .add_see_also("osd_deep_scrub_large_omap_object_key_threshold"),
2620
2621     Option("osd_class_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2622     .set_default(CEPH_LIBDIR "/rados-classes")
2623     .set_description(""),
2624
2625     Option("osd_open_classes_on_start", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2626     .set_default(true)
2627     .set_description(""),
2628
2629     Option("osd_class_load_list", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2630     .set_default("cephfs hello journal lock log numops " "rbd refcount replica_log rgw statelog timeindex user version")
2631     .set_description(""),
2632
2633     Option("osd_class_default_list", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2634     .set_default("cephfs hello journal lock log numops " "rbd refcount replica_log rgw statelog timeindex user version")
2635     .set_description(""),
2636
2637     Option("osd_check_for_log_corruption", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2638     .set_default(false)
2639     .set_description(""),
2640
2641     Option("osd_use_stale_snap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2642     .set_default(false)
2643     .set_description(""),
2644
2645     Option("osd_rollback_to_cluster_snap", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2646     .set_default("")
2647     .set_description(""),
2648
2649     Option("osd_default_notify_timeout", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2650     .set_default(30)
2651     .set_description(""),
2652
2653     Option("osd_kill_backfill_at", Option::TYPE_INT, Option::LEVEL_DEV)
2654     .set_default(0)
2655     .set_description(""),
2656
2657     Option("osd_pg_epoch_persisted_max_stale", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2658     .set_default(40)
2659     .set_description(""),
2660
2661     Option("osd_min_pg_log_entries", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2662     .set_default(1500)
2663     .set_description("minimum number of entries to maintain in the PG log")
2664     .add_service("osd")
2665     .add_see_also("osd_max_pg_log_entries")
2666     .add_see_also("osd_pg_log_dups_tracked"),
2667
2668     Option("osd_max_pg_log_entries", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2669     .set_default(10000)
2670     .set_description("maximum number of entries to maintain in the PG log when degraded before we trim")
2671     .add_service("osd")
2672     .add_see_also("osd_min_pg_log_entries")
2673     .add_see_also("osd_pg_log_dups_tracked"),
2674
2675     Option("osd_pg_log_dups_tracked", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2676     .set_default(3000)
2677     .set_description("how many versions back to track in order to detect duplicate ops; this is combined with both the regular pg log entries and additional minimal dup detection entries")
2678     .add_service("osd")
2679     .add_see_also("osd_min_pg_log_entries")
2680     .add_see_also("osd_max_pg_log_entries"),
2681
2682     Option("osd_force_recovery_pg_log_entries_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2683     .set_default(1.3)
2684     .set_description(""),
2685
2686     Option("osd_pg_log_trim_min", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2687     .set_default(100)
2688     .set_description(""),
2689
2690     Option("osd_max_pg_per_osd_hard_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2691     .set_default(3)
2692     .set_min(1)
2693     .set_description("Maximum number of PG per OSD, a factor of 'mon_max_pg_per_osd'")
2694     .set_long_description("OSD will refuse to instantiate PG if the number of PG it serves exceeds this number.")
2695     .add_see_also("mon_max_pg_per_osd"),
2696
2697     Option("osd_pg_log_trim_max", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2698     .set_default(10000)
2699     .set_description("maximum number of entries to remove at once from the PG log")
2700     .add_service("osd")
2701     .add_see_also("osd_min_pg_log_entries")
2702     .add_see_also("osd_max_pg_log_entries"),
2703
2704     Option("osd_op_complaint_time", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2705     .set_default(30)
2706     .set_description(""),
2707
2708     Option("osd_command_max_records", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2709     .set_default(256)
2710     .set_description(""),
2711
2712     Option("osd_max_pg_blocked_by", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2713     .set_default(16)
2714     .set_description(""),
2715
2716     Option("osd_op_log_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2717     .set_default(5)
2718     .set_description(""),
2719
2720     Option("osd_verify_sparse_read_holes", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2721     .set_default(false)
2722     .set_description(""),
2723
2724     Option("osd_backoff_on_unfound", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2725     .set_default(true)
2726     .set_description(""),
2727
2728     Option("osd_backoff_on_degraded", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2729     .set_default(false)
2730     .set_description(""),
2731
2732     Option("osd_backoff_on_down", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2733     .set_default(true)
2734     .set_description(""),
2735
2736     Option("osd_backoff_on_peering", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2737     .set_default(false)
2738     .set_description(""),
2739
2740     Option("osd_debug_shutdown", Option::TYPE_BOOL, Option::LEVEL_DEV)
2741     .set_default(false)
2742     .set_description("Turn up debug levels during shutdown"),
2743
2744     Option("osd_debug_crash_on_ignored_backoff", Option::TYPE_BOOL, Option::LEVEL_DEV)
2745     .set_default(false)
2746     .set_description(""),
2747
2748     Option("osd_debug_inject_dispatch_delay_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2749     .set_default(0)
2750     .set_description(""),
2751
2752     Option("osd_debug_inject_dispatch_delay_duration", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2753     .set_default(.1)
2754     .set_description(""),
2755
2756     Option("osd_debug_drop_ping_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2757     .set_default(0)
2758     .set_description(""),
2759
2760     Option("osd_debug_drop_ping_duration", Option::TYPE_INT, Option::LEVEL_DEV)
2761     .set_default(0)
2762     .set_description(""),
2763
2764     Option("osd_debug_op_order", Option::TYPE_BOOL, Option::LEVEL_DEV)
2765     .set_default(false)
2766     .set_description(""),
2767
2768     Option("osd_debug_verify_missing_on_start", Option::TYPE_BOOL, Option::LEVEL_DEV)
2769     .set_default(false)
2770     .set_description(""),
2771
2772     Option("osd_debug_verify_snaps", Option::TYPE_BOOL, Option::LEVEL_DEV)
2773     .set_default(false)
2774     .set_description(""),
2775
2776     Option("osd_debug_verify_stray_on_activate", Option::TYPE_BOOL, Option::LEVEL_DEV)
2777     .set_default(false)
2778     .set_description(""),
2779
2780     Option("osd_debug_skip_full_check_in_backfill_reservation", Option::TYPE_BOOL, Option::LEVEL_DEV)
2781     .set_default(false)
2782     .set_description(""),
2783
2784     Option("osd_debug_reject_backfill_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2785     .set_default(0)
2786     .set_description(""),
2787
2788     Option("osd_debug_inject_copyfrom_error", Option::TYPE_BOOL, Option::LEVEL_DEV)
2789     .set_default(false)
2790     .set_description(""),
2791
2792     Option("osd_debug_misdirected_ops", Option::TYPE_BOOL, Option::LEVEL_DEV)
2793     .set_default(false)
2794     .set_description(""),
2795
2796     Option("osd_debug_skip_full_check_in_recovery", Option::TYPE_BOOL, Option::LEVEL_DEV)
2797     .set_default(false)
2798     .set_description(""),
2799
2800     Option("osd_debug_random_push_read_error", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2801     .set_default(0)
2802     .set_description(""),
2803
2804     Option("osd_debug_verify_cached_snaps", Option::TYPE_BOOL, Option::LEVEL_DEV)
2805     .set_default(false)
2806     .set_description(""),
2807
2808     Option("osd_debug_deep_scrub_sleep", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2809     .set_default(0)
2810     .set_description("Inject an expensive sleep during deep scrub IO to make it easier to induce preemption"),
2811
2812     Option("osd_enable_op_tracker", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2813     .set_default(true)
2814     .set_description(""),
2815
2816     Option("osd_num_op_tracker_shard", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2817     .set_default(32)
2818     .set_description(""),
2819
2820     Option("osd_op_history_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2821     .set_default(20)
2822     .set_description(""),
2823
2824     Option("osd_op_history_duration", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2825     .set_default(600)
2826     .set_description(""),
2827
2828     Option("osd_op_history_slow_op_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2829     .set_default(20)
2830     .set_description(""),
2831
2832     Option("osd_op_history_slow_op_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2833     .set_default(10.0)
2834     .set_description(""),
2835
2836     Option("osd_target_transaction_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2837     .set_default(30)
2838     .set_description(""),
2839
2840     Option("osd_failsafe_full_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2841     .set_default(.97)
2842     .set_description(""),
2843
2844     Option("osd_fast_fail_on_connection_refused", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2845     .set_default(true)
2846     .set_description(""),
2847
2848     Option("osd_pg_object_context_cache_count", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2849     .set_default(64)
2850     .set_description(""),
2851
2852     Option("osd_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2853     .set_default(false)
2854     .set_description(""),
2855
2856     Option("osd_function_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2857     .set_default(false)
2858     .set_description(""),
2859
2860     Option("osd_fast_info", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2861     .set_default(true)
2862     .set_description(""),
2863
2864     Option("osd_debug_pg_log_writeout", Option::TYPE_BOOL, Option::LEVEL_DEV)
2865     .set_default(false)
2866     .set_description(""),
2867
2868     Option("osd_loop_before_reset_tphandle", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2869     .set_default(64)
2870     .set_description(""),
2871
2872     Option("threadpool_default_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2873     .set_default(60)
2874     .set_description(""),
2875
2876     Option("threadpool_empty_queue_max_wait", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2877     .set_default(2)
2878     .set_description(""),
2879
2880     Option("leveldb_log_to_ceph_log", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2881     .set_default(true)
2882     .set_description(""),
2883
2884     Option("leveldb_write_buffer_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2885     .set_default(8_M)
2886     .set_description(""),
2887
2888     Option("leveldb_cache_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2889     .set_default(128_M)
2890     .set_description(""),
2891
2892     Option("leveldb_block_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2893     .set_default(0)
2894     .set_description(""),
2895
2896     Option("leveldb_bloom_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2897     .set_default(0)
2898     .set_description(""),
2899
2900     Option("leveldb_max_open_files", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2901     .set_default(0)
2902     .set_description(""),
2903
2904     Option("leveldb_compression", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2905     .set_default(true)
2906     .set_description(""),
2907
2908     Option("leveldb_paranoid", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2909     .set_default(false)
2910     .set_description(""),
2911
2912     Option("leveldb_log", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2913     .set_default("/dev/null")
2914     .set_description(""),
2915
2916     Option("leveldb_compact_on_mount", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2917     .set_default(false)
2918     .set_description(""),
2919
2920     Option("kinetic_host", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2921     .set_default("")
2922     .set_description(""),
2923
2924     Option("kinetic_port", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2925     .set_default(8123)
2926     .set_description(""),
2927
2928     Option("kinetic_user_id", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2929     .set_default(1)
2930     .set_description(""),
2931
2932     Option("kinetic_hmac_key", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2933     .set_default("asdfasdf")
2934     .set_description(""),
2935
2936     Option("kinetic_use_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2937     .set_default(false)
2938     .set_description(""),
2939
2940     Option("rocksdb_separate_wal_dir", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2941     .set_default(false)
2942     .set_description(""),
2943
2944     Option("rocksdb_db_paths", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2945     .set_default("")
2946     .set_description("")
2947     .set_safe(),
2948
2949     Option("rocksdb_log_to_ceph_log", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2950     .set_default(true)
2951     .set_description(""),
2952
2953     Option("rocksdb_cache_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2954     .set_default(128_M)
2955     .set_description(""),
2956
2957     Option("rocksdb_cache_row_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2958     .set_default(0)
2959     .set_description(""),
2960
2961     Option("rocksdb_cache_shard_bits", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2962     .set_default(4)
2963     .set_description(""),
2964
2965     Option("rocksdb_cache_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2966     .set_default("lru")
2967     .set_description(""),
2968
2969     Option("rocksdb_block_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2970     .set_default(4_K)
2971     .set_description(""),
2972
2973     Option("rocksdb_perf", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2974     .set_default(false)
2975     .set_description(""),
2976
2977     Option("rocksdb_collect_compaction_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2978     .set_default(false)
2979     .set_description(""),
2980
2981     Option("rocksdb_collect_extended_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2982     .set_default(false)
2983     .set_description(""),
2984
2985     Option("rocksdb_collect_memory_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2986     .set_default(false)
2987     .set_description(""),
2988
2989     Option("rocksdb_enable_rmrange", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2990     .set_default(false)
2991     .set_description(""),
2992
2993     Option("rocksdb_bloom_bits_per_key", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2994     .set_default(20)
2995     .set_description("Number of bits per key to use for RocksDB's bloom filters.")
2996     .set_long_description("RocksDB bloom filters can be used to quickly answer the question of whether or not a key may exist or definitely does not exist in a given RocksDB SST file without having to read all keys into memory.  Using a higher bit value decreases the likelihood of false positives at the expense of additional disk space and memory consumption when the filter is loaded into RAM.  The current default value of 20 was found to provide significant performance gains when getattr calls are made (such as during new object creation in bluestore) without significant memory overhead or cache pollution when combined with rocksdb partitioned index filters.  See: https://github.com/facebook/rocksdb/wiki/Partitioned-Index-Filters for more information."),
2997
2998     Option("rocksdb_cache_index_and_filter_blocks", Option::TYPE_BOOL, Option::LEVEL_DEV)
2999     .set_default(true)
3000     .set_description("Whether to cache indices and filters in block cache")
3001     .set_long_description("By default RocksDB will load an SST file's index and bloom filters into memory when it is opened and remove them from memory when an SST file is closed.  Thus, memory consumption by indices and bloom filters is directly tied to the number of concurrent SST files allowed to be kept open.  This option instead stores cached indicies and filters in the block cache where they directly compete with other cached data.  By default we set this option to true to better account for and bound rocksdb memory usage and keep filters in memory even when an SST file is closed."),
3002
3003     Option("rocksdb_cache_index_and_filter_blocks_with_high_priority", Option::TYPE_BOOL, Option::LEVEL_DEV)
3004     .set_default(true)
3005     .set_description("Whether to cache indices and filters in the block cache with high priority")
3006     .set_long_description("A downside of setting rocksdb_cache_index_and_filter_blocks to true is that regular data can push indices and filters out of memory.  Setting this option to true means they are cached with higher priority than other data and should typically stay in the block cache."),
3007
3008     Option("rocksdb_pin_l0_filter_and_index_blocks_in_cache", Option::TYPE_BOOL, Option::LEVEL_DEV)
3009     .set_default(true)
3010     .set_description("Whether to pin Level 0 indices and bloom filters in the block cache")
3011     .set_long_description("A downside of setting rocksdb_cache_index_and_filter_blocks to true is that regular data can push indices and filters out of memory.  Setting this option to true means that level 0 SST files will always have their indices and filters pinned in the block cache."),
3012
3013     Option("rocksdb_index_type", Option::TYPE_STR, Option::LEVEL_DEV)
3014     .set_default("binary_search")
3015     .set_description("Type of index for SST files: binary_search, hash_search, two_level")
3016     .set_long_description("This option controls the table index type.  binary_search is a space efficient index block that is optimized for block-search-based index. hash_search may improve prefix lookup performance at the expense of higher disk and memory usage and potentially slower compactions.  two_level is an experimental index type that uses two binary search indexes and works in conjunction with partition filters.  See: http://rocksdb.org/blog/2017/05/12/partitioned-index-filter.html"),
3017
3018     Option("rocksdb_partition_filters", Option::TYPE_BOOL, Option::LEVEL_DEV)
3019     .set_default(false)
3020     .set_description("(experimental) partition SST index/filters into smaller blocks")
3021     .set_long_description("This is an experimental option for rocksdb that works in conjunction with two_level indices to avoid having to keep the entire filter/index in cache when cache_index_and_filter_blocks is true.  The idea is to keep a much smaller top-level index in heap/cache and then opportunistically cache the lower level indices.  See: https://github.com/facebook/rocksdb/wiki/Partitioned-Index-Filters"),
3022
3023     Option("rocksdb_metadata_block_size", Option::TYPE_UINT, Option::LEVEL_DEV)
3024     .set_default(4_K)
3025     .set_description("The block size for index partitions. (0 = rocksdb default)"),
3026
3027     Option("mon_rocksdb_options", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3028     .set_default("write_buffer_size=33554432,"
3029                  "compression=kNoCompression,"
3030                  "level_compaction_dynamic_level_bytes=true")
3031     .set_description(""),
3032
3033     Option("osd_client_op_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3034     .set_default(63)
3035     .set_description(""),
3036
3037     Option("osd_recovery_op_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3038     .set_default(3)
3039     .set_description(""),
3040
3041     Option("osd_snap_trim_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3042     .set_default(5)
3043     .set_description(""),
3044
3045     Option("osd_snap_trim_cost", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3046     .set_default(1<<20)
3047     .set_description(""),
3048
3049     Option("osd_scrub_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3050     .set_default(5)
3051     .set_description("Priority for scrub operations in work queue"),
3052
3053     Option("osd_scrub_cost", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3054     .set_default(50<<20)
3055     .set_description("Cost for scrub operations in work queue"),
3056
3057     Option("osd_requested_scrub_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3058     .set_default(120)
3059     .set_description(""),
3060
3061     Option("osd_recovery_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3062     .set_default(5)
3063     .set_description(""),
3064
3065     Option("osd_recovery_cost", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3066     .set_default(20<<20)
3067     .set_description(""),
3068
3069     Option("osd_recovery_op_warn_multiple", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3070     .set_default(16)
3071     .set_description(""),
3072
3073     Option("osd_mon_shutdown_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3074     .set_default(5)
3075     .set_description(""),
3076
3077     Option("osd_shutdown_pgref_assert", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3078     .set_default(false)
3079     .set_description(""),
3080
3081     Option("osd_max_object_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3082     .set_default(128_M)
3083     .set_description(""),
3084
3085     Option("osd_max_object_name_len", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3086     .set_default(2048)
3087     .set_description(""),
3088
3089     Option("osd_max_object_namespace_len", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3090     .set_default(256)
3091     .set_description(""),
3092
3093     Option("osd_max_attr_name_len", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3094     .set_default(100)
3095     .set_description(""),
3096
3097     Option("osd_max_attr_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3098     .set_default(0)
3099     .set_description(""),
3100
3101     Option("osd_max_omap_entries_per_request", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3102     .set_default(131072)
3103     .set_description(""),
3104
3105     Option("osd_max_omap_bytes_per_request", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3106     .set_default(1<<30)
3107     .set_description(""),
3108
3109     Option("osd_objectstore", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3110     .set_default("filestore")
3111     .set_description(""),
3112
3113     Option("osd_objectstore_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3114     .set_default(false)
3115     .set_description(""),
3116
3117     Option("osd_objectstore_fuse", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3118     .set_default(false)
3119     .set_description(""),
3120
3121     Option("osd_bench_small_size_max_iops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3122     .set_default(100)
3123     .set_description(""),
3124
3125     Option("osd_bench_large_size_max_throughput", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3126     .set_default(100 << 20)
3127     .set_description(""),
3128
3129     Option("osd_bench_max_block_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3130     .set_default(64 << 20)
3131     .set_description(""),
3132
3133     Option("osd_bench_duration", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3134     .set_default(30)
3135     .set_description(""),
3136
3137     Option("osd_blkin_trace_all", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3138     .set_default(false)
3139     .set_description(""),
3140
3141     Option("osdc_blkin_trace_all", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3142     .set_default(false)
3143     .set_description(""),
3144
3145     Option("osd_discard_disconnected_ops", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3146     .set_default(true)
3147     .set_description(""),
3148
3149     Option("memstore_device_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3150     .set_default(1_G)
3151     .set_description(""),
3152
3153     Option("memstore_page_set", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3154     .set_default(false)
3155     .set_description(""),
3156
3157     Option("memstore_page_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3158     .set_default(64_K)
3159     .set_description(""),
3160
3161     Option("objectstore_blackhole", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3162     .set_default(false)
3163     .set_description(""),
3164
3165     // --------------------------
3166     // bluestore
3167
3168     Option("bdev_inject_bad_size", Option::TYPE_BOOL, Option::LEVEL_DEV)
3169     .set_default(false)
3170     .set_description(""),
3171
3172     Option("bdev_debug_inflight_ios", Option::TYPE_BOOL, Option::LEVEL_DEV)
3173     .set_default(false)
3174     .set_description(""),
3175
3176     Option("bdev_inject_crash", Option::TYPE_INT, Option::LEVEL_DEV)
3177     .set_default(0)
3178     .set_description(""),
3179
3180     Option("bdev_inject_crash_flush_delay", Option::TYPE_INT, Option::LEVEL_DEV)
3181     .set_default(2)
3182     .set_description(""),
3183
3184     Option("bdev_aio", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3185     .set_default(true)
3186     .set_description(""),
3187
3188     Option("bdev_aio_poll_ms", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3189     .set_default(250)
3190     .set_description(""),
3191
3192     Option("bdev_aio_max_queue_depth", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3193     .set_default(1024)
3194     .set_description(""),
3195
3196     Option("bdev_aio_reap_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3197     .set_default(16)
3198     .set_description(""),
3199
3200     Option("bdev_block_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3201     .set_default(4_K)
3202     .set_description(""),
3203
3204     Option("bdev_debug_aio", Option::TYPE_BOOL, Option::LEVEL_DEV)
3205     .set_default(false)
3206     .set_description(""),
3207
3208     Option("bdev_debug_aio_suicide_timeout", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3209     .set_default(60.0)
3210     .set_description(""),
3211
3212     Option("bdev_nvme_unbind_from_kernel", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3213     .set_default(false)
3214     .set_description(""),
3215
3216     Option("bdev_nvme_retry_count", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3217     .set_default(-1)
3218     .set_description(""),
3219
3220     Option("bluefs_alloc_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3221     .set_default(1_M)
3222     .set_description(""),
3223
3224     Option("bluefs_max_prefetch", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3225     .set_default(1_M)
3226     .set_description(""),
3227
3228     Option("bluefs_min_log_runway", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3229     .set_default(1_M)
3230     .set_description(""),
3231
3232     Option("bluefs_max_log_runway", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3233     .set_default(4194304)
3234     .set_description(""),
3235
3236     Option("bluefs_log_compact_min_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3237     .set_default(5.0)
3238     .set_description(""),
3239
3240     Option("bluefs_log_compact_min_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3241     .set_default(16_M)
3242     .set_description(""),
3243
3244     Option("bluefs_min_flush_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3245     .set_default(512_K)
3246     .set_description(""),
3247
3248     Option("bluefs_compact_log_sync", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3249     .set_default(false)
3250     .set_description(""),
3251
3252     Option("bluefs_buffered_io", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3253     .set_default(false)
3254     .set_description(""),
3255
3256     Option("bluefs_sync_write", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3257     .set_default(false)
3258     .set_description(""),
3259
3260     Option("bluefs_allocator", Option::TYPE_STR, Option::LEVEL_DEV)
3261     .set_default("stupid")
3262     .set_description(""),
3263
3264     Option("bluefs_preextend_wal_files", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3265     .set_default(false)
3266     .set_description(""),
3267
3268     Option("bluestore_bluefs", Option::TYPE_BOOL, Option::LEVEL_DEV)
3269     .set_default(true)
3270     .add_tag("mkfs")
3271     .set_description("Use BlueFS to back rocksdb")
3272     .set_long_description("BlueFS allows rocksdb to share the same physical device(s) as the rest of BlueStore.  It should be used in all cases unless testing/developing an alternative metadata database for BlueStore."),
3273
3274     Option("bluestore_bluefs_env_mirror", Option::TYPE_BOOL, Option::LEVEL_DEV)
3275     .set_default(false)
3276     .add_tag("mkfs")
3277     .set_description("Mirror bluefs data to file system for testing/validation"),
3278
3279     Option("bluestore_bluefs_min", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3280     .set_default(1_G)
3281     .set_description("minimum disk space allocated to BlueFS (e.g., at mkfs)"),
3282
3283     Option("bluestore_bluefs_min_free", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3284     .set_default(1*1024*1024*1024)
3285     .set_description("minimum free space allocated to BlueFS"),
3286
3287     Option("bluestore_bluefs_min_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3288     .set_default(.02)
3289     .set_description("Minimum fraction of free space devoted to BlueFS"),
3290
3291     Option("bluestore_bluefs_max_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3292     .set_default(.90)
3293     .set_description("Maximum fraction of free storage devoted to BlueFS"),
3294
3295     Option("bluestore_bluefs_gift_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3296     .set_default(.02)
3297     .set_description("Maximum fraction of free space to give to BlueFS at once"),
3298
3299     Option("bluestore_bluefs_reclaim_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3300     .set_default(.20)
3301     .set_description("Maximum fraction of free space to reclaim from BlueFS at once"),
3302
3303     Option("bluestore_bluefs_balance_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3304     .set_default(1)
3305     .set_description("How frequently (in seconds) to balance free space between BlueFS and BlueStore"),
3306
3307     Option("bluestore_spdk_mem", Option::TYPE_UINT, Option::LEVEL_DEV)
3308     .set_default(512)
3309     .set_description(""),
3310
3311     Option("bluestore_spdk_coremask", Option::TYPE_STR, Option::LEVEL_DEV)
3312     .set_default("0x3")
3313     .set_description(""),
3314
3315     Option("bluestore_spdk_max_io_completion", Option::TYPE_UINT, Option::LEVEL_DEV)
3316     .set_default(0)
3317     .set_description(""),
3318
3319     Option("bluestore_block_path", Option::TYPE_STR, Option::LEVEL_DEV)
3320     .set_default("")
3321     .add_tag("mkfs")
3322     .set_description("Path to block device/file"),
3323
3324     Option("bluestore_block_size", Option::TYPE_UINT, Option::LEVEL_DEV)
3325     .set_default(10_G)
3326     .add_tag("mkfs")
3327     .set_description("Size of file to create for backing bluestore"),
3328
3329     Option("bluestore_block_create", Option::TYPE_BOOL, Option::LEVEL_DEV)
3330     .set_default(true)
3331     .add_tag("mkfs")
3332     .set_description("Create bluestore_block_path if it doesn't exist")
3333     .add_see_also("bluestore_block_path").add_see_also("bluestore_block_size"),
3334
3335     Option("bluestore_block_db_path", Option::TYPE_STR, Option::LEVEL_DEV)
3336     .set_default("")
3337     .add_tag("mkfs")
3338     .set_description("Path for db block device"),
3339
3340     Option("bluestore_block_db_size", Option::TYPE_UINT, Option::LEVEL_DEV)
3341     .set_default(0)
3342     .add_tag("mkfs")
3343     .set_description("Size of file to create for bluestore_block_db_path"),
3344
3345     Option("bluestore_block_db_create", Option::TYPE_BOOL, Option::LEVEL_DEV)
3346     .set_default(false)
3347     .add_tag("mkfs")
3348     .set_description("Create bluestore_block_db_path if it doesn't exist")
3349     .add_see_also("bluestore_block_db_path")
3350     .add_see_also("bluestore_block_db_size"),
3351
3352     Option("bluestore_block_wal_path", Option::TYPE_STR, Option::LEVEL_DEV)
3353     .set_default("")
3354     .add_tag("mkfs")
3355     .set_description("Path to block device/file backing bluefs wal"),
3356
3357     Option("bluestore_block_wal_size", Option::TYPE_UINT, Option::LEVEL_DEV)
3358     .set_default(96_M)
3359     .add_tag("mkfs")
3360     .set_description("Size of file to create for bluestore_block_wal_path"),
3361
3362     Option("bluestore_block_wal_create", Option::TYPE_BOOL, Option::LEVEL_DEV)
3363     .set_default(false)
3364     .add_tag("mkfs")
3365     .set_description("Create bluestore_block_wal_path if it doesn't exist")
3366     .add_see_also("bluestore_block_wal_path")
3367     .add_see_also("bluestore_block_wal_size"),
3368
3369     Option("bluestore_block_preallocate_file", Option::TYPE_BOOL, Option::LEVEL_DEV)
3370     .set_default(false)
3371     .add_tag("mkfs")
3372     .set_description("Preallocate file created via bluestore_block*_create"),
3373
3374     Option("bluestore_csum_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3375     .set_default("crc32c")
3376     .set_enum_allowed({"none", "crc32c", "crc32c_16", "crc32c_8", "xxhash32", "xxhash64"})
3377     .set_safe()
3378     .set_description("Default checksum algorithm to use")
3379     .set_long_description("crc32c, xxhash32, and xxhash64 are available.  The _16 and _8 variants use only a subset of the bits for more compact (but less reliable) checksumming."),
3380
3381     Option("bluestore_csum_min_block", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3382     .set_default(4096)
3383     .set_safe()
3384     .set_description("Minimum block size to checksum")
3385     .set_long_description("A larger checksum block means less checksum metadata to store, but results in read amplification when doing a read smaller than this size (because the entire block must be read to verify the checksum).")
3386     .add_see_also("bluestore_csum_max_block"),
3387
3388     Option("bluestore_csum_max_block", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3389     .set_default(64_K)
3390     .set_safe()
3391     .set_description("Maximum block size to checksum")
3392     .add_see_also("bluestore_csum_min_block"),
3393
3394     Option("bluestore_min_alloc_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3395     .set_default(0)
3396     .add_tag("mkfs")
3397     .set_description("Minimum allocation size to allocate for an object")
3398     .set_long_description("A smaller allocation size generally means less data is read and then rewritten when a copy-on-write operation is triggered (e.g., when writing to something that was recently snapshotted).  Similarly, less data is journaled before performing an overwrite (writes smaller than min_alloc_size must first pass through the BlueStore journal).  Larger values of min_alloc_size reduce the amount of metadata required to describe the on-disk layout and reduce overall fragmentation."),
3399
3400     Option("bluestore_min_alloc_size_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3401     .set_default(64_K)
3402     .add_tag("mkfs")
3403     .set_description("Default min_alloc_size value for rotational media"),
3404
3405     Option("bluestore_min_alloc_size_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3406     .set_default(16_K)
3407     .add_tag("mkfs")
3408     .set_description("Default min_alloc_size value for non-rotational (solid state)  media"),
3409
3410     Option("bluestore_max_alloc_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3411     .set_default(0)
3412     .add_tag("mkfs")
3413     .set_description("Maximum size of a single allocation (0 for no max)"),
3414
3415     Option("bluestore_prefer_deferred_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3416     .set_default(0)
3417     .set_safe()
3418     .set_description("Writes smaller than this size will be written to the journal and then asynchronously written to the device.  This can be beneficial when using rotational media where seeks are expensive, and is helpful both with and without solid state journal/wal devices."),
3419
3420     Option("bluestore_prefer_deferred_size_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3421     .set_default(32768)
3422     .set_safe()
3423     .set_description("Default bluestore_prefer_deferred_size for rotational media"),
3424
3425     Option("bluestore_prefer_deferred_size_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3426     .set_default(0)
3427     .set_safe()
3428     .set_description("Default bluestore_prefer_deferred_size for non-rotational (solid state) media"),
3429
3430     Option("bluestore_compression_mode", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3431     .set_default("none")
3432     .set_enum_allowed({"none", "passive", "aggressive", "force"})
3433     .set_safe()
3434     .set_description("Default policy for using compression when pool does not specify")
3435     .set_long_description("'none' means never use compression.  'passive' means use compression when clients hint that data is compressible.  'aggressive' means use compression unless clients hint that data is not compressible.  This option is used when the per-pool property for the compression mode is not present."),
3436
3437     Option("bluestore_compression_algorithm", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3438     .set_default("snappy")
3439     .set_enum_allowed({"", "snappy", "zlib", "zstd", "lz4"})
3440     .set_safe()
3441     .set_description("Default compression algorithm to use when writing object data")
3442     .set_long_description("This controls the default compressor to use (if any) if the per-pool property is not set.  Note that zstd is *not* recommended for bluestore due to high CPU overhead when compressing small amounts of data."),
3443
3444     Option("bluestore_compression_min_blob_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3445     .set_default(0)
3446     .set_safe()
3447     .set_description("Chunks smaller than this are never compressed"),
3448
3449     Option("bluestore_compression_min_blob_size_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3450     .set_default(128_K)
3451     .set_safe()
3452     .set_description("Default value of bluestore_compression_min_blob_size for rotational media"),
3453
3454     Option("bluestore_compression_min_blob_size_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3455     .set_default(8_K)
3456     .set_safe()
3457     .set_description("Default value of bluestore_compression_min_blob_size for non-rotational (solid state) media"),
3458
3459     Option("bluestore_compression_max_blob_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3460     .set_default(0)
3461     .set_safe()
3462     .set_description("Chunks larger than this are broken into smaller chunks before being compressed"),
3463
3464     Option("bluestore_compression_max_blob_size_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3465     .set_default(512_K)
3466     .set_safe()
3467     .set_description("Default value of bluestore_compression_max_blob_size for rotational media"),
3468
3469     Option("bluestore_compression_max_blob_size_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3470     .set_default(64_K)
3471     .set_safe()
3472     .set_description("Default value of bluestore_compression_max_blob_size for non-rotational (solid state) media"),
3473
3474     Option("bluestore_gc_enable_blob_threshold", Option::TYPE_INT, Option::LEVEL_DEV)
3475     .set_default(0)
3476     .set_safe()
3477     .set_description(""),
3478
3479     Option("bluestore_gc_enable_total_threshold", Option::TYPE_INT, Option::LEVEL_DEV)
3480     .set_default(0)
3481     .set_safe()
3482     .set_description(""),
3483
3484     Option("bluestore_max_blob_size", Option::TYPE_UINT, Option::LEVEL_DEV)
3485     .set_default(0)
3486     .set_safe()
3487     .set_description(""),
3488
3489     Option("bluestore_max_blob_size_hdd", Option::TYPE_UINT, Option::LEVEL_DEV)
3490     .set_default(512_K)
3491     .set_safe()
3492     .set_description(""),
3493
3494     Option("bluestore_max_blob_size_ssd", Option::TYPE_UINT, Option::LEVEL_DEV)
3495     .set_default(64_K)
3496     .set_safe()
3497     .set_description(""),
3498
3499     Option("bluestore_compression_required_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3500     .set_default(.875)
3501     .set_safe()
3502     .set_description("Compression ratio required to store compressed data")
3503     .set_long_description("If we compress data and get less than this we discard the result and store the original uncompressed data."),
3504
3505     Option("bluestore_extent_map_shard_max_size", Option::TYPE_UINT, Option::LEVEL_DEV)
3506     .set_default(1200)
3507     .set_description("Max size (bytes) for a single extent map shard before splitting"),
3508
3509     Option("bluestore_extent_map_shard_target_size", Option::TYPE_UINT, Option::LEVEL_DEV)
3510     .set_default(500)
3511     .set_description("Target size (bytes) for a single extent map shard"),
3512
3513     Option("bluestore_extent_map_shard_min_size", Option::TYPE_UINT, Option::LEVEL_DEV)
3514     .set_default(150)
3515     .set_description("Min size (bytes) for a single extent map shard before merging"),
3516
3517     Option("bluestore_extent_map_shard_target_size_slop", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3518     .set_default(.2)
3519     .set_description("Ratio above/below target for a shard when trying to align to an existing extent or blob boundary"),
3520
3521     Option("bluestore_extent_map_inline_shard_prealloc_size", Option::TYPE_UINT, Option::LEVEL_DEV)
3522     .set_default(256)
3523     .set_description("Preallocated buffer for inline shards"),
3524
3525     Option("bluestore_cache_trim_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3526     .set_default(.05)
3527     .set_description("How frequently we trim the bluestore cache"),
3528
3529     Option("bluestore_cache_trim_max_skip_pinned", Option::TYPE_UINT, Option::LEVEL_DEV)
3530     .set_default(64)
3531     .set_description("Max pinned cache entries we consider before giving up"),
3532
3533     Option("bluestore_cache_type", Option::TYPE_STR, Option::LEVEL_DEV)
3534     .set_default("2q")
3535     .set_enum_allowed({"2q", "lru"})
3536     .set_description("Cache replacement algorithm"),
3537
3538     Option("bluestore_2q_cache_kin_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3539     .set_default(.5)
3540     .set_description("2Q paper suggests .5"),
3541
3542     Option("bluestore_2q_cache_kout_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3543     .set_default(.5)
3544     .set_description("2Q paper suggests .5"),
3545
3546     Option("bluestore_cache_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3547     .set_default(0)
3548     .set_description("Cache size (in bytes) for BlueStore")
3549     .set_long_description("This includes data and metadata cached by BlueStore as well as memory devoted to rocksdb's cache(s)."),
3550
3551     Option("bluestore_cache_size_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3552     .set_default(1_G)
3553     .set_description("Default bluestore_cache_size for rotational media"),
3554
3555     Option("bluestore_cache_size_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3556     .set_default(3_G)
3557     .set_description("Default bluestore_cache_size for non-rotational (solid state) media"),
3558
3559     Option("bluestore_cache_meta_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3560     .set_default(.01)
3561     .set_description("Ratio of bluestore cache to devote to metadata"),
3562
3563     Option("bluestore_cache_kv_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3564     .set_default(.99)
3565     .set_description("Ratio of bluestore cache to devote to kv database (rocksdb)"),
3566
3567     Option("bluestore_cache_kv_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3568     .set_default(512_M)
3569     .set_description("Max memory (bytes) to devote to kv database (rocksdb)")
3570     .set_long_description("A negative value means using bluestore_cache_meta_ratio "
3571       "and bluestore_cache_kv_ratio instead of calculating these ratios using "
3572       "bluestore_cache_size_* and bluestore_cache_kv_max."),
3573
3574     Option("bluestore_kvbackend", Option::TYPE_STR, Option::LEVEL_DEV)
3575     .set_default("rocksdb")
3576     .add_tag("mkfs")
3577     .set_description("Key value database to use for bluestore"),
3578
3579     Option("bluestore_allocator", Option::TYPE_STR, Option::LEVEL_DEV)
3580     .set_default("stupid")
3581     .set_enum_allowed({"bitmap", "stupid"})
3582     .set_description("Allocator policy"),
3583
3584     Option("bluestore_freelist_blocks_per_key", Option::TYPE_INT, Option::LEVEL_DEV)
3585     .set_default(128)
3586     .set_description("Block (and bits) per database key"),
3587
3588     Option("bluestore_bitmapallocator_blocks_per_zone", Option::TYPE_INT, Option::LEVEL_DEV)
3589     .set_default(1024)
3590     .set_description(""),
3591
3592     Option("bluestore_bitmapallocator_span_size", Option::TYPE_INT, Option::LEVEL_DEV)
3593     .set_default(1024)
3594     .set_description(""),
3595
3596     Option("bluestore_max_deferred_txc", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3597     .set_default(32)
3598     .set_description("Max transactions with deferred writes that can accumulate before we force flush deferred writes"),
3599
3600     Option("bluestore_rocksdb_options", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3601     .set_default("compression=kNoCompression,max_write_buffer_number=4,min_write_buffer_number_to_merge=1,recycle_log_file_num=4,write_buffer_size=268435456,writable_file_max_buffer_size=0,compaction_readahead_size=2097152")
3602     .set_description("Rocksdb options"),
3603
3604     Option("bluestore_fsck_on_mount", Option::TYPE_BOOL, Option::LEVEL_DEV)
3605     .set_default(false)
3606     .set_description("Run fsck at mount"),
3607
3608     Option("bluestore_fsck_on_mount_deep", Option::TYPE_BOOL, Option::LEVEL_DEV)
3609     .set_default(true)
3610     .set_description("Run deep fsck at mount"),
3611
3612     Option("bluestore_fsck_on_umount", Option::TYPE_BOOL, Option::LEVEL_DEV)
3613     .set_default(false)
3614     .set_description("Run fsck at umount"),
3615
3616     Option("bluestore_fsck_on_umount_deep", Option::TYPE_BOOL, Option::LEVEL_DEV)
3617     .set_default(true)
3618     .set_description("Run deep fsck at umount"),
3619
3620     Option("bluestore_fsck_on_mkfs", Option::TYPE_BOOL, Option::LEVEL_DEV)
3621     .set_default(true)
3622     .set_description("Run fsck after mkfs"),
3623
3624     Option("bluestore_fsck_on_mkfs_deep", Option::TYPE_BOOL, Option::LEVEL_DEV)
3625     .set_default(false)
3626     .set_description("Run deep fsck after mkfs"),
3627
3628     Option("bluestore_sync_submit_transaction", Option::TYPE_BOOL, Option::LEVEL_DEV)
3629     .set_default(false)
3630     .set_description("Try to submit metadata transaction to rocksdb in queuing thread context"),
3631
3632     Option("bluestore_throttle_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3633     .set_default(64_M)
3634     .set_safe()
3635     .set_description("Maximum bytes in flight before we throttle IO submission"),
3636
3637     Option("bluestore_throttle_deferred_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3638     .set_default(128_M)
3639     .set_safe()
3640     .set_description("Maximum bytes for deferred writes before we throttle IO submission"),
3641
3642     Option("bluestore_throttle_cost_per_io", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3643     .set_default(0)
3644     .set_safe()
3645     .set_description("Overhead added to transaction cost (in bytes) for each IO"),
3646
3647   Option("bluestore_throttle_cost_per_io_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3648     .set_default(670000)
3649     .set_safe()
3650     .set_description("Default bluestore_throttle_cost_per_io for rotational media"),
3651
3652     Option("bluestore_throttle_cost_per_io_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3653     .set_default(4000)
3654     .set_safe()
3655     .set_description("Default bluestore_throttle_cost_per_io for non-rotation (solid state) media"),
3656
3657
3658     Option("bluestore_deferred_batch_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3659     .set_default(0)
3660     .set_safe()
3661     .set_description("Max number of deferred writes before we flush the deferred write queue"),
3662
3663     Option("bluestore_deferred_batch_ops_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3664     .set_default(64)
3665     .set_safe()
3666     .set_description("Default bluestore_deferred_batch_ops for rotational media"),
3667
3668     Option("bluestore_deferred_batch_ops_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3669     .set_default(16)
3670     .set_safe()
3671     .set_description("Default bluestore_deferred_batch_ops for non-rotational (solid state) media"),
3672
3673     Option("bluestore_nid_prealloc", Option::TYPE_INT, Option::LEVEL_DEV)
3674     .set_default(1024)
3675     .set_description("Number of unique object ids to preallocate at a time"),
3676
3677     Option("bluestore_blobid_prealloc", Option::TYPE_UINT, Option::LEVEL_DEV)
3678     .set_default(10240)
3679     .set_description("Number of unique blob ids to preallocate at a time"),
3680
3681     Option("bluestore_clone_cow", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3682     .set_default(true)
3683     .set_safe()
3684     .set_description("Use copy-on-write when cloning objects (versus reading and rewriting them at clone time)"),
3685
3686     Option("bluestore_default_buffered_read", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3687     .set_default(true)
3688     .set_safe()
3689     .set_description("Cache read results by default (unless hinted NOCACHE or WONTNEED)"),
3690
3691     Option("bluestore_default_buffered_write", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3692     .set_default(false)
3693     .set_safe()
3694     .set_description("Cache writes by default (unless hinted NOCACHE or WONTNEED)"),
3695
3696     Option("bluestore_debug_misc", Option::TYPE_BOOL, Option::LEVEL_DEV)
3697     .set_default(false)
3698     .set_description(""),
3699
3700     Option("bluestore_debug_no_reuse_blocks", Option::TYPE_BOOL, Option::LEVEL_DEV)
3701     .set_default(false)
3702     .set_description(""),
3703
3704     Option("bluestore_debug_small_allocations", Option::TYPE_INT, Option::LEVEL_DEV)
3705     .set_default(0)
3706     .set_description(""),
3707
3708     Option("bluestore_debug_freelist", Option::TYPE_BOOL, Option::LEVEL_DEV)
3709     .set_default(false)
3710     .set_description(""),
3711
3712     Option("bluestore_debug_prefill", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3713     .set_default(0)
3714     .set_description("simulate fragmentation"),
3715
3716     Option("bluestore_debug_prefragment_max", Option::TYPE_INT, Option::LEVEL_DEV)
3717     .set_default(1_M)
3718     .set_description(""),
3719
3720     Option("bluestore_debug_inject_read_err", Option::TYPE_BOOL, Option::LEVEL_DEV)
3721     .set_default(false)
3722     .set_description(""),
3723
3724     Option("bluestore_debug_randomize_serial_transaction", Option::TYPE_INT, Option::LEVEL_DEV)
3725     .set_default(0)
3726     .set_description(""),
3727
3728     Option("bluestore_debug_omit_block_device_write", Option::TYPE_BOOL, Option::LEVEL_DEV)
3729     .set_default(false)
3730     .set_description(""),
3731
3732     Option("bluestore_debug_fsck_abort", Option::TYPE_BOOL, Option::LEVEL_DEV)
3733     .set_default(false)
3734     .set_description(""),
3735
3736     Option("bluestore_debug_omit_kv_commit", Option::TYPE_BOOL, Option::LEVEL_DEV)
3737     .set_default(false)
3738     .set_description(""),
3739
3740     Option("bluestore_debug_permit_any_bdev_label", Option::TYPE_BOOL, Option::LEVEL_DEV)
3741     .set_default(false)
3742     .set_description(""),
3743
3744     Option("bluestore_shard_finishers", Option::TYPE_BOOL, Option::LEVEL_DEV)
3745     .set_default(false)
3746     .set_description(""),
3747
3748     Option("bluestore_debug_random_read_err", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3749     .set_default(0)
3750     .set_description(""),
3751
3752     // -----------------------------------------
3753     // kstore
3754
3755     Option("kstore_max_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3756     .set_default(512)
3757     .set_description(""),
3758
3759     Option("kstore_max_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3760     .set_default(64_M)
3761     .set_description(""),
3762
3763     Option("kstore_backend", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3764     .set_default("rocksdb")
3765     .set_description(""),
3766
3767     Option("kstore_rocksdb_options", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3768     .set_default("compression=kNoCompression")
3769     .set_description(""),
3770
3771     Option("kstore_fsck_on_mount", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3772     .set_default(false)
3773     .set_description(""),
3774
3775     Option("kstore_fsck_on_mount_deep", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3776     .set_default(true)
3777     .set_description(""),
3778
3779     Option("kstore_nid_prealloc", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3780     .set_default(1024)
3781     .set_description(""),
3782
3783     Option("kstore_sync_transaction", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3784     .set_default(false)
3785     .set_description(""),
3786
3787     Option("kstore_sync_submit_transaction", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3788     .set_default(false)
3789     .set_description(""),
3790
3791     Option("kstore_onode_map_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3792     .set_default(1024)
3793     .set_description(""),
3794
3795     Option("kstore_default_stripe_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3796     .set_default(65536)
3797     .set_description(""),
3798
3799     // ---------------------
3800     // filestore
3801
3802     Option("filestore_rocksdb_options", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3803     .set_default("max_background_compactions=8,compaction_readahead_size=2097152,compression=kNoCompression")
3804     .set_description(""),
3805
3806     Option("filestore_omap_backend", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3807     .set_default("rocksdb")
3808     .set_description(""),
3809
3810     Option("filestore_omap_backend_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3811     .set_default("")
3812     .set_description(""),
3813
3814     Option("filestore_wbthrottle_enable", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3815     .set_default(true)
3816     .set_description(""),
3817
3818     Option("filestore_wbthrottle_btrfs_bytes_start_flusher", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3819     .set_default(41943040)
3820     .set_description(""),
3821
3822     Option("filestore_wbthrottle_btrfs_bytes_hard_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3823     .set_default(419430400)
3824     .set_description(""),
3825
3826     Option("filestore_wbthrottle_btrfs_ios_start_flusher", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3827     .set_default(500)
3828     .set_description(""),
3829
3830     Option("filestore_wbthrottle_btrfs_ios_hard_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3831     .set_default(5000)
3832     .set_description(""),
3833
3834     Option("filestore_wbthrottle_btrfs_inodes_start_flusher", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3835     .set_default(500)
3836     .set_description(""),
3837
3838     Option("filestore_wbthrottle_xfs_bytes_start_flusher", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3839     .set_default(41943040)
3840     .set_description(""),
3841
3842     Option("filestore_wbthrottle_xfs_bytes_hard_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3843     .set_default(419430400)
3844     .set_description(""),
3845
3846     Option("filestore_wbthrottle_xfs_ios_start_flusher", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3847     .set_default(500)
3848     .set_description(""),
3849
3850     Option("filestore_wbthrottle_xfs_ios_hard_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3851     .set_default(5000)
3852     .set_description(""),
3853
3854     Option("filestore_wbthrottle_xfs_inodes_start_flusher", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3855     .set_default(500)
3856     .set_description(""),
3857
3858     Option("filestore_wbthrottle_btrfs_inodes_hard_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3859     .set_default(5000)
3860     .set_description(""),
3861
3862     Option("filestore_wbthrottle_xfs_inodes_hard_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3863     .set_default(5000)
3864     .set_description(""),
3865
3866     Option("filestore_odsync_write", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3867     .set_default(false)
3868     .set_description(""),
3869
3870     Option("filestore_index_retry_probability", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3871     .set_default(0)
3872     .set_description(""),
3873
3874     Option("filestore_debug_inject_read_err", Option::TYPE_BOOL, Option::LEVEL_DEV)
3875     .set_default(false)
3876     .set_description(""),
3877
3878     Option("filestore_debug_random_read_err", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3879     .set_default(0)
3880     .set_description(""),
3881
3882     Option("filestore_debug_omap_check", Option::TYPE_BOOL, Option::LEVEL_DEV)
3883     .set_default(false)
3884     .set_description(""),
3885
3886     Option("filestore_omap_header_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3887     .set_default(1024)
3888     .set_description(""),
3889
3890     Option("filestore_max_inline_xattr_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3891     .set_default(0)
3892     .set_description(""),
3893
3894     Option("filestore_max_inline_xattr_size_xfs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3895     .set_default(65536)
3896     .set_description(""),
3897
3898     Option("filestore_max_inline_xattr_size_btrfs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3899     .set_default(2048)
3900     .set_description(""),
3901
3902     Option("filestore_max_inline_xattr_size_other", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3903     .set_default(512)
3904     .set_description(""),
3905
3906     Option("filestore_max_inline_xattrs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3907     .set_default(0)
3908     .set_description(""),
3909
3910     Option("filestore_max_inline_xattrs_xfs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3911     .set_default(10)
3912     .set_description(""),
3913
3914     Option("filestore_max_inline_xattrs_btrfs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3915     .set_default(10)
3916     .set_description(""),
3917
3918     Option("filestore_max_inline_xattrs_other", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3919     .set_default(2)
3920     .set_description(""),
3921
3922     Option("filestore_max_xattr_value_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3923     .set_default(0)
3924     .set_description(""),
3925
3926     Option("filestore_max_xattr_value_size_xfs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3927     .set_default(64<<10)
3928     .set_description(""),
3929
3930     Option("filestore_max_xattr_value_size_btrfs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3931     .set_default(64<<10)
3932     .set_description(""),
3933
3934     Option("filestore_max_xattr_value_size_other", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3935     .set_default(1<<10)
3936     .set_description(""),
3937
3938     Option("filestore_sloppy_crc", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3939     .set_default(false)
3940     .set_description(""),
3941
3942     Option("filestore_sloppy_crc_block_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3943     .set_default(65536)
3944     .set_description(""),
3945
3946     Option("filestore_max_alloc_hint_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3947     .set_default(1ULL << 20)
3948     .set_description(""),
3949
3950     Option("filestore_max_sync_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3951     .set_default(5)
3952     .set_description(""),
3953
3954     Option("filestore_min_sync_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3955     .set_default(.01)
3956     .set_description(""),
3957
3958     Option("filestore_btrfs_snap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3959     .set_default(true)
3960     .set_description(""),
3961
3962     Option("filestore_btrfs_clone_range", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3963     .set_default(true)
3964     .set_description(""),
3965
3966     Option("filestore_zfs_snap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3967     .set_default(false)
3968     .set_description(""),
3969
3970     Option("filestore_fsync_flushes_journal_data", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3971     .set_default(false)
3972     .set_description(""),
3973
3974     Option("filestore_fiemap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3975     .set_default(false)
3976     .set_description(""),
3977
3978     Option("filestore_punch_hole", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3979     .set_default(false)
3980     .set_description(""),
3981
3982     Option("filestore_seek_data_hole", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3983     .set_default(false)
3984     .set_description(""),
3985
3986     Option("filestore_splice", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3987     .set_default(false)
3988     .set_description(""),
3989
3990     Option("filestore_fadvise", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3991     .set_default(true)
3992     .set_description(""),
3993
3994     Option("filestore_collect_device_partition_information", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3995     .set_default(true)
3996     .set_description(""),
3997
3998     Option("filestore_xfs_extsize", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3999     .set_default(false)
4000     .set_description(""),
4001
4002     Option("filestore_journal_parallel", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4003     .set_default(false)
4004     .set_description(""),
4005
4006     Option("filestore_journal_writeahead", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4007     .set_default(false)
4008     .set_description(""),
4009
4010     Option("filestore_journal_trailing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4011     .set_default(false)
4012     .set_description(""),
4013
4014     Option("filestore_queue_max_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4015     .set_default(50)
4016     .set_description(""),
4017
4018     Option("filestore_queue_max_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4019     .set_default(100 << 20)
4020     .set_description(""),
4021
4022     Option("filestore_caller_concurrency", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4023     .set_default(10)
4024     .set_description(""),
4025
4026     Option("filestore_expected_throughput_bytes", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4027     .set_default(200 << 20)
4028     .set_description(""),
4029
4030     Option("filestore_expected_throughput_ops", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4031     .set_default(200)
4032     .set_description(""),
4033
4034     Option("filestore_queue_max_delay_multiple", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4035     .set_default(0)
4036     .set_description(""),
4037
4038     Option("filestore_queue_high_delay_multiple", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4039     .set_default(0)
4040     .set_description(""),
4041
4042     Option("filestore_queue_low_threshhold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4043     .set_default(0.3)
4044     .set_description(""),
4045
4046     Option("filestore_queue_high_threshhold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4047     .set_default(0.9)
4048     .set_description(""),
4049
4050     Option("filestore_op_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4051     .set_default(2)
4052     .set_description(""),
4053
4054     Option("filestore_op_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4055     .set_default(60)
4056     .set_description(""),
4057
4058     Option("filestore_op_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4059     .set_default(180)
4060     .set_description(""),
4061
4062     Option("filestore_commit_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4063     .set_default(600)
4064     .set_description(""),
4065
4066     Option("filestore_fiemap_threshold", Option::TYPE_INT, Option::LEVEL_DEV)
4067     .set_default(4_K)
4068     .set_description(""),
4069
4070     Option("filestore_merge_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4071     .set_default(10)
4072     .set_description(""),
4073
4074     Option("filestore_split_multiple", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4075     .set_default(2)
4076     .set_description(""),
4077
4078     Option("filestore_split_rand_factor", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4079     .set_default(20)
4080     .set_description(""),
4081
4082     Option("filestore_update_to", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4083     .set_default(1000)
4084     .set_description(""),
4085
4086     Option("filestore_blackhole", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4087     .set_default(false)
4088     .set_description(""),
4089
4090     Option("filestore_fd_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4091     .set_default(128)
4092     .set_description(""),
4093
4094     Option("filestore_fd_cache_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4095     .set_default(16)
4096     .set_description(""),
4097
4098     Option("filestore_ondisk_finisher_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4099     .set_default(1)
4100     .set_description(""),
4101
4102     Option("filestore_apply_finisher_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4103     .set_default(1)
4104     .set_description(""),
4105
4106     Option("filestore_dump_file", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4107     .set_default("")
4108     .set_description(""),
4109
4110     Option("filestore_kill_at", Option::TYPE_INT, Option::LEVEL_DEV)
4111     .set_default(0)
4112     .set_description(""),
4113
4114     Option("filestore_inject_stall", Option::TYPE_INT, Option::LEVEL_DEV)
4115     .set_default(0)
4116     .set_description(""),
4117
4118     Option("filestore_fail_eio", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4119     .set_default(true)
4120     .set_description(""),
4121
4122     Option("filestore_debug_verify_split", Option::TYPE_BOOL, Option::LEVEL_DEV)
4123     .set_default(false)
4124     .set_description(""),
4125
4126     Option("journal_dio", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4127     .set_default(true)
4128     .set_description(""),
4129
4130     Option("journal_aio", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4131     .set_default(true)
4132     .set_description(""),
4133
4134     Option("journal_force_aio", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4135     .set_default(false)
4136     .set_description(""),
4137
4138     Option("journal_block_size", Option::TYPE_INT, Option::LEVEL_DEV)
4139     .set_default(4_K)
4140     .set_description(""),
4141
4142     Option("journal_max_corrupt_search", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4143     .set_default(10<<20)
4144     .set_description(""),
4145
4146     Option("journal_block_align", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4147     .set_default(true)
4148     .set_description(""),
4149
4150     Option("journal_write_header_frequency", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4151     .set_default(0)
4152     .set_description(""),
4153
4154     Option("journal_max_write_bytes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4155     .set_default(10 << 20)
4156     .set_description(""),
4157
4158     Option("journal_max_write_entries", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4159     .set_default(100)
4160     .set_description(""),
4161
4162     Option("journal_throttle_low_threshhold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4163     .set_default(0.6)
4164     .set_description(""),
4165
4166     Option("journal_throttle_high_threshhold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4167     .set_default(0.9)
4168     .set_description(""),
4169
4170     Option("journal_throttle_high_multiple", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4171     .set_default(0)
4172     .set_description(""),
4173
4174     Option("journal_throttle_max_multiple", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4175     .set_default(0)
4176     .set_description(""),
4177
4178     Option("journal_align_min_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4179     .set_default(64 << 10)
4180     .set_description(""),
4181
4182     Option("journal_replay_from", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4183     .set_default(0)
4184     .set_description(""),
4185
4186   Option("mgr_stats_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4187   .set_default((int64_t)PerfCountersBuilder::PRIO_USEFUL)
4188   .set_description("Lowest perfcounter priority collected by mgr")
4189   .set_long_description("Daemons only set perf counter data to the manager "
4190     "daemon if the counter has a priority higher than this.")
4191   .set_min_max((int64_t)PerfCountersBuilder::PRIO_DEBUGONLY,
4192                (int64_t)PerfCountersBuilder::PRIO_CRITICAL),
4193
4194     Option("journal_zero_on_create", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4195     .set_default(false)
4196     .set_description(""),
4197
4198     Option("journal_ignore_corruption", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4199     .set_default(false)
4200     .set_description(""),
4201
4202     Option("journal_discard", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4203     .set_default(false)
4204     .set_description(""),
4205
4206     Option("fio_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4207     .set_default("/tmp/fio")
4208     .set_description(""),
4209
4210     Option("rados_mon_op_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4211     .set_default(0)
4212     .set_description(""),
4213
4214     Option("rados_osd_op_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4215     .set_default(0)
4216     .set_description(""),
4217
4218     Option("rados_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4219     .set_default(false)
4220     .set_description(""),
4221
4222     Option("nss_db_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4223     .set_default("")
4224     .set_description(""),
4225
4226     Option("mgr_module_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4227     .set_default(CEPH_PKGLIBDIR "/mgr")
4228     .add_service("mgr")
4229     .set_description("Filesystem path to manager modules."),
4230
4231     Option("mgr_initial_modules", Option::TYPE_STR, Option::LEVEL_BASIC)
4232     .set_default("restful status balancer")
4233     .add_service("mon")
4234     .set_description("List of manager modules to enable when the cluster is "
4235                      "first started")
4236     .set_long_description("This list of module names is read by the monitor "
4237         "when the cluster is first started after installation, to populate "
4238         "the list of enabled manager modules.  Subsequent updates are done using "
4239         "the 'mgr module [enable|disable]' commands.  List may be comma "
4240         "or space separated."),
4241
4242     Option("mgr_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4243     .set_default("/var/lib/ceph/mgr/$cluster-$id")
4244     .add_service("mgr")
4245     .set_description("Filesystem path to the ceph-mgr data directory, used to "
4246                      "contain keyring."),
4247
4248     Option("mgr_tick_period", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4249     .set_default(2)
4250     .add_service("mgr")
4251     .set_description("Period in seconds of beacon messages to monitor"),
4252
4253     Option("mgr_stats_period", Option::TYPE_INT, Option::LEVEL_BASIC)
4254     .set_default(5)
4255     .add_service("mgr")
4256     .set_description("Period in seconds of OSD/MDS stats reports to manager")
4257     .set_long_description("Use this setting to control the granularity of "
4258                           "time series data collection from daemons.  Adjust "
4259                           "upwards if the manager CPU load is too high, or "
4260                           "if you simply do not require the most up to date "
4261                           "performance counter data."),
4262
4263     Option("mgr_client_bytes", Option::TYPE_UINT, Option::LEVEL_DEV)
4264     .set_default(128_M)
4265     .add_service("mgr"),
4266
4267     Option("mgr_client_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
4268     .set_default(512)
4269     .add_service("mgr"),
4270
4271     Option("mgr_osd_bytes", Option::TYPE_UINT, Option::LEVEL_DEV)
4272     .set_default(512_M)
4273     .add_service("mgr"),
4274
4275     Option("mgr_osd_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
4276     .set_default(8192)
4277     .add_service("mgr"),
4278
4279     Option("mgr_mds_bytes", Option::TYPE_UINT, Option::LEVEL_DEV)
4280     .set_default(128_M)
4281     .add_service("mgr"),
4282
4283     Option("mgr_mds_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
4284     .set_default(128)
4285     .add_service("mgr"),
4286
4287     Option("mgr_mon_bytes", Option::TYPE_UINT, Option::LEVEL_DEV)
4288     .set_default(128_M)
4289     .add_service("mgr"),
4290
4291     Option("mgr_mon_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
4292     .set_default(128)
4293     .add_service("mgr"),
4294
4295     Option("mgr_connect_retry_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4296     .set_default(1.0)
4297     .add_service("common"),
4298
4299     Option("mgr_service_beacon_grace", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4300     .set_default(60.0)
4301     .add_service("mgr")
4302     .set_description("Period in seconds from last beacon to manager dropping "
4303                      "state about a monitored service (RGW, rbd-mirror etc)"),
4304
4305     Option("mon_mgr_digest_period", Option::TYPE_INT, Option::LEVEL_DEV)
4306     .set_default(5)
4307     .add_service("mon")
4308     .set_description("Period in seconds between monitor-to-manager "
4309                      "health/status updates"),
4310
4311     Option("mon_mgr_beacon_grace", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4312     .set_default(30)
4313     .add_service("mon")
4314     .set_description("Period in seconds from last beacon to monitor marking "
4315                      "a manager daemon as failed"),
4316
4317     Option("mon_mgr_inactive_grace", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4318     .set_default(60)
4319     .add_service("mon")
4320     .set_description("Period in seconds after cluster creation during which "
4321                      "cluster may have no active manager")
4322     .set_long_description("This grace period enables the cluster to come "
4323                           "up cleanly without raising spurious health check "
4324                           "failures about managers that aren't online yet"),
4325
4326     Option("mon_mgr_mkfs_grace", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4327     .set_default(60)
4328     .add_service("mon")
4329     .set_description("Period in seconds that the cluster may have no active "
4330                      "manager before this is reported as an ERR rather than "
4331                      "a WARN"),
4332
4333     Option("mutex_perf_counter", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4334     .set_default(false)
4335     .set_description(""),
4336
4337     Option("throttler_perf_counter", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4338     .set_default(true)
4339     .set_description(""),
4340
4341     Option("event_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4342     .set_default(false)
4343     .set_description(""),
4344
4345     Option("internal_safe_to_start_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4346     .set_default(false)
4347     .set_description(""),
4348
4349     Option("debug_deliberately_leak_memory", Option::TYPE_BOOL, Option::LEVEL_DEV)
4350     .set_default(false)
4351     .set_description(""),
4352
4353     Option("debug_asserts_on_shutdown", Option::TYPE_BOOL,Option::LEVEL_DEV)
4354     .set_default(false)
4355     .set_description("Enable certain asserts to check for refcounting bugs on shutdown; see http://tracker.ceph.com/issues/21738"),
4356   });
4357 }
4358
4359 std::vector<Option> get_rgw_options() {
4360   return std::vector<Option>({
4361     Option("rgw_acl_grants_max_num", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4362     .set_default(100)
4363     .set_description("Max number of ACL grants in a single request"),
4364
4365     Option("rgw_max_chunk_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4366     .set_default(4_M)
4367     .set_description("Set RGW max chunk size")
4368     .set_long_description(
4369         "The chunk size is the size of RADOS I/O requests that RGW sends when accessing "
4370         "data objects. RGW read and write operation will never request more than this amount "
4371         "in a single request. This also defines the rgw object head size, as head operations "
4372         "need to be atomic, and anything larger than this would require more than a single "
4373         "operation."),
4374
4375     Option("rgw_put_obj_min_window_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4376     .set_default(16_M)
4377     .set_description("The minimum RADOS write window size (in bytes).")
4378     .set_long_description(
4379         "The window size determines the total concurrent RADOS writes of a single rgw object. "
4380         "When writing an object RGW will send multiple chunks to RADOS. The total size of the "
4381         "writes does not exceed the window size. The window size can be automatically "
4382         "in order to better utilize the pipe.")
4383     .add_see_also({"rgw_put_obj_max_window_size", "rgw_max_chunk_size"}),
4384
4385     Option("rgw_put_obj_max_window_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4386     .set_default(64_M)
4387     .set_description("The maximum RADOS write window size (in bytes).")
4388     .set_long_description("The window size may be dynamically adjusted, but will not surpass this value.")
4389     .add_see_also({"rgw_put_obj_min_window_size", "rgw_max_chunk_size"}),
4390
4391     Option("rgw_max_put_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4392     .set_default(5_G)
4393     .set_description("Max size (in bytes) of regular (non multi-part) object upload.")
4394     .set_long_description(
4395         "Plain object upload is capped at this amount of data. In order to upload larger "
4396         "objects, a special upload mechanism is required. The S3 API provides the "
4397         "multi-part upload, and Swift provides DLO and SLO."),
4398
4399     Option("rgw_max_put_param_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4400     .set_default(1_M)
4401     .set_description("The maximum size (in bytes) of data input of certain RESTful requests."),
4402
4403     Option("rgw_max_attr_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4404     .set_default(0)
4405     .set_description("The maximum length of metadata value. 0 skips the check"),
4406
4407     Option("rgw_max_attr_name_len", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4408     .set_default(0)
4409     .set_description("The maximum length of metadata name. 0 skips the check"),
4410
4411     Option("rgw_max_attrs_num_in_req", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4412     .set_default(0)
4413     .set_description("The maximum number of metadata items that can be put via single request"),
4414
4415     Option("rgw_override_bucket_index_max_shards", Option::TYPE_UINT, Option::LEVEL_DEV)
4416     .set_default(0)
4417     .set_description(""),
4418
4419     Option("rgw_bucket_index_max_aio", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4420     .set_default(8)
4421     .set_description("Max number of concurrent RADOS requests when handling bucket shards."),
4422
4423     Option("rgw_enable_quota_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4424     .set_default(true)
4425     .set_description("Enables the quota maintenance thread.")
4426     .set_long_description(
4427         "The quota maintenance thread is responsible for quota related maintenance work. "
4428         "The thread itself can be disabled, but in order for quota to work correctly, at "
4429         "least one RGW in each zone needs to have this thread running. Having the thread "
4430         "enabled on multiple RGW processes within the same zone can spread "
4431         "some of the maintenance work between them.")
4432     .add_see_also({"rgw_enable_gc_threads", "rgw_enable_lc_threads"}),
4433
4434     Option("rgw_enable_gc_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4435     .set_default(true)
4436     .set_description("Enables the garbage collection maintenance thread.")
4437     .set_long_description(
4438         "The garbage collection maintenance thread is responsible for garbage collector "
4439         "maintenance work. The thread itself can be disabled, but in order for garbage "
4440         "collection to work correctly, at least one RGW in each zone needs to have this "
4441         "thread running.  Having the thread enabled on multiple RGW processes within the "
4442         "same zone can spread some of the maintenance work between them.")
4443     .add_see_also({"rgw_enable_quota_threads", "rgw_enable_lc_threads"}),
4444
4445     Option("rgw_enable_lc_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4446     .set_default(true)
4447     .set_description("Enables the lifecycle maintenance thread. This is required on at least on rgw for each zone.")
4448     .set_long_description(
4449         "The lifecycle maintenance thread is responsible for lifecycle related maintenance "
4450         "work. The thread itself can be disabled, but in order for lifecycle to work "
4451         "correctly, at least one RGW in each zone needs to have this thread running. Having"
4452         "the thread enabled on multiple RGW processes within the same zone can spread "
4453         "some of the maintenance work between them.")
4454     .add_see_also({"rgw_enable_gc_threads", "rgw_enable_quota_threads"}),
4455
4456     Option("rgw_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4457     .set_default("/var/lib/ceph/radosgw/$cluster-$id")
4458     .set_description("Alternative location for RGW configuration.")
4459     .set_long_description(
4460         "If this is set, the different Ceph system configurables (such as the keyring file "
4461         "will be located in the path that is specified here. "),
4462
4463     Option("rgw_enable_apis", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4464     .set_default("s3, s3website, swift, swift_auth, admin")
4465     .set_description("A list of set of RESTful APIs that rgw handles."),
4466
4467     Option("rgw_cache_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4468     .set_default(true)
4469     .set_description("Enable RGW metadata cache.")
4470     .set_long_description(
4471         "The metadata cache holds metadata entries that RGW requires for processing "
4472         "requests. Metadata entries can be user info, bucket info, and bucket instance "
4473         "info. If not found in the cache, entries will be fetched from the backing "
4474         "RADOS store.")
4475     .add_see_also("rgw_cache_lru_size"),
4476
4477     Option("rgw_cache_lru_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4478     .set_default(10000)
4479     .set_description("Max number of items in RGW metadata cache.")
4480     .set_long_description(
4481         "When full, the RGW metadata cache evicts least recently used entries.")
4482     .add_see_also("rgw_cache_enabled"),
4483
4484     Option("rgw_socket_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4485     .set_default("")
4486     .set_description("RGW FastCGI socket path (for FastCGI over Unix domain sockets).")
4487     .add_see_also("rgw_fcgi_socket_backlog"),
4488
4489     Option("rgw_host", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4490     .set_default("")
4491     .set_description("RGW FastCGI host name (for FastCGI over TCP)")
4492     .add_see_also({"rgw_port", "rgw_fcgi_socket_backlog"}),
4493
4494     Option("rgw_port", Option::TYPE_STR, Option::LEVEL_BASIC)
4495     .set_default("")
4496     .set_description("RGW FastCGI port number (for FastCGI over TCP)")
4497     .add_see_also({"rgw_host", "rgw_fcgi_socket_backlog"}),
4498
4499     Option("rgw_dns_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4500     .set_default("")
4501     .set_description("The host name that RGW uses.")
4502     .set_long_description(
4503         "This is Needed for virtual hosting of buckets to work properly, unless configured "
4504         "via zonegroup configuration."),
4505
4506     Option("rgw_dns_s3website_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4507     .set_default("")
4508     .set_description("The host name that RGW uses for static websites (S3)")
4509     .set_long_description(
4510         "This is needed for virtual hosting of buckets, unless configured via zonegroup "
4511         "configuration."),
4512
4513     Option("rgw_content_length_compat", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4514     .set_default(false)
4515     .set_description("Multiple content length headers compatibility")
4516     .set_long_description(
4517         "Try to handle requests with abiguous multiple content length headers "
4518         "(Content-Length, Http-Content-Length)."),
4519
4520     Option("rgw_lifecycle_work_time", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4521     .set_default("00:00-06:00")
4522     .set_description("Lifecycle allowed work time")
4523     .set_long_description("Local time window in which the lifecycle maintenance thread can work."),
4524
4525     Option("rgw_lc_lock_max_time", Option::TYPE_INT, Option::LEVEL_DEV)
4526     .set_default(60)
4527     .set_description(""),
4528
4529     Option("rgw_lc_max_objs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4530     .set_default(32)
4531     .set_description("Number of lifecycle data shards")
4532     .set_long_description(
4533           "Number of RADOS objects to use for storing lifecycle index. This can affect "
4534           "concurrency of lifecycle maintenance, but requires multiple RGW processes "
4535           "running on the zone to be utilized."),
4536
4537     Option("rgw_lc_debug_interval", Option::TYPE_INT, Option::LEVEL_DEV)
4538     .set_default(-1)
4539     .set_description(""),
4540
4541     Option("rgw_mp_lock_max_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4542     .set_default(600)
4543     .set_description("Multipart upload max completion time")
4544     .set_long_description(
4545         "Time length to allow completion of a multipart upload operation. This is done "
4546         "to prevent concurrent completions on the same object with the same upload id."),
4547
4548     Option("rgw_script_uri", Option::TYPE_STR, Option::LEVEL_DEV)
4549     .set_default("")
4550     .set_description(""),
4551
4552     Option("rgw_request_uri", Option::TYPE_STR, Option::LEVEL_DEV)
4553     .set_default("")
4554     .set_description(""),
4555
4556     Option("rgw_ignore_get_invalid_range", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4557     .set_default(false)
4558     .set_description("Treat invalid (e.g., negative) range request as full")
4559     .set_long_description("Treat invalid (e.g., negative) range request "
4560                           "as request for the full object (AWS compatibility)"),
4561
4562     Option("rgw_swift_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4563     .set_default("")
4564     .set_description("Swift-auth storage URL")
4565     .set_long_description(
4566         "Used in conjunction with rgw internal swift authentication. This affects the "
4567         "X-Storage-Url response header value.")
4568     .add_see_also("rgw_swift_auth_entry"),
4569
4570     Option("rgw_swift_url_prefix", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4571     .set_default("swift")
4572     .set_description("Swift URL prefix")
4573     .set_long_description("The URL path prefix for swift requests."),
4574
4575     Option("rgw_swift_auth_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4576     .set_default("")
4577     .set_description("Swift auth URL")
4578     .set_long_description(
4579         "Default url to which RGW connects and verifies tokens for v1 auth (if not using "
4580         "internal swift auth)."),
4581
4582     Option("rgw_swift_auth_entry", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4583     .set_default("auth")
4584     .set_description("Swift auth URL prefix")
4585     .set_long_description("URL path prefix for internal swift auth requests.")
4586     .add_see_also("rgw_swift_url"),
4587
4588     Option("rgw_swift_tenant_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4589     .set_default("")
4590     .set_description("Swift tenant name")
4591     .set_long_description("Tenant name that is used when constructing the swift path.")
4592     .add_see_also("rgw_swift_account_in_url"),
4593
4594     Option("rgw_swift_account_in_url", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4595     .set_default(false)
4596     .set_description("Swift account encoded in URL")
4597     .set_long_description("Whether the swift account is encoded in the uri path (AUTH_<account>).")
4598     .add_see_also("rgw_swift_tenant_name"),
4599
4600     Option("rgw_swift_enforce_content_length", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4601     .set_default(false)
4602     .set_description("Send content length when listing containers (Swift)")
4603     .set_long_description(
4604         "Whether content length header is needed when listing containers. When this is "
4605         "set to false, RGW will send extra info for each entry in the response."),
4606
4607     Option("rgw_keystone_url", Option::TYPE_STR, Option::LEVEL_BASIC)
4608     .set_default("")
4609     .set_description("The URL to the Keystone server."),
4610
4611     Option("rgw_keystone_admin_token", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4612     .set_default("")
4613     .set_description("The admin token (shared secret) that is used for the Keystone requests."),
4614
4615     Option("rgw_keystone_admin_user", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4616     .set_default("")
4617     .set_description("Keystone admin user."),
4618
4619     Option("rgw_keystone_admin_password", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4620     .set_default("")
4621     .set_description("Keystone admin password."),
4622
4623     Option("rgw_keystone_admin_tenant", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4624     .set_default("")
4625     .set_description("Keystone admin user tenant."),
4626
4627     Option("rgw_keystone_admin_project", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4628     .set_default("")
4629     .set_description("Keystone admin user project (for Keystone v3)."),
4630
4631     Option("rgw_keystone_admin_domain", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4632     .set_default("")
4633     .set_description("Keystone admin user domain (for Keystone v3)."),
4634
4635     Option("rgw_keystone_barbican_user", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4636     .set_default("")
4637     .set_description("Keystone user to access barbican secrets."),
4638
4639     Option("rgw_keystone_barbican_password", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4640     .set_default("")
4641     .set_description("Keystone password for barbican user."),
4642
4643     Option("rgw_keystone_barbican_tenant", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4644     .set_default("")
4645     .set_description("Keystone barbican user tenant (Keystone v2.0)."),
4646
4647     Option("rgw_keystone_barbican_project", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4648     .set_default("")
4649     .set_description("Keystone barbican user project (Keystone v3)."),
4650
4651     Option("rgw_keystone_barbican_domain", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4652     .set_default("")
4653     .set_description("Keystone barbican user domain."),
4654
4655     Option("rgw_keystone_api_version", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4656     .set_default(2)
4657     .set_description("Version of Keystone API to use (2 or 3)."),
4658
4659     Option("rgw_keystone_accepted_roles", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4660     .set_default("Member, admin")
4661     .set_description("Only users with one of these roles will be served when doing Keystone authentication."),
4662
4663     Option("rgw_keystone_accepted_admin_roles", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4664     .set_default("")
4665     .set_description("List of roles allowing user to gain admin privileges (Keystone)."),
4666
4667     Option("rgw_keystone_token_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4668     .set_default(10000)
4669     .set_description("Keystone token cache size")
4670     .set_long_description(
4671         "Max number of Keystone tokens that will be cached. Token that is not cached "
4672         "requires RGW to access the Keystone server when authenticating."),
4673
4674     Option("rgw_keystone_revocation_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4675     .set_default(15_min)
4676     .set_description("Keystone cache revocation interval")
4677     .set_long_description(
4678         "Time (in seconds) that RGW waits between requests to Keystone for getting a list "
4679         "of revoked tokens. A revoked token might still be considered valid by RGW for "
4680         "this amount of time."),
4681
4682     Option("rgw_keystone_verify_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4683     .set_default(true)
4684     .set_description("Should RGW verify the Keystone server SSL certificate."),
4685
4686     Option("rgw_keystone_implicit_tenants", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4687     .set_default("false")
4688     .set_enum_allowed( { "false", "true", "swift", "s3", "both", "0", "1", "none" } )
4689     .set_description("RGW Keystone implicit tenants creation")
4690     .set_long_description(
4691         "Implicitly create new users in their own tenant with the same name when "
4692         "authenticating via Keystone.  Can be limited to s3 or swift only."),
4693
4694     Option("rgw_cross_domain_policy", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4695     .set_default("<allow-access-from domain=\"*\" secure=\"false\" />")
4696     .set_description("RGW handle cross domain policy")
4697     .set_long_description("Returned cross domain policy when accessing the crossdomain.xml "
4698                           "resource (Swift compatiility)."),
4699
4700     Option("rgw_healthcheck_disabling_path", Option::TYPE_STR, Option::LEVEL_DEV)
4701     .set_default("")
4702     .set_description("Swift health check api can be disabled if a file can be accessed in this path."),
4703
4704     Option("rgw_s3_auth_use_rados", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4705     .set_default(true)
4706     .set_description("Should S3 authentication use credentials stored in RADOS backend."),
4707
4708     Option("rgw_s3_auth_use_keystone", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4709     .set_default(false)
4710     .set_description("Should S3 authentication use Keystone."),
4711
4712     Option("rgw_barbican_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4713     .set_default("")
4714     .set_description("URL to barbican server."),
4715
4716     Option("rgw_ldap_uri", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4717     .set_default("ldaps://<ldap.your.domain>")
4718     .set_description("Space-separated list of LDAP servers in URI format."),
4719
4720     Option("rgw_ldap_binddn", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4721     .set_default("uid=admin,cn=users,dc=example,dc=com")
4722     .set_description("LDAP entry RGW will bind with (user match)."),
4723
4724     Option("rgw_ldap_searchdn", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4725     .set_default("cn=users,cn=accounts,dc=example,dc=com")
4726     .set_description("LDAP search base (basedn)."),
4727
4728     Option("rgw_ldap_dnattr", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4729     .set_default("uid")
4730     .set_description("LDAP attribute containing RGW user names (to form binddns)."),
4731
4732     Option("rgw_ldap_secret", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4733     .set_default("/etc/openldap/secret")
4734     .set_description("Path to file containing credentials for rgw_ldap_binddn."),
4735
4736     Option("rgw_s3_auth_use_ldap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4737     .set_default(false)
4738     .set_description("Should S3 authentication use LDAP."),
4739
4740     Option("rgw_ldap_searchfilter", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4741     .set_default("")
4742     .set_description("LDAP search filter."),
4743
4744     Option("rgw_admin_entry", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4745     .set_default("admin")
4746     .set_description("Path prefix to be used for accessing RGW RESTful admin API."),
4747
4748     Option("rgw_enforce_swift_acls", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4749     .set_default(true)
4750     .set_description("RGW enforce swift acls")
4751     .set_long_description(
4752         "Should RGW enforce special Swift-only ACLs. Swift has a special ACL that gives "
4753         "permission to access all objects in a container."),
4754
4755     Option("rgw_swift_token_expiration", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4756     .set_default(1_day)
4757     .set_description("Expiration time (in seconds) for token generated through RGW Swift auth."),
4758
4759     Option("rgw_print_continue", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4760     .set_default(true)
4761     .set_description("RGW support of 100-continue")
4762     .set_long_description(
4763         "Should RGW explicitly send 100 (continue) responses. This is mainly relevant when "
4764         "using FastCGI, as some FastCGI modules do not fully support this feature."),
4765
4766     Option("rgw_print_prohibited_content_length", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4767     .set_default(false)
4768     .set_description("RGW RFC-7230 compatibility")
4769     .set_long_description(
4770         "Specifies whether RGW violates RFC 7230 and sends Content-Length with 204 or 304 "
4771         "statuses."),
4772
4773     Option("rgw_remote_addr_param", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4774     .set_default("REMOTE_ADDR")
4775     .set_description("HTTP header that holds the remote address in incoming requests.")
4776     .set_long_description(
4777         "RGW will use this header to extract requests origin. When RGW runs behind "
4778         "a reverse proxy, the remote address header will point at the proxy's address "
4779         "and not at the originator's address. Therefore it is sometimes possible to "
4780         "have the proxy add the originator's address in a separate HTTP header, which "
4781         "will allow RGW to log it correctly."
4782         )
4783     .add_see_also("rgw_enable_ops_log"),
4784
4785     Option("rgw_op_thread_timeout", Option::TYPE_INT, Option::LEVEL_DEV)
4786     .set_default(10*60)
4787     .set_description("Timeout for async rados coroutine operations."),
4788
4789     Option("rgw_op_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_DEV)
4790     .set_default(0)
4791     .set_description(""),
4792
4793     Option("rgw_thread_pool_size", Option::TYPE_INT, Option::LEVEL_BASIC)
4794     .set_default(100)
4795     .set_description("RGW requests handling thread pool size.")
4796     .set_long_description(
4797         "This parameter determines the number of concurrent requests RGW can process "
4798         "when using either the civetweb, or the fastcgi frontends. The higher this "
4799         "number is, RGW will be able to deal with more concurrent requests at the "
4800         "cost of more resource utilization."),
4801
4802     Option("rgw_num_control_oids", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4803     .set_default(8)
4804     .set_description("Number of control objects used for cross-RGW communication.")
4805     .set_long_description(
4806         "RGW uses certain control objects to send messages between different RGW "
4807         "processes running on the same zone. These messages include metadata cache "
4808         "invalidation info that is being sent when metadata is modified (such as "
4809         "user or bucket information). A higher number of control objects allows "
4810         "better concurrency of these messages, at the cost of more resource "
4811         "utilization."),
4812
4813     Option("rgw_num_rados_handles", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4814     .set_default(1)
4815     .set_description("Number of librados handles that RGW uses.")
4816     .set_long_description(
4817         "This param affects the number of separate librados handles it uses to "
4818         "connect to the RADOS backend, which directly affects the number of connections "
4819         "RGW will have to each OSD. A higher number affects resource utilization."),
4820
4821     Option("rgw_verify_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4822     .set_default(true)
4823     .set_description("Should RGW verify SSL when connecing to a remote HTTP server")
4824     .set_long_description(
4825         "RGW can send requests to other RGW servers (e.g., in multi-site sync work). "
4826         "This configurable selects whether RGW should verify the certificate for "
4827         "the remote peer and host.")
4828     .add_see_also("rgw_keystone_verify_ssl"),
4829
4830     Option("rgw_nfs_lru_lanes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4831     .set_default(5)
4832     .set_description(""),
4833
4834     Option("rgw_nfs_lru_lane_hiwat", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4835     .set_default(911)
4836     .set_description(""),
4837
4838     Option("rgw_nfs_fhcache_partitions", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4839     .set_default(3)
4840     .set_description(""),
4841
4842     Option("rgw_nfs_fhcache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4843     .set_default(2017)
4844     .set_description(""),
4845
4846     Option("rgw_nfs_namespace_expire_secs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4847     .set_default(300)
4848     .set_min(1)
4849     .set_description(""),
4850
4851     Option("rgw_nfs_max_gc", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4852     .set_default(300)
4853     .set_min(1)
4854     .set_description(""),
4855
4856     Option("rgw_nfs_write_completion_interval_s", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4857     .set_default(10)
4858     .set_description(""),
4859
4860     Option("rgw_zone", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4861     .set_default("")
4862     .set_description("Zone name")
4863     .add_see_also({"rgw_zonegroup", "rgw_realm"}),
4864
4865     Option("rgw_zone_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4866     .set_default(".rgw.root")
4867     .set_description("Zone root pool name")
4868     .set_long_description(
4869         "The zone root pool, is the pool where the RGW zone configuration located."
4870     )
4871     .add_see_also({"rgw_zonegroup_root_pool", "rgw_realm_root_pool", "rgw_period_root_pool"}),
4872
4873     Option("rgw_default_zone_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4874     .set_default("default.zone")
4875     .set_description("Default zone info object id")
4876     .set_long_description(
4877         "Name of the RADOS object that holds the default zone information."
4878     ),
4879
4880     Option("rgw_region", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4881     .set_default("")
4882     .set_description("Region name")
4883     .set_long_description(
4884         "Obsolete config option. The rgw_zonegroup option should be used instead.")
4885     .add_see_also("rgw_zonegroup"),
4886
4887     Option("rgw_region_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4888     .set_default(".rgw.root")
4889     .set_description("Region root pool")
4890     .set_long_description(
4891         "Obsolete config option. The rgw_zonegroup_root_pool should be used instead.")
4892     .add_see_also("rgw_zonegroup_root_pool"),
4893
4894     Option("rgw_default_region_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4895     .set_default("default.region")
4896     .set_description("Default region info object id")
4897     .set_long_description(
4898         "Obsolete config option. The rgw_default_zonegroup_info_oid should be used instead.")
4899     .add_see_also("rgw_default_zonegroup_info_oid"),
4900
4901     Option("rgw_zonegroup", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4902     .set_default("")
4903     .set_description("Zonegroup name")
4904     .add_see_also({"rgw_zone", "rgw_realm"}),
4905
4906     Option("rgw_zonegroup_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4907     .set_default(".rgw.root")
4908     .set_description("Zonegroup root pool")
4909     .set_long_description(
4910         "The zonegroup root pool, is the pool where the RGW zonegroup configuration located."
4911     )
4912     .add_see_also({"rgw_zone_root_pool", "rgw_realm_root_pool", "rgw_period_root_pool"}),
4913
4914     Option("rgw_default_zonegroup_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4915     .set_default("default.zonegroup")
4916     .set_description(""),
4917
4918     Option("rgw_realm", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4919     .set_default("")
4920     .set_description(""),
4921
4922     Option("rgw_realm_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4923     .set_default(".rgw.root")
4924     .set_description("Realm root pool")
4925     .set_long_description(
4926         "The realm root pool, is the pool where the RGW realm configuration located."
4927     )
4928     .add_see_also({"rgw_zonegroup_root_pool", "rgw_zone_root_pool", "rgw_period_root_pool"}),
4929
4930     Option("rgw_default_realm_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4931     .set_default("default.realm")
4932     .set_description(""),
4933
4934     Option("rgw_period_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4935     .set_default(".rgw.root")
4936     .set_description("Period root pool")
4937     .set_long_description(
4938         "The realm root pool, is the pool where the RGW realm configuration located."
4939     )
4940     .add_see_also({"rgw_zonegroup_root_pool", "rgw_zone_root_pool", "rgw_realm_root_pool"}),
4941
4942     Option("rgw_period_latest_epoch_info_oid", Option::TYPE_STR, Option::LEVEL_DEV)
4943     .set_default(".latest_epoch")
4944     .set_description(""),
4945
4946     Option("rgw_log_nonexistent_bucket", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4947     .set_default(false)
4948     .set_description("Should RGW log operations on bucket that does not exist")
4949     .set_long_description(
4950         "This config option applies to the ops log. When this option is set, the ops log "
4951         "will log operations that are sent to non existing buckets. These operations "
4952         "inherently fail, and do not correspond to a specific user.")
4953     .add_see_also("rgw_enable_ops_log"),
4954
4955     Option("rgw_log_object_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4956     .set_default("%Y-%m-%d-%H-%i-%n")
4957     .set_description("Ops log object name format")
4958     .set_long_description(
4959         "Defines the format of the RADOS objects names that ops log uses to store ops "
4960         "log data")
4961     .add_see_also("rgw_enable_ops_log"),
4962
4963     Option("rgw_log_object_name_utc", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4964     .set_default(false)
4965     .set_description("Should ops log object name based on UTC")
4966     .set_long_description(
4967         "If set, the names of the RADOS objects that hold the ops log data will be based "
4968         "on UTC time zone. If not set, it will use the local time zone.")
4969     .add_see_also({"rgw_enable_ops_log", "rgw_log_object_name"}),
4970
4971     Option("rgw_usage_max_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4972     .set_default(32)
4973     .set_description("Number of shards for usage log.")
4974     .set_long_description(
4975         "The number of RADOS objects that RGW will use in order to store the usage log "
4976         "data.")
4977     .add_see_also("rgw_enable_usage_log"),
4978
4979     Option("rgw_usage_max_user_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4980     .set_default(1)
4981     .set_min(1)
4982     .set_description("Number of shards for single user in usage log")
4983     .set_long_description(
4984         "The number of shards that a single user will span over in the usage log.")
4985     .add_see_also("rgw_enable_usage_log"),
4986
4987     Option("rgw_enable_ops_log", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4988     .set_default(false)
4989     .set_description("Enable ops log")
4990     .add_see_also({"rgw_log_nonexistent_bucket", "rgw_log_object_name", "rgw_ops_log_rados",
4991                "rgw_ops_log_socket_path"}),
4992
4993     Option("rgw_enable_usage_log", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4994     .set_default(false)
4995     .set_description("Enable usage log")
4996     .add_see_also("rgw_usage_max_shards"),
4997
4998     Option("rgw_ops_log_rados", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4999     .set_default(true)
5000     .set_description("Use RADOS for ops log")
5001     .set_long_description(
5002        "If set, RGW will store ops log information in RADOS.")
5003     .add_see_also({"rgw_enable_ops_log"}),
5004
5005     Option("rgw_ops_log_socket_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5006     .set_default("")
5007     .set_description("Unix domain socket path for ops log.")
5008     .set_long_description(
5009         "Path to unix domain socket that RGW will listen for connection on. When connected, "
5010         "RGW will send ops log data through it.")
5011     .add_see_also({"rgw_enable_ops_log", "rgw_ops_log_data_backlog"}),
5012
5013     Option("rgw_ops_log_data_backlog", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5014     .set_default(5 << 20)
5015     .set_description("Ops log socket backlog")
5016     .set_long_description(
5017         "Maximum amount of data backlog that RGW can keep when ops log is configured to "
5018         "send info through unix domain socket. When data backlog is higher than this, "
5019         "ops log entries will be lost. In order to avoid ops log information loss, the "
5020         "listener needs to clear data (by reading it) quickly enough.")
5021     .add_see_also({"rgw_enable_ops_log", "rgw_ops_log_socket_path"}),
5022
5023     Option("rgw_fcgi_socket_backlog", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5024     .set_default(1024)
5025     .set_description("FastCGI socket connection backlog")
5026     .set_long_description(
5027         "Size of FastCGI connection backlog. This reflects the maximum number of new "
5028         "connection requests that RGW can handle concurrently without dropping any. ")
5029     .add_see_also({"rgw_host", "rgw_socket_path"}),
5030
5031     Option("rgw_usage_log_flush_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5032     .set_default(1024)
5033     .set_description("Number of entries in usage log before flushing")
5034     .set_long_description(
5035         "This is the max number of entries that will be held in the usage log, before it "
5036         "will be flushed to the backend. Note that the usage log is periodically flushed, "
5037         "even if number of entries does not reach this threshold. A usage log entry "
5038         "corresponds to one or more operations on a single bucket.i")
5039     .add_see_also({"rgw_enable_usage_log", "rgw_usage_log_tick_interval"}),
5040
5041     Option("rgw_usage_log_tick_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5042     .set_default(30)
5043     .set_description("Number of seconds between usage log flush cycles")
5044     .set_long_description(
5045         "The number of seconds between consecutive usage log flushes. The usage log will "
5046         "also flush itself to the backend if the number of pending entries reaches a "
5047         "certain threshold.")
5048     .add_see_also({"rgw_enable_usage_log", "rgw_usage_log_flush_threshold"}),
5049
5050     Option("rgw_init_timeout", Option::TYPE_INT, Option::LEVEL_BASIC)
5051     .set_default(300)
5052     .set_description("Initialization timeout")
5053     .set_long_description(
5054         "The time length (in seconds) that RGW will allow for its initialization. RGW "
5055         "process will give up and quit if initialization is not complete after this amount "
5056         "of time."),
5057
5058     Option("rgw_mime_types_file", Option::TYPE_STR, Option::LEVEL_BASIC)
5059     .set_default("/etc/mime.types")
5060     .set_description("Path to local mime types file")
5061     .set_long_description(
5062         "The mime types file is needed in Swift when uploading an object. If object's "
5063         "content type is not specified, RGW will use data from this file to assign "
5064         "a content type to the object."),
5065
5066     Option("rgw_gc_max_objs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5067     .set_default(32)
5068     .set_description("Number of shards for garbage collector data")
5069     .set_long_description(
5070         "The number of garbage collector data shards, is the number of RADOS objects that "
5071         "RGW will use to store the garbage collection information on.")
5072     .add_see_also({"rgw_gc_obj_min_wait", "rgw_gc_processor_max_time", "rgw_gc_processor_period"}),
5073
5074     Option("rgw_gc_obj_min_wait", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5075     .set_default(2_hr)
5076     .set_description("Garabge collection object expiration time")
5077     .set_long_description(
5078        "The length of time (in seconds) that the RGW collector will wait before purging "
5079        "a deleted object's data. RGW will not remove object immediately, as object could "
5080        "still have readers. A mechanism exists to increase the object's expiration time "
5081        "when it's being read.")
5082     .add_see_also({"rgw_gc_max_objs", "rgw_gc_processor_max_time", "rgw_gc_processor_period"}),
5083
5084     Option("rgw_gc_processor_max_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5085     .set_default(1_hr)
5086     .set_description("Length of time GC processor can lease shard")
5087     .set_long_description(
5088         "Garbage collection thread in RGW process holds a lease on its data shards. These "
5089         "objects contain the information about the objects that need to be removed. RGW "
5090         "takes a lease in order to prevent multiple RGW processes from handling the same "
5091         "objects concurrently. This time signifies that maximum amount of time that RGW "
5092         "is allowed to hold that lease. In the case where RGW goes down uncleanly, this "
5093         "is the amount of time where processing of that data shard will be blocked.")
5094     .add_see_also({"rgw_gc_max_objs", "rgw_gc_obj_min_wait", "rgw_gc_processor_period"}),
5095
5096     Option("rgw_gc_processor_period", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5097     .set_default(1_hr)
5098     .set_description("Garbage collector cycle run time")
5099     .set_long_description(
5100         "The amount of time between the start of consecutive runs of the garbage collector "
5101         "threads. If garbage collector runs takes more than this period, it will not wait "
5102         "before running again.")
5103     .add_see_also({"rgw_gc_max_objs", "rgw_gc_obj_min_wait", "rgw_gc_processor_max_time"}),
5104
5105     Option("rgw_s3_success_create_obj_status", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5106     .set_default(0)
5107     .set_description("HTTP return code override for object creation")
5108     .set_long_description(
5109         "If not zero, this is the HTTP return code that will be returned on a succesful S3 "
5110         "object creation."),
5111
5112     Option("rgw_resolve_cname", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5113     .set_default(false)
5114     .set_description("Support vanity domain names via CNAME")
5115     .set_long_description(
5116         "If true, RGW will query DNS when detecting that it's serving a request that was "
5117         "sent to a host in another domain. If a CNAME record is configured for that domain "
5118         "it will use it instead. This gives user to have the ability of creating a unique "
5119         "domain of their own to point at data in their bucket."),
5120
5121     Option("rgw_obj_stripe_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5122     .set_default(4_M)
5123     .set_description("RGW object stripe size")
5124     .set_long_description(
5125         "The size of an object stripe for RGW objects. This is the maximum size a backing "
5126         "RADOS object will have. RGW objects that are larger than this will span over "
5127         "multiple objects."),
5128
5129     Option("rgw_extended_http_attrs", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5130     .set_default("")
5131     .set_description("RGW support extended HTTP attrs")
5132     .set_long_description(
5133         "Add new set of attributes that could be set on an object. These extra attributes "
5134         "can be set through HTTP header fields when putting the objects. If set, these "
5135         "attributes will return as HTTP fields when doing GET/HEAD on the object."),
5136
5137     Option("rgw_exit_timeout_secs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5138     .set_default(120)
5139     .set_description("RGW shutdown timeout")
5140     .set_long_description("Number of seconds to wait for a process before exiting unconditionally."),
5141
5142     Option("rgw_get_obj_window_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5143     .set_default(16_M)
5144     .set_description("RGW object read window size")
5145     .set_long_description("The window size in bytes for a single object read request"),
5146
5147     Option("rgw_get_obj_max_req_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5148     .set_default(4_M)
5149     .set_description("RGW object read chunk size")
5150     .set_long_description(
5151         "The maximum request size of a single object read operation sent to RADOS"),
5152
5153     Option("rgw_relaxed_s3_bucket_names", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5154     .set_default(false)
5155     .set_description("RGW enable relaxed S3 bucket names")
5156     .set_long_description("RGW enable relaxed S3 bucket name rules for US region buckets."),
5157
5158     Option("rgw_defer_to_bucket_acls", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5159     .set_default("")
5160     .set_description("Bucket ACLs override object ACLs")
5161     .set_long_description(
5162         "If not empty, a string that selects that mode of operation. 'recurse' will use "
5163         "bucket's ACL for the authorizaton. 'full-control' will allow users that users "
5164         "that have full control permission on the bucket have access to the object."),
5165
5166     Option("rgw_list_buckets_max_chunk", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5167     .set_default(1000)
5168     .set_description("Max number of buckets to retrieve in a single listing operation")
5169     .set_long_description(
5170         "When RGW fetches lists of user's buckets from the backend, this is the max number "
5171         "of entries it will try to retrieve in a single operation. Note that the backend "
5172         "may choose to return a smaller number of entries."),
5173
5174     Option("rgw_md_log_max_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5175     .set_default(64)
5176     .set_description("RGW number of metadata log shards")
5177     .set_long_description(
5178         "The number of shards the RGW metadata log entries will reside in. This affects "
5179         "the metadata sync parallelism as a shard can only be processed by a single "
5180         "RGW at a time"),
5181
5182     Option("rgw_num_zone_opstate_shards", Option::TYPE_INT, Option::LEVEL_DEV)
5183     .set_default(128)
5184     .set_description(""),
5185
5186     Option("rgw_opstate_ratelimit_sec", Option::TYPE_INT, Option::LEVEL_DEV)
5187     .set_default(30)
5188     .set_description(""),
5189
5190     Option("rgw_curl_wait_timeout_ms", Option::TYPE_INT, Option::LEVEL_DEV)
5191     .set_default(1000)
5192     .set_description(""),
5193
5194     Option("rgw_copy_obj_progress", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5195     .set_default(true)
5196     .set_description("Send progress report through copy operation")
5197     .set_long_description(
5198         "If true, RGW will send progress information when copy operation is executed. "),
5199
5200     Option("rgw_copy_obj_progress_every_bytes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5201     .set_default(1_M)
5202     .set_description("Send copy-object progress info after these many bytes"),
5203
5204     Option("rgw_obj_tombstone_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5205     .set_default(1000)
5206     .set_description("Max number of entries to keep in tombstone cache")
5207     .set_long_description(
5208         "The tombstone cache is used when doing a multi-zone data sync. RGW keeps "
5209         "there information about removed objects which is needed in order to prevent "
5210         "re-syncing of objects that were already removed."),
5211
5212     Option("rgw_data_log_window", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5213     .set_default(30)
5214     .set_description("Data log time window")
5215     .set_long_description(
5216         "The data log keeps information about buckets that have objectst that were "
5217         "modified within a specific timeframe. The sync process then knows which buckets "
5218         "are needed to be scanned for data sync."),
5219
5220     Option("rgw_data_log_changes_size", Option::TYPE_INT, Option::LEVEL_DEV)
5221     .set_default(1000)
5222     .set_description("Max size of pending changes in data log")
5223     .set_long_description(
5224         "RGW will trigger update to the data log if the number of pending entries reached "
5225         "this number."),
5226
5227     Option("rgw_data_log_num_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5228     .set_default(128)
5229     .set_description("Number of data log shards")
5230     .set_long_description(
5231         "The number of shards the RGW data log entries will reside in. This affects the "
5232         "data sync parallelism as a shard can only be processed by a single RGW at a time."),
5233
5234     Option("rgw_data_log_obj_prefix", Option::TYPE_STR, Option::LEVEL_DEV)
5235     .set_default("data_log")
5236     .set_description(""),
5237
5238     Option("rgw_replica_log_obj_prefix", Option::TYPE_STR, Option::LEVEL_DEV)
5239     .set_default("replica_log")
5240     .set_description(""),
5241
5242     Option("rgw_bucket_quota_ttl", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5243     .set_default(600)
5244     .set_description("Bucket quota stats cache TTL")
5245     .set_long_description(
5246         "Length of time for bucket stats to be cached within RGW instance."),
5247
5248     Option("rgw_bucket_quota_soft_threshold", Option::TYPE_FLOAT, Option::LEVEL_BASIC)
5249     .set_default(0.95)
5250     .set_description("RGW quota soft threshold")
5251     .set_long_description(
5252         "Threshold from which RGW doesn't rely on cached info for quota "
5253         "decisions. This is done for higher accuracy of the quota mechanism at "
5254         "cost of performance, when getting close to the quota limit. The value "
5255         "configured here is the ratio between the data usage to the max usage "
5256         "as specified by the quota."),
5257
5258     Option("rgw_bucket_quota_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5259     .set_default(10000)
5260     .set_description("RGW quota stats cache size")
5261     .set_long_description(
5262         "Maximum number of entries in the quota stats cache."),
5263
5264     Option("rgw_bucket_default_quota_max_objects", Option::TYPE_INT, Option::LEVEL_BASIC)
5265     .set_default(-1)
5266     .set_description("Default quota for max objects in a bucket")
5267     .set_long_description(
5268         "The default quota configuration for max number of objects in a bucket. A "
5269         "negative number means 'unlimited'."),
5270
5271     Option("rgw_bucket_default_quota_max_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5272     .set_default(-1)
5273     .set_description("Default quota for total size in a bucket")
5274     .set_long_description(
5275         "The default quota configuration for total size of objects in a bucket. A "
5276         "negative number means 'unlimited'."),
5277
5278     Option("rgw_expose_bucket", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5279     .set_default(false)
5280     .set_description("Send Bucket HTTP header with the response")
5281     .set_long_description(
5282         "If true, RGW will send a Bucket HTTP header with the responses. The header will "
5283         "contain the name of the bucket the operation happened on."),
5284
5285     Option("rgw_frontends", Option::TYPE_STR, Option::LEVEL_BASIC)
5286     .set_default("civetweb port=7480")
5287     .set_description("RGW frontends configuration")
5288     .set_long_description(
5289         "A comma delimited list of frontends configuration. Each configuration contains "
5290         "the type of the frontend followed by an optional space delimited set of "
5291         "key=value config parameters."),
5292
5293     Option("rgw_user_quota_bucket_sync_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5294     .set_default(180)
5295     .set_description("User quota bucket sync interval")
5296     .set_long_description(
5297         "Time period for accumulating modified buckets before syncing these stats."),
5298
5299     Option("rgw_user_quota_sync_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5300     .set_default(1_day)
5301     .set_description("User quota sync interval")
5302     .set_long_description(
5303         "Time period for accumulating modified buckets before syncing entire user stats."),
5304
5305     Option("rgw_user_quota_sync_idle_users", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5306     .set_default(false)
5307     .set_description("Should sync idle users quota")
5308     .set_long_description(
5309         "Whether stats for idle users be fully synced."),
5310
5311     Option("rgw_user_quota_sync_wait_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5312     .set_default(1_day)
5313     .set_description("User quota full-sync wait time")
5314     .set_long_description(
5315         "Minimum time between two full stats sync for non-idle users."),
5316
5317     Option("rgw_user_default_quota_max_objects", Option::TYPE_INT, Option::LEVEL_BASIC)
5318     .set_default(-1)
5319     .set_description("User quota max objects")
5320     .set_long_description(
5321         "The default quota configuration for total number of objects for a single user. A "
5322         "negative number means 'unlimited'."),
5323
5324     Option("rgw_user_default_quota_max_size", Option::TYPE_INT, Option::LEVEL_BASIC)
5325     .set_default(-1)
5326     .set_description("User quota max size")
5327     .set_long_description(
5328         "The default quota configuration for total size of objects for a single user. A "
5329         "negative number means 'unlimited'."),
5330
5331     Option("rgw_multipart_min_part_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5332     .set_default(5_M)
5333     .set_description("Minimum S3 multipart-upload part size")
5334     .set_long_description(
5335         "When doing a multipart upload, each part (other than the last part) should be "
5336         "at least this size."),
5337
5338     Option("rgw_multipart_part_upload_limit", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5339     .set_default(10000)
5340     .set_description("Max number of parts in multipart upload"),
5341
5342     Option("rgw_max_slo_entries", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5343     .set_default(1000)
5344     .set_description("Max number of entries in Swift Static Large Object manifest"),
5345
5346     Option("rgw_olh_pending_timeout_sec", Option::TYPE_INT, Option::LEVEL_DEV)
5347     .set_default(1_hr)
5348     .set_description("Max time for pending OLH change to complete")
5349     .set_long_description(
5350         "OLH is a versioned object's logical head. Operations on it are journaled and "
5351         "as pending before completion. If an operation doesn't complete with this amount "
5352         "of seconds, we remove the operation from the journal."),
5353
5354     Option("rgw_user_max_buckets", Option::TYPE_INT, Option::LEVEL_BASIC)
5355     .set_default(1000)
5356     .set_description("Max number of buckets per user")
5357     .set_long_description(
5358         "A user can create this many buckets. Zero means unlimmited, negative number means "
5359         "user cannot create any buckets (although user will retain buckets already created."),
5360
5361     Option("rgw_objexp_gc_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5362     .set_default(10_min)
5363     .set_description("Swift objects expirer garbage collector interval"),
5364
5365     Option("rgw_objexp_hints_num_shards", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5366     .set_default(127)
5367     .set_description("Number of object expirer data shards")
5368     .set_long_description(
5369         "The number of shards the (Swift) object expirer will store its data on."),
5370
5371     Option("rgw_objexp_chunk_size", Option::TYPE_UINT, Option::LEVEL_DEV)
5372     .set_default(100)
5373     .set_description(""),
5374
5375     Option("rgw_enable_static_website", Option::TYPE_BOOL, Option::LEVEL_BASIC)
5376     .set_default(false)
5377     .set_description("Enable static website APIs")
5378     .set_long_description(
5379         "This configurable controls whether RGW handles the website control APIs. RGW can "
5380         "server static websites if s3website hostnames are configured, and unrelated to "
5381         "this configurable."),
5382
5383     Option("rgw_log_http_headers", Option::TYPE_STR, Option::LEVEL_BASIC)
5384     .set_default("")
5385     .set_description("List of HTTP headers to log")
5386     .set_long_description(
5387         "A comma delimited list of HTTP headers to log when seen, ignores case (e.g., "
5388         "http_x_forwarded_for)."),
5389
5390     Option("rgw_num_async_rados_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5391     .set_default(32)
5392     .set_description("Number of concurrent RADOS operations in multisite sync")
5393     .set_long_description(
5394         "The number of concurrent RADOS IO operations that will be triggered for handling "
5395         "multisite sync operations. This includes control related work, and not the actual "
5396         "sync operations."),
5397
5398     Option("rgw_md_notify_interval_msec", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5399     .set_default(200)
5400     .set_description("Length of time to aggregate metadata changes")
5401     .set_long_description(
5402         "Length of time (in milliseconds) in which the master zone aggregates all the "
5403         "metadata changes that occured, before sending notifications to all the other "
5404         "zones."),
5405
5406     Option("rgw_run_sync_thread", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5407     .set_default(true)
5408     .set_description("Should run sync thread"),
5409
5410     Option("rgw_sync_lease_period", Option::TYPE_INT, Option::LEVEL_DEV)
5411     .set_default(120)
5412     .set_description(""),
5413
5414     Option("rgw_sync_log_trim_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5415     .set_default(1200)
5416     .set_description("Sync log trim interval")
5417     .set_long_description(
5418         "Time in seconds between attempts to trim sync logs."),
5419
5420     Option("rgw_sync_log_trim_max_buckets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5421     .set_default(16)
5422     .set_description("Maximum number of buckets to trim per interval")
5423     .set_long_description("The maximum number of buckets to consider for bucket index log trimming each trim interval, regardless of the number of bucket index shards. Priority is given to buckets with the most sync activity over the last trim interval.")
5424     .add_see_also("rgw_sync_log_trim_interval")
5425     .add_see_also("rgw_sync_log_trim_min_cold_buckets")
5426     .add_see_also("rgw_sync_log_trim_concurrent_buckets"),
5427
5428     Option("rgw_sync_log_trim_min_cold_buckets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5429     .set_default(4)
5430     .set_description("Minimum number of cold buckets to trim per interval")
5431     .set_long_description("Of the `rgw_sync_log_trim_max_buckets` selected for bucket index log trimming each trim interval, at least this many of them must be 'cold' buckets. These buckets are selected in order from the list of all bucket instances, to guarantee that all buckets will be visited eventually.")
5432     .add_see_also("rgw_sync_log_trim_interval")
5433     .add_see_also("rgw_sync_log_trim_max_buckets")
5434     .add_see_also("rgw_sync_log_trim_concurrent_buckets"),
5435
5436     Option("rgw_sync_log_trim_concurrent_buckets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5437     .set_default(4)
5438     .set_description("Maximum number of buckets to trim in parallel")
5439     .add_see_also("rgw_sync_log_trim_interval")
5440     .add_see_also("rgw_sync_log_trim_max_buckets")
5441     .add_see_also("rgw_sync_log_trim_min_cold_buckets"),
5442
5443     Option("rgw_sync_data_inject_err_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
5444     .set_default(0)
5445     .set_description(""),
5446
5447     Option("rgw_sync_meta_inject_err_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
5448     .set_default(0)
5449     .set_description(""),
5450
5451     Option("rgw_period_push_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5452     .set_default(2)
5453     .set_description("Period push interval")
5454     .set_long_description(
5455         "Number of seconds to wait before retrying 'period push' operation."),
5456
5457     Option("rgw_period_push_interval_max", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5458     .set_default(30)
5459     .set_description("Period push maximum interval")
5460     .set_long_description(
5461         "The max number of seconds to wait before retrying 'period push' after exponential "
5462         "backoff."),
5463
5464     Option("rgw_safe_max_objects_per_shard", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5465     .set_default(100*1024)
5466     .set_description("Safe number of objects per shard")
5467     .set_long_description(
5468         "This is the max number of objects per bucket index shard that RGW considers "
5469         "safe. RGW will warn if it identifies a bucket where its per-shard count is "
5470         "higher than a percentage of this number.")
5471     .add_see_also("rgw_shard_warning_threshold"),
5472
5473     Option("rgw_shard_warning_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5474     .set_default(90)
5475     .set_description("Warn about max objects per shard")
5476     .set_long_description(
5477         "Warn if number of objects per shard in a specific bucket passed this percentage "
5478         "of the safe number.")
5479     .add_see_also("rgw_safe_max_objects_per_shard"),
5480
5481     Option("rgw_swift_versioning_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5482     .set_default(false)
5483     .set_description("Enable Swift versioning"),
5484
5485     Option("rgw_swift_custom_header", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5486     .set_default("")
5487     .set_description("Enable swift custom header")
5488     .set_long_description(
5489         "If not empty, specifies a name of HTTP header that can include custom data. When "
5490         "uploading an object, if this header is passed RGW will store this header info "
5491         "and it will be available when listing the bucket."),
5492
5493     Option("rgw_swift_need_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5494     .set_default(true)
5495     .set_description("Enable stats on bucket listing in Swift"),
5496
5497     Option("rgw_reshard_num_logs", Option::TYPE_INT, Option::LEVEL_DEV)
5498     .set_default(16)
5499     .set_description(""),
5500
5501     Option("rgw_reshard_bucket_lock_duration", Option::TYPE_INT, Option::LEVEL_DEV)
5502     .set_default(120)
5503     .set_description(""),
5504
5505     Option("rgw_crypt_require_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5506     .set_default(true)
5507     .set_description("Requests including encryption key headers must be sent over ssl"),
5508
5509     Option("rgw_crypt_default_encryption_key", Option::TYPE_STR, Option::LEVEL_DEV)
5510     .set_default("")
5511     .set_description(""),
5512
5513     Option("rgw_crypt_s3_kms_encryption_keys", Option::TYPE_STR, Option::LEVEL_DEV)
5514     .set_default("")
5515     .set_description(""),
5516
5517     Option("rgw_crypt_suppress_logs", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5518     .set_default(true)
5519     .set_description("Suppress logs that might print client key"),
5520
5521     Option("rgw_list_bucket_min_readahead", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5522     .set_default(1000)
5523     .set_description("Minimum number of entries to request from rados for bucket listing"),
5524
5525     Option("rgw_rest_getusage_op_compat", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5526     .set_default(false)
5527     .set_description("REST GetUsage request backward compatibility"),
5528
5529     Option("rgw_torrent_flag", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5530     .set_default(false)
5531     .set_description("When true, uploaded objects will calculate and store "
5532                      "a SHA256 hash of object data so the object can be "
5533                      "retrieved as a torrent file"),
5534
5535     Option("rgw_torrent_tracker", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5536     .set_default("")
5537     .set_description("Torrent field annouce and annouce list"),
5538
5539     Option("rgw_torrent_createby", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5540     .set_default("")
5541     .set_description("torrent field created by"),
5542
5543     Option("rgw_torrent_comment", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5544     .set_default("")
5545     .set_description("Torrent field comment"),
5546
5547     Option("rgw_torrent_encoding", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5548     .set_default("")
5549     .set_description("torrent field encoding"),
5550
5551     Option("rgw_data_notify_interval_msec", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5552     .set_default(200)
5553     .set_description("data changes notification interval to followers"),
5554
5555     Option("rgw_torrent_origin", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5556     .set_default("")
5557     .set_description("Torrent origin"),
5558
5559     Option("rgw_torrent_sha_unit", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5560     .set_default(512*1024)
5561     .set_description(""),
5562
5563     Option("rgw_dynamic_resharding", Option::TYPE_BOOL, Option::LEVEL_BASIC)
5564     .set_default(true)
5565     .set_description("Enable dynamic resharding")
5566     .set_long_description(
5567         "If true, RGW will dynamicall increase the number of shards in buckets that have "
5568         "a high number of objects per shard.")
5569     .add_see_also("rgw_max_objs_per_shard"),
5570
5571     Option("rgw_max_objs_per_shard", Option::TYPE_INT, Option::LEVEL_BASIC)
5572     .set_default(100000)
5573     .set_description("Max objects per shard for dynamic resharding")
5574     .set_long_description(
5575         "This is the max number of objects per bucket index shard that RGW will "
5576         "allow with dynamic resharding. RGW will trigger an automatic reshard operation "
5577         "on the bucket if it exceeds this number.")
5578     .add_see_also("rgw_dynamic_resharding"),
5579
5580     Option("rgw_reshard_thread_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5581     .set_default(10_min)
5582     .set_description(""),
5583
5584     Option("rgw_cache_expiry_interval", Option::TYPE_UINT,
5585            Option::LEVEL_ADVANCED)
5586     .set_default(900)
5587     .set_description("Number of seconds before entries in the bucket info "
5588                      "cache are assumed stale and re-fetched. Zero is never.")
5589     .add_tag("performance")
5590     .add_service("rgw")
5591     .set_long_description("The Rados Gateway stores metadata about buckets in "
5592                           "an internal cache. This should be kept consistent "
5593                           "by the OSD's relaying notify events between "
5594                           "multiple watching RGW processes. In the event "
5595                           "that this notification protocol fails, bounding "
5596                           "the length of time that any data in the cache will "
5597                           "be assumed valid will ensure that any RGW instance "
5598                           "that falls out of sync will eventually recover. "
5599                           "This seems to be an issue mostly for large numbers "
5600                           "of RGW instances under heavy use. If you would like "
5601                           "to turn off cache expiry, set this value to zero."),
5602
5603   });
5604 }
5605
5606 static std::vector<Option> get_rbd_options() {
5607   return std::vector<Option>({
5608     Option("rbd_default_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5609     .set_default("rbd")
5610     .set_description("default pool for storing new images")
5611     .set_validator([](std::string *value, std::string *error_message){
5612       boost::regex pattern("^[^@/]+$");
5613       if (!boost::regex_match (*value, pattern)) {
5614         *value = "rbd";
5615         *error_message = "invalid RBD default pool, resetting to 'rbd'";
5616       }
5617       return 0;
5618     }),
5619
5620     Option("rbd_default_data_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5621     .set_default("")
5622     .set_description("default pool for storing data blocks for new images")
5623     .set_validator([](std::string *value, std::string *error_message){
5624       boost::regex pattern("^[^@/]*$");
5625       if (!boost::regex_match (*value, pattern)) {
5626         *value = "";
5627         *error_message = "ignoring invalid RBD data pool";
5628       }
5629       return 0;
5630     }),
5631
5632     Option("rbd_default_features", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5633     .set_default("layering,exclusive-lock,object-map,fast-diff,deep-flatten")
5634     .set_description("default v2 image features for new images")
5635     .set_long_description(
5636         "RBD features are only applicable for v2 images. This setting accepts "
5637         "either an integer bitmask value or comma-delimited string of RBD "
5638         "feature names. This setting is always internally stored as an integer "
5639         "bitmask value. The mapping between feature bitmask value and feature "
5640         "name is as follows: +1 -> layering, +2 -> striping, "
5641         "+4 -> exclusive-lock, +8 -> object-map, +16 -> fast-diff, "
5642         "+32 -> deep-flatten, +64 -> journaling, +128 -> data-pool")
5643     .set_safe()
5644     .set_validator([](std::string *value, std::string *error_message){
5645       static const std::map<std::string, uint64_t> FEATURE_MAP = {
5646         {RBD_FEATURE_NAME_LAYERING, RBD_FEATURE_LAYERING},
5647         {RBD_FEATURE_NAME_STRIPINGV2, RBD_FEATURE_STRIPINGV2},
5648         {RBD_FEATURE_NAME_EXCLUSIVE_LOCK, RBD_FEATURE_EXCLUSIVE_LOCK},
5649         {RBD_FEATURE_NAME_OBJECT_MAP, RBD_FEATURE_OBJECT_MAP},
5650         {RBD_FEATURE_NAME_FAST_DIFF, RBD_FEATURE_FAST_DIFF},
5651         {RBD_FEATURE_NAME_DEEP_FLATTEN, RBD_FEATURE_DEEP_FLATTEN},
5652         {RBD_FEATURE_NAME_JOURNALING, RBD_FEATURE_JOURNALING},
5653         {RBD_FEATURE_NAME_DATA_POOL, RBD_FEATURE_DATA_POOL},
5654       };
5655       static_assert((RBD_FEATURE_DATA_POOL << 1) > RBD_FEATURES_ALL,
5656                     "new RBD feature added");
5657
5658       // convert user-friendly comma delimited feature name list to a bitmask
5659       // that is used by the librbd API
5660       uint64_t features = 0;
5661       error_message->clear();
5662
5663       try {
5664         features = boost::lexical_cast<decltype(features)>(*value);
5665
5666         uint64_t unsupported_features = (features & ~RBD_FEATURES_ALL);
5667         if (unsupported_features != 0ull) {
5668           features &= RBD_FEATURES_ALL;
5669
5670           std::stringstream ss;
5671           ss << "ignoring unknown feature mask 0x"
5672              << std::hex << unsupported_features;
5673           *error_message = ss.str();
5674         }
5675       } catch (const boost::bad_lexical_cast& ) {
5676         int r = 0;
5677         std::vector<std::string> feature_names;
5678         boost::split(feature_names, *value, boost::is_any_of(","));
5679         for (auto feature_name: feature_names) {
5680           boost::trim(feature_name);
5681           auto feature_it = FEATURE_MAP.find(feature_name);
5682           if (feature_it != FEATURE_MAP.end()) {
5683             features += feature_it->second;
5684           } else {
5685             if (!error_message->empty()) {
5686               *error_message += ", ";
5687             }
5688             *error_message += "ignoring unknown feature " + feature_name;
5689             r = -EINVAL;
5690           }
5691         }
5692
5693         if (features == 0 && r == -EINVAL) {
5694           features = RBD_FEATURES_DEFAULT;
5695         }
5696       }
5697       *value = stringify(features);
5698       return 0;
5699     }),
5700
5701     Option("rbd_op_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5702     .set_default(1)
5703     .set_description("number of threads to utilize for internal processing"),
5704
5705     Option("rbd_op_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5706     .set_default(60)
5707     .set_description("time in seconds for detecting a hung thread"),
5708
5709     Option("rbd_non_blocking_aio", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5710     .set_default(true)
5711     .set_description("process AIO ops from a dispatch thread to prevent blocking"),
5712
5713     Option("rbd_cache", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5714     .set_default(true)
5715     .set_description("whether to enable caching (writeback unless rbd_cache_max_dirty is 0)"),
5716
5717     Option("rbd_cache_writethrough_until_flush", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5718     .set_default(true)
5719     .set_description("whether to make writeback caching writethrough until "
5720                      "flush is called, to be sure the user of librbd will send "
5721                      "flushes so that writeback is safe"),
5722
5723     Option("rbd_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5724     .set_default(32<<20)
5725     .set_description("cache size in bytes"),
5726
5727     Option("rbd_cache_max_dirty", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5728     .set_default(24<<20)
5729     .set_description("dirty limit in bytes - set to 0 for write-through caching"),
5730
5731     Option("rbd_cache_target_dirty", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5732     .set_default(16<<20)
5733     .set_description("target dirty limit in bytes"),
5734
5735     Option("rbd_cache_max_dirty_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5736     .set_default(1.0)
5737     .set_description("seconds in cache before writeback starts"),
5738
5739     Option("rbd_cache_max_dirty_object", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5740     .set_default(0)
5741     .set_description("dirty limit for objects - set to 0 for auto calculate from rbd_cache_size"),
5742
5743     Option("rbd_cache_block_writes_upfront", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5744     .set_default(false)
5745     .set_description("whether to block writes to the cache before the aio_write call completes"),
5746
5747     Option("rbd_concurrent_management_ops", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5748     .set_default(10)
5749     .set_min(1)
5750     .set_description("how many operations can be in flight for a management operation like deleting or resizing an image"),
5751
5752     Option("rbd_balance_snap_reads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5753     .set_default(false)
5754     .set_description("distribute snap read requests to random OSD"),
5755
5756     Option("rbd_localize_snap_reads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5757     .set_default(false)
5758     .set_description("localize snap read requests to closest OSD"),
5759
5760     Option("rbd_balance_parent_reads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5761     .set_default(false)
5762     .set_description("distribute parent read requests to random OSD"),
5763
5764     Option("rbd_localize_parent_reads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5765     .set_default(false)
5766     .set_description("localize parent requests to closest OSD"),
5767
5768     Option("rbd_sparse_read_threshold_bytes", Option::TYPE_UINT,
5769            Option::LEVEL_ADVANCED)
5770     .set_default(64_K)
5771     .set_description("threshold for issuing a sparse-read")
5772     .set_long_description("minimum number of sequential bytes to read against "
5773                           "an object before issuing a sparse-read request to "
5774                           "the cluster. 0 implies it must be a full object read"
5775                           "to issue a sparse-read, 1 implies always use "
5776                           "sparse-read, and any value larger than the maximum "
5777                           "object size will disable sparse-read for all "
5778                           "requests"),
5779
5780     Option("rbd_readahead_trigger_requests", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5781     .set_default(10)
5782     .set_description("number of sequential requests necessary to trigger readahead"),
5783
5784     Option("rbd_readahead_max_bytes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5785     .set_default(512_K)
5786     .set_description("set to 0 to disable readahead"),
5787
5788     Option("rbd_readahead_disable_after_bytes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5789     .set_default(50_M)
5790     .set_description("how many bytes are read in total before readahead is disabled"),
5791
5792     Option("rbd_clone_copy_on_read", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5793     .set_default(false)
5794     .set_description("copy-up parent image blocks to clone upon read request"),
5795
5796     Option("rbd_blacklist_on_break_lock", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5797     .set_default(true)
5798     .set_description("whether to blacklist clients whose lock was broken"),
5799
5800     Option("rbd_blacklist_expire_seconds", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5801     .set_default(0)
5802     .set_description("number of seconds to blacklist - set to 0 for OSD default"),
5803
5804     Option("rbd_request_timed_out_seconds", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5805     .set_default(30)
5806     .set_description("number of seconds before maintenance request times out"),
5807
5808     Option("rbd_skip_partial_discard", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5809     .set_default(false)
5810     .set_description("when trying to discard a range inside an object, set to true to skip zeroing the range"),
5811
5812     Option("rbd_enable_alloc_hint", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5813     .set_default(true)
5814     .set_description("when writing a object, it will issue a hint to osd backend to indicate the expected size object need"),
5815
5816     Option("rbd_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5817     .set_default(false)
5818     .set_description("true if LTTng-UST tracepoints should be enabled"),
5819
5820     Option("rbd_blkin_trace_all", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5821     .set_default(false)
5822     .set_description("create a blkin trace for all RBD requests"),
5823
5824     Option("rbd_validate_pool", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5825     .set_default(true)
5826     .set_description("validate empty pools for RBD compatibility"),
5827
5828     Option("rbd_validate_names", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5829     .set_default(true)
5830     .set_description("validate new image names for RBD compatibility"),
5831
5832     Option("rbd_auto_exclusive_lock_until_manual_request", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5833     .set_default(true)
5834     .set_description("automatically acquire/release exclusive lock until it is explicitly requested"),
5835
5836     Option("rbd_mirroring_resync_after_disconnect", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5837     .set_default(false)
5838     .set_description("automatically start image resync after mirroring is disconnected due to being laggy"),
5839
5840     Option("rbd_mirroring_replay_delay", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5841     .set_default(0)
5842     .set_description("time-delay in seconds for rbd-mirror asynchronous replication"),
5843
5844     Option("rbd_default_format", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5845     .set_default(2)
5846     .set_description("default image format for new images"),
5847
5848     Option("rbd_default_order", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5849     .set_default(22)
5850     .set_description("default order (data block object size) for new images"),
5851
5852     Option("rbd_default_stripe_count", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5853     .set_default(0)
5854     .set_description("default stripe count for new images"),
5855
5856     Option("rbd_default_stripe_unit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5857     .set_default(0)
5858     .set_description("default stripe width for new images"),
5859
5860     Option("rbd_default_map_options", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5861     .set_default("")
5862     .set_description("default krbd map options"),
5863
5864     Option("rbd_journal_order", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5865     .set_min(12)
5866     .set_default(24)
5867     .set_description("default order (object size) for journal data objects"),
5868
5869     Option("rbd_journal_splay_width", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5870     .set_default(4)
5871     .set_description("number of active journal objects"),
5872
5873     Option("rbd_journal_commit_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5874     .set_default(5)
5875     .set_description("commit time interval, seconds"),
5876
5877     Option("rbd_journal_object_flush_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5878     .set_default(0)
5879     .set_description("maximum number of pending commits per journal object"),
5880
5881     Option("rbd_journal_object_flush_bytes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5882     .set_default(0)
5883     .set_description("maximum number of pending bytes per journal object"),
5884
5885     Option("rbd_journal_object_flush_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5886     .set_default(0)
5887     .set_description("maximum age (in seconds) for pending commits"),
5888
5889     Option("rbd_journal_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5890     .set_default("")
5891     .set_description("pool for journal objects"),
5892
5893     Option("rbd_journal_max_payload_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5894     .set_default(16384)
5895     .set_description("maximum journal payload size before splitting"),
5896
5897     Option("rbd_journal_max_concurrent_object_sets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5898     .set_default(0)
5899     .set_description("maximum number of object sets a journal client can be behind before it is automatically unregistered"),
5900   });
5901 }
5902
5903 static std::vector<Option> get_rbd_mirror_options() {
5904   return std::vector<Option>({
5905     Option("rbd_mirror_journal_commit_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5906     .set_default(5)
5907     .set_description("commit time interval, seconds"),
5908
5909     Option("rbd_mirror_journal_poll_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5910     .set_default(5)
5911     .set_description("maximum age (in seconds) between successive journal polls"),
5912
5913     Option("rbd_mirror_journal_max_fetch_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5914     .set_default(32768)
5915     .set_description("maximum bytes to read from each journal data object per fetch"),
5916
5917     Option("rbd_mirror_sync_point_update_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5918     .set_default(30)
5919     .set_description("number of seconds between each update of the image sync point object number"),
5920
5921     Option("rbd_mirror_concurrent_image_syncs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5922     .set_default(5)
5923     .set_description("maximum number of image syncs in parallel"),
5924
5925     Option("rbd_mirror_pool_replayers_refresh_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5926     .set_default(30)
5927     .set_description("interval to refresh peers in rbd-mirror daemon"),
5928
5929     Option("rbd_mirror_delete_retry_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5930     .set_default(30)
5931     .set_description("interval to check and retry the failed requests in deleter"),
5932
5933     Option("rbd_mirror_image_state_check_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5934     .set_default(30)
5935     .set_min(1)
5936     .set_description("interval to get images from pool watcher and set sources in replayer"),
5937
5938     Option("rbd_mirror_leader_heartbeat_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5939     .set_default(5)
5940     .set_min(1)
5941     .set_description("interval (in seconds) between mirror leader heartbeats"),
5942
5943     Option("rbd_mirror_leader_max_missed_heartbeats", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5944     .set_default(2)
5945     .set_description("number of missed heartbeats for non-lock owner to attempt to acquire lock"),
5946
5947     Option("rbd_mirror_leader_max_acquire_attempts_before_break", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5948     .set_default(3)
5949     .set_description("number of failed attempts to acquire lock after missing heartbeats before breaking lock"),
5950   });
5951 }
5952
5953 std::vector<Option> get_mds_options() {
5954   return std::vector<Option>({
5955     Option("mds_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5956     .set_default("/var/lib/ceph/mds/$cluster-$id")
5957     .set_description(""),
5958
5959     Option("mds_max_file_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5960     .set_default(1ULL << 40)
5961     .set_description(""),
5962
5963     Option("mds_max_xattr_pairs_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5964     .set_default(64 << 10)
5965     .set_description(""),
5966
5967     Option("mds_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5968     .set_default(0)
5969     .set_description("maximum number of inodes in MDS cache (<=0 is unlimited)")
5970     .set_long_description("This tunable is no longer recommended. Use mds_cache_memory_limit."),
5971
5972     Option("mds_cache_memory_limit", Option::TYPE_UINT, Option::LEVEL_BASIC)
5973     .set_default(1*(1LL<<30))
5974     .set_description("target maximum memory usage of MDS cache")
5975     .set_long_description("This sets a target maximum memory usage of the MDS cache and is the primary tunable to limit the MDS memory usage. The MDS will try to stay under a reservation of this limit (by default 95%; 1 - mds_cache_reservation) by trimming unused metadata in its cache and recalling cached items in the client caches. It is possible for the MDS to exceed this limit due to slow recall from clients. The mds_health_cache_threshold (150%) sets a cache full threshold for when the MDS signals a cluster health warning."),
5976
5977     Option("mds_cache_reservation", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5978     .set_default(.05)
5979     .set_description("amount of memory to reserve"),
5980
5981     Option("mds_health_cache_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5982     .set_default(1.5)
5983     .set_description("threshold for cache size to generate health warning"),
5984
5985     Option("mds_cache_mid", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5986     .set_default(.7)
5987     .set_description(""),
5988
5989     Option("mds_max_file_recover", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5990     .set_default(32)
5991     .set_description(""),
5992
5993     Option("mds_dir_max_commit_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5994     .set_default(10)
5995     .set_description(""),
5996
5997     Option("mds_dir_keys_per_op", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5998     .set_default(16384)
5999     .set_description(""),
6000
6001     Option("mds_decay_halflife", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6002     .set_default(5)
6003     .set_description(""),
6004
6005     Option("mds_beacon_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6006     .set_default(4)
6007     .set_description(""),
6008
6009     Option("mds_beacon_grace", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6010     .set_default(15)
6011     .set_description(""),
6012
6013     Option("mds_enforce_unique_name", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6014     .set_default(true)
6015     .set_description(""),
6016
6017     Option("mds_session_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6018     .set_default(60)
6019     .set_description(""),
6020
6021     Option("mds_session_blacklist_on_timeout", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6022     .set_default(true)
6023     .set_description(""),
6024
6025     Option("mds_session_blacklist_on_evict", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6026     .set_default(true)
6027     .set_description(""),
6028
6029     Option("mds_sessionmap_keys_per_op", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6030     .set_default(1024)
6031     .set_description(""),
6032
6033     Option("mds_recall_state_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6034     .set_default(60)
6035     .set_description(""),
6036
6037     Option("mds_freeze_tree_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6038     .set_default(30)
6039     .set_description(""),
6040
6041     Option("mds_session_autoclose", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6042     .set_default(300)
6043     .set_description(""),
6044
6045     Option("mds_health_summarize_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6046     .set_default(10)
6047     .set_description(""),
6048
6049     Option("mds_reconnect_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6050     .set_default(45)
6051     .set_description(""),
6052
6053     Option("mds_tick_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6054     .set_default(5)
6055     .set_description(""),
6056
6057     Option("mds_dirstat_min_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6058     .set_default(1)
6059     .set_description(""),
6060
6061     Option("mds_scatter_nudge_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6062     .set_default(5)
6063     .set_description(""),
6064
6065     Option("mds_client_prealloc_inos", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6066     .set_default(1000)
6067     .set_description(""),
6068
6069     Option("mds_early_reply", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6070     .set_default(true)
6071     .set_description(""),
6072
6073     Option("mds_default_dir_hash", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6074     .set_default(CEPH_STR_HASH_RJENKINS)
6075     .set_description(""),
6076
6077     Option("mds_log_pause", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6078     .set_default(false)
6079     .set_description(""),
6080
6081     Option("mds_log_skip_corrupt_events", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6082     .set_default(false)
6083     .set_description(""),
6084
6085     Option("mds_log_max_events", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6086     .set_default(-1)
6087     .set_description(""),
6088
6089     Option("mds_log_events_per_segment", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6090     .set_default(1024)
6091     .set_description(""),
6092
6093     Option("mds_log_segment_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6094     .set_default(0)
6095     .set_description(""),
6096
6097     Option("mds_log_max_segments", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6098     .set_default(128)
6099     .set_description(""),
6100
6101     Option("mds_bal_export_pin", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6102     .set_default(true)
6103     .set_description(""),
6104
6105     Option("mds_bal_sample_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6106     .set_default(3.0)
6107     .set_description(""),
6108
6109     Option("mds_bal_replicate_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6110     .set_default(8000)
6111     .set_description(""),
6112
6113     Option("mds_bal_unreplicate_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6114     .set_default(0)
6115     .set_description(""),
6116
6117     Option("mds_bal_frag", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6118     .set_default(true)
6119     .set_description(""),
6120
6121     Option("mds_bal_split_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6122     .set_default(10000)
6123     .set_description(""),
6124
6125     Option("mds_bal_split_rd", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6126     .set_default(25000)
6127     .set_description(""),
6128
6129     Option("mds_bal_split_wr", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6130     .set_default(10000)
6131     .set_description(""),
6132
6133     Option("mds_bal_split_bits", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6134     .set_default(3)
6135     .set_description(""),
6136
6137     Option("mds_bal_merge_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6138     .set_default(50)
6139     .set_description(""),
6140
6141     Option("mds_bal_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6142     .set_default(10)
6143     .set_description(""),
6144
6145     Option("mds_bal_fragment_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6146     .set_default(5)
6147     .set_description(""),
6148
6149     Option("mds_bal_fragment_size_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6150     .set_default(10000*10)
6151     .set_description(""),
6152
6153     Option("mds_bal_fragment_fast_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6154     .set_default(1.5)
6155     .set_description(""),
6156
6157     Option("mds_bal_idle_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6158     .set_default(0)
6159     .set_description(""),
6160
6161     Option("mds_bal_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6162     .set_default(-1)
6163     .set_description(""),
6164
6165     Option("mds_bal_max_until", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6166     .set_default(-1)
6167     .set_description(""),
6168
6169     Option("mds_bal_mode", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6170     .set_default(0)
6171     .set_description(""),
6172
6173     Option("mds_bal_min_rebalance", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6174     .set_default(.1)
6175     .set_description(""),
6176
6177     Option("mds_bal_min_start", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6178     .set_default(.2)
6179     .set_description(""),
6180
6181     Option("mds_bal_need_min", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6182     .set_default(.8)
6183     .set_description(""),
6184
6185     Option("mds_bal_need_max", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6186     .set_default(1.2)
6187     .set_description(""),
6188
6189     Option("mds_bal_midchunk", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6190     .set_default(.3)
6191     .set_description(""),
6192
6193     Option("mds_bal_minchunk", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6194     .set_default(.001)
6195     .set_description(""),
6196
6197     Option("mds_bal_target_decay", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6198     .set_default(10.0)
6199     .set_description(""),
6200
6201     Option("mds_replay_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6202     .set_default(1.0)
6203     .set_description(""),
6204
6205     Option("mds_shutdown_check", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6206     .set_default(0)
6207     .set_description(""),
6208
6209     Option("mds_thrash_exports", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6210     .set_default(0)
6211     .set_description(""),
6212
6213     Option("mds_thrash_fragments", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6214     .set_default(0)
6215     .set_description(""),
6216
6217     Option("mds_dump_cache_on_map", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6218     .set_default(false)
6219     .set_description(""),
6220
6221     Option("mds_dump_cache_after_rejoin", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6222     .set_default(false)
6223     .set_description(""),
6224
6225     Option("mds_verify_scatter", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6226     .set_default(false)
6227     .set_description(""),
6228
6229     Option("mds_debug_scatterstat", Option::TYPE_BOOL, Option::LEVEL_DEV)
6230     .set_default(false)
6231     .set_description(""),
6232
6233     Option("mds_debug_frag", Option::TYPE_BOOL, Option::LEVEL_DEV)
6234     .set_default(false)
6235     .set_description(""),
6236
6237     Option("mds_debug_auth_pins", Option::TYPE_BOOL, Option::LEVEL_DEV)
6238     .set_default(false)
6239     .set_description(""),
6240
6241     Option("mds_debug_subtrees", Option::TYPE_BOOL, Option::LEVEL_DEV)
6242     .set_default(false)
6243     .set_description(""),
6244
6245     Option("mds_kill_mdstable_at", Option::TYPE_INT, Option::LEVEL_DEV)
6246     .set_default(0)
6247     .set_description(""),
6248
6249     Option("mds_max_export_size", Option::TYPE_UINT, Option::LEVEL_DEV)
6250     .set_default(1_G)
6251     .set_description(""),
6252
6253     Option("mds_kill_export_at", Option::TYPE_INT, Option::LEVEL_DEV)
6254     .set_default(0)
6255     .set_description(""),
6256
6257     Option("mds_kill_import_at", Option::TYPE_INT, Option::LEVEL_DEV)
6258     .set_default(0)
6259     .set_description(""),
6260
6261     Option("mds_kill_link_at", Option::TYPE_INT, Option::LEVEL_DEV)
6262     .set_default(0)
6263     .set_description(""),
6264
6265     Option("mds_kill_rename_at", Option::TYPE_INT, Option::LEVEL_DEV)
6266     .set_default(0)
6267     .set_description(""),
6268
6269     Option("mds_kill_openc_at", Option::TYPE_INT, Option::LEVEL_DEV)
6270     .set_default(0)
6271     .set_description(""),
6272
6273     Option("mds_kill_journal_at", Option::TYPE_INT, Option::LEVEL_DEV)
6274     .set_default(0)
6275     .set_description(""),
6276
6277     Option("mds_kill_journal_expire_at", Option::TYPE_INT, Option::LEVEL_DEV)
6278     .set_default(0)
6279     .set_description(""),
6280
6281     Option("mds_kill_journal_replay_at", Option::TYPE_INT, Option::LEVEL_DEV)
6282     .set_default(0)
6283     .set_description(""),
6284
6285     Option("mds_journal_format", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6286     .set_default(1)
6287     .set_description(""),
6288
6289     Option("mds_kill_create_at", Option::TYPE_INT, Option::LEVEL_DEV)
6290     .set_default(0)
6291     .set_description(""),
6292
6293     Option("mds_inject_traceless_reply_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
6294     .set_default(0)
6295     .set_description(""),
6296
6297     Option("mds_wipe_sessions", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6298     .set_default(0)
6299     .set_description(""),
6300
6301     Option("mds_wipe_ino_prealloc", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6302     .set_default(0)
6303     .set_description(""),
6304
6305     Option("mds_skip_ino", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6306     .set_default(0)
6307     .set_description(""),
6308
6309     Option("mds_standby_for_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6310     .set_default("")
6311     .set_description(""),
6312
6313     Option("mds_standby_for_rank", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6314     .set_default(-1)
6315     .set_description(""),
6316
6317     Option("mds_standby_for_fscid", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6318     .set_default(-1)
6319     .set_description(""),
6320
6321     Option("mds_standby_replay", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6322     .set_default(false)
6323     .set_description(""),
6324
6325     Option("mds_enable_op_tracker", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6326     .set_default(true)
6327     .set_description(""),
6328
6329     Option("mds_op_history_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6330     .set_default(20)
6331     .set_description(""),
6332
6333     Option("mds_op_history_duration", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6334     .set_default(600)
6335     .set_description(""),
6336
6337     Option("mds_op_complaint_time", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6338     .set_default(30)
6339     .set_description(""),
6340
6341     Option("mds_op_log_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6342     .set_default(5)
6343     .set_description(""),
6344
6345     Option("mds_snap_min_uid", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6346     .set_default(0)
6347     .set_description(""),
6348
6349     Option("mds_snap_max_uid", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6350     .set_default(4294967294)
6351     .set_description(""),
6352
6353     Option("mds_snap_rstat", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6354     .set_default(false)
6355     .set_description(""),
6356
6357     Option("mds_verify_backtrace", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6358     .set_default(1)
6359     .set_description(""),
6360
6361     Option("mds_max_completed_flushes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6362     .set_default(100000)
6363     .set_description(""),
6364
6365     Option("mds_max_completed_requests", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6366     .set_default(100000)
6367     .set_description(""),
6368
6369     Option("mds_action_on_write_error", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6370     .set_default(1)
6371     .set_description(""),
6372
6373     Option("mds_mon_shutdown_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6374     .set_default(5)
6375     .set_description(""),
6376
6377     Option("mds_max_purge_files", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6378     .set_default(64)
6379     .set_description(""),
6380
6381     Option("mds_max_purge_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6382     .set_default(8192)
6383     .set_description(""),
6384
6385     Option("mds_max_purge_ops_per_pg", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6386     .set_default(0.5)
6387     .set_description(""),
6388
6389     Option("mds_purge_queue_busy_flush_period", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6390     .set_default(1.0)
6391     .set_description(""),
6392
6393     Option("mds_root_ino_uid", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6394     .set_default(0)
6395     .set_description(""),
6396
6397     Option("mds_root_ino_gid", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6398     .set_default(0)
6399     .set_description(""),
6400
6401     Option("mds_max_scrub_ops_in_progress", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6402     .set_default(5)
6403     .set_description(""),
6404
6405     Option("mds_damage_table_max_entries", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6406     .set_default(10000)
6407     .set_description(""),
6408
6409     Option("mds_client_writeable_range_max_inc_objs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6410     .set_default(1024)
6411     .set_description(""),
6412
6413     Option("mds_min_caps_per_client", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6414     .set_default(100)
6415     .set_description("minimum number of capabilities a client may hold"),
6416
6417     Option("mds_max_ratio_caps_per_client", Option::TYPE_FLOAT, Option::LEVEL_DEV)
6418     .set_default(.8)
6419     .set_description("maximum ratio of current caps that may be recalled during MDS cache pressure"),
6420     Option("mds_hack_allow_loading_invalid_metadata", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6421      .set_default(0)
6422      .set_description("INTENTIONALLY CAUSE DATA LOSS by bypasing checks for invalid metadata on disk. Allows testing repair tools."),
6423
6424     Option("mds_inject_migrator_session_race", Option::TYPE_BOOL, Option::LEVEL_DEV)
6425      .set_default(false),
6426   });
6427 }
6428
6429 std::vector<Option> get_mds_client_options() {
6430   return std::vector<Option>({
6431     Option("client_cache_size", Option::TYPE_INT, Option::LEVEL_BASIC)
6432     .set_default(16384)
6433     .set_description("soft maximum number of directory entries in client cache"),
6434
6435     Option("client_cache_mid", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6436     .set_default(.75)
6437     .set_description("mid-point of client cache LRU"),
6438
6439     Option("client_use_random_mds", Option::TYPE_BOOL, Option::LEVEL_DEV)
6440     .set_default(false)
6441     .set_description("issue new requests to a random active MDS"),
6442
6443     Option("client_mount_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6444     .set_default(300.0)
6445     .set_description("timeout for mounting CephFS (seconds)"),
6446
6447     Option("client_tick_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
6448     .set_default(1.0)
6449     .set_description("seconds between client upkeep ticks"),
6450
6451     Option("client_trace", Option::TYPE_STR, Option::LEVEL_DEV)
6452     .set_default("")
6453     .set_description("file containing trace of client operations"),
6454
6455     Option("client_readahead_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6456     .set_default(128*1024)
6457     .set_description("minimum bytes to readahead in a file"),
6458
6459     Option("client_readahead_max_bytes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6460     .set_default(0)
6461     .set_description("maximum bytes to readahead in a file (zero is unlimited)"),
6462
6463     Option("client_readahead_max_periods", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6464     .set_default(4)
6465     .set_description("maximum stripe periods to readahead in a file"),
6466
6467     Option("client_reconnect_stale", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6468     .set_default(false)
6469     .set_description("reconnect when the session becomes stale"),
6470
6471     Option("client_snapdir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6472     .set_default(".snap")
6473     .set_description("pseudo directory for snapshot access to a directory"),
6474
6475     Option("client_mountpoint", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6476     .set_default("/")
6477     .set_description("default mount-point"),
6478
6479     Option("client_mount_uid", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6480     .set_default(-1)
6481     .set_description("uid to mount as"),
6482
6483     Option("client_mount_gid", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6484     .set_default(-1)
6485     .set_description("gid to mount as"),
6486
6487     /* RADOS client option */
6488     Option("client_notify_timeout", Option::TYPE_INT, Option::LEVEL_DEV)
6489     .set_default(10)
6490     .set_description(""),
6491
6492     /* RADOS client option */
6493     Option("osd_client_watch_timeout", Option::TYPE_INT, Option::LEVEL_DEV)
6494     .set_default(30)
6495     .set_description(""),
6496
6497     Option("client_caps_release_delay", Option::TYPE_INT, Option::LEVEL_DEV)
6498     .set_default(5)
6499     .set_description(""),
6500
6501     Option("client_quota_df", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6502     .set_default(true)
6503     .set_description("show quota usage for statfs (df)"),
6504
6505     Option("client_oc", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6506     .set_default(true)
6507     .set_description("enable object caching"),
6508
6509     Option("client_oc_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6510     .set_default(200_M)
6511     .set_description("maximum size of object cache"),
6512
6513     Option("client_oc_max_dirty", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6514     .set_default(100_M)
6515     .set_description("maximum size of dirty pages in object cache"),
6516
6517     Option("client_oc_target_dirty", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6518     .set_default(8_M)
6519     .set_description("target size of dirty pages object cache"),
6520
6521     Option("client_oc_max_dirty_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6522     .set_default(5.0)
6523     .set_description("maximum age of dirty pages in object cache (seconds)"),
6524
6525     Option("client_oc_max_objects", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6526     .set_default(1000)
6527     .set_description("maximum number of objects in cache"),
6528
6529     Option("client_debug_getattr_caps", Option::TYPE_BOOL, Option::LEVEL_DEV)
6530     .set_default(false)
6531     .set_description(""),
6532
6533     Option("client_debug_force_sync_read", Option::TYPE_BOOL, Option::LEVEL_DEV)
6534     .set_default(false)
6535     .set_description(""),
6536
6537     Option("client_debug_inject_tick_delay", Option::TYPE_INT, Option::LEVEL_DEV)
6538     .set_default(0)
6539     .set_description(""),
6540
6541     Option("client_max_inline_size", Option::TYPE_UINT, Option::LEVEL_DEV)
6542     .set_default(4_K)
6543     .set_description(""),
6544
6545     Option("client_inject_release_failure", Option::TYPE_BOOL, Option::LEVEL_DEV)
6546     .set_default(false)
6547     .set_description(""),
6548
6549     Option("client_inject_fixed_oldest_tid", Option::TYPE_BOOL, Option::LEVEL_DEV)
6550     .set_default(false)
6551     .set_description(""),
6552
6553     Option("client_metadata", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6554     .set_default("")
6555     .set_description("metadata key=value comma-delimited pairs appended to session metadata"),
6556
6557     Option("client_acl_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6558     .set_default("")
6559     .set_description("ACL type to enforce (none or \"posix_acl\")"),
6560
6561     Option("client_permissions", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6562     .set_default(true)
6563     .set_description("client-enforced permission checking"),
6564
6565     Option("client_dirsize_rbytes", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6566     .set_default(true)
6567     .set_description("set the directory size as the number of file bytes recursively used")
6568     .set_long_description("This option enables a CephFS feature that stores the recursive directory size (the bytes used by files in the directory and its descendents) in the st_size field of the stat structure."),
6569
6570     Option("fuse_use_invalidate_cb", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6571     .set_default(true)
6572     .set_description(""),
6573
6574     Option("fuse_disable_pagecache", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6575     .set_default(false)
6576     .set_description("disable page caching in the kernel for this FUSE mount"),
6577
6578     Option("fuse_allow_other", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6579     .set_default(true)
6580     .set_description("pass allow_other to FUSE on mount"),
6581
6582     Option("fuse_default_permissions", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6583     .set_default(false)
6584     .set_description("pass default_permisions to FUSE on mount"),
6585
6586     Option("fuse_big_writes", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6587     .set_default(true)
6588     .set_description(""),
6589
6590     Option("fuse_atomic_o_trunc", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6591     .set_default(true)
6592     .set_description("pass atomic_o_trunc flag to FUSE on mount"),
6593
6594     Option("fuse_debug", Option::TYPE_BOOL, Option::LEVEL_DEV)
6595     .set_default(false)
6596     .set_description(""),
6597
6598     Option("fuse_multithreaded", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6599     .set_default(true)
6600     .set_description("allow parallel processing through FUSE library"),
6601
6602     Option("fuse_require_active_mds", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6603     .set_default(true)
6604     .set_description("require active MDSs in the file system when mounting"),
6605
6606     Option("fuse_syncfs_on_mksnap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6607     .set_default(true)
6608     .set_description("synchronize all local metadata/file changes after snapshot"),
6609
6610     Option("fuse_set_user_groups", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6611     .set_default(true)
6612     .set_description("check for ceph-fuse to consider supplementary groups for permissions"),
6613
6614     Option("client_try_dentry_invalidate", Option::TYPE_BOOL, Option::LEVEL_DEV)
6615     .set_default(false)
6616     .set_description(""),
6617
6618     Option("client_die_on_failed_remount", Option::TYPE_BOOL, Option::LEVEL_DEV)
6619     .set_default(false)
6620     .set_description(""),
6621
6622     Option("client_die_on_failed_dentry_invalidate", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6623     .set_default(true)
6624     .set_description("kill the client when no dentry invalidation options are available")
6625     .set_long_description("The CephFS client requires a mechanism to invalidate dentries in the caller (e.g. the kernel for ceph-fuse) when capabilities must be recalled. If the client cannot do this then the MDS cache cannot shrink which can cause the MDS to fail."),
6626
6627     Option("client_check_pool_perm", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6628     .set_default(true)
6629     .set_description("confirm access to inode's data pool/namespace described in file layout"),
6630
6631     Option("client_use_faked_inos", Option::TYPE_BOOL, Option::LEVEL_DEV)
6632     .set_default(false)
6633     .set_description(""),
6634
6635     Option("client_mds_namespace", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6636     .set_default("")
6637     .set_description("CephFS file system name to mount"),
6638   });
6639 }
6640
6641
6642 static std::vector<Option> build_options()
6643 {
6644   std::vector<Option> result = get_global_options();
6645
6646   auto ingest = [&result](std::vector<Option>&& options, const char* svc) {
6647     for (const auto &o_in : options) {
6648       Option o(o_in);
6649       o.add_service(svc);
6650       result.push_back(o);
6651     }
6652   };
6653
6654   ingest(get_rgw_options(), "rgw");
6655   ingest(get_rbd_options(), "rbd");
6656   ingest(get_rbd_mirror_options(), "rbd-mirror");
6657   ingest(get_mds_options(), "mds");
6658   ingest(get_mds_client_options(), "mds_client");
6659
6660   return result;
6661 }
6662
6663 const std::vector<Option> ceph_options = build_options();