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