]> git.proxmox.com Git - ceph.git/blame - ceph/src/common/options.cc
bump version to 15.2.11-pve1
[ceph.git] / ceph / src / common / options.cc
CommitLineData
c07f9fc5
FG
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"
9f95a23c 10#include "include/common_fwd.h"
c07f9fc5
FG
11#include <boost/algorithm/string.hpp>
12#include <boost/lexical_cast.hpp>
11fdf7f2 13#include <regex>
c07f9fc5 14
3efd9988
FG
15// Definitions for enums
16#include "common/perf_counters.h"
17
11fdf7f2
TL
18// rbd feature validation
19#include "librbd/Features.h"
20
21namespace {
22class printer : public boost::static_visitor<> {
23 ostream& out;
24public:
25 explicit printer(ostream& os)
26 : out(os) {}
27 template<typename T>
28 void operator()(const T& v) const {
29 out << v;
30 }
31 void operator()(boost::blank blank) const {
32 return;
33 }
34 void operator()(bool v) const {
35 out << (v ? "true" : "false");
36 }
37 void operator()(double v) const {
38 out << std::fixed << v << std::defaultfloat;
39 }
40 void operator()(const Option::size_t& v) const {
41 out << v.value;
42 }
43 void operator()(const std::chrono::seconds v) const {
44 out << v.count();
45 }
46};
47}
48
49ostream& operator<<(ostream& os, const Option::value_t& v) {
50 printer p{os};
51 v.apply_visitor(p);
52 return os;
53}
c07f9fc5
FG
54
55void Option::dump_value(const char *field_name,
56 const Option::value_t &v, Formatter *f) const
57{
58 if (boost::get<boost::blank>(&v)) {
59 // This should be nil but Formatter doesn't allow it.
60 f->dump_string(field_name, "");
11fdf7f2
TL
61 return;
62 }
63 switch (type) {
64 case TYPE_INT:
65 f->dump_int(field_name, boost::get<int64_t>(v)); break;
66 case TYPE_UINT:
67 f->dump_unsigned(field_name, boost::get<uint64_t>(v)); break;
68 case TYPE_STR:
69 f->dump_string(field_name, boost::get<std::string>(v)); break;
70 case TYPE_FLOAT:
71 f->dump_float(field_name, boost::get<double>(v)); break;
72 case TYPE_BOOL:
73 f->dump_bool(field_name, boost::get<bool>(v)); break;
74 default:
75 f->dump_stream(field_name) << v; break;
c07f9fc5
FG
76 }
77}
78
79int Option::pre_validate(std::string *new_value, std::string *err) const
80{
81 if (validator) {
82 return validator(new_value, err);
83 } else {
84 return 0;
85 }
86}
87
88int Option::validate(const Option::value_t &new_value, std::string *err) const
89{
90 // Generic validation: min
91 if (!boost::get<boost::blank>(&(min))) {
92 if (new_value < min) {
93 std::ostringstream oss;
94 oss << "Value '" << new_value << "' is below minimum " << min;
95 *err = oss.str();
96 return -EINVAL;
97 }
98 }
99
100 // Generic validation: max
101 if (!boost::get<boost::blank>(&(max))) {
102 if (new_value > max) {
103 std::ostringstream oss;
104 oss << "Value '" << new_value << "' exceeds maximum " << max;
105 *err = oss.str();
106 return -EINVAL;
107 }
108 }
109
110 // Generic validation: enum
111 if (!enum_allowed.empty() && type == Option::TYPE_STR) {
112 auto found = std::find(enum_allowed.begin(), enum_allowed.end(),
113 boost::get<std::string>(new_value));
114 if (found == enum_allowed.end()) {
115 std::ostringstream oss;
116 oss << "'" << new_value << "' is not one of the permitted "
117 "values: " << joinify(enum_allowed.begin(),
118 enum_allowed.end(),
119 std::string(", "));
120 *err = oss.str();
121 return -EINVAL;
122 }
123 }
124
125 return 0;
126}
127
11fdf7f2
TL
128int Option::parse_value(
129 const std::string& raw_val,
130 value_t *out,
131 std::string *error_message,
132 std::string *normalized_value) const
133{
134 std::string val = raw_val;
135
136 int r = pre_validate(&val, error_message);
137 if (r != 0) {
138 return r;
139 }
140
141 if (type == Option::TYPE_INT) {
142 int64_t f = strict_si_cast<int64_t>(val.c_str(), error_message);
143 if (!error_message->empty()) {
144 return -EINVAL;
145 }
146 *out = f;
147 } else if (type == Option::TYPE_UINT) {
148 uint64_t f = strict_si_cast<uint64_t>(val.c_str(), error_message);
149 if (!error_message->empty()) {
150 return -EINVAL;
151 }
152 *out = f;
153 } else if (type == Option::TYPE_STR) {
154 *out = val;
155 } else if (type == Option::TYPE_FLOAT) {
156 double f = strict_strtod(val.c_str(), error_message);
157 if (!error_message->empty()) {
158 return -EINVAL;
159 } else {
160 *out = f;
161 }
162 } else if (type == Option::TYPE_BOOL) {
163 if (strcasecmp(val.c_str(), "false") == 0) {
164 *out = false;
165 } else if (strcasecmp(val.c_str(), "true") == 0) {
166 *out = true;
167 } else {
168 int b = strict_strtol(val.c_str(), 10, error_message);
169 if (!error_message->empty()) {
170 return -EINVAL;
171 }
172 *out = (bool)!!b;
173 }
174 } else if (type == Option::TYPE_ADDR) {
175 entity_addr_t addr;
176 if (!addr.parse(val.c_str())){
177 return -EINVAL;
178 }
179 *out = addr;
9f95a23c 180 } else if (type == Option::TYPE_ADDRVEC) {
11fdf7f2
TL
181 entity_addrvec_t addr;
182 if (!addr.parse(val.c_str())){
183 return -EINVAL;
184 }
185 *out = addr;
186 } else if (type == Option::TYPE_UUID) {
187 uuid_d uuid;
188 if (!uuid.parse(val.c_str())) {
189 return -EINVAL;
190 }
191 *out = uuid;
192 } else if (type == Option::TYPE_SIZE) {
193 Option::size_t sz{strict_iecstrtoll(val.c_str(), error_message)};
194 if (!error_message->empty()) {
195 return -EINVAL;
196 }
197 *out = sz;
198 } else if (type == Option::TYPE_SECS) {
199 try {
200 *out = parse_timespan(val);
201 } catch (const invalid_argument& e) {
202 *error_message = e.what();
203 return -EINVAL;
204 }
205 } else {
206 ceph_abort();
207 }
208
209 r = validate(*out, error_message);
210 if (r != 0) {
211 return r;
212 }
213
214 if (normalized_value) {
215 *normalized_value = to_str(*out);
216 }
217 return 0;
218}
219
c07f9fc5
FG
220void Option::dump(Formatter *f) const
221{
c07f9fc5
FG
222 f->dump_string("name", name);
223
224 f->dump_string("type", type_to_str(type));
c07f9fc5
FG
225
226 f->dump_string("level", level_to_str(level));
227
228 f->dump_string("desc", desc);
229 f->dump_string("long_desc", long_desc);
230
231 dump_value("default", value, f);
232 dump_value("daemon_default", daemon_value, f);
233
234 f->open_array_section("tags");
235 for (const auto t : tags) {
236 f->dump_string("tag", t);
237 }
238 f->close_section();
239
240 f->open_array_section("services");
241 for (const auto s : services) {
242 f->dump_string("service", s);
243 }
244 f->close_section();
245
246 f->open_array_section("see_also");
247 for (const auto sa : see_also) {
248 f->dump_string("see_also", sa);
249 }
250 f->close_section();
251
252 if (type == TYPE_STR) {
253 f->open_array_section("enum_values");
254 for (const auto &ea : enum_allowed) {
255 f->dump_string("enum_value", ea);
256 }
257 f->close_section();
258 }
259
260 dump_value("min", min, f);
261 dump_value("max", max, f);
262
11fdf7f2
TL
263 f->dump_bool("can_update_at_runtime", can_update_at_runtime());
264
265 f->open_array_section("flags");
266 if (has_flag(FLAG_RUNTIME)) {
267 f->dump_string("option", "runtime");
268 }
269 if (has_flag(FLAG_NO_MON_UPDATE)) {
270 f->dump_string("option", "no_mon_update");
271 }
272 if (has_flag(FLAG_STARTUP)) {
273 f->dump_string("option", "startup");
274 }
275 if (has_flag(FLAG_CLUSTER_CREATE)) {
276 f->dump_string("option", "cluster_create");
277 }
278 if (has_flag(FLAG_CREATE)) {
279 f->dump_string("option", "create");
280 }
c07f9fc5
FG
281 f->close_section();
282}
283
11fdf7f2
TL
284std::string Option::to_str(const Option::value_t& v)
285{
286 return stringify(v);
287}
288
289void Option::print(ostream *out) const
290{
291 *out << name << " - " << desc << "\n";
292 *out << " (" << type_to_str(type) << ", " << level_to_str(level) << ")\n";
293 if (!boost::get<boost::blank>(&daemon_value)) {
294 *out << " Default (non-daemon): " << stringify(value) << "\n";
295 *out << " Default (daemon): " << stringify(daemon_value) << "\n";
296 } else {
297 *out << " Default: " << stringify(value) << "\n";
298 }
299 if (!enum_allowed.empty()) {
300 *out << " Possible values: ";
301 for (auto& i : enum_allowed) {
302 *out << " " << stringify(i);
303 }
304 *out << "\n";
305 }
306 if (!boost::get<boost::blank>(&min)) {
307 *out << " Minimum: " << stringify(min) << "\n"
308 << " Maximum: " << stringify(max) << "\n";
309 }
310 *out << " Can update at runtime: "
311 << (can_update_at_runtime() ? "true" : "false") << "\n";
312 if (!services.empty()) {
313 *out << " Services: " << services << "\n";
314 }
315 if (!tags.empty()) {
316 *out << " Tags: " << tags << "\n";
317 }
318 if (!see_also.empty()) {
319 *out << " See also: " << see_also << "\n";
320 }
321
322 if (long_desc.size()) {
323 *out << "\n" << long_desc << "\n";
324 }
325}
326
b32b8144
FG
327constexpr unsigned long long operator"" _min (unsigned long long min) {
328 return min * 60;
329}
330constexpr unsigned long long operator"" _hr (unsigned long long hr) {
331 return hr * 60 * 60;
332}
333constexpr unsigned long long operator"" _day (unsigned long long day) {
334 return day * 60 * 60 * 24;
335}
336constexpr unsigned long long operator"" _K (unsigned long long n) {
337 return n << 10;
338}
339constexpr unsigned long long operator"" _M (unsigned long long n) {
340 return n << 20;
341}
342constexpr unsigned long long operator"" _G (unsigned long long n) {
343 return n << 30;
344}
9f95a23c
TL
345constexpr unsigned long long operator"" _T (unsigned long long n) {
346 return n << 40;
347}
c07f9fc5 348
d2e6a577
FG
349std::vector<Option> get_global_options() {
350 return std::vector<Option>({
351 Option("host", Option::TYPE_STR, Option::LEVEL_BASIC)
352 .set_description("local hostname")
353 .set_long_description("if blank, ceph assumes the short hostname (hostname -s)")
11fdf7f2 354 .set_flag(Option::FLAG_NO_MON_UPDATE)
d2e6a577
FG
355 .add_service("common")
356 .add_tag("network"),
357
358 Option("fsid", Option::TYPE_UUID, Option::LEVEL_BASIC)
359 .set_description("cluster fsid (uuid)")
11fdf7f2 360 .set_flag(Option::FLAG_NO_MON_UPDATE)
81eedcae 361 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
362 .add_service("common")
363 .add_tag("service"),
364
365 Option("public_addr", Option::TYPE_ADDR, Option::LEVEL_BASIC)
366 .set_description("public-facing address to bind to")
81eedcae 367 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
368 .add_service({"mon", "mds", "osd", "mgr"}),
369
9f95a23c
TL
370 Option("public_addrv", Option::TYPE_ADDRVEC, Option::LEVEL_BASIC)
371 .set_description("public-facing address to bind to")
372 .set_flag(Option::FLAG_STARTUP)
373 .add_service({"mon", "mds", "osd", "mgr"}),
374
d2e6a577
FG
375 Option("public_bind_addr", Option::TYPE_ADDR, Option::LEVEL_ADVANCED)
376 .set_default(entity_addr_t())
81eedcae 377 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
378 .add_service("mon")
379 .set_description(""),
380
381 Option("cluster_addr", Option::TYPE_ADDR, Option::LEVEL_BASIC)
382 .set_description("cluster-facing address to bind to")
383 .add_service("osd")
81eedcae 384 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
385 .add_tag("network"),
386
387 Option("public_network", Option::TYPE_STR, Option::LEVEL_ADVANCED)
388 .add_service({"mon", "mds", "osd", "mgr"})
81eedcae 389 .set_flag(Option::FLAG_STARTUP)
d2e6a577 390 .add_tag("network")
3efd9988
FG
391 .set_description("Network(s) from which to choose a public address to bind to"),
392
393 Option("public_network_interface", Option::TYPE_STR, Option::LEVEL_ADVANCED)
394 .add_service({"mon", "mds", "osd", "mgr"})
395 .add_tag("network")
81eedcae 396 .set_flag(Option::FLAG_STARTUP)
3efd9988
FG
397 .set_description("Interface name(s) from which to choose an address from a public_network to bind to; public_network must also be specified.")
398 .add_see_also("public_network"),
d2e6a577
FG
399
400 Option("cluster_network", Option::TYPE_STR, Option::LEVEL_ADVANCED)
401 .add_service("osd")
81eedcae 402 .set_flag(Option::FLAG_STARTUP)
d2e6a577 403 .add_tag("network")
3efd9988
FG
404 .set_description("Network(s) from which to choose a cluster address to bind to"),
405
406 Option("cluster_network_interface", Option::TYPE_STR, Option::LEVEL_ADVANCED)
407 .add_service({"mon", "mds", "osd", "mgr"})
81eedcae 408 .set_flag(Option::FLAG_STARTUP)
3efd9988
FG
409 .add_tag("network")
410 .set_description("Interface name(s) from which to choose an address from a cluster_network to bind to; cluster_network must also be specified.")
411 .add_see_also("cluster_network"),
d2e6a577
FG
412
413 Option("monmap", Option::TYPE_STR, Option::LEVEL_ADVANCED)
414 .set_description("path to MonMap file")
415 .set_long_description("This option is normally used during mkfs, but can also "
416 "be used to identify which monitors to connect to.")
11fdf7f2 417 .set_flag(Option::FLAG_NO_MON_UPDATE)
d2e6a577 418 .add_service("mon")
11fdf7f2 419 .set_flag(Option::FLAG_CREATE),
d2e6a577
FG
420
421 Option("mon_host", Option::TYPE_STR, Option::LEVEL_BASIC)
422 .set_description("list of hosts or addresses to search for a monitor")
423 .set_long_description("This is a comma, whitespace, or semicolon separated "
424 "list of IP addresses or hostnames. Hostnames are "
425 "resolved via DNS and all A or AAAA records are "
426 "included in the search list.")
11fdf7f2 427 .set_flag(Option::FLAG_NO_MON_UPDATE)
81eedcae 428 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
429 .add_service("common"),
430
f91f0fd5
TL
431 Option("mon_host_override", Option::TYPE_STR, Option::LEVEL_ADVANCED)
432 .set_description("monitor(s) to use overriding the MonMap")
433 .set_flag(Option::FLAG_NO_MON_UPDATE)
434 .set_flag(Option::FLAG_STARTUP)
435 .add_service("common"),
436
d2e6a577 437 Option("mon_dns_srv_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3efd9988 438 .set_default("ceph-mon")
d2e6a577 439 .set_description("name of DNS SRV record to check for monitor addresses")
81eedcae 440 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
441 .add_service("common")
442 .add_tag("network")
443 .add_see_also("mon_host"),
444
9f95a23c
TL
445 Option("container_image", Option::TYPE_STR, Option::LEVEL_BASIC)
446 .set_description("container image (used by cephadm orchestrator)")
447 .set_flag(Option::FLAG_STARTUP)
448 .set_default("docker.io/ceph/ceph:v15"),
449
450 Option("no_config_file", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
451 .set_default(false)
452 .set_flag(Option::FLAG_NO_MON_UPDATE)
453 .set_flag(Option::FLAG_STARTUP)
454 .add_service("common")
455 .add_tag("config")
456 .set_description("signal that we don't require a config file to be present")
457 .set_long_description("When specified, we won't be looking for a "
458 "configuration file, and will instead expect that "
459 "whatever options or values are required for us to "
460 "work will be passed as arguments."),
461
d2e6a577
FG
462 // lockdep
463 Option("lockdep", Option::TYPE_BOOL, Option::LEVEL_DEV)
464 .set_description("enable lockdep lock dependency analyzer")
11fdf7f2 465 .set_flag(Option::FLAG_NO_MON_UPDATE)
81eedcae 466 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
467 .add_service("common"),
468
469 Option("lockdep_force_backtrace", Option::TYPE_BOOL, Option::LEVEL_DEV)
470 .set_description("always gather current backtrace at every lock")
81eedcae 471 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
472 .add_service("common")
473 .add_see_also("lockdep"),
474
475 Option("run_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
476 .set_default("/var/run/ceph")
81eedcae 477 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
478 .set_description("path for the 'run' directory for storing pid and socket files")
479 .add_service("common")
480 .add_see_also("admin_socket"),
481
482 Option("admin_socket", Option::TYPE_STR, Option::LEVEL_ADVANCED)
483 .set_default("")
484 .set_daemon_default("$run_dir/$cluster-$name.asok")
81eedcae 485 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
486 .set_description("path for the runtime control socket file, used by the 'ceph daemon' command")
487 .add_service("common"),
488
489 Option("admin_socket_mode", Option::TYPE_STR, Option::LEVEL_ADVANCED)
490 .set_description("file mode to set for the admin socket file, e.g, '0755'")
81eedcae 491 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
492 .add_service("common")
493 .add_see_also("admin_socket"),
494
d2e6a577
FG
495 // daemon
496 Option("daemonize", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
497 .set_default(false)
498 .set_daemon_default(true)
499 .set_description("whether to daemonize (background) after startup")
81eedcae 500 .set_flag(Option::FLAG_STARTUP)
11fdf7f2 501 .set_flag(Option::FLAG_NO_MON_UPDATE)
d2e6a577
FG
502 .add_service({"mon", "mgr", "osd", "mds"})
503 .add_tag("service")
504 .add_see_also({"pid_file", "chdir"}),
505
506 Option("setuser", Option::TYPE_STR, Option::LEVEL_ADVANCED)
81eedcae 507 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
508 .set_description("uid or user name to switch to on startup")
509 .set_long_description("This is normally specified by the systemd unit file.")
510 .add_service({"mon", "mgr", "osd", "mds"})
511 .add_tag("service")
512 .add_see_also("setgroup"),
513
514 Option("setgroup", Option::TYPE_STR, Option::LEVEL_ADVANCED)
81eedcae 515 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
516 .set_description("gid or group name to switch to on startup")
517 .set_long_description("This is normally specified by the systemd unit file.")
518 .add_service({"mon", "mgr", "osd", "mds"})
519 .add_tag("service")
520 .add_see_also("setuser"),
521
522 Option("setuser_match_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
81eedcae 523 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
524 .set_description("if set, setuser/setgroup is condition on this path matching ownership")
525 .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.")
526 .add_service({"mon", "mgr", "osd", "mds"})
527 .add_tag("service")
528 .add_see_also({"setuser", "setgroup"}),
529
530 Option("pid_file", Option::TYPE_STR, Option::LEVEL_ADVANCED)
81eedcae 531 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
532 .set_description("path to write a pid file (if any)")
533 .add_service({"mon", "mgr", "osd", "mds"})
534 .add_tag("service"),
535
536 Option("chdir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
537 .set_description("path to chdir(2) to after daemonizing")
81eedcae 538 .set_flag(Option::FLAG_STARTUP)
11fdf7f2 539 .set_flag(Option::FLAG_NO_MON_UPDATE)
d2e6a577
FG
540 .add_service({"mon", "mgr", "osd", "mds"})
541 .add_tag("service")
542 .add_see_also("daemonize"),
543
544 Option("fatal_signal_handlers", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
545 .set_default(true)
81eedcae 546 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
547 .set_description("whether to register signal handlers for SIGABRT etc that dump a stack trace")
548 .set_long_description("This is normally true for daemons and values for libraries.")
549 .add_service({"mon", "mgr", "osd", "mds"})
550 .add_tag("service"),
551
11fdf7f2 552 Option("crash_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
81eedcae 553 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
554 .set_default("/var/lib/ceph/crash")
555 .set_description("Directory where crash reports are archived"),
556
d2e6a577
FG
557 // restapi
558 Option("restapi_log_level", Option::TYPE_STR, Option::LEVEL_ADVANCED)
559 .set_description("default set by python code"),
560
561 Option("restapi_base_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
562 .set_description("default set by python code"),
563
564 Option("erasure_code_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
565 .set_default(CEPH_PKGLIBDIR"/erasure-code")
81eedcae 566 .set_flag(Option::FLAG_STARTUP)
d2e6a577 567 .set_description("directory where erasure-code plugins can be found")
11fdf7f2 568 .add_service({"mon", "osd"}),
d2e6a577
FG
569
570 // logging
571 Option("log_file", Option::TYPE_STR, Option::LEVEL_BASIC)
572 .set_default("")
573 .set_daemon_default("/var/log/ceph/$cluster-$name.log")
574 .set_description("path to log file")
11fdf7f2
TL
575 .add_see_also({"log_to_file",
576 "log_to_stderr",
d2e6a577
FG
577 "err_to_stderr",
578 "log_to_syslog",
579 "err_to_syslog"}),
580
581 Option("log_max_new", Option::TYPE_INT, Option::LEVEL_ADVANCED)
582 .set_default(1000)
583 .set_description("max unwritten log entries to allow before waiting to flush to the log")
584 .add_see_also("log_max_recent"),
585
586 Option("log_max_recent", Option::TYPE_INT, Option::LEVEL_ADVANCED)
587 .set_default(500)
588 .set_daemon_default(10000)
589 .set_description("recent log entries to keep in memory to dump in the event of a crash")
590 .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."),
591
11fdf7f2
TL
592 Option("log_to_file", Option::TYPE_BOOL, Option::LEVEL_BASIC)
593 .set_default(true)
594 .set_description("send log lines to a file")
595 .add_see_also("log_file"),
596
d2e6a577
FG
597 Option("log_to_stderr", Option::TYPE_BOOL, Option::LEVEL_BASIC)
598 .set_default(true)
599 .set_daemon_default(false)
600 .set_description("send log lines to stderr"),
601
602 Option("err_to_stderr", Option::TYPE_BOOL, Option::LEVEL_BASIC)
603 .set_default(false)
604 .set_daemon_default(true)
605 .set_description("send critical error log lines to stderr"),
606
b32b8144 607 Option("log_stderr_prefix", Option::TYPE_STR, Option::LEVEL_ADVANCED)
11fdf7f2
TL
608 .set_description("String to prefix log messages with when sent to stderr")
609 .set_long_description("This is useful in container environments when combined with mon_cluster_log_to_stderr. The mon log prefixes each line with the channel name (e.g., 'default', 'audit'), while log_stderr_prefix can be set to 'debug '.")
610 .add_see_also("mon_cluster_log_to_stderr"),
b32b8144 611
d2e6a577
FG
612 Option("log_to_syslog", Option::TYPE_BOOL, Option::LEVEL_BASIC)
613 .set_default(false)
614 .set_description("send log lines to syslog facility"),
615
616 Option("err_to_syslog", Option::TYPE_BOOL, Option::LEVEL_BASIC)
617 .set_default(false)
618 .set_description("send critical error log lines to syslog facility"),
619
620 Option("log_flush_on_exit", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
621 .set_default(false)
622 .set_description("set a process exit handler to ensure the log is flushed on exit"),
623
624 Option("log_stop_at_utilization", Option::TYPE_FLOAT, Option::LEVEL_BASIC)
625 .set_default(.97)
626 .set_min_max(0.0, 1.0)
627 .set_description("stop writing to the log file when device utilization reaches this ratio")
628 .add_see_also("log_file"),
629
630 Option("log_to_graylog", Option::TYPE_BOOL, Option::LEVEL_BASIC)
631 .set_default(false)
632 .set_description("send log lines to remote graylog server")
633 .add_see_also({"err_to_graylog",
634 "log_graylog_host",
635 "log_graylog_port"}),
636
637 Option("err_to_graylog", Option::TYPE_BOOL, Option::LEVEL_BASIC)
638 .set_default(false)
639 .set_description("send critical error log lines to remote graylog server")
640 .add_see_also({"log_to_graylog",
641 "log_graylog_host",
642 "log_graylog_port"}),
643
644 Option("log_graylog_host", Option::TYPE_STR, Option::LEVEL_BASIC)
645 .set_default("127.0.0.1")
646 .set_description("address or hostname of graylog server to log to")
647 .add_see_also({"log_to_graylog",
648 "err_to_graylog",
649 "log_graylog_port"}),
650
651 Option("log_graylog_port", Option::TYPE_INT, Option::LEVEL_BASIC)
652 .set_default(12201)
653 .set_description("port number for the remote graylog server")
654 .add_see_also("log_graylog_host"),
655
11fdf7f2
TL
656 Option("log_coarse_timestamps", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
657 .set_default(true)
658 .set_description("timestamp log entries from coarse system clock "
659 "to improve performance")
660 .add_service("common")
661 .add_tag("performance")
662 .add_tag("service"),
d2e6a577
FG
663
664
665 // unmodified
666 Option("clog_to_monitors", Option::TYPE_STR, Option::LEVEL_ADVANCED)
667 .set_default("default=true")
81eedcae 668 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2 669 .set_description("Make daemons send cluster log messages to monitors"),
d2e6a577
FG
670
671 Option("clog_to_syslog", Option::TYPE_STR, Option::LEVEL_ADVANCED)
672 .set_default("false")
81eedcae 673 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2 674 .set_description("Make daemons send cluster log messages to syslog"),
d2e6a577
FG
675
676 Option("clog_to_syslog_level", Option::TYPE_STR, Option::LEVEL_ADVANCED)
677 .set_default("info")
81eedcae 678 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
679 .set_description("Syslog level for cluster log messages")
680 .add_see_also("clog_to_syslog"),
d2e6a577
FG
681
682 Option("clog_to_syslog_facility", Option::TYPE_STR, Option::LEVEL_ADVANCED)
683 .set_default("default=daemon audit=local0")
81eedcae 684 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
685 .set_description("Syslog facility for cluster log messages")
686 .add_see_also("clog_to_syslog"),
d2e6a577
FG
687
688 Option("clog_to_graylog", Option::TYPE_STR, Option::LEVEL_ADVANCED)
689 .set_default("false")
81eedcae 690 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2 691 .set_description("Make daemons send cluster log to graylog"),
d2e6a577
FG
692
693 Option("clog_to_graylog_host", Option::TYPE_STR, Option::LEVEL_ADVANCED)
694 .set_default("127.0.0.1")
81eedcae 695 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
696 .set_description("Graylog host to cluster log messages")
697 .add_see_also("clog_to_graylog"),
d2e6a577
FG
698
699 Option("clog_to_graylog_port", Option::TYPE_STR, Option::LEVEL_ADVANCED)
700 .set_default("12201")
81eedcae 701 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
702 .set_description("Graylog port number for cluster log messages")
703 .add_see_also("clog_to_graylog"),
d2e6a577 704
b32b8144
FG
705 Option("mon_cluster_log_to_stderr", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
706 .set_default(false)
11fdf7f2 707 .add_service("mon")
81eedcae 708 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
709 .set_description("Make monitor send cluster log messages to stderr (prefixed by channel)")
710 .add_see_also("log_stderr_prefix"),
b32b8144 711
d2e6a577
FG
712 Option("mon_cluster_log_to_syslog", Option::TYPE_STR, Option::LEVEL_ADVANCED)
713 .set_default("default=false")
81eedcae 714 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
715 .add_service("mon")
716 .set_description("Make monitor send cluster log messages to syslog"),
d2e6a577
FG
717
718 Option("mon_cluster_log_to_syslog_level", Option::TYPE_STR, Option::LEVEL_ADVANCED)
719 .set_default("info")
11fdf7f2 720 .add_service("mon")
81eedcae 721 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
722 .set_description("Syslog level for cluster log messages")
723 .add_see_also("mon_cluster_log_to_syslog"),
d2e6a577
FG
724
725 Option("mon_cluster_log_to_syslog_facility", Option::TYPE_STR, Option::LEVEL_ADVANCED)
726 .set_default("daemon")
11fdf7f2 727 .add_service("mon")
81eedcae 728 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
729 .set_description("Syslog facility for cluster log messages")
730 .add_see_also("mon_cluster_log_to_syslog"),
731
732 Option("mon_cluster_log_to_file", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
733 .set_default(true)
81eedcae 734 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
735 .add_service("mon")
736 .set_description("Make monitor send cluster log messages to file")
737 .add_see_also("mon_cluster_log_file"),
d2e6a577
FG
738
739 Option("mon_cluster_log_file", Option::TYPE_STR, Option::LEVEL_ADVANCED)
740 .set_default("default=/var/log/ceph/$cluster.$channel.log cluster=/var/log/ceph/$cluster.log")
81eedcae 741 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
742 .add_service("mon")
743 .set_description("File(s) to write cluster log to")
744 .set_long_description("This can either be a simple file name to receive all messages, or a list of key/value pairs where the key is the log channel and the value is the filename, which may include $cluster and $channel metavariables")
745 .add_see_also("mon_cluster_log_to_file"),
d2e6a577
FG
746
747 Option("mon_cluster_log_file_level", Option::TYPE_STR, Option::LEVEL_ADVANCED)
a8e16298 748 .set_default("debug")
81eedcae 749 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
750 .add_service("mon")
751 .set_description("Lowest level to include is cluster log file")
752 .add_see_also("mon_cluster_log_file"),
d2e6a577
FG
753
754 Option("mon_cluster_log_to_graylog", Option::TYPE_STR, Option::LEVEL_ADVANCED)
755 .set_default("false")
81eedcae 756 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
757 .add_service("mon")
758 .set_description("Make monitor send cluster log to graylog"),
d2e6a577
FG
759
760 Option("mon_cluster_log_to_graylog_host", Option::TYPE_STR, Option::LEVEL_ADVANCED)
761 .set_default("127.0.0.1")
81eedcae 762 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
763 .add_service("mon")
764 .set_description("Graylog host for cluster log messages")
765 .add_see_also("mon_cluster_log_to_graylog"),
d2e6a577
FG
766
767 Option("mon_cluster_log_to_graylog_port", Option::TYPE_STR, Option::LEVEL_ADVANCED)
768 .set_default("12201")
81eedcae 769 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
770 .add_service("mon")
771 .set_description("Graylog port for cluster log messages")
772 .add_see_also("mon_cluster_log_to_graylog"),
d2e6a577
FG
773
774 Option("enable_experimental_unrecoverable_data_corrupting_features", Option::TYPE_STR, Option::LEVEL_ADVANCED)
81eedcae 775 .set_flag(Option::FLAG_RUNTIME)
d2e6a577 776 .set_default("")
11fdf7f2 777 .set_description("Enable named (or all with '*') experimental features that may be untested, dangerous, and/or cause permanent data loss"),
d2e6a577
FG
778
779 Option("plugin_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
780 .set_default(CEPH_PKGLIBDIR)
81eedcae 781 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
782 .add_service({"mon", "osd"})
783 .set_description("Base directory for dynamically loaded plugins"),
d2e6a577 784
11fdf7f2 785 // Compressor
d2e6a577
FG
786 Option("compressor_zlib_isal", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
787 .set_default(false)
11fdf7f2 788 .set_description("Use Intel ISA-L accelerated zlib implementation if available"),
d2e6a577
FG
789
790 Option("compressor_zlib_level", Option::TYPE_INT, Option::LEVEL_ADVANCED)
791 .set_default(5)
11fdf7f2 792 .set_description("Zlib compression level to use"),
d2e6a577 793
f91f0fd5
TL
794 Option("compressor_zstd_level", Option::TYPE_INT, Option::LEVEL_ADVANCED)
795 .set_default(1)
796 .set_description("Zstd compression level to use"),
797
11fdf7f2 798 Option("qat_compressor_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
d2e6a577 799 .set_default(false)
11fdf7f2 800 .set_description("Enable Intel QAT acceleration support for compression if available"),
d2e6a577
FG
801
802 Option("plugin_crypto_accelerator", Option::TYPE_STR, Option::LEVEL_ADVANCED)
803 .set_default("crypto_isal")
11fdf7f2 804 .set_description("Crypto accelerator library to use"),
d2e6a577 805
11fdf7f2 806 Option("mempool_debug", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 807 .set_default(false)
11fdf7f2 808 .set_flag(Option::FLAG_NO_MON_UPDATE)
d2e6a577
FG
809 .set_description(""),
810
92f5a8d4
TL
811 Option("thp", Option::TYPE_BOOL, Option::LEVEL_DEV)
812 .set_default(false)
813 .set_flag(Option::FLAG_STARTUP)
814 .set_description("enable transparent huge page (THP) support")
815 .set_long_description("Ceph is known to suffer from memory fragmentation due to THP use. This is indicated by RSS usage above configured memory targets. Enabling THP is currently discouraged until selective use of THP by Ceph is implemented."),
816
d2e6a577
FG
817 Option("key", Option::TYPE_STR, Option::LEVEL_ADVANCED)
818 .set_default("")
3efd9988
FG
819 .set_description("Authentication key")
820 .set_long_description("A CephX authentication key, base64 encoded. It normally looks something like 'AQAtut9ZdMbNJBAAHz6yBAWyJyz2yYRyeMWDag=='.")
81eedcae 821 .set_flag(Option::FLAG_STARTUP)
11fdf7f2 822 .set_flag(Option::FLAG_NO_MON_UPDATE)
3efd9988
FG
823 .add_see_also("keyfile")
824 .add_see_also("keyring"),
d2e6a577
FG
825
826 Option("keyfile", Option::TYPE_STR, Option::LEVEL_ADVANCED)
827 .set_default("")
3efd9988
FG
828 .set_description("Path to a file containing a key")
829 .set_long_description("The file should contain a CephX authentication key and optionally a trailing newline, but nothing else.")
81eedcae 830 .set_flag(Option::FLAG_STARTUP)
11fdf7f2 831 .set_flag(Option::FLAG_NO_MON_UPDATE)
3efd9988 832 .add_see_also("key"),
d2e6a577
FG
833
834 Option("keyring", Option::TYPE_STR, Option::LEVEL_ADVANCED)
835 .set_default(
836 "/etc/ceph/$cluster.$name.keyring,/etc/ceph/$cluster.keyring,"
11fdf7f2 837 "/etc/ceph/keyring,/etc/ceph/keyring.bin,"
d2e6a577
FG
838 #if defined(__FreeBSD)
839 "/usr/local/etc/ceph/$cluster.$name.keyring,"
840 "/usr/local/etc/ceph/$cluster.keyring,"
11fdf7f2 841 "/usr/local/etc/ceph/keyring,/usr/local/etc/ceph/keyring.bin,"
d2e6a577
FG
842 #endif
843 )
3efd9988
FG
844 .set_description("Path to a keyring file.")
845 .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.")
81eedcae 846 .set_flag(Option::FLAG_STARTUP)
11fdf7f2 847 .set_flag(Option::FLAG_NO_MON_UPDATE)
3efd9988
FG
848 .add_see_also("key")
849 .add_see_also("keyfile"),
d2e6a577
FG
850
851 Option("heartbeat_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
852 .set_default(5)
81eedcae 853 .set_flag(Option::FLAG_STARTUP)
11fdf7f2 854 .set_description("Frequency of internal heartbeat checks (seconds)"),
d2e6a577
FG
855
856 Option("heartbeat_file", Option::TYPE_STR, Option::LEVEL_ADVANCED)
857 .set_default("")
81eedcae 858 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
859 .set_description("File to touch on successful internal heartbeat")
860 .set_long_description("If set, this file will be touched every time an internal heartbeat check succeeds.")
861 .add_see_also("heartbeat_interval"),
d2e6a577
FG
862
863 Option("heartbeat_inject_failure", Option::TYPE_INT, Option::LEVEL_DEV)
864 .set_default(0)
865 .set_description(""),
866
867 Option("perf", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
868 .set_default(true)
11fdf7f2
TL
869 .set_description("Enable internal performance metrics")
870 .set_long_description("If enabled, collect and expose internal health metrics"),
d2e6a577
FG
871
872 Option("ms_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
81eedcae 873 .set_flag(Option::FLAG_STARTUP)
d2e6a577 874 .set_default("async+posix")
11fdf7f2 875 .set_description("Messenger implementation to use for network communication"),
d2e6a577
FG
876
877 Option("ms_public_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
878 .set_default("")
81eedcae 879 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
880 .set_description("Messenger implementation to use for the public network")
881 .set_long_description("If not specified, use ms_type")
882 .add_see_also("ms_type"),
d2e6a577
FG
883
884 Option("ms_cluster_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
885 .set_default("")
81eedcae 886 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
887 .set_description("Messenger implementation to use for the internal cluster network")
888 .set_long_description("If not specified, use ms_type")
889 .add_see_also("ms_type"),
890
891 Option("ms_mon_cluster_mode", Option::TYPE_STR, Option::LEVEL_BASIC)
494da23a 892 .set_default("secure crc")
81eedcae 893 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
894 .set_description("Connection modes (crc, secure) for intra-mon connections in order of preference")
895 .add_see_also("ms_mon_service_mode")
896 .add_see_also("ms_mon_client_mode")
897 .add_see_also("ms_service_mode")
898 .add_see_also("ms_cluster_mode")
899 .add_see_also("ms_client_mode"),
900
901 Option("ms_mon_service_mode", Option::TYPE_STR, Option::LEVEL_BASIC)
494da23a 902 .set_default("secure crc")
81eedcae 903 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
904 .set_description("Allowed connection modes (crc, secure) for connections to mons")
905 .add_see_also("ms_service_mode")
906 .add_see_also("ms_mon_cluster_mode")
907 .add_see_also("ms_mon_client_mode")
908 .add_see_also("ms_cluster_mode")
909 .add_see_also("ms_client_mode"),
910
911 Option("ms_mon_client_mode", Option::TYPE_STR, Option::LEVEL_BASIC)
494da23a 912 .set_default("secure crc")
81eedcae 913 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
914 .set_description("Connection modes (crc, secure) for connections from clients to monitors in order of preference")
915 .add_see_also("ms_mon_service_mode")
916 .add_see_also("ms_mon_cluster_mode")
917 .add_see_also("ms_service_mode")
918 .add_see_also("ms_cluster_mode")
919 .add_see_also("ms_client_mode"),
920
921 Option("ms_cluster_mode", Option::TYPE_STR, Option::LEVEL_BASIC)
494da23a 922 .set_default("crc secure")
81eedcae 923 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
924 .set_description("Connection modes (crc, secure) for intra-cluster connections in order of preference")
925 .add_see_also("ms_service_mode")
926 .add_see_also("ms_client_mode"),
927
928 Option("ms_service_mode", Option::TYPE_STR, Option::LEVEL_BASIC)
494da23a 929 .set_default("crc secure")
81eedcae 930 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
931 .set_description("Allowed connection modes (crc, secure) for connections to daemons")
932 .add_see_also("ms_cluster_mode")
933 .add_see_also("ms_client_mode"),
934
935 Option("ms_client_mode", Option::TYPE_STR, Option::LEVEL_BASIC)
494da23a 936 .set_default("crc secure")
81eedcae 937 .set_flag(Option::FLAG_STARTUP)
11fdf7f2
TL
938 .set_description("Connection modes (crc, secure) for connections from clients in order of preference")
939 .add_see_also("ms_cluster_mode")
940 .add_see_also("ms_service_mode"),
d2e6a577 941
81eedcae
TL
942 Option("ms_learn_addr_from_peer", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
943 .set_default(true)
944 .set_description("Learn address from what IP our first peer thinks we connect from")
945 .set_long_description("Use the IP address our first peer (usually a monitor) sees that we are connecting from. This is useful if a client is behind some sort of NAT and we want to see it identified by its local (not NATed) address."),
946
d2e6a577
FG
947 Option("ms_tcp_nodelay", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
948 .set_default(true)
11fdf7f2 949 .set_description("Disable Nagle's algorithm and send queued network traffic immediately"),
d2e6a577 950
11fdf7f2 951 Option("ms_tcp_rcvbuf", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 952 .set_default(0)
11fdf7f2 953 .set_description("Size of TCP socket receive buffer"),
d2e6a577 954
11fdf7f2 955 Option("ms_tcp_prefetch_max_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 956 .set_default(4_K)
11fdf7f2 957 .set_description("Maximum amount of data to prefetch out of the socket receive buffer"),
d2e6a577
FG
958
959 Option("ms_initial_backoff", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
960 .set_default(.2)
11fdf7f2 961 .set_description("Initial backoff after a network error is detected (seconds)"),
d2e6a577
FG
962
963 Option("ms_max_backoff", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
964 .set_default(15.0)
11fdf7f2
TL
965 .set_description("Maximum backoff after a network error before retrying (seconds)")
966 .add_see_also("ms_initial_backoff"),
d2e6a577 967
11fdf7f2 968 Option("ms_crc_data", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 969 .set_default(true)
11fdf7f2 970 .set_description("Set and/or verify crc32c checksum on data payload sent over network"),
d2e6a577 971
11fdf7f2 972 Option("ms_crc_header", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 973 .set_default(true)
11fdf7f2 974 .set_description("Set and/or verify crc32c checksum on header payload sent over network"),
d2e6a577 975
11fdf7f2 976 Option("ms_die_on_bad_msg", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 977 .set_default(false)
11fdf7f2 978 .set_description("Induce a daemon crash/exit when a bad network message is received"),
d2e6a577 979
11fdf7f2 980 Option("ms_die_on_unhandled_msg", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 981 .set_default(false)
11fdf7f2 982 .set_description("Induce a daemon crash/exit when an unrecognized message is received"),
d2e6a577 983
11fdf7f2 984 Option("ms_die_on_old_message", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 985 .set_default(false)
11fdf7f2 986 .set_description("Induce a daemon crash/exit when a old, undecodable message is received"),
d2e6a577 987
11fdf7f2 988 Option("ms_die_on_skipped_message", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 989 .set_default(false)
11fdf7f2 990 .set_description("Induce a daemon crash/exit if sender skips a message sequence number"),
d2e6a577 991
11fdf7f2
TL
992 Option("ms_die_on_bug", Option::TYPE_BOOL, Option::LEVEL_DEV)
993 .set_default(false)
994 .set_description("Induce a crash/exit on various bugs (for testing purposes)"),
995
996 Option("ms_dispatch_throttle_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
997 .set_default(100_M)
998 .set_description("Limit messages that are read off the network but still being processed"),
999
11fdf7f2
TL
1000 Option("ms_bind_ipv4", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1001 .set_default(true)
1002 .set_description("Bind servers to IPv4 address(es)")
1003 .add_see_also("ms_bind_ipv6"),
d2e6a577
FG
1004
1005 Option("ms_bind_ipv6", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1006 .set_default(false)
11fdf7f2
TL
1007 .set_description("Bind servers to IPv6 address(es)")
1008 .add_see_also("ms_bind_ipv4"),
1009
1010 Option("ms_bind_prefer_ipv4", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1011 .set_default(false)
1012 .set_description("Prefer IPV4 over IPV6 address(es)"),
1013
1014 Option("ms_bind_msgr1", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1015 .set_default(true)
1016 .set_description("Bind servers to msgr1 (legacy) protocol address(es)")
1017 .add_see_also("ms_bind_msgr2"),
1018
1019 Option("ms_bind_msgr2", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1020 .set_default(true)
1021 .set_description("Bind servers to msgr2 (nautilus+) protocol address(es)")
1022 .add_see_also("ms_bind_msgr1"),
d2e6a577
FG
1023
1024 Option("ms_bind_port_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1025 .set_default(6800)
11fdf7f2 1026 .set_description("Lowest port number to bind daemon(s) to"),
d2e6a577
FG
1027
1028 Option("ms_bind_port_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1029 .set_default(7300)
11fdf7f2 1030 .set_description("Highest port number to bind daemon(s) to"),
d2e6a577
FG
1031
1032 Option("ms_bind_retry_count", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1033 #if !defined(__FreeBSD__)
1034 .set_default(3)
1035 #else
1036 // FreeBSD does not use SO_REAUSEADDR so allow for a bit more time per default
1037 .set_default(6)
1038 #endif
11fdf7f2 1039 .set_description("Number of attempts to make while bind(2)ing to a port"),
d2e6a577
FG
1040
1041 Option("ms_bind_retry_delay", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1042 #if !defined(__FreeBSD__)
1043 .set_default(5)
1044 #else
1045 // FreeBSD does not use SO_REAUSEADDR so allow for a bit more time per default
1046 .set_default(6)
1047 #endif
11fdf7f2 1048 .set_description("Delay between bind(2) attempts (seconds)"),
d2e6a577
FG
1049
1050 Option("ms_bind_before_connect", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1051 .set_default(false)
11fdf7f2 1052 .set_description("Call bind(2) on client sockets"),
d2e6a577
FG
1053
1054 Option("ms_tcp_listen_backlog", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1055 .set_default(512)
11fdf7f2 1056 .set_description("Size of queue of incoming connections for accept(2)"),
d2e6a577 1057
d2e6a577 1058
81eedcae
TL
1059 Option("ms_connection_ready_timeout", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1060 .set_default(10)
1061 .set_description("Time before we declare a not yet ready connection as dead (seconds)"),
1062
1063 Option("ms_connection_idle_timeout", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 1064 .set_default(900)
81eedcae 1065 .set_description("Time before an idle connection is closed (seconds)"),
d2e6a577 1066
11fdf7f2 1067 Option("ms_pq_max_tokens_per_priority", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
1068 .set_default(16777216)
1069 .set_description(""),
1070
11fdf7f2 1071 Option("ms_pq_min_cost", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
1072 .set_default(65536)
1073 .set_description(""),
1074
1075 Option("ms_inject_socket_failures", Option::TYPE_UINT, Option::LEVEL_DEV)
1076 .set_default(0)
11fdf7f2 1077 .set_description("Inject a socket failure every Nth socket operation"),
d2e6a577
FG
1078
1079 Option("ms_inject_delay_type", Option::TYPE_STR, Option::LEVEL_DEV)
1080 .set_default("")
11fdf7f2
TL
1081 .set_description("Entity type to inject delays for")
1082 .set_flag(Option::FLAG_RUNTIME),
d2e6a577
FG
1083
1084 Option("ms_inject_delay_msg_type", Option::TYPE_STR, Option::LEVEL_DEV)
1085 .set_default("")
11fdf7f2 1086 .set_description("Message type to inject delays for"),
d2e6a577
FG
1087
1088 Option("ms_inject_delay_max", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1089 .set_default(1)
11fdf7f2 1090 .set_description("Max delay to inject"),
d2e6a577
FG
1091
1092 Option("ms_inject_delay_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1093 .set_default(0)
1094 .set_description(""),
1095
1096 Option("ms_inject_internal_delays", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1097 .set_default(0)
11fdf7f2 1098 .set_description("Inject various internal delays to induce races (seconds)"),
d2e6a577 1099
9f95a23c
TL
1100 Option("ms_blackhole_osd", Option::TYPE_BOOL, Option::LEVEL_DEV)
1101 .set_default(false)
1102 .set_description(""),
1103
1104 Option("ms_blackhole_mon", Option::TYPE_BOOL, Option::LEVEL_DEV)
1105 .set_default(false)
1106 .set_description(""),
1107
1108 Option("ms_blackhole_mds", Option::TYPE_BOOL, Option::LEVEL_DEV)
1109 .set_default(false)
1110 .set_description(""),
1111
1112 Option("ms_blackhole_mgr", Option::TYPE_BOOL, Option::LEVEL_DEV)
1113 .set_default(false)
1114 .set_description(""),
1115
1116 Option("ms_blackhole_client", Option::TYPE_BOOL, Option::LEVEL_DEV)
1117 .set_default(false)
1118 .set_description(""),
1119
d2e6a577
FG
1120 Option("ms_dump_on_send", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1121 .set_default(false)
11fdf7f2 1122 .set_description("Hexdump message to debug log on message send"),
d2e6a577
FG
1123
1124 Option("ms_dump_corrupt_message_level", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1125 .set_default(1)
11fdf7f2 1126 .set_description("Log level at which to hexdump corrupt messages we receive"),
d2e6a577
FG
1127
1128 Option("ms_async_op_threads", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1129 .set_default(3)
11fdf7f2
TL
1130 .set_min_max(1, 24)
1131 .set_description("Threadpool size for AsyncMessenger (ms_type=async)"),
d2e6a577
FG
1132
1133 Option("ms_async_max_op_threads", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1134 .set_default(5)
11fdf7f2
TL
1135 .set_description("Maximum threadpool size of AsyncMessenger")
1136 .add_see_also("ms_async_op_threads"),
d2e6a577
FG
1137
1138 Option("ms_async_rdma_device_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1139 .set_default("")
1140 .set_description(""),
1141
1142 Option("ms_async_rdma_enable_hugepage", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1143 .set_default(false)
1144 .set_description(""),
1145
11fdf7f2 1146 Option("ms_async_rdma_buffer_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 1147 .set_default(128_K)
d2e6a577
FG
1148 .set_description(""),
1149
1150 Option("ms_async_rdma_send_buffers", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
b32b8144 1151 .set_default(1_K)
d2e6a577
FG
1152 .set_description(""),
1153
1154 Option("ms_async_rdma_receive_buffers", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
11fdf7f2
TL
1155 .set_default(32768)
1156 .set_description(""),
1157
1158 Option("ms_async_rdma_receive_queue_len", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1159 .set_default(4096)
1160 .set_description(""),
1161
1162 Option("ms_async_rdma_support_srq", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1163 .set_default(true)
d2e6a577
FG
1164 .set_description(""),
1165
1166 Option("ms_async_rdma_port_num", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1167 .set_default(1)
1168 .set_description(""),
1169
1170 Option("ms_async_rdma_polling_us", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1171 .set_default(1000)
1172 .set_description(""),
1173
9f95a23c
TL
1174 Option("ms_async_rdma_gid_idx", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1175 .set_default(0)
1176 .set_description("use gid_idx to select GID for choosing RoCEv1 or RoCEv2"),
1177
d2e6a577
FG
1178 Option("ms_async_rdma_local_gid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1179 .set_default("")
1180 .set_description(""),
1181
1182 Option("ms_async_rdma_roce_ver", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1183 .set_default(1)
1184 .set_description(""),
1185
1186 Option("ms_async_rdma_sl", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1187 .set_default(3)
1188 .set_description(""),
1189
1190 Option("ms_async_rdma_dscp", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1191 .set_default(96)
1192 .set_description(""),
1193
91327a77
AA
1194 Option("ms_max_accept_failures", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1195 .set_default(4)
1196 .set_description("The maximum number of consecutive failed accept() calls before "
1197 "considering the daemon is misconfigured and abort it."),
1198
11fdf7f2
TL
1199 Option("ms_async_rdma_cm", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1200 .set_default(false)
1201 .set_description(""),
1202
1203 Option("ms_async_rdma_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1204 .set_default("ib")
1205 .set_description(""),
1206
d2e6a577
FG
1207 Option("ms_dpdk_port_id", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1208 .set_default(0)
1209 .set_description(""),
1210
1211 Option("ms_dpdk_coremask", Option::TYPE_STR, Option::LEVEL_ADVANCED)
11fdf7f2 1212 .set_default("0xF") //begin with 0x for the string
d2e6a577 1213 .set_description("")
11fdf7f2 1214 .add_see_also("ms_async_op_threads"),
d2e6a577
FG
1215
1216 Option("ms_dpdk_memory_channel", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1217 .set_default("4")
1218 .set_description(""),
1219
1220 Option("ms_dpdk_hugepages", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1221 .set_default("")
1222 .set_description(""),
1223
1224 Option("ms_dpdk_pmd", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1225 .set_default("")
1226 .set_description(""),
1227
1228 Option("ms_dpdk_host_ipv4_addr", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1229 .set_default("")
11fdf7f2 1230 .set_description(""),
d2e6a577
FG
1231
1232 Option("ms_dpdk_gateway_ipv4_addr", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1233 .set_default("")
11fdf7f2 1234 .set_description(""),
d2e6a577
FG
1235
1236 Option("ms_dpdk_netmask_ipv4_addr", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1237 .set_default("")
11fdf7f2 1238 .set_description(""),
c07f9fc5 1239
d2e6a577
FG
1240 Option("ms_dpdk_lro", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1241 .set_default(true)
1242 .set_description(""),
c07f9fc5 1243
d2e6a577
FG
1244 Option("ms_dpdk_hw_flow_control", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1245 .set_default(true)
1246 .set_description(""),
c07f9fc5 1247
d2e6a577
FG
1248 Option("ms_dpdk_hw_queue_weight", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1249 .set_default(1)
1250 .set_description(""),
c07f9fc5 1251
d2e6a577
FG
1252 Option("ms_dpdk_debug_allow_loopback", Option::TYPE_BOOL, Option::LEVEL_DEV)
1253 .set_default(false)
1254 .set_description(""),
c07f9fc5 1255
d2e6a577
FG
1256 Option("ms_dpdk_rx_buffer_count_per_core", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1257 .set_default(8192)
1258 .set_description(""),
c07f9fc5 1259
d2e6a577
FG
1260 Option("inject_early_sigterm", Option::TYPE_BOOL, Option::LEVEL_DEV)
1261 .set_default(false)
11fdf7f2
TL
1262 .set_description("send ourselves a SIGTERM early during startup"),
1263
1264 // MON
1265 Option("mon_enable_op_tracker", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1266 .set_default(true)
1267 .add_service("mon")
1268 .set_description("enable/disable MON op tracking"),
1269
1270 Option("mon_op_complaint_time", Option::TYPE_SECS, Option::LEVEL_ADVANCED)
1271 .set_default(30)
1272 .add_service("mon")
1273 .set_description("time after which to consider a monitor operation blocked "
1274 "after no updates"),
1275
1276 Option("mon_op_log_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1277 .set_default(5)
1278 .add_service("mon")
1279 .set_description("max number of slow ops to display"),
1280
1281 Option("mon_op_history_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1282 .set_default(20)
1283 .add_service("mon")
1284 .set_description("max number of completed ops to track"),
1285
1286 Option("mon_op_history_duration", Option::TYPE_SECS, Option::LEVEL_ADVANCED)
1287 .set_default(600)
1288 .add_service("mon")
1289 .set_description("expiration time in seconds of historical MON OPS"),
1290
1291 Option("mon_op_history_slow_op_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1292 .set_default(20)
1293 .add_service("mon")
1294 .set_description("max number of slow historical MON OPS to keep"),
1295
1296 Option("mon_op_history_slow_op_threshold", Option::TYPE_SECS, Option::LEVEL_ADVANCED)
1297 .set_default(10)
1298 .add_service("mon")
1299 .set_description("duration of an op to be considered as a historical slow op"),
c07f9fc5 1300
d2e6a577 1301 Option("mon_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
11fdf7f2 1302 .set_flag(Option::FLAG_NO_MON_UPDATE)
d2e6a577 1303 .set_default("/var/lib/ceph/mon/$cluster-$id")
11fdf7f2
TL
1304 .add_service("mon")
1305 .set_description("path to mon database"),
c07f9fc5 1306
d2e6a577
FG
1307 Option("mon_initial_members", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1308 .set_default("")
11fdf7f2
TL
1309 .add_service("mon")
1310 .set_flag(Option::FLAG_NO_MON_UPDATE)
1311 .set_flag(Option::FLAG_CLUSTER_CREATE)
d2e6a577 1312 .set_description(""),
c07f9fc5 1313
d2e6a577
FG
1314 Option("mon_compact_on_start", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1315 .set_default(false)
11fdf7f2 1316 .add_service("mon")
d2e6a577 1317 .set_description(""),
c07f9fc5 1318
d2e6a577
FG
1319 Option("mon_compact_on_bootstrap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1320 .set_default(false)
11fdf7f2 1321 .add_service("mon")
d2e6a577 1322 .set_description(""),
c07f9fc5 1323
d2e6a577
FG
1324 Option("mon_compact_on_trim", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1325 .set_default(true)
11fdf7f2 1326 .add_service("mon")
d2e6a577 1327 .set_description(""),
c07f9fc5 1328
11fdf7f2
TL
1329 /* -- mon: osdmap prune (begin) -- */
1330 Option("mon_osdmap_full_prune_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1331 .set_default(true)
1332 .add_service("mon")
1333 .set_description("enables pruning full osdmap versions when we go over a given number of maps")
1334 .add_see_also("mon_osdmap_full_prune_min")
1335 .add_see_also("mon_osdmap_full_prune_interval")
1336 .add_see_also("mon_osdmap_full_prune_txsize"),
1337
1338 Option("mon_osdmap_full_prune_min", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1339 .set_default(10000)
1340 .add_service("mon")
1341 .set_description("minimum number of versions in the store to trigger full map pruning")
1342 .add_see_also("mon_osdmap_full_prune_enabled")
1343 .add_see_also("mon_osdmap_full_prune_interval")
1344 .add_see_also("mon_osdmap_full_prune_txsize"),
1345
1346 Option("mon_osdmap_full_prune_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1347 .set_default(10)
1348 .add_service("mon")
1349 .set_description("interval between maps that will not be pruned; maps in the middle will be pruned.")
1350 .add_see_also("mon_osdmap_full_prune_enabled")
1351 .add_see_also("mon_osdmap_full_prune_interval")
1352 .add_see_also("mon_osdmap_full_prune_txsize"),
1353
1354 Option("mon_osdmap_full_prune_txsize", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1355 .set_default(100)
1356 .add_service("mon")
1357 .set_description("number of maps we will prune per iteration")
1358 .add_see_also("mon_osdmap_full_prune_enabled")
1359 .add_see_also("mon_osdmap_full_prune_interval")
1360 .add_see_also("mon_osdmap_full_prune_txsize"),
1361 /* -- mon: osdmap prune (end) -- */
1362
d2e6a577 1363 Option("mon_osd_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
f64942e4 1364 .set_default(500)
11fdf7f2
TL
1365 .add_service("mon")
1366 .set_description("maximum number of OSDMaps to cache in memory"),
c07f9fc5 1367
eafe8130
TL
1368 Option("mon_osd_cache_size_min", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
1369 .set_default(128_M)
1370 .add_service("mon")
1371 .set_description("The minimum amount of bytes to be kept mapped in memory for osd monitor caches."),
1372
1373 Option("mon_memory_target", Option::TYPE_SIZE, Option::LEVEL_BASIC)
1374 .set_default(2_G)
1375 .set_flag(Option::FLAG_RUNTIME)
1376 .add_service("mon")
1377 .set_description("The amount of bytes pertaining to osd monitor caches and kv cache to be kept mapped in memory with cache auto-tuning enabled"),
1378
1379 Option("mon_memory_autotune", Option::TYPE_BOOL, Option::LEVEL_BASIC)
1380 .set_default(true)
1381 .set_flag(Option::FLAG_RUNTIME)
1382 .add_service("mon")
1383 .set_description("Autotune the cache memory being used for osd monitors and kv database"),
1384
d2e6a577
FG
1385 Option("mon_cpu_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1386 .set_default(4)
11fdf7f2
TL
1387 .add_service("mon")
1388 .set_description("worker threads for CPU intensive background work"),
c07f9fc5 1389
11fdf7f2 1390 Option("mon_osd_mapping_pgs_per_chunk", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577 1391 .set_default(4096)
11fdf7f2
TL
1392 .add_service("mon")
1393 .set_description("granularity of PG placement calculation background work"),
c07f9fc5 1394
9f95a23c 1395 Option("mon_clean_pg_upmaps_per_chunk", Option::TYPE_UINT, Option::LEVEL_DEV)
494da23a
TL
1396 .set_default(256)
1397 .add_service("mon")
1398 .set_description("granularity of PG upmap validation background work"),
1399
d2e6a577
FG
1400 Option("mon_osd_max_creating_pgs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1401 .set_default(1024)
11fdf7f2
TL
1402 .add_service("mon")
1403 .set_description("maximum number of PGs the mon will create at once"),
1404
1405 Option("mon_osd_max_initial_pgs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1406 .set_default(1024)
1407 .add_service("mon")
1408 .set_description("maximum number of PGs a pool will created with")
1409 .set_long_description("If the user specifies more PGs than this, the cluster will subsequently split PGs after the pool is created in order to reach the target."),
c07f9fc5 1410
d2e6a577
FG
1411 Option("mon_tick_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1412 .set_default(5)
11fdf7f2
TL
1413 .add_service("mon")
1414 .set_description("interval for internal mon background checks"),
c07f9fc5 1415
d2e6a577
FG
1416 Option("mon_session_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1417 .set_default(300)
11fdf7f2
TL
1418 .add_service("mon")
1419 .set_description("close inactive mon client connections after this many seconds"),
c07f9fc5 1420
11fdf7f2 1421 Option("mon_subscribe_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
b32b8144 1422 .set_default(1_day)
11fdf7f2
TL
1423 .add_service("mon")
1424 .set_description("subscribe interval for pre-jewel clients"),
c07f9fc5 1425
d2e6a577
FG
1426 Option("mon_delta_reset_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1427 .set_default(10)
11fdf7f2
TL
1428 .add_service("mon")
1429 .add_service("mon")
1430 .set_description("window duration for rate calculations in 'ceph status'"),
1431
d2e6a577 1432 Option("mon_osd_laggy_halflife", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144 1433 .set_default(1_hr)
11fdf7f2
TL
1434 .add_service("mon")
1435 .set_description("halflife of OSD 'lagginess' factor"),
c07f9fc5 1436
d2e6a577
FG
1437 Option("mon_osd_laggy_weight", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1438 .set_default(.3)
11fdf7f2
TL
1439 .set_min_max(0.0, 1.0)
1440 .add_service("mon")
1441 .set_description("how heavily to weight OSD marking itself back up in overall laggy_probability")
1442 .set_long_description("1.0 means that an OSD marking itself back up (because it was marked down but not actually dead) means a 100% laggy_probability; 0.0 effectively disables tracking of laggy_probability."),
c07f9fc5 1443
d2e6a577
FG
1444 Option("mon_osd_laggy_max_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1445 .set_default(300)
11fdf7f2
TL
1446 .add_service("mon")
1447 .set_description("cap value for period for OSD to be marked for laggy_interval calculation"),
c07f9fc5 1448
d2e6a577
FG
1449 Option("mon_osd_adjust_heartbeat_grace", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1450 .set_default(true)
11fdf7f2
TL
1451 .add_service("mon")
1452 .set_description("increase OSD heartbeat grace if peers appear to be laggy")
1453 .set_long_description("If an OSD is marked down but then marks itself back up, it implies it wasn't actually down but was unable to respond to heartbeats. If this option is true, we can use the laggy_probability and laggy_interval values calculated to model this situation to increase the heartbeat grace period for this OSD so that it isn't marked down again. laggy_probability is an estimated probability that the given OSD is down because it is laggy (not actually down), and laggy_interval is an estiate on how long it stays down when it is laggy.")
1454 .add_see_also("mon_osd_laggy_halflife")
1455 .add_see_also("mon_osd_laggy_weight")
1456 .add_see_also("mon_osd_laggy_max_interval"),
c07f9fc5 1457
d2e6a577
FG
1458 Option("mon_osd_adjust_down_out_interval", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1459 .set_default(true)
11fdf7f2
TL
1460 .add_service("mon")
1461 .set_description("increase the mon_osd_down_out_interval if an OSD appears to be laggy")
1462 .add_see_also("mon_osd_adjust_heartbeat_grace"),
c07f9fc5 1463
d2e6a577
FG
1464 Option("mon_osd_auto_mark_in", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1465 .set_default(false)
11fdf7f2
TL
1466 .add_service("mon")
1467 .set_description("mark any OSD that comes up 'in'"),
c07f9fc5 1468
d2e6a577
FG
1469 Option("mon_osd_auto_mark_auto_out_in", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1470 .set_default(true)
11fdf7f2
TL
1471 .add_service("mon")
1472 .set_description("mark any OSD that comes up that was automatically marked 'out' back 'in'")
1473 .add_see_also("mon_osd_down_out_interval"),
c07f9fc5 1474
d2e6a577
FG
1475 Option("mon_osd_auto_mark_new_in", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1476 .set_default(true)
11fdf7f2
TL
1477 .add_service("mon")
1478 .set_description("mark any new OSD that comes up 'in'"),
c07f9fc5 1479
d2e6a577
FG
1480 Option("mon_osd_destroyed_out_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1481 .set_default(600)
11fdf7f2
TL
1482 .add_service("mon")
1483 .set_description("mark any OSD 'out' that has been 'destroy'ed for this long (seconds)"),
c07f9fc5 1484
d2e6a577
FG
1485 Option("mon_osd_down_out_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1486 .set_default(600)
11fdf7f2
TL
1487 .add_service("mon")
1488 .set_description("mark any OSD 'out' that has been 'down' for this long (seconds)"),
c07f9fc5 1489
d2e6a577
FG
1490 Option("mon_osd_down_out_subtree_limit", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1491 .set_default("rack")
11fdf7f2
TL
1492 .set_flag(Option::FLAG_RUNTIME)
1493 .add_service("mon")
1494 .set_description("do not automatically mark OSDs 'out' if an entire subtree of this size is down")
1495 .add_see_also("mon_osd_down_out_interval"),
c07f9fc5 1496
d2e6a577
FG
1497 Option("mon_osd_min_up_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1498 .set_default(.3)
11fdf7f2
TL
1499 .add_service("mon")
1500 .set_description("do not automatically mark OSDs 'out' if fewer than this many OSDs are 'up'")
1501 .add_see_also("mon_osd_down_out_interval"),
c07f9fc5 1502
d2e6a577
FG
1503 Option("mon_osd_min_in_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1504 .set_default(.75)
11fdf7f2
TL
1505 .add_service("mon")
1506 .set_description("do not automatically mark OSDs 'out' if fewer than this many OSDs are 'in'")
1507 .add_see_also("mon_osd_down_out_interval"),
c07f9fc5 1508
d2e6a577
FG
1509 Option("mon_osd_warn_op_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1510 .set_default(32)
11fdf7f2
TL
1511 .add_service("mgr")
1512 .set_description("issue REQUEST_SLOW health warning if OSD ops are slower than this age (seconds)"),
c07f9fc5 1513
f6b5b4d7
TL
1514 Option("mon_osd_warn_num_repaired", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1515 .set_default(10)
1516 .add_service("mon")
1517 .set_description("issue OSD_TOO_MANY_REPAIRS health warning if an OSD has more than this many read repairs"),
1518
d2e6a577
FG
1519 Option("mon_osd_err_op_age_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1520 .set_default(128)
11fdf7f2
TL
1521 .add_service("mgr")
1522 .set_description("issue REQUEST_STUCK health error if OSD ops are slower than is age (seconds)"),
c07f9fc5 1523
11fdf7f2 1524 Option("mon_osd_prime_pg_temp", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 1525 .set_default(true)
11fdf7f2
TL
1526 .add_service("mon")
1527 .set_description("minimize peering work by priming pg_temp values after a map change"),
c07f9fc5 1528
11fdf7f2 1529 Option("mon_osd_prime_pg_temp_max_time", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577 1530 .set_default(.5)
11fdf7f2
TL
1531 .add_service("mon")
1532 .set_description("maximum time to spend precalculating PG mappings on map change (seconds)"),
c07f9fc5 1533
d2e6a577
FG
1534 Option("mon_osd_prime_pg_temp_max_estimate", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1535 .set_default(.25)
11fdf7f2
TL
1536 .add_service("mon")
1537 .set_description("calculate all PG mappings if estimated fraction of PGs that change is above this amount"),
c07f9fc5 1538
b32b8144 1539 Option("mon_stat_smooth_intervals", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 1540 .set_default(6)
b32b8144
FG
1541 .set_min(1)
1542 .add_service("mgr")
1543 .set_description("number of PGMaps stats over which we calc the average read/write throughput of the whole cluster"),
c07f9fc5 1544
d2e6a577
FG
1545 Option("mon_election_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1546 .set_default(5)
11fdf7f2
TL
1547 .add_service("mon")
1548 .set_description("maximum time for a mon election (seconds)"),
c07f9fc5 1549
d2e6a577
FG
1550 Option("mon_lease", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1551 .set_default(5)
11fdf7f2
TL
1552 .add_service("mon")
1553 .set_description("lease interval between quorum monitors (seconds)")
1554 .set_long_description("This setting controls how sensitive your mon quorum is to intermittent network issues or other failures."),
c07f9fc5 1555
d2e6a577
FG
1556 Option("mon_lease_renew_interval_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1557 .set_default(.6)
11fdf7f2
TL
1558 .set_min_max((double)0.0, (double).9999999)
1559 .add_service("mon")
1560 .set_description("multiple of mon_lease for the lease renewal interval")
1561 .set_long_description("Leases must be renewed before they time out. A smaller value means frequent renewals, while a value close to 1 makes a lease expiration more likely.")
1562 .add_see_also("mon_lease"),
c07f9fc5 1563
d2e6a577
FG
1564 Option("mon_lease_ack_timeout_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1565 .set_default(2.0)
11fdf7f2
TL
1566 .set_min_max(1.0001, 100.0)
1567 .add_service("mon")
1568 .set_description("multiple of mon_lease for the lease ack interval before calling new election")
1569 .add_see_also("mon_lease"),
c07f9fc5 1570
d2e6a577
FG
1571 Option("mon_accept_timeout_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1572 .set_default(2.0)
11fdf7f2
TL
1573 .add_service("mon")
1574 .set_description("multiple of mon_lease for follower mons to accept proposed state changes before calling a new election")
1575 .add_see_also("mon_lease"),
c07f9fc5 1576
d2e6a577
FG
1577 Option("mon_clock_drift_allowed", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1578 .set_default(.050)
11fdf7f2
TL
1579 .add_service("mon")
1580 .set_description("allowed clock drift (in seconds) between mons before issuing a health warning"),
c07f9fc5 1581
d2e6a577
FG
1582 Option("mon_clock_drift_warn_backoff", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1583 .set_default(5)
11fdf7f2
TL
1584 .add_service("mon")
1585 .set_description("exponential backoff factor for logging clock drift warnings in the cluster log"),
c07f9fc5 1586
d2e6a577
FG
1587 Option("mon_timecheck_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1588 .set_default(300.0)
11fdf7f2
TL
1589 .add_service("mon")
1590 .set_description("frequency of clock synchronization checks between monitors (seconds)"),
c07f9fc5 1591
d2e6a577
FG
1592 Option("mon_timecheck_skew_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1593 .set_default(30.0)
11fdf7f2
TL
1594 .add_service("mon")
1595 .set_description("frequency of clock synchronization (re)checks between monitors while clocks are believed to be skewed (seconds)")
1596 .add_see_also("mon_timecheck_interval"),
c07f9fc5 1597
d2e6a577
FG
1598 Option("mon_pg_stuck_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1599 .set_default(60)
b32b8144
FG
1600 .set_description("number of seconds after which pgs can be considered stuck inactive, unclean, etc")
1601 .set_long_description("see doc/control.rst under dump_stuck for more info")
1602 .add_service("mgr"),
c07f9fc5 1603
3efd9988 1604 Option("mon_pg_warn_min_per_osd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
9f95a23c 1605 .set_default(0)
11fdf7f2 1606 .add_service("mgr")
3efd9988 1607 .set_description("minimal number PGs per (in) osd before we warn the admin"),
c07f9fc5 1608
3efd9988 1609 Option("mon_max_pg_per_osd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
11fdf7f2 1610 .set_min(1)
91327a77 1611 .set_default(250)
11fdf7f2
TL
1612 .add_service("mgr")
1613 .set_description("Max number of PGs per OSD the cluster will allow")
1614 .set_long_description("If the number of PGs per OSD exceeds this, a "
1615 "health warning will be visible in `ceph status`. This is also used "
1616 "in automated PG management, as the threshold at which some pools' "
1617 "pg_num may be shrunk in order to enable increasing the pg_num of "
1618 "others."),
1619
1620 Option("mon_target_pg_per_osd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1621 .set_min(1)
1622 .set_default(100)
1623 .set_description("Automated PG management creates this many PGs per OSD")
1624 .set_long_description("When creating pools, the automated PG management "
1625 "logic will attempt to reach this target. In some circumstances, it "
1626 "may exceed this target, up to the ``mon_max_pg_per_osd`` limit. "
1627 "Conversely, a lower number of PGs per OSD may be created if the "
1628 "cluster is not yet fully utilised"),
c07f9fc5 1629
d2e6a577
FG
1630 Option("mon_pg_warn_max_object_skew", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1631 .set_default(10.0)
b32b8144
FG
1632 .set_description("max skew few average in objects per pg")
1633 .add_service("mgr"),
c07f9fc5 1634
d2e6a577
FG
1635 Option("mon_pg_warn_min_objects", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1636 .set_default(10000)
b32b8144
FG
1637 .set_description("do not warn below this object #")
1638 .add_service("mgr"),
c07f9fc5 1639
d2e6a577
FG
1640 Option("mon_pg_warn_min_pool_objects", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1641 .set_default(1000)
b32b8144
FG
1642 .set_description("do not warn on pools below this object #")
1643 .add_service("mgr"),
c07f9fc5 1644
d2e6a577
FG
1645 Option("mon_pg_check_down_all_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1646 .set_default(.5)
b32b8144
FG
1647 .set_description("threshold of down osds after which we check all pgs")
1648 .add_service("mgr"),
c07f9fc5 1649
d2e6a577
FG
1650 Option("mon_cache_target_full_warn_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1651 .set_default(.66)
11fdf7f2
TL
1652 .add_service("mgr")
1653 .set_flag(Option::FLAG_NO_MON_UPDATE)
1654 .set_flag(Option::FLAG_CLUSTER_CREATE)
1655 .set_description("issue CACHE_POOL_NEAR_FULL health warning when cache pool utilization exceeds this ratio of usable space"),
c07f9fc5 1656
d2e6a577
FG
1657 Option("mon_osd_full_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1658 .set_default(.95)
11fdf7f2
TL
1659 .set_flag(Option::FLAG_NO_MON_UPDATE)
1660 .set_flag(Option::FLAG_CLUSTER_CREATE)
1661 .set_description("full ratio of OSDs to be set during initial creation of the cluster"),
c07f9fc5 1662
d2e6a577
FG
1663 Option("mon_osd_backfillfull_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1664 .set_default(.90)
11fdf7f2
TL
1665 .set_flag(Option::FLAG_NO_MON_UPDATE)
1666 .set_flag(Option::FLAG_CLUSTER_CREATE)
d2e6a577 1667 .set_description(""),
c07f9fc5 1668
d2e6a577
FG
1669 Option("mon_osd_nearfull_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1670 .set_default(.85)
11fdf7f2
TL
1671 .set_flag(Option::FLAG_NO_MON_UPDATE)
1672 .set_flag(Option::FLAG_CLUSTER_CREATE)
1673 .set_description("nearfull ratio for OSDs to be set during initial creation of cluster"),
c07f9fc5 1674
d2e6a577
FG
1675 Option("mon_osd_initial_require_min_compat_client", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1676 .set_default("jewel")
11fdf7f2
TL
1677 .set_flag(Option::FLAG_NO_MON_UPDATE)
1678 .set_flag(Option::FLAG_CLUSTER_CREATE)
d2e6a577 1679 .set_description(""),
c07f9fc5 1680
d2e6a577
FG
1681 Option("mon_allow_pool_delete", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1682 .set_default(false)
11fdf7f2
TL
1683 .add_service("mon")
1684 .set_description("allow pool deletions"),
c07f9fc5 1685
d2e6a577
FG
1686 Option("mon_fake_pool_delete", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1687 .set_default(false)
11fdf7f2
TL
1688 .add_service("mon")
1689 .set_description("fake pool deletions by renaming the rados pool"),
c07f9fc5 1690
d2e6a577
FG
1691 Option("mon_globalid_prealloc", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1692 .set_default(10000)
11fdf7f2
TL
1693 .add_service("mon")
1694 .set_description("number of globalid values to preallocate")
1695 .set_long_description("This setting caps how many new clients can authenticate with the cluster before the monitors have to perform a write to preallocate more. Large values burn through the 64-bit ID space more quickly."),
c07f9fc5 1696
d2e6a577
FG
1697 Option("mon_osd_report_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1698 .set_default(900)
11fdf7f2
TL
1699 .add_service("mon")
1700 .set_description("time before OSDs who do not report to the mons are marked down (seconds)"),
c07f9fc5 1701
c5c27e9a
TL
1702 Option("mon_warn_on_insecure_global_id_reclaim", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1703 .set_default(true)
1704 .add_service("mon")
1705 .set_description("issue AUTH_INSECURE_GLOBAL_ID_RECLAIM health warning if any connected clients are insecurely reclaiming global_id")
1706 .add_see_also("mon_warn_on_insecure_global_id_reclaim_allowed")
1707 .add_see_also("auth_allow_insecure_global_id_reclaim")
1708 .add_see_also("auth_expose_insecure_global_id_reclaim"),
1709
1710 Option("mon_warn_on_insecure_global_id_reclaim_allowed", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1711 .set_default(true)
1712 .add_service("mon")
1713 .set_description("issue AUTH_INSECURE_GLOBAL_ID_RECLAIM_ALLOWED health warning if insecure global_id reclaim is allowed")
1714 .add_see_also("mon_warn_on_insecure_global_id_reclaim")
1715 .add_see_also("auth_allow_insecure_global_id_reclaim")
1716 .add_see_also("auth_expose_insecure_global_id_reclaim"),
1717
11fdf7f2 1718 Option("mon_warn_on_msgr2_not_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
d2e6a577 1719 .set_default(true)
11fdf7f2
TL
1720 .add_service("mon")
1721 .set_description("issue MON_MSGR2_NOT_ENABLED health warning if monitors are all running Nautilus but not all binding to a msgr2 port")
1722 .add_see_also("ms_bind_msgr2"),
c07f9fc5 1723
d2e6a577
FG
1724 Option("mon_warn_on_legacy_crush_tunables", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1725 .set_default(true)
11fdf7f2
TL
1726 .add_service("mgr")
1727 .set_description("issue OLD_CRUSH_TUNABLES health warning if CRUSH tunables are older than mon_crush_min_required_version")
1728 .add_see_also("mon_crush_min_required_version"),
c07f9fc5 1729
d2e6a577 1730 Option("mon_crush_min_required_version", Option::TYPE_STR, Option::LEVEL_ADVANCED)
81eedcae 1731 .set_default("hammer")
11fdf7f2
TL
1732 .add_service("mgr")
1733 .set_description("minimum ceph release to use for mon_warn_on_legacy_crush_tunables")
1734 .add_see_also("mon_warn_on_legacy_crush_tunables"),
c07f9fc5 1735
d2e6a577
FG
1736 Option("mon_warn_on_crush_straw_calc_version_zero", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1737 .set_default(true)
11fdf7f2
TL
1738 .add_service("mgr")
1739 .set_description("issue OLD_CRUSH_STRAW_CALC_VERSION health warning if the CRUSH map's straw_calc_version is zero"),
c07f9fc5 1740
d2e6a577
FG
1741 Option("mon_warn_on_osd_down_out_interval_zero", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1742 .set_default(true)
11fdf7f2
TL
1743 .add_service("mgr")
1744 .set_description("issue OSD_NO_DOWN_OUT_INTERVAL health warning if mon_osd_down_out_interval is zero")
1745 .set_long_description("Having mon_osd_down_out_interval set to 0 means that down OSDs are not marked out automatically and the cluster does not heal itself without administrator intervention.")
1746 .add_see_also("mon_osd_down_out_interval"),
c07f9fc5 1747
d2e6a577
FG
1748 Option("mon_warn_on_cache_pools_without_hit_sets", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1749 .set_default(true)
11fdf7f2
TL
1750 .add_service("mgr")
1751 .set_description("issue CACHE_POOL_NO_HIT_SET health warning for cache pools that do not have hit sets configured"),
c07f9fc5 1752
d2e6a577
FG
1753 Option("mon_warn_on_pool_no_app", Option::TYPE_BOOL, Option::LEVEL_DEV)
1754 .set_default(true)
11fdf7f2
TL
1755 .add_service("mgr")
1756 .set_description("issue POOL_APP_NOT_ENABLED health warning if pool has not application enabled"),
c07f9fc5 1757
92f5a8d4
TL
1758 Option("mon_warn_on_pool_pg_num_not_power_of_two", Option::TYPE_BOOL, Option::LEVEL_DEV)
1759 .set_default(true)
1760 .add_service("mon")
1761 .set_description("issue POOL_PG_NUM_NOT_POWER_OF_TWO warning if pool has a non-power-of-two pg_num value"),
1762
9f95a23c
TL
1763 Option("mon_warn_on_pool_no_redundancy", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1764 .set_default(true)
1765 .add_service("mon")
1766 .set_description("Issue a health warning if any pool is configured with no replicas")
1767 .add_see_also("osd_pool_default_size")
1768 .add_see_also("osd_pool_default_min_size"),
1769
11fdf7f2
TL
1770 Option("mon_warn_on_misplaced", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1771 .set_default(false)
1772 .add_service("mgr")
1773 .set_description("Issue a health warning if there are misplaced objects"),
1774
eafe8130
TL
1775 Option("mon_warn_on_too_few_osds", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1776 .set_default(true)
1777 .add_service("mgr")
1778 .set_description("Issue a health warning if there are fewer OSDs than osd_pool_default_size"),
1779
1780 Option("mon_warn_on_slow_ping_time", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1781 .set_default(0)
1782 .add_service("mgr")
1783 .set_description("Override mon_warn_on_slow_ping_ratio with specified threshold in milliseconds")
1784 .add_see_also("mon_warn_on_slow_ping_ratio"),
1785
1786 Option("mon_warn_on_slow_ping_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1787 .set_default(.05)
1788 .add_service("mgr")
1789 .set_description("Issue a health warning if heartbeat ping longer than percentage of osd_heartbeat_grace")
1790 .add_see_also("osd_heartbeat_grace")
1791 .add_see_also("mon_warn_on_slow_ping_time"),
1792
11fdf7f2
TL
1793 Option("mon_max_snap_prune_per_epoch", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1794 .set_default(100)
1795 .add_service("mon")
1796 .set_description("max number of pruned snaps we will process in a single OSDMap epoch"),
c07f9fc5 1797
11fdf7f2 1798 Option("mon_min_osdmap_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
d2e6a577 1799 .set_default(500)
11fdf7f2
TL
1800 .add_service("mon")
1801 .set_description("min number of OSDMaps to store"),
c07f9fc5 1802
d2e6a577
FG
1803 Option("mon_max_log_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1804 .set_default(500)
11fdf7f2
TL
1805 .add_service("mon")
1806 .set_description("max number of past cluster log epochs to store"),
c07f9fc5 1807
d2e6a577
FG
1808 Option("mon_max_mdsmap_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1809 .set_default(500)
11fdf7f2
TL
1810 .add_service("mon")
1811 .set_description("max number of FSMaps/MDSMaps to store"),
c07f9fc5 1812
b32b8144
FG
1813 Option("mon_max_mgrmap_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1814 .set_default(500)
11fdf7f2
TL
1815 .add_service("mon")
1816 .set_description("max number of MgrMaps to store"),
b32b8144 1817
d2e6a577
FG
1818 Option("mon_max_osd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1819 .set_default(10000)
11fdf7f2
TL
1820 .add_service("mon")
1821 .set_description("max number of OSDs in a cluster"),
c07f9fc5 1822
d2e6a577
FG
1823 Option("mon_probe_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1824 .set_default(2.0)
11fdf7f2
TL
1825 .add_service("mon")
1826 .set_description("timeout for querying other mons during bootstrap pre-election phase (seconds)"),
c07f9fc5 1827
11fdf7f2 1828 Option("mon_client_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 1829 .set_default(100ul << 20)
11fdf7f2
TL
1830 .add_service("mon")
1831 .set_description("max bytes of outstanding client messages mon will read off the network"),
1832
1833 Option("mon_daemon_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
1834 .set_default(400ul << 20)
1835 .add_service("mon")
1836 .set_description("max bytes of outstanding mon messages mon will read off the network"),
c07f9fc5 1837
3efd9988 1838 Option("mon_mgr_proxy_client_bytes_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577 1839 .set_default(.3)
11fdf7f2 1840 .add_service("mon")
3efd9988
FG
1841 .set_description("ratio of mon_client_bytes that can be consumed by "
1842 "proxied mgr commands before we error out to client"),
c07f9fc5 1843
d2e6a577
FG
1844 Option("mon_log_max_summary", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1845 .set_default(50)
11fdf7f2
TL
1846 .add_service("mon")
1847 .set_description("number of recent cluster log messages to retain"),
c07f9fc5 1848
d2e6a577
FG
1849 Option("mon_max_log_entries_per_event", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1850 .set_default(4096)
11fdf7f2
TL
1851 .add_service("mon")
1852 .set_description("max cluster log entries per paxos event"),
c07f9fc5 1853
d2e6a577
FG
1854 Option("mon_reweight_min_pgs_per_osd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
1855 .set_default(10)
11fdf7f2 1856 .add_service("mgr")
d2e6a577 1857 .set_description(""),
c07f9fc5 1858
11fdf7f2 1859 Option("mon_reweight_min_bytes_per_osd", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 1860 .set_default(100_M)
11fdf7f2 1861 .add_service("mgr")
d2e6a577 1862 .set_description(""),
c07f9fc5 1863
d2e6a577
FG
1864 Option("mon_reweight_max_osds", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1865 .set_default(4)
11fdf7f2 1866 .add_service("mgr")
d2e6a577 1867 .set_description(""),
c07f9fc5 1868
d2e6a577
FG
1869 Option("mon_reweight_max_change", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1870 .set_default(0.05)
11fdf7f2 1871 .add_service("mgr")
d2e6a577 1872 .set_description(""),
c07f9fc5 1873
d2e6a577
FG
1874 Option("mon_health_to_clog", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1875 .set_default(true)
11fdf7f2
TL
1876 .add_service("mon")
1877 .set_description("log monitor health to cluster log"),
c07f9fc5 1878
d2e6a577 1879 Option("mon_health_to_clog_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
f91f0fd5 1880 .set_default(10_min)
11fdf7f2
TL
1881 .add_service("mon")
1882 .set_description("frequency to log monitor health to cluster log")
1883 .add_see_also("mon_health_to_clog"),
c07f9fc5 1884
11fdf7f2 1885 Option("mon_health_to_clog_tick_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577 1886 .set_default(60.0)
11fdf7f2 1887 .add_service("mon")
d2e6a577 1888 .set_description(""),
c07f9fc5 1889
f91f0fd5
TL
1890 Option("mon_health_detail_to_clog", Option::TYPE_BOOL, Option::LEVEL_DEV)
1891 .set_default(true)
1892 .set_description("log health detail to cluster log"),
1893
b32b8144 1894 Option("mon_health_max_detail", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 1895 .set_default(50)
11fdf7f2 1896 .add_service("mon")
b32b8144 1897 .set_description("max detailed pgs to report in health detail"),
c07f9fc5 1898
181888fb
FG
1899 Option("mon_health_log_update_period", Option::TYPE_INT, Option::LEVEL_DEV)
1900 .set_default(5)
11fdf7f2
TL
1901 .add_service("mon")
1902 .set_description("minimum time in seconds between log messages about "
181888fb
FG
1903 "each health check")
1904 .set_min(0),
1905
d2e6a577
FG
1906 Option("mon_data_avail_crit", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1907 .set_default(5)
11fdf7f2
TL
1908 .add_service("mon")
1909 .set_description("issue MON_DISK_CRIT health error when mon available space below this percentage"),
c07f9fc5 1910
d2e6a577
FG
1911 Option("mon_data_avail_warn", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1912 .set_default(30)
11fdf7f2
TL
1913 .add_service("mon")
1914 .set_description("issue MON_DISK_LOW health warning when mon available space below this percentage"),
c07f9fc5 1915
11fdf7f2 1916 Option("mon_data_size_warn", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 1917 .set_default(15_G)
11fdf7f2
TL
1918 .add_service("mon")
1919 .set_description("issue MON_DISK_BIG health warning when mon database is above this size"),
c07f9fc5 1920
11fdf7f2
TL
1921 Option("mon_warn_pg_not_scrubbed_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1922 .set_default(0.5)
1923 .set_min(0)
1924 .set_description("Percentage of the scrub max interval past the scrub max interval to warn")
1925 .set_long_description("")
1926 .add_see_also("osd_scrub_max_interval"),
c07f9fc5 1927
11fdf7f2
TL
1928 Option("mon_warn_pg_not_deep_scrubbed_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1929 .set_default(0.75)
1930 .set_min(0)
1931 .set_description("Percentage of the deep scrub interval past the deep scrub interval to warn")
1932 .set_long_description("")
1933 .add_see_also("osd_deep_scrub_interval"),
c07f9fc5 1934
d2e6a577 1935 Option("mon_scrub_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144 1936 .set_default(1_day)
11fdf7f2
TL
1937 .add_service("mon")
1938 .set_description("frequency for scrubbing mon database"),
c07f9fc5 1939
d2e6a577 1940 Option("mon_scrub_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144 1941 .set_default(5_min)
11fdf7f2
TL
1942 .add_service("mon")
1943 .set_description("timeout to restart scrub of mon quorum participant does not respond for the latest chunk"),
c07f9fc5 1944
d2e6a577
FG
1945 Option("mon_scrub_max_keys", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1946 .set_default(100)
11fdf7f2
TL
1947 .add_service("mon")
1948 .set_description("max keys per on scrub chunk/step"),
c07f9fc5 1949
d2e6a577
FG
1950 Option("mon_scrub_inject_crc_mismatch", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1951 .set_default(0.0)
11fdf7f2
TL
1952 .add_service("mon")
1953 .set_description("probability for injecting crc mismatches into mon scrub"),
c07f9fc5 1954
d2e6a577
FG
1955 Option("mon_scrub_inject_missing_keys", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1956 .set_default(0.0)
11fdf7f2
TL
1957 .add_service("mon")
1958 .set_description("probability for injecting missing keys into mon scrub"),
c07f9fc5 1959
11fdf7f2
TL
1960 Option("mon_config_key_max_entry_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
1961 .set_default(64_K)
1962 .add_service("mon")
1963 .set_description("Defines the number of bytes allowed to be held in a "
1964 "single config-key entry"),
c07f9fc5 1965
d2e6a577
FG
1966 Option("mon_sync_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
1967 .set_default(60.0)
11fdf7f2
TL
1968 .add_service("mon")
1969 .set_description("timeout before canceling sync if syncing mon does not respond"),
c07f9fc5 1970
11fdf7f2 1971 Option("mon_sync_max_payload_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 1972 .set_default(1_M)
11fdf7f2
TL
1973 .add_service("mon")
1974 .set_description("target max message payload for mon sync"),
c07f9fc5 1975
9f95a23c
TL
1976 Option("mon_sync_max_payload_keys", Option::TYPE_INT, Option::LEVEL_ADVANCED)
1977 .set_default(2000)
1978 .add_service("mon")
1979 .set_description("target max keys in message payload for mon sync"),
1980
11fdf7f2 1981 Option("mon_sync_debug", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 1982 .set_default(false)
11fdf7f2
TL
1983 .add_service("mon")
1984 .set_description("enable extra debugging during mon sync"),
c07f9fc5 1985
d2e6a577
FG
1986 Option("mon_inject_sync_get_chunk_delay", Option::TYPE_FLOAT, Option::LEVEL_DEV)
1987 .set_default(0)
11fdf7f2
TL
1988 .add_service("mon")
1989 .set_description("inject delay during sync (seconds)"),
c07f9fc5 1990
11fdf7f2 1991 Option("mon_osd_min_down_reporters", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 1992 .set_default(2)
11fdf7f2
TL
1993 .add_service("mon")
1994 .set_description("number of OSDs from different subtrees who need to report a down OSD for it to count")
1995 .add_see_also("mon_osd_reporter_subtree_level"),
c07f9fc5 1996
d2e6a577
FG
1997 Option("mon_osd_reporter_subtree_level", Option::TYPE_STR, Option::LEVEL_ADVANCED)
1998 .set_default("host")
11fdf7f2
TL
1999 .add_service("mon")
2000 .set_flag(Option::FLAG_RUNTIME)
2001 .set_description("in which level of parent bucket the reporters are counted"),
c07f9fc5 2002
b32b8144
FG
2003 Option("mon_osd_snap_trim_queue_warn_on", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2004 .set_default(32768)
11fdf7f2 2005 .add_service("mon")
b32b8144
FG
2006 .set_description("Warn when snap trim queue is that large (or larger).")
2007 .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"),
2008
11fdf7f2 2009 Option("mon_osd_force_trim_to", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577 2010 .set_default(0)
11fdf7f2
TL
2011 .add_service("mon")
2012 .set_description("force mons to trim osdmaps through this epoch"),
c07f9fc5 2013
11fdf7f2 2014 Option("mon_mds_force_trim_to", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577 2015 .set_default(0)
11fdf7f2
TL
2016 .add_service("mon")
2017 .set_description("force mons to trim mdsmaps/fsmaps through this epoch"),
c07f9fc5 2018
d2e6a577
FG
2019 Option("mon_mds_skip_sanity", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2020 .set_default(false)
11fdf7f2
TL
2021 .add_service("mon")
2022 .set_description("skip sanity checks on fsmap/mdsmap"),
c07f9fc5 2023
11fdf7f2
TL
2024 Option("mon_debug_extra_checks", Option::TYPE_BOOL, Option::LEVEL_DEV)
2025 .set_default(false)
2026 .add_service("mon")
2027 .set_description("Enable some additional monitor checks")
2028 .set_long_description(
2029 "Enable some additional monitor checks that would be too expensive "
2030 "to run on production systems, or would only be relevant while "
2031 "testing or debugging."),
2032
2033 Option("mon_debug_block_osdmap_trim", Option::TYPE_BOOL, Option::LEVEL_DEV)
2034 .set_default(false)
2035 .add_service("mon")
2036 .set_description("Block OSDMap trimming while the option is enabled.")
2037 .set_long_description(
2038 "Blocking OSDMap trimming may be quite helpful to easily reproduce "
2039 "states in which the monitor keeps (hundreds of) thousands of "
2040 "osdmaps."),
3efd9988 2041
d2e6a577
FG
2042 Option("mon_debug_deprecated_as_obsolete", Option::TYPE_BOOL, Option::LEVEL_DEV)
2043 .set_default(false)
11fdf7f2
TL
2044 .add_service("mon")
2045 .set_description("treat deprecated mon commands as obsolete"),
c07f9fc5 2046
d2e6a577
FG
2047 Option("mon_debug_dump_transactions", Option::TYPE_BOOL, Option::LEVEL_DEV)
2048 .set_default(false)
11fdf7f2
TL
2049 .add_service("mon")
2050 .set_description("dump paxos transactions to log")
2051 .add_see_also("mon_debug_dump_location"),
c07f9fc5 2052
d2e6a577
FG
2053 Option("mon_debug_dump_json", Option::TYPE_BOOL, Option::LEVEL_DEV)
2054 .set_default(false)
11fdf7f2
TL
2055 .add_service("mon")
2056 .set_description("dump paxos transasctions to log as json")
2057 .add_see_also("mon_debug_dump_transactions"),
c07f9fc5 2058
d2e6a577
FG
2059 Option("mon_debug_dump_location", Option::TYPE_STR, Option::LEVEL_DEV)
2060 .set_default("/var/log/ceph/$cluster-$name.tdump")
11fdf7f2
TL
2061 .add_service("mon")
2062 .set_description("file to dump paxos transactions to")
2063 .add_see_also("mon_debug_dump_transactions"),
c07f9fc5 2064
9f95a23c 2065 Option("mon_debug_no_require_nautilus", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 2066 .set_default(false)
11fdf7f2
TL
2067 .add_service("mon")
2068 .set_flag(Option::FLAG_CLUSTER_CREATE)
9f95a23c 2069 .set_description("do not set nautilus feature for new mon clusters"),
11fdf7f2 2070
9f95a23c 2071 Option("mon_debug_no_require_octopus", Option::TYPE_BOOL, Option::LEVEL_DEV)
11fdf7f2
TL
2072 .set_default(false)
2073 .add_service("mon")
2074 .set_flag(Option::FLAG_CLUSTER_CREATE)
9f95a23c 2075 .set_description("do not set octopus feature for new mon clusters"),
c07f9fc5 2076
d2e6a577
FG
2077 Option("mon_debug_no_require_bluestore_for_ec_overwrites", Option::TYPE_BOOL, Option::LEVEL_DEV)
2078 .set_default(false)
11fdf7f2
TL
2079 .add_service("mon")
2080 .set_description("do not require bluestore OSDs to enable EC overwrites on a rados pool"),
c07f9fc5 2081
d2e6a577
FG
2082 Option("mon_debug_no_initial_persistent_features", Option::TYPE_BOOL, Option::LEVEL_DEV)
2083 .set_default(false)
11fdf7f2
TL
2084 .add_service("mon")
2085 .set_flag(Option::FLAG_CLUSTER_CREATE)
2086 .set_description("do not set any monmap features for new mon clusters"),
c07f9fc5 2087
d2e6a577
FG
2088 Option("mon_inject_transaction_delay_max", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2089 .set_default(10.0)
11fdf7f2
TL
2090 .add_service("mon")
2091 .set_description("max duration of injected delay in paxos"),
c07f9fc5 2092
d2e6a577
FG
2093 Option("mon_inject_transaction_delay_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2094 .set_default(0)
11fdf7f2
TL
2095 .add_service("mon")
2096 .set_description("probability of injecting a delay in paxos"),
2097
2098 Option("mon_inject_pg_merge_bounce_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2099 .set_default(0)
2100 .add_service("mon")
2101 .set_description("probability of failing and reverting a pg_num decrement"),
c07f9fc5 2102
d2e6a577
FG
2103 Option("mon_sync_provider_kill_at", Option::TYPE_INT, Option::LEVEL_DEV)
2104 .set_default(0)
11fdf7f2
TL
2105 .add_service("mon")
2106 .set_description("kill mon sync requester at specific point"),
c07f9fc5 2107
d2e6a577
FG
2108 Option("mon_sync_requester_kill_at", Option::TYPE_INT, Option::LEVEL_DEV)
2109 .set_default(0)
11fdf7f2
TL
2110 .add_service("mon")
2111 .set_description("kill mon sync requestor at specific point"),
c07f9fc5 2112
d2e6a577
FG
2113 Option("mon_force_quorum_join", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2114 .set_default(false)
11fdf7f2
TL
2115 .add_service("mon")
2116 .set_description("force mon to rejoin quorum even though it was just removed"),
c07f9fc5 2117
d2e6a577
FG
2118 Option("mon_keyvaluedb", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2119 .set_default("rocksdb")
11fdf7f2
TL
2120 .set_enum_allowed({"leveldb", "rocksdb"})
2121 .set_flag(Option::FLAG_CREATE)
2122 .add_service("mon")
2123 .set_description("database backend to use for the mon database"),
c07f9fc5 2124
d2e6a577
FG
2125 Option("mon_debug_unsafe_allow_tier_with_nonempty_snaps", Option::TYPE_BOOL, Option::LEVEL_DEV)
2126 .set_default(false)
11fdf7f2 2127 .add_service("mon")
d2e6a577 2128 .set_description(""),
c07f9fc5 2129
d2e6a577 2130 Option("mon_osd_blacklist_default_expire", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
b32b8144 2131 .set_default(1_hr)
11fdf7f2 2132 .add_service("mon")
b32b8144
FG
2133 .set_description("Duration in seconds that blacklist entries for clients "
2134 "remain in the OSD map"),
2135
2136 Option("mon_mds_blacklist_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2137 .set_default(1_day)
2138 .set_min(1_hr)
11fdf7f2 2139 .add_service("mon")
b32b8144 2140 .set_description("Duration in seconds that blacklist entries for MDS "
9f95a23c
TL
2141 "daemons remain in the OSD map")
2142 .set_flag(Option::FLAG_RUNTIME),
2143
2144 Option("mon_mgr_blacklist_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2145 .set_default(1_day)
2146 .set_min(1_hr)
2147 .add_service("mon")
2148 .set_description("Duration in seconds that blacklist entries for mgr "
2149 "daemons remain in the OSD map")
2150 .set_flag(Option::FLAG_RUNTIME),
c07f9fc5 2151
d2e6a577
FG
2152 Option("mon_osd_crush_smoke_test", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2153 .set_default(true)
11fdf7f2
TL
2154 .add_service("mon")
2155 .set_description("perform a smoke test on any new CRUSH map before accepting changes"),
2156
2157 Option("mon_smart_report_timeout", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2158 .set_default(5)
2159 .add_service("mon")
2160 .set_description("Timeout (in seconds) for smarctl to run, default is set to 5"),
2161
2162
2163 // PAXOS
c07f9fc5 2164
d2e6a577
FG
2165 Option("paxos_stash_full_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2166 .set_default(25)
11fdf7f2 2167 .add_service("mon")
d2e6a577 2168 .set_description(""),
c07f9fc5 2169
d2e6a577
FG
2170 Option("paxos_max_join_drift", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2171 .set_default(10)
11fdf7f2 2172 .add_service("mon")
d2e6a577 2173 .set_description(""),
c07f9fc5 2174
d2e6a577
FG
2175 Option("paxos_propose_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2176 .set_default(1.0)
11fdf7f2 2177 .add_service("mon")
d2e6a577 2178 .set_description(""),
c07f9fc5 2179
d2e6a577
FG
2180 Option("paxos_min_wait", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2181 .set_default(0.05)
11fdf7f2 2182 .add_service("mon")
d2e6a577 2183 .set_description(""),
c07f9fc5 2184
d2e6a577
FG
2185 Option("paxos_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2186 .set_default(500)
11fdf7f2 2187 .add_service("mon")
d2e6a577 2188 .set_description(""),
c07f9fc5 2189
d2e6a577
FG
2190 Option("paxos_trim_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2191 .set_default(250)
11fdf7f2 2192 .add_service("mon")
d2e6a577 2193 .set_description(""),
c07f9fc5 2194
d2e6a577
FG
2195 Option("paxos_trim_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2196 .set_default(500)
11fdf7f2 2197 .add_service("mon")
d2e6a577 2198 .set_description(""),
c07f9fc5 2199
d2e6a577
FG
2200 Option("paxos_service_trim_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2201 .set_default(250)
11fdf7f2 2202 .add_service("mon")
d2e6a577 2203 .set_description(""),
c07f9fc5 2204
d2e6a577
FG
2205 Option("paxos_service_trim_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2206 .set_default(500)
11fdf7f2 2207 .add_service("mon")
d2e6a577 2208 .set_description(""),
c07f9fc5 2209
d2e6a577
FG
2210 Option("paxos_kill_at", Option::TYPE_INT, Option::LEVEL_DEV)
2211 .set_default(0)
11fdf7f2 2212 .add_service("mon")
d2e6a577 2213 .set_description(""),
c07f9fc5 2214
11fdf7f2
TL
2215
2216 // AUTH
2217
d2e6a577
FG
2218 Option("auth_cluster_required", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2219 .set_default("cephx")
11fdf7f2 2220 .set_description("authentication methods required by the cluster"),
c07f9fc5 2221
d2e6a577
FG
2222 Option("auth_service_required", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2223 .set_default("cephx")
11fdf7f2 2224 .set_description("authentication methods required by service daemons"),
c07f9fc5 2225
d2e6a577
FG
2226 Option("auth_client_required", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2227 .set_default("cephx, none")
11fdf7f2
TL
2228 .set_flag(Option::FLAG_MINIMAL_CONF)
2229 .set_description("authentication methods allowed by clients"),
c07f9fc5 2230
d2e6a577
FG
2231 Option("auth_supported", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2232 .set_default("")
11fdf7f2 2233 .set_description("authentication methods required (deprecated)"),
c07f9fc5 2234
d2e6a577
FG
2235 Option("max_rotating_auth_attempts", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2236 .set_default(10)
11fdf7f2
TL
2237 .set_description("number of attempts to initialize rotating keys before giving up"),
2238
2239 Option("rotating_keys_bootstrap_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2240 .set_default(30)
2241 .set_description("timeout for obtaining rotating keys during bootstrap phase (seconds)"),
2242
2243 Option("rotating_keys_renewal_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2244 .set_default(10)
2245 .set_description("timeout for updating rotating keys (seconds)"),
c07f9fc5 2246
d2e6a577
FG
2247 Option("cephx_require_signatures", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2248 .set_default(false)
2249 .set_description(""),
c07f9fc5 2250
28e407b8
AA
2251 Option("cephx_require_version", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2252 .set_default(1)
2253 .set_description("Cephx version required (1 = pre-mimic, 2 = mimic+)"),
2254
d2e6a577
FG
2255 Option("cephx_cluster_require_signatures", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2256 .set_default(false)
2257 .set_description(""),
c07f9fc5 2258
28e407b8
AA
2259 Option("cephx_cluster_require_version", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2260 .set_default(1)
2261 .set_description("Cephx version required by the cluster from clients (1 = pre-mimic, 2 = mimic+)"),
2262
d2e6a577
FG
2263 Option("cephx_service_require_signatures", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2264 .set_default(false)
2265 .set_description(""),
c07f9fc5 2266
28e407b8
AA
2267 Option("cephx_service_require_version", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2268 .set_default(1)
2269 .set_description("Cephx version required from ceph services (1 = pre-mimic, 2 = mimic+)"),
2270
d2e6a577
FG
2271 Option("cephx_sign_messages", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2272 .set_default(true)
2273 .set_description(""),
c07f9fc5 2274
d2e6a577 2275 Option("auth_mon_ticket_ttl", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
c5c27e9a 2276 .set_default(72_hr)
d2e6a577 2277 .set_description(""),
c07f9fc5 2278
d2e6a577 2279 Option("auth_service_ticket_ttl", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
b32b8144 2280 .set_default(1_hr)
d2e6a577 2281 .set_description(""),
c07f9fc5 2282
c5c27e9a
TL
2283 Option("auth_allow_insecure_global_id_reclaim", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2284 .set_default(true)
2285 .set_description("Allow reclaiming global_id without presenting a valid ticket proving previous possession of that global_id")
2286 .set_long_description("Allowing unauthorized global_id (re)use poses a security risk. Unfortunately, older clients may omit their ticket on reconnects and therefore rely on this being allowed for preserving their global_id for the lifetime of the client instance. Setting this value to false would immediately prevent new connections from those clients (assuming auth_expose_insecure_global_id_reclaim set to true) and eventually break existing sessions as well (regardless of auth_expose_insecure_global_id_reclaim setting).")
2287 .add_see_also("mon_warn_on_insecure_global_id_reclaim")
2288 .add_see_also("mon_warn_on_insecure_global_id_reclaim_allowed")
2289 .add_see_also("auth_expose_insecure_global_id_reclaim"),
2290
2291 Option("auth_expose_insecure_global_id_reclaim", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2292 .set_default(true)
2293 .set_description("Force older clients that may omit their ticket on reconnects to reconnect as part of establishing a session")
2294 .set_long_description("In permissive mode (auth_allow_insecure_global_id_reclaim set to true), this helps with identifying clients that are not patched. In enforcing mode (auth_allow_insecure_global_id_reclaim set to false), this is a fail-fast mechanism: don't establish a session that will almost inevitably be broken later.")
2295 .add_see_also("mon_warn_on_insecure_global_id_reclaim")
2296 .add_see_also("mon_warn_on_insecure_global_id_reclaim_allowed")
2297 .add_see_also("auth_allow_insecure_global_id_reclaim"),
2298
d2e6a577
FG
2299 Option("auth_debug", Option::TYPE_BOOL, Option::LEVEL_DEV)
2300 .set_default(false)
2301 .set_description(""),
c07f9fc5 2302
d2e6a577 2303 Option("mon_client_hunt_parallel", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
11fdf7f2 2304 .set_default(3)
d2e6a577 2305 .set_description(""),
c07f9fc5 2306
d2e6a577
FG
2307 Option("mon_client_hunt_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2308 .set_default(3.0)
2309 .set_description(""),
c07f9fc5 2310
9f95a23c
TL
2311 Option("mon_client_log_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2312 .set_default(1.0)
2313 .set_description("How frequently we send queued cluster log messages to mon"),
2314
d2e6a577
FG
2315 Option("mon_client_ping_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2316 .set_default(10.0)
2317 .set_description(""),
c07f9fc5 2318
d2e6a577
FG
2319 Option("mon_client_ping_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2320 .set_default(30.0)
2321 .set_description(""),
c07f9fc5 2322
d2e6a577 2323 Option("mon_client_hunt_interval_backoff", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
11fdf7f2 2324 .set_default(1.5)
d2e6a577 2325 .set_description(""),
c07f9fc5 2326
d2e6a577
FG
2327 Option("mon_client_hunt_interval_min_multiple", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2328 .set_default(1.0)
2329 .set_description(""),
c07f9fc5 2330
d2e6a577
FG
2331 Option("mon_client_hunt_interval_max_multiple", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2332 .set_default(10.0)
2333 .set_description(""),
c07f9fc5 2334
d2e6a577
FG
2335 Option("mon_client_max_log_entries_per_message", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2336 .set_default(1000)
2337 .set_description(""),
c07f9fc5 2338
eafe8130
TL
2339 Option("mon_client_directed_command_retry", Option::TYPE_INT, Option::LEVEL_DEV)
2340 .set_default(2)
2341 .set_description("Number of times to try sending a comamnd directed at a specific monitor"),
2342
11fdf7f2 2343 Option("mon_max_pool_pg_num", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577
FG
2344 .set_default(65536)
2345 .set_description(""),
c07f9fc5 2346
d2e6a577
FG
2347 Option("mon_pool_quota_warn_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2348 .set_default(0)
b32b8144
FG
2349 .set_description("percent of quota at which to issue warnings")
2350 .add_service("mgr"),
c07f9fc5 2351
d2e6a577
FG
2352 Option("mon_pool_quota_crit_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2353 .set_default(0)
b32b8144
FG
2354 .set_description("percent of quota at which to issue errors")
2355 .add_service("mgr"),
c07f9fc5 2356
d2e6a577
FG
2357 Option("crush_location", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2358 .set_default("")
2359 .set_description(""),
c07f9fc5 2360
d2e6a577
FG
2361 Option("crush_location_hook", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2362 .set_default("")
2363 .set_description(""),
c07f9fc5 2364
d2e6a577
FG
2365 Option("crush_location_hook_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2366 .set_default(10)
2367 .set_description(""),
c07f9fc5 2368
11fdf7f2 2369 Option("objecter_tick_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
2370 .set_default(5.0)
2371 .set_description(""),
c07f9fc5 2372
d2e6a577
FG
2373 Option("objecter_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2374 .set_default(10.0)
11fdf7f2 2375 .set_description("Seconds before in-flight op is considered 'laggy' and we query mon for the latest OSDMap"),
c07f9fc5 2376
11fdf7f2 2377 Option("objecter_inflight_op_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 2378 .set_default(100_M)
11fdf7f2 2379 .set_description("Max in-flight data in bytes (both directions)"),
c07f9fc5 2380
d2e6a577
FG
2381 Option("objecter_inflight_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2382 .set_default(1024)
11fdf7f2 2383 .set_description("Max in-flight operations"),
c07f9fc5 2384
11fdf7f2 2385 Option("objecter_completion_locks_per_session", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
2386 .set_default(32)
2387 .set_description(""),
c07f9fc5 2388
d2e6a577
FG
2389 Option("objecter_inject_no_watch_ping", Option::TYPE_BOOL, Option::LEVEL_DEV)
2390 .set_default(false)
2391 .set_description(""),
c07f9fc5 2392
11fdf7f2 2393 Option("objecter_retry_writes_after_first_reply", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
2394 .set_default(false)
2395 .set_description(""),
c07f9fc5 2396
d2e6a577
FG
2397 Option("objecter_debug_inject_relock_delay", Option::TYPE_BOOL, Option::LEVEL_DEV)
2398 .set_default(false)
2399 .set_description(""),
c07f9fc5 2400
d2e6a577
FG
2401 Option("filer_max_purge_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2402 .set_default(10)
11fdf7f2 2403 .set_description("Max in-flight operations for purging a striped range (e.g., MDS journal)"),
c07f9fc5 2404
d2e6a577
FG
2405 Option("filer_max_truncate_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2406 .set_default(128)
11fdf7f2 2407 .set_description("Max in-flight operations for truncating/deleting a striped sequence (e.g., MDS journal)"),
c07f9fc5 2408
d2e6a577
FG
2409 Option("journaler_write_head_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2410 .set_default(15)
11fdf7f2 2411 .set_description("Interval in seconds between journal header updates (to help bound replay time)"),
c07f9fc5 2412
11fdf7f2
TL
2413 // * journal object size
2414 Option("journaler_prefetch_periods", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 2415 .set_default(10)
11fdf7f2
TL
2416 .set_min(2) // we need at least 2 periods to make progress.
2417 .set_description("Number of striping periods to prefetch while reading MDS journal"),
c07f9fc5 2418
11fdf7f2
TL
2419 // * journal object size
2420 Option("journaler_prezero_periods", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2421 .set_default(5)
2422 // we need to zero at least two periods, minimum, to ensure that we
2423 // have a full empty object/period in front of us.
2424 .set_min(2)
2425 .set_description("Number of striping periods to zero head of MDS journal write position"),
2426
2427 // -- OSD --
a8e16298
TL
2428 Option("osd_calc_pg_upmaps_aggressively", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2429 .set_default(true)
11fdf7f2 2430 .set_flag(Option::FLAG_RUNTIME)
a8e16298
TL
2431 .set_description("try to calculate PG upmaps more aggressively, e.g., "
2432 "by doing a fairly exhaustive search of existing PGs "
2433 "that can be unmapped or upmapped"),
2434
a8e16298
TL
2435 Option("osd_calc_pg_upmaps_local_fallback_retries", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2436 .set_default(100)
11fdf7f2 2437 .set_flag(Option::FLAG_RUNTIME)
a8e16298
TL
2438 .set_description("Maximum number of PGs we can attempt to unmap or upmap "
2439 "for a specific overfull or underfull osd per iteration "),
2440
11fdf7f2
TL
2441 Option("osd_numa_prefer_iface", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2442 .set_default(true)
2443 .set_flag(Option::FLAG_STARTUP)
2444 .set_description("prefer IP on network interface on same numa node as storage")
2445 .add_see_also("osd_numa_auto_affinity"),
2446
2447 Option("osd_numa_auto_affinity", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2448 .set_default(true)
2449 .set_flag(Option::FLAG_STARTUP)
2450 .set_description("automatically set affinity to numa node when storage and network match"),
2451
2452 Option("osd_numa_node", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2453 .set_default(-1)
2454 .set_flag(Option::FLAG_STARTUP)
2455 .set_description("set affinity to a numa node (-1 for none)")
2456 .add_see_also("osd_numa_auto_affinity"),
2457
2458 Option("osd_smart_report_timeout", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 2459 .set_default(5)
11fdf7f2 2460 .set_description("Timeout (in seconds) for smarctl to run, default is set to 5"),
c07f9fc5 2461
11fdf7f2 2462 Option("osd_check_max_object_name_len_on_startup", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
2463 .set_default(true)
2464 .set_description(""),
c07f9fc5 2465
d2e6a577
FG
2466 Option("osd_max_backfills", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2467 .set_default(1)
11fdf7f2
TL
2468 .set_description("Maximum number of concurrent local and remote backfills or recoveries per OSD ")
2469 .set_long_description("There can be osd_max_backfills local reservations AND the same remote reservations per OSD. So a value of 1 lets this OSD participate as 1 PG primary in recovery and 1 shard of another recovering PG."),
c07f9fc5 2470
d2e6a577
FG
2471 Option("osd_min_recovery_priority", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2472 .set_default(0)
11fdf7f2
TL
2473 .set_description("Minimum priority below which recovery is not performed")
2474 .set_long_description("The purpose here is to prevent the cluster from doing *any* lower priority work (e.g., rebalancing) below this threshold and focus solely on higher priority work (e.g., replicating degraded objects)."),
c07f9fc5 2475
d2e6a577
FG
2476 Option("osd_backfill_retry_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2477 .set_default(30.0)
11fdf7f2 2478 .set_description("how frequently to retry backfill reservations after being denied (e.g., due to a full OSD)"),
c07f9fc5 2479
d2e6a577
FG
2480 Option("osd_recovery_retry_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2481 .set_default(30.0)
11fdf7f2 2482 .set_description("how frequently to retry recovery reservations after being denied (e.g., due to a full OSD)"),
c07f9fc5 2483
d2e6a577
FG
2484 Option("osd_agent_max_ops", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2485 .set_default(4)
11fdf7f2 2486 .set_description("maximum concurrent tiering operations for tiering agent"),
c07f9fc5 2487
d2e6a577
FG
2488 Option("osd_agent_max_low_ops", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2489 .set_default(2)
11fdf7f2 2490 .set_description("maximum concurrent low-priority tiering operations for tiering agent"),
c07f9fc5 2491
d2e6a577
FG
2492 Option("osd_agent_min_evict_effort", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2493 .set_default(.1)
11fdf7f2
TL
2494 .set_min_max(0.0, .99)
2495 .set_description("minimum effort to expend evicting clean objects"),
c07f9fc5 2496
d2e6a577
FG
2497 Option("osd_agent_quantize_effort", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2498 .set_default(.1)
11fdf7f2 2499 .set_description("size of quantize unit for eviction effort"),
c07f9fc5 2500
d2e6a577
FG
2501 Option("osd_agent_delay_time", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2502 .set_default(5.0)
11fdf7f2 2503 .set_description("how long agent should sleep if it has no work to do"),
c07f9fc5 2504
11fdf7f2 2505 Option("osd_find_best_info_ignore_history_les", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 2506 .set_default(false)
11fdf7f2
TL
2507 .set_description("ignore last_epoch_started value when peering AND PROBABLY LOSE DATA")
2508 .set_long_description("THIS IS AN EXTREMELY DANGEROUS OPTION THAT SHOULD ONLY BE USED AT THE DIRECTION OF A DEVELOPER. It makes peering ignore the last_epoch_started value when peering, which can allow the OSD to believe an OSD has an authoritative view of a PG's contents even when it is in fact old and stale, typically leading to data loss (by believing a stale PG is up to date)."),
c07f9fc5 2509
d2e6a577
FG
2510 Option("osd_agent_hist_halflife", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2511 .set_default(1000)
11fdf7f2 2512 .set_description("halflife of agent atime and temp histograms"),
c07f9fc5 2513
d2e6a577
FG
2514 Option("osd_agent_slop", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2515 .set_default(.02)
11fdf7f2 2516 .set_description("slop factor to avoid switching tiering flush and eviction mode"),
c07f9fc5 2517
d2e6a577
FG
2518 Option("osd_uuid", Option::TYPE_UUID, Option::LEVEL_ADVANCED)
2519 .set_default(uuid_d())
11fdf7f2
TL
2520 .set_flag(Option::FLAG_CREATE)
2521 .set_description("uuid label for a new OSD"),
c07f9fc5 2522
d2e6a577
FG
2523 Option("osd_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2524 .set_default("/var/lib/ceph/osd/$cluster-$id")
11fdf7f2
TL
2525 .set_flag(Option::FLAG_NO_MON_UPDATE)
2526 .set_description("path to OSD data"),
c07f9fc5 2527
d2e6a577
FG
2528 Option("osd_journal", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2529 .set_default("/var/lib/ceph/osd/$cluster-$id/journal")
11fdf7f2
TL
2530 .set_flag(Option::FLAG_NO_MON_UPDATE)
2531 .set_description("path to OSD journal (when FileStore backend is in use)"),
c07f9fc5 2532
11fdf7f2 2533 Option("osd_journal_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 2534 .set_default(5120)
11fdf7f2
TL
2535 .set_flag(Option::FLAG_CREATE)
2536 .set_description("size of FileStore journal (in MiB)"),
c07f9fc5 2537
d2e6a577
FG
2538 Option("osd_journal_flush_on_shutdown", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2539 .set_default(true)
11fdf7f2 2540 .set_description("flush FileStore journal contents during clean OSD shutdown"),
c07f9fc5 2541
11fdf7f2 2542 Option("osd_os_flags", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577 2543 .set_default(0)
11fdf7f2 2544 .set_description("flags to skip filestore omap or journal initialization"),
c07f9fc5 2545
11fdf7f2
TL
2546 Option("osd_max_write_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
2547 .set_min(4)
d2e6a577 2548 .set_default(90)
11fdf7f2
TL
2549 .set_description("Maximum size of a RADOS write operation in megabytes")
2550 .set_long_description("This setting prevents clients from doing "
2551 "very large writes to RADOS. If you set this to a value "
2552 "below what clients expect, they will receive an error "
2553 "when attempting to write to the cluster."),
c07f9fc5 2554
d2e6a577
FG
2555 Option("osd_max_pgls", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2556 .set_default(1024)
11fdf7f2 2557 .set_description("maximum number of results when listing objects in a pool"),
c07f9fc5 2558
11fdf7f2 2559 Option("osd_client_message_size_cap", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 2560 .set_default(500_M)
11fdf7f2
TL
2561 .set_description("maximum memory to devote to in-flight client requests")
2562 .set_long_description("If this value is exceeded, the OSD will not read any new client data off of the network until memory is freed."),
c07f9fc5 2563
d2e6a577 2564 Option("osd_client_message_cap", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
f6b5b4d7 2565 .set_default(0)
11fdf7f2 2566 .set_description("maximum number of in-flight client requests"),
c07f9fc5 2567
d2e6a577
FG
2568 Option("osd_crush_update_weight_set", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2569 .set_default(true)
11fdf7f2
TL
2570 .set_description("update CRUSH weight-set weights when updating weights")
2571 .set_long_description("If this setting is true, we will update the weight-set weights when adjusting an item's weight, effectively making changes take effect immediately, and discarding any previous optimization in the weight-set value. Setting this value to false will leave it to the balancer to (slowly, presumably) adjust weights to approach the new target value."),
c07f9fc5 2572
11fdf7f2 2573 Option("osd_crush_chooseleaf_type", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577 2574 .set_default(1)
9f95a23c 2575 .set_flag(Option::FLAG_CLUSTER_CREATE)
11fdf7f2 2576 .set_description("default chooseleaf type for osdmaptool --create"),
c07f9fc5 2577
11fdf7f2 2578 Option("osd_pool_use_gmt_hitset", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 2579 .set_default(true)
11fdf7f2
TL
2580 .set_description("use UTC for hitset timestamps")
2581 .set_long_description("This setting only exists for compatibility with hammer (and older) clusters."),
c07f9fc5 2582
d2e6a577
FG
2583 Option("osd_crush_update_on_start", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2584 .set_default(true)
11fdf7f2 2585 .set_description("update OSD CRUSH location on startup"),
c07f9fc5 2586
d2e6a577
FG
2587 Option("osd_class_update_on_start", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2588 .set_default(true)
11fdf7f2 2589 .set_description("set OSD device class on startup"),
c07f9fc5 2590
d2e6a577
FG
2591 Option("osd_crush_initial_weight", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2592 .set_default(-1)
11fdf7f2
TL
2593 .set_description("if >= 0, initial CRUSH weight for newly created OSDs")
2594 .set_long_description("If this value is negative, the size of the OSD in TiB is used."),
2595
2596 Option("osd_pool_default_ec_fast_read", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2597 .set_default(false)
2598 .set_description("set ec_fast_read for new erasure-coded pools")
2599 .add_service("mon"),
c07f9fc5 2600
d2e6a577
FG
2601 Option("osd_pool_default_crush_rule", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2602 .set_default(-1)
11fdf7f2
TL
2603 .set_description("CRUSH rule for newly created pools")
2604 .add_service("mon"),
c07f9fc5 2605
11fdf7f2 2606 Option("osd_pool_erasure_code_stripe_unit", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 2607 .set_default(4_K)
11fdf7f2
TL
2608 .set_description("the amount of data (in bytes) in a data chunk, per stripe")
2609 .add_service("mon"),
c07f9fc5 2610
11fdf7f2 2611 Option("osd_pool_default_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 2612 .set_default(3)
11fdf7f2
TL
2613 .set_min_max(0, 10)
2614 .set_flag(Option::FLAG_RUNTIME)
2615 .set_description("the number of copies of an object for new replicated pools")
2616 .add_service("mon"),
c07f9fc5 2617
11fdf7f2 2618 Option("osd_pool_default_min_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 2619 .set_default(0)
11fdf7f2
TL
2620 .set_min_max(0, 255)
2621 .set_flag(Option::FLAG_RUNTIME)
2622 .set_description("the minimal number of copies allowed to write to a degraded pool for new replicated pools")
2623 .set_long_description("0 means no specific default; ceph will use size-size/2")
2624 .add_see_also("osd_pool_default_size")
2625 .add_service("mon"),
c07f9fc5 2626
11fdf7f2 2627 Option("osd_pool_default_pg_num", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
92f5a8d4 2628 .set_default(32)
11fdf7f2
TL
2629 .set_description("number of PGs for new pools")
2630 .set_flag(Option::FLAG_RUNTIME)
2631 .add_service("mon"),
c07f9fc5 2632
11fdf7f2
TL
2633 Option("osd_pool_default_pgp_num", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2634 .set_default(0)
2635 .set_description("number of PGs for placement purposes (0 to match pg_num)")
2636 .add_see_also("osd_pool_default_pg_num")
2637 .set_flag(Option::FLAG_RUNTIME)
2638 .add_service("mon"),
c07f9fc5 2639
d2e6a577
FG
2640 Option("osd_pool_default_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2641 .set_default("replicated")
11fdf7f2
TL
2642 .set_enum_allowed({"replicated", "erasure"})
2643 .set_flag(Option::FLAG_RUNTIME)
2644 .set_description("default type of pool to create")
2645 .add_service("mon"),
c07f9fc5 2646
d2e6a577 2647 Option("osd_pool_default_erasure_code_profile", Option::TYPE_STR, Option::LEVEL_ADVANCED)
9f95a23c 2648 .set_default("plugin=jerasure technique=reed_sol_van k=2 m=2")
11fdf7f2
TL
2649 .set_flag(Option::FLAG_RUNTIME)
2650 .set_description("default erasure code profile for new erasure-coded pools")
2651 .add_service("mon"),
c07f9fc5 2652
d2e6a577
FG
2653 Option("osd_erasure_code_plugins", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2654 .set_default("jerasure lrc"
f91f0fd5 2655 #if defined(HAVE_BETTER_YASM_ELF64) || defined(HAVE_ARMV8_SIMD)
d2e6a577
FG
2656 " isa"
2657 #endif
2658 )
11fdf7f2
TL
2659 .set_flag(Option::FLAG_STARTUP)
2660 .set_description("erasure code plugins to load")
2661 .add_service("mon")
2662 .add_service("osd"),
c07f9fc5 2663
11fdf7f2 2664 Option("osd_allow_recovery_below_min_size", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 2665 .set_default(true)
11fdf7f2
TL
2666 .set_description("allow replicated pools to recover with < min_size active members")
2667 .add_service("osd"),
c07f9fc5 2668
11fdf7f2 2669 Option("osd_pool_default_flags", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577 2670 .set_default(0)
11fdf7f2
TL
2671 .set_description("(integer) flags to set on new pools")
2672 .add_service("mon"),
c07f9fc5 2673
d2e6a577
FG
2674 Option("osd_pool_default_flag_hashpspool", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2675 .set_default(true)
11fdf7f2
TL
2676 .set_description("set hashpspool (better hashing scheme) flag on new pools")
2677 .add_service("mon"),
c07f9fc5 2678
d2e6a577
FG
2679 Option("osd_pool_default_flag_nodelete", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2680 .set_default(false)
11fdf7f2
TL
2681 .set_description("set nodelete flag on new pools")
2682 .add_service("mon"),
c07f9fc5 2683
d2e6a577
FG
2684 Option("osd_pool_default_flag_nopgchange", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2685 .set_default(false)
11fdf7f2
TL
2686 .set_description("set nopgchange flag on new pools")
2687 .add_service("mon"),
c07f9fc5 2688
d2e6a577
FG
2689 Option("osd_pool_default_flag_nosizechange", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2690 .set_default(false)
11fdf7f2
TL
2691 .set_description("set nosizechange flag on new pools")
2692 .add_service("mon"),
c07f9fc5 2693
d2e6a577
FG
2694 Option("osd_pool_default_hit_set_bloom_fpp", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2695 .set_default(.05)
11fdf7f2
TL
2696 .set_description("")
2697 .add_see_also("osd_tier_default_cache_hit_set_type")
2698 .add_service("mon"),
c07f9fc5 2699
d2e6a577
FG
2700 Option("osd_pool_default_cache_target_dirty_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2701 .set_default(.4)
2702 .set_description(""),
c07f9fc5 2703
d2e6a577
FG
2704 Option("osd_pool_default_cache_target_dirty_high_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2705 .set_default(.6)
2706 .set_description(""),
c07f9fc5 2707
d2e6a577
FG
2708 Option("osd_pool_default_cache_target_full_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2709 .set_default(.8)
2710 .set_description(""),
c07f9fc5 2711
d2e6a577
FG
2712 Option("osd_pool_default_cache_min_flush_age", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2713 .set_default(0)
2714 .set_description(""),
c07f9fc5 2715
d2e6a577
FG
2716 Option("osd_pool_default_cache_min_evict_age", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2717 .set_default(0)
2718 .set_description(""),
c07f9fc5 2719
d2e6a577
FG
2720 Option("osd_pool_default_cache_max_evict_check_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2721 .set_default(10)
2722 .set_description(""),
c07f9fc5 2723
11fdf7f2 2724 Option("osd_pool_default_pg_autoscale_mode", Option::TYPE_STR, Option::LEVEL_ADVANCED)
9f95a23c 2725 .set_default("on")
81eedcae 2726 .set_flag(Option::FLAG_RUNTIME)
11fdf7f2
TL
2727 .set_enum_allowed({"off", "warn", "on"})
2728 .set_description("Default PG autoscaling behavior for new pools"),
2729
9f95a23c
TL
2730 Option("osd_pool_default_read_lease_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2731 .set_default(.8)
2732 .set_flag(Option::FLAG_RUNTIME)
2733 .set_description("Default read_lease_ratio for a pool, as a multiple of osd_heartbeat_grace")
2734 .set_long_description("This should be <= 1.0 so that the read lease will have expired by the time we decide to mark a peer OSD down.")
2735 .add_see_also("osd_heartbeat_grace"),
2736
d2e6a577
FG
2737 Option("osd_hit_set_min_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2738 .set_default(1000)
2739 .set_description(""),
c07f9fc5 2740
d2e6a577
FG
2741 Option("osd_hit_set_max_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2742 .set_default(100000)
2743 .set_description(""),
c07f9fc5 2744
d2e6a577
FG
2745 Option("osd_hit_set_namespace", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2746 .set_default(".ceph-internal")
2747 .set_description(""),
c07f9fc5 2748
d2e6a577
FG
2749 Option("osd_tier_promote_max_objects_sec", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2750 .set_default(25)
2751 .set_description(""),
c07f9fc5 2752
11fdf7f2 2753 Option("osd_tier_promote_max_bytes_sec", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 2754 .set_default(5_M)
d2e6a577 2755 .set_description(""),
c07f9fc5 2756
d2e6a577
FG
2757 Option("osd_tier_default_cache_mode", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2758 .set_default("writeback")
11fdf7f2
TL
2759 .set_enum_allowed({"none", "writeback", "forward",
2760 "readonly", "readforward", "readproxy", "proxy"})
2761 .set_flag(Option::FLAG_RUNTIME)
d2e6a577 2762 .set_description(""),
c07f9fc5 2763
11fdf7f2 2764 Option("osd_tier_default_cache_hit_set_count", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577
FG
2765 .set_default(4)
2766 .set_description(""),
c07f9fc5 2767
11fdf7f2 2768 Option("osd_tier_default_cache_hit_set_period", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577
FG
2769 .set_default(1200)
2770 .set_description(""),
c07f9fc5 2771
d2e6a577
FG
2772 Option("osd_tier_default_cache_hit_set_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2773 .set_default("bloom")
11fdf7f2
TL
2774 .set_enum_allowed({"bloom", "explicit_hash", "explicit_object"})
2775 .set_flag(Option::FLAG_RUNTIME)
d2e6a577 2776 .set_description(""),
c07f9fc5 2777
11fdf7f2 2778 Option("osd_tier_default_cache_min_read_recency_for_promote", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 2779 .set_default(1)
11fdf7f2 2780 .set_description("number of recent HitSets the object must appear in to be promoted (on read)"),
c07f9fc5 2781
11fdf7f2 2782 Option("osd_tier_default_cache_min_write_recency_for_promote", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 2783 .set_default(1)
11fdf7f2 2784 .set_description("number of recent HitSets the object must appear in to be promoted (on write)"),
c07f9fc5 2785
11fdf7f2 2786 Option("osd_tier_default_cache_hit_set_grade_decay_rate", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577
FG
2787 .set_default(20)
2788 .set_description(""),
c07f9fc5 2789
11fdf7f2 2790 Option("osd_tier_default_cache_hit_set_search_last_n", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577
FG
2791 .set_default(1)
2792 .set_description(""),
c07f9fc5 2793
11fdf7f2
TL
2794 Option("osd_objecter_finishers", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2795 .set_default(1)
2796 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
2797 .set_description(""),
2798
11fdf7f2
TL
2799 Option("osd_map_dedup", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2800 .set_default(true)
d2e6a577
FG
2801 .set_description(""),
2802
2803 Option("osd_map_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2804 .set_default(50)
2805 .set_description(""),
2806
2807 Option("osd_map_message_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2808 .set_default(40)
11fdf7f2
TL
2809 .set_description("maximum number of OSDMaps to include in a single message"),
2810
2811 Option("osd_map_message_max_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
2812 .set_default(10_M)
2813 .set_description("maximum number of bytes worth of OSDMaps to include in a single message"),
d2e6a577
FG
2814
2815 Option("osd_map_share_max_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2816 .set_default(40)
2817 .set_description(""),
2818
11fdf7f2
TL
2819 Option("osd_pg_epoch_max_lag_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
2820 .set_default(2.0)
2821 .set_description("Max multiple of the map cache that PGs can lag before we throttle map injest")
2822 .add_see_also("osd_map_cache_size"),
2823
d2e6a577
FG
2824 Option("osd_inject_bad_map_crc_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
2825 .set_default(0)
2826 .set_description(""),
2827
2828 Option("osd_inject_failure_on_pg_removal", Option::TYPE_BOOL, Option::LEVEL_DEV)
2829 .set_default(false)
2830 .set_description(""),
2831
2832 Option("osd_max_markdown_period", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2833 .set_default(600)
2834 .set_description(""),
2835
2836 Option("osd_max_markdown_count", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2837 .set_default(5)
2838 .set_description(""),
2839
d2e6a577
FG
2840 Option("osd_op_pq_max_tokens_per_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2841 .set_default(4194304)
2842 .set_description(""),
2843
11fdf7f2 2844 Option("osd_op_pq_min_cost", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577
FG
2845 .set_default(65536)
2846 .set_description(""),
2847
d2e6a577
FG
2848 Option("osd_recover_clone_overlap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2849 .set_default(true)
2850 .set_description(""),
2851
9f95a23c
TL
2852 Option("osd_num_cache_shards", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
2853 .set_default(32)
2854 .set_flag(Option::FLAG_STARTUP)
2855 .set_description("The number of cache shards to use in the object store."),
2856
d2e6a577
FG
2857 Option("osd_op_num_threads_per_shard", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2858 .set_default(0)
11fdf7f2 2859 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
2860 .set_description(""),
2861
2862 Option("osd_op_num_threads_per_shard_hdd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2863 .set_default(1)
11fdf7f2
TL
2864 .set_flag(Option::FLAG_STARTUP)
2865 .set_description("")
2866 .add_see_also("osd_op_num_threads_per_shard"),
d2e6a577
FG
2867
2868 Option("osd_op_num_threads_per_shard_ssd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2869 .set_default(2)
11fdf7f2
TL
2870 .set_flag(Option::FLAG_STARTUP)
2871 .set_description("")
2872 .add_see_also("osd_op_num_threads_per_shard"),
d2e6a577
FG
2873
2874 Option("osd_op_num_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2875 .set_default(0)
11fdf7f2 2876 .set_flag(Option::FLAG_STARTUP)
d2e6a577
FG
2877 .set_description(""),
2878
2879 Option("osd_op_num_shards_hdd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2880 .set_default(5)
11fdf7f2
TL
2881 .set_flag(Option::FLAG_STARTUP)
2882 .set_description("")
2883 .add_see_also("osd_op_num_shards"),
d2e6a577
FG
2884
2885 Option("osd_op_num_shards_ssd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2886 .set_default(8)
11fdf7f2
TL
2887 .set_flag(Option::FLAG_STARTUP)
2888 .set_description("")
2889 .add_see_also("osd_op_num_shards"),
d2e6a577 2890
28e407b8
AA
2891 Option("osd_skip_data_digest", Option::TYPE_BOOL, Option::LEVEL_DEV)
2892 .set_default(false)
11fdf7f2 2893 .set_description("Do not store full-object checksums if the backend (bluestore) does its own checksums. Only usable with all BlueStore OSDs."),
28e407b8 2894
d2e6a577
FG
2895 Option("osd_op_queue", Option::TYPE_STR, Option::LEVEL_ADVANCED)
2896 .set_default("wpq")
9f95a23c
TL
2897 .set_enum_allowed( { "wpq", "prioritized",
2898 "mclock_opclass", "mclock_client", "mclock_scheduler",
2899 "debug_random" } )
2900 .set_description("which operation priority queue algorithm to use")
2901 .set_long_description("which operation priority queue algorithm to use; "
2902 "mclock_opclass mclock_client, and "
2903 "mclock_client_profile are currently experimental")
d2e6a577
FG
2904 .add_see_also("osd_op_queue_cut_off"),
2905
2906 Option("osd_op_queue_cut_off", Option::TYPE_STR, Option::LEVEL_ADVANCED)
9f95a23c 2907 .set_default("high")
d2e6a577
FG
2908 .set_enum_allowed( { "low", "high", "debug_random" } )
2909 .set_description("the threshold between high priority ops and low priority ops")
2910 .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")
2911 .add_see_also("osd_op_queue"),
2912
9f95a23c
TL
2913 Option("osd_mclock_scheduler_client_res", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2914 .set_default(1)
2915 .set_description("IO proportion reserved for each client (default)")
2916 .set_long_description("Only considered for osd_op_queue = mClockScheduler")
2917 .add_see_also("osd_op_queue"),
2918
2919 Option("osd_mclock_scheduler_client_wgt", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2920 .set_default(1)
2921 .set_description("IO share for each client (default) over reservation")
2922 .set_long_description("Only considered for osd_op_queue = mClockScheduler")
2923 .add_see_also("osd_op_queue"),
2924
2925 Option("osd_mclock_scheduler_client_lim", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2926 .set_default(999999)
2927 .set_description("IO limit for each client (default) over reservation")
2928 .set_long_description("Only considered for osd_op_queue = mClockScheduler")
2929 .add_see_also("osd_op_queue"),
2930
2931 Option("osd_mclock_scheduler_background_recovery_res", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2932 .set_default(1)
2933 .set_description("IO proportion reserved for background recovery (default)")
2934 .set_long_description("Only considered for osd_op_queue = mClockScheduler")
2935 .add_see_also("osd_op_queue"),
2936
2937 Option("osd_mclock_scheduler_background_recovery_wgt", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2938 .set_default(1)
2939 .set_description("IO share for each background recovery over reservation")
2940 .set_long_description("Only considered for osd_op_queue = mClockScheduler")
2941 .add_see_also("osd_op_queue"),
2942
2943 Option("osd_mclock_scheduler_background_recovery_lim", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2944 .set_default(999999)
2945 .set_description("IO limit for background recovery over reservation")
2946 .set_long_description("Only considered for osd_op_queue = mClockScheduler")
2947 .add_see_also("osd_op_queue"),
2948
2949 Option("osd_mclock_scheduler_background_best_effort_res", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2950 .set_default(1)
2951 .set_description("IO proportion reserved for background best_effort (default)")
2952 .set_long_description("Only considered for osd_op_queue = mClockScheduler")
2953 .add_see_also("osd_op_queue"),
2954
2955 Option("osd_mclock_scheduler_background_best_effort_wgt", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2956 .set_default(1)
2957 .set_description("IO share for each background best_effort over reservation")
2958 .set_long_description("Only considered for osd_op_queue = mClockScheduler")
2959 .add_see_also("osd_op_queue"),
2960
2961 Option("osd_mclock_scheduler_background_best_effort_lim", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
2962 .set_default(999999)
2963 .set_description("IO limit for background best_effort over reservation")
2964 .set_long_description("Only considered for osd_op_queue = mClockScheduler")
2965 .add_see_also("osd_op_queue"),
2966
2967 Option("osd_mclock_scheduler_anticipation_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
11fdf7f2
TL
2968 .set_default(0.0)
2969 .set_description("mclock anticipation timeout in seconds")
9f95a23c 2970 .set_long_description("the amount of time that mclock waits until the unused resource is forfeited"),
d2e6a577
FG
2971
2972 Option("osd_ignore_stale_divergent_priors", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2973 .set_default(false)
2974 .set_description(""),
2975
2976 Option("osd_read_ec_check_for_errors", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
2977 .set_default(false)
2978 .set_description(""),
2979
9f95a23c
TL
2980 // Only use clone_overlap for recovery if there are fewer than
2981 // osd_recover_clone_overlap_limit entries in the overlap set
2982 Option("osd_recover_clone_overlap_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 2983 .set_default(10)
9f95a23c
TL
2984 .set_description("")
2985 .set_flag(Option::FLAG_RUNTIME),
d2e6a577 2986
81eedcae
TL
2987 Option("osd_debug_feed_pullee", Option::TYPE_INT, Option::LEVEL_DEV)
2988 .set_default(-1)
2989 .set_description("Feed a pullee, and force primary to pull "
2990 "a currently missing object from it"),
2991
d2e6a577
FG
2992 Option("osd_backfill_scan_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2993 .set_default(64)
2994 .set_description(""),
2995
2996 Option("osd_backfill_scan_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
2997 .set_default(512)
2998 .set_description(""),
2999
3000 Option("osd_op_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3001 .set_default(15)
3002 .set_description(""),
3003
3004 Option("osd_op_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3005 .set_default(150)
3006 .set_description(""),
3007
d2e6a577
FG
3008 Option("osd_recovery_sleep", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3009 .set_default(0)
3010 .set_description("Time in seconds to sleep before next recovery or backfill op"),
3011
3012 Option("osd_recovery_sleep_hdd", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3013 .set_default(0.1)
3014 .set_description("Time in seconds to sleep before next recovery or backfill op for HDDs"),
3015
3016 Option("osd_recovery_sleep_ssd", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3017 .set_default(0)
11fdf7f2
TL
3018 .set_description("Time in seconds to sleep before next recovery or backfill op for SSDs")
3019 .add_see_also("osd_recovery_sleep"),
d2e6a577
FG
3020
3021 Option("osd_recovery_sleep_hybrid", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3022 .set_default(0.025)
11fdf7f2
TL
3023 .set_description("Time in seconds to sleep before next recovery or backfill op when data is on HDD and journal is on SSD")
3024 .add_see_also("osd_recovery_sleep"),
d2e6a577
FG
3025
3026 Option("osd_snap_trim_sleep", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3027 .set_default(0)
494da23a
TL
3028 .set_description("Time in seconds to sleep before next snap trim (overrides values below)"),
3029
3030 Option("osd_snap_trim_sleep_hdd", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3031 .set_default(5)
3032 .set_description("Time in seconds to sleep before next snap trim for HDDs"),
3033
3034 Option("osd_snap_trim_sleep_ssd", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3035 .set_default(0)
3036 .set_description("Time in seconds to sleep before next snap trim for SSDs"),
3037
3038 Option("osd_snap_trim_sleep_hybrid", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3039 .set_default(2)
3040 .set_description("Time in seconds to sleep before next snap trim when data is on HDD and journal is on SSD"),
d2e6a577
FG
3041
3042 Option("osd_scrub_invalid_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3043 .set_default(true)
3044 .set_description(""),
3045
d2e6a577 3046 Option("osd_command_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144 3047 .set_default(10_min)
d2e6a577
FG
3048 .set_description(""),
3049
3050 Option("osd_command_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144 3051 .set_default(15_min)
d2e6a577
FG
3052 .set_description(""),
3053
eafe8130 3054 Option("osd_heartbeat_interval", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577 3055 .set_default(6)
eafe8130 3056 .set_min_max(1, 60)
11fdf7f2 3057 .set_description("Interval (in seconds) between peer pings"),
d2e6a577
FG
3058
3059 Option("osd_heartbeat_grace", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3060 .set_default(20)
3061 .set_description(""),
3062
494da23a
TL
3063 Option("osd_heartbeat_stale", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3064 .set_default(600)
3065 .set_description("Interval (in seconds) we mark an unresponsive heartbeat peer as stale.")
3066 .set_long_description("Automatically mark unresponsive heartbeat sessions as stale and tear them down. "
3067 "The primary benefit is that OSD doesn't need to keep a flood of "
3068 "blocked heartbeat messages around in memory."),
3069
d2e6a577
FG
3070 Option("osd_heartbeat_min_peers", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3071 .set_default(10)
3072 .set_description(""),
3073
3074 Option("osd_heartbeat_use_min_delay_socket", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3075 .set_default(false)
3076 .set_description(""),
c07f9fc5 3077
11fdf7f2 3078 Option("osd_heartbeat_min_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 3079 .set_default(2000)
11fdf7f2 3080 .set_description("Minimum heartbeat packet size in bytes. Will add dummy payload if heartbeat packet is smaller than this."),
c07f9fc5 3081
d2e6a577
FG
3082 Option("osd_pg_max_concurrent_snap_trims", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3083 .set_default(2)
3084 .set_description(""),
c07f9fc5 3085
d2e6a577
FG
3086 Option("osd_max_trimming_pgs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3087 .set_default(2)
3088 .set_description(""),
c07f9fc5 3089
d2e6a577
FG
3090 Option("osd_heartbeat_min_healthy_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3091 .set_default(.33)
3092 .set_description(""),
c07f9fc5 3093
d2e6a577
FG
3094 Option("osd_mon_heartbeat_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3095 .set_default(30)
3096 .set_description(""),
c07f9fc5 3097
eafe8130
TL
3098 Option("osd_mon_heartbeat_stat_stale", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3099 .set_default(1_hr)
3100 .set_description("Stop reporting on heartbeat ping times not updated for this many seconds.")
3101 .set_long_description("Stop reporting on old heartbeat information unless this is set to zero"),
3102
11fdf7f2 3103 Option("osd_mon_report_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
d2e6a577 3104 .set_default(5)
11fdf7f2 3105 .set_description("Frequency of OSD reports to mon for peer failures, fullness status changes"),
c07f9fc5 3106
d2e6a577
FG
3107 Option("osd_mon_report_max_in_flight", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3108 .set_default(2)
3109 .set_description(""),
c07f9fc5 3110
d2e6a577
FG
3111 Option("osd_beacon_report_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3112 .set_default(300)
3113 .set_description(""),
c07f9fc5 3114
d2e6a577
FG
3115 Option("osd_pg_stat_report_interval_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3116 .set_default(500)
3117 .set_description(""),
c07f9fc5 3118
d2e6a577
FG
3119 Option("osd_mon_ack_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3120 .set_default(30.0)
3121 .set_description(""),
c07f9fc5 3122
d2e6a577
FG
3123 Option("osd_stats_ack_timeout_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3124 .set_default(2.0)
3125 .set_description(""),
c07f9fc5 3126
d2e6a577
FG
3127 Option("osd_stats_ack_timeout_decay", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3128 .set_default(.9)
3129 .set_description(""),
c07f9fc5 3130
11fdf7f2
TL
3131 Option("osd_max_snap_prune_intervals_per_epoch", Option::TYPE_UINT, Option::LEVEL_DEV)
3132 .set_default(512)
3133 .set_description("Max number of snap intervals to report to mgr in pg_stat_t"),
3134
d2e6a577
FG
3135 Option("osd_default_data_pool_replay_window", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3136 .set_default(45)
3137 .set_description(""),
c07f9fc5 3138
d2e6a577
FG
3139 Option("osd_auto_mark_unfound_lost", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3140 .set_default(false)
3141 .set_description(""),
c07f9fc5 3142
d2e6a577
FG
3143 Option("osd_recovery_delay_start", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3144 .set_default(0)
3145 .set_description(""),
c07f9fc5 3146
d2e6a577 3147 Option("osd_recovery_max_active", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
9f95a23c
TL
3148 .set_default(0)
3149 .set_description("Number of simultaneous active recovery operations per OSD (overrides _ssd and _hdd if non-zero)")
3150 .add_see_also("osd_recovery_max_active_hdd")
3151 .add_see_also("osd_recovery_max_active_ssd"),
3152
3153 Option("osd_recovery_max_active_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 3154 .set_default(3)
9f95a23c
TL
3155 .set_description("Number of simultaneous active recovery oeprations per OSD (for rotational devices)")
3156 .add_see_also("osd_recovery_max_active")
3157 .add_see_also("osd_recovery_max_active_ssd"),
3158
3159 Option("osd_recovery_max_active_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3160 .set_default(10)
3161 .set_description("Number of simultaneous active recovery oeprations per OSD (for non-rotational solid state devices)")
3162 .add_see_also("osd_recovery_max_active")
3163 .add_see_also("osd_recovery_max_active_hdd"),
c07f9fc5 3164
d2e6a577
FG
3165 Option("osd_recovery_max_single_start", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3166 .set_default(1)
3167 .set_description(""),
c07f9fc5 3168
11fdf7f2
TL
3169 Option("osd_recovery_max_chunk", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
3170 .set_default(8_M)
d2e6a577 3171 .set_description(""),
c07f9fc5 3172
d2e6a577 3173 Option("osd_recovery_max_omap_entries_per_chunk", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
b32b8144 3174 .set_default(8096)
d2e6a577 3175 .set_description(""),
c07f9fc5 3176
11fdf7f2
TL
3177 Option("osd_copyfrom_max_chunk", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
3178 .set_default(8_M)
d2e6a577 3179 .set_description(""),
c07f9fc5 3180
11fdf7f2 3181 Option("osd_push_per_object_cost", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577
FG
3182 .set_default(1000)
3183 .set_description(""),
c07f9fc5 3184
11fdf7f2 3185 Option("osd_max_push_cost", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577
FG
3186 .set_default(8<<20)
3187 .set_description(""),
c07f9fc5 3188
d2e6a577
FG
3189 Option("osd_max_push_objects", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3190 .set_default(10)
3191 .set_description(""),
c07f9fc5 3192
d2e6a577
FG
3193 Option("osd_max_scrubs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3194 .set_default(1)
28e407b8 3195 .set_description("Maximum concurrent scrubs on a single OSD"),
c07f9fc5 3196
d2e6a577
FG
3197 Option("osd_scrub_during_recovery", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3198 .set_default(false)
28e407b8 3199 .set_description("Allow scrubbing when PGs on the OSD are undergoing recovery"),
c07f9fc5 3200
eafe8130
TL
3201 Option("osd_repair_during_recovery", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3202 .set_default(false)
3203 .set_description("Allow requested repairing when PGs on the OSD are undergoing recovery"),
3204
d2e6a577
FG
3205 Option("osd_scrub_begin_hour", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3206 .set_default(0)
28e407b8
AA
3207 .set_description("Restrict scrubbing to this hour of the day or later")
3208 .add_see_also("osd_scrub_end_hour"),
c07f9fc5 3209
d2e6a577
FG
3210 Option("osd_scrub_end_hour", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3211 .set_default(24)
28e407b8
AA
3212 .set_description("Restrict scrubbing to hours of the day earlier than this")
3213 .add_see_also("osd_scrub_begin_hour"),
3214
3215 Option("osd_scrub_begin_week_day", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3216 .set_default(0)
3217 .set_description("Restrict scrubbing to this day of the week or later")
3218 .set_long_description("0 or 7 = Sunday, 1 = Monday, etc.")
3219 .add_see_also("osd_scrub_end_week_day"),
3220
3221 Option("osd_scrub_end_week_day", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3222 .set_default(7)
3223 .set_description("Restrict scrubbing to days of the week earlier than this")
3224 .set_long_description("0 or 7 = Sunday, 1 = Monday, etc.")
3225 .add_see_also("osd_scrub_begin_week_day"),
c07f9fc5 3226
d2e6a577
FG
3227 Option("osd_scrub_load_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3228 .set_default(0.5)
28e407b8 3229 .set_description("Allow scrubbing when system load divided by number of CPUs is below this value"),
c07f9fc5 3230
d2e6a577 3231 Option("osd_scrub_min_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
b32b8144 3232 .set_default(1_day)
28e407b8
AA
3233 .set_description("Scrub each PG no more often than this interval")
3234 .add_see_also("osd_scrub_max_interval"),
d2e6a577
FG
3235
3236 Option("osd_scrub_max_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
b32b8144 3237 .set_default(7_day)
28e407b8
AA
3238 .set_description("Scrub each PG no less often than this interval")
3239 .add_see_also("osd_scrub_min_interval"),
d2e6a577
FG
3240
3241 Option("osd_scrub_interval_randomize_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3242 .set_default(0.5)
28e407b8
AA
3243 .set_description("Ratio of scrub interval to randomly vary")
3244 .set_long_description("This prevents a scrub 'stampede' by randomly varying the scrub intervals so that they are soon uniformly distributed over the week")
3245 .add_see_also("osd_scrub_min_interval"),
d2e6a577 3246
28e407b8 3247 Option("osd_scrub_backoff_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577 3248 .set_default(.66)
a8e16298
TL
3249 .set_long_description("This is the precentage of ticks that do NOT schedule scrubs, 66% means that 1 out of 3 ticks will schedule scrubs")
3250 .set_description("Backoff ratio for scheduling scrubs"),
d2e6a577
FG
3251
3252 Option("osd_scrub_chunk_min", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3253 .set_default(5)
28e407b8
AA
3254 .set_description("Minimum number of objects to scrub in a single chunk")
3255 .add_see_also("osd_scrub_chunk_max"),
d2e6a577
FG
3256
3257 Option("osd_scrub_chunk_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3258 .set_default(25)
11fdf7f2 3259 .set_description("Maximum number of objects to scrub in a single chunk")
28e407b8 3260 .add_see_also("osd_scrub_chunk_min"),
d2e6a577
FG
3261
3262 Option("osd_scrub_sleep", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3263 .set_default(0)
28e407b8 3264 .set_description("Duration to inject a delay during scrubbing"),
d2e6a577 3265
9f95a23c
TL
3266 Option("osd_scrub_extended_sleep", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3267 .set_default(0)
3268 .set_description("Duration to inject a delay during scrubbing out of scrubbing hours")
3269 .add_see_also("osd_scrub_begin_hour")
3270 .add_see_also("osd_scrub_end_hour")
3271 .add_see_also("osd_scrub_begin_week_day")
3272 .add_see_also("osd_scrub_end_week_day"),
3273
d2e6a577
FG
3274 Option("osd_scrub_auto_repair", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3275 .set_default(false)
28e407b8 3276 .set_description("Automatically repair damaged objects detected during scrub"),
d2e6a577
FG
3277
3278 Option("osd_scrub_auto_repair_num_errors", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3279 .set_default(5)
28e407b8
AA
3280 .set_description("Maximum number of detected errors to automatically repair")
3281 .add_see_also("osd_scrub_auto_repair"),
3282
3283 Option("osd_scrub_max_preemptions", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3284 .set_default(5)
f6b5b4d7 3285 .set_min_max(0, 30)
28e407b8 3286 .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"),
d2e6a577
FG
3287
3288 Option("osd_deep_scrub_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
b32b8144 3289 .set_default(7_day)
28e407b8 3290 .set_description("Deep scrub each PG (i.e., verify data checksums) at least this often"),
d2e6a577
FG
3291
3292 Option("osd_deep_scrub_randomize_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3293 .set_default(0.15)
a8e16298
TL
3294 .set_description("Scrubs will randomly become deep scrubs at this rate (0.15 -> 15% of scrubs are deep)")
3295 .set_long_description("This prevents a deep scrub 'stampede' by spreading deep scrubs so they are uniformly distributed over the week"),
d2e6a577 3296
11fdf7f2
TL
3297 Option("osd_deep_scrub_stride", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
3298 .set_default(512_K)
28e407b8
AA
3299 .set_description("Number of bytes to read from an object at a time during deep scrub"),
3300
3301 Option("osd_deep_scrub_keys", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3302 .set_default(1024)
3303 .set_description("Number of keys to read from an object at a time during deep scrub"),
d2e6a577
FG
3304
3305 Option("osd_deep_scrub_update_digest_min_age", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144 3306 .set_default(2_hr)
28e407b8
AA
3307 .set_description("Update overall object digest only if object was last modified longer ago than this"),
3308
3309 Option("osd_deep_scrub_large_omap_object_key_threshold", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
494da23a 3310 .set_default(200000)
28e407b8
AA
3311 .set_description("Warn when we encounter an object with more omap keys than this")
3312 .add_service("osd")
3313 .add_see_also("osd_deep_scrub_large_omap_object_value_sum_threshold"),
3314
11fdf7f2 3315 Option("osd_deep_scrub_large_omap_object_value_sum_threshold", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
28e407b8
AA
3316 .set_default(1_G)
3317 .set_description("Warn when we encounter an object with more omap key bytes than this")
3318 .add_service("osd")
3319 .add_see_also("osd_deep_scrub_large_omap_object_key_threshold"),
d2e6a577
FG
3320
3321 Option("osd_class_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3322 .set_default(CEPH_LIBDIR "/rados-classes")
3323 .set_description(""),
3324
3325 Option("osd_open_classes_on_start", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3326 .set_default(true)
3327 .set_description(""),
3328
3329 Option("osd_class_load_list", Option::TYPE_STR, Option::LEVEL_ADVANCED)
9f95a23c 3330 .set_default("cephfs hello journal lock log numops " "otp rbd refcount rgw rgw_gc timeindex user version cas")
d2e6a577
FG
3331 .set_description(""),
3332
3333 Option("osd_class_default_list", Option::TYPE_STR, Option::LEVEL_ADVANCED)
9f95a23c 3334 .set_default("cephfs hello journal lock log numops " "otp rbd refcount rgw rgw_gc timeindex user version cas")
d2e6a577
FG
3335 .set_description(""),
3336
3337 Option("osd_check_for_log_corruption", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3338 .set_default(false)
3339 .set_description(""),
3340
3341 Option("osd_use_stale_snap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3342 .set_default(false)
3343 .set_description(""),
3344
3345 Option("osd_rollback_to_cluster_snap", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3346 .set_default("")
3347 .set_description(""),
3348
3349 Option("osd_default_notify_timeout", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3350 .set_default(30)
3351 .set_description(""),
3352
3353 Option("osd_kill_backfill_at", Option::TYPE_INT, Option::LEVEL_DEV)
3354 .set_default(0)
3355 .set_description(""),
3356
3357 Option("osd_pg_epoch_persisted_max_stale", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3358 .set_default(40)
3359 .set_description(""),
3360
9f95a23c
TL
3361 Option("osd_target_pg_log_entries_per_osd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3362 .set_default(3000 * 100)
3363 .set_description("target number of PG entries total on an OSD")
3364 .add_see_also("osd_max_pg_log_entries")
3365 .add_see_also("osd_min_pg_log_entries"),
3366
d2e6a577 3367 Option("osd_min_pg_log_entries", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
9f95a23c 3368 .set_default(250)
d2e6a577
FG
3369 .set_description("minimum number of entries to maintain in the PG log")
3370 .add_service("osd")
3371 .add_see_also("osd_max_pg_log_entries")
3372 .add_see_also("osd_pg_log_dups_tracked"),
3373
3374 Option("osd_max_pg_log_entries", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
9f95a23c 3375 .set_default(10000)
d2e6a577
FG
3376 .set_description("maximum number of entries to maintain in the PG log when degraded before we trim")
3377 .add_service("osd")
3378 .add_see_also("osd_min_pg_log_entries")
3379 .add_see_also("osd_pg_log_dups_tracked"),
3380
3381 Option("osd_pg_log_dups_tracked", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3382 .set_default(3000)
3383 .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")
3384 .add_service("osd")
3385 .add_see_also("osd_min_pg_log_entries")
3386 .add_see_also("osd_max_pg_log_entries"),
3387
9f95a23c
TL
3388 Option("osd_object_clean_region_max_num_intervals", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3389 .set_default(10)
3390 .set_description("number of intervals in clean_offsets")
3391 .set_long_description("partial recovery uses multiple intervals to record the clean part of the object"
3392 "when the number of intervals is greater than osd_object_clean_region_max_num_intervals, minimum interval will be trimmed"
3393 "(0 will recovery the entire object data interval)")
3394 .add_service("osd"),
3395
d2e6a577
FG
3396 Option("osd_force_recovery_pg_log_entries_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3397 .set_default(1.3)
3398 .set_description(""),
3399
3400 Option("osd_pg_log_trim_min", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3401 .set_default(100)
3402 .set_description(""),
3403
11fdf7f2
TL
3404 Option("osd_force_auth_primary_missing_objects", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3405 .set_default(100)
3406 .set_description("Approximate missing objects above which to force auth_log_shard to be primary temporarily"),
3407
3408 Option("osd_async_recovery_min_cost", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3409 .set_default(100)
3410 .set_description("A mixture measure of number of current log entries difference "
3411 "and historical missing objects, above which we switch to use "
3412 "asynchronous recovery when appropriate"),
3413
3efd9988 3414 Option("osd_max_pg_per_osd_hard_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
28e407b8 3415 .set_default(3)
3efd9988
FG
3416 .set_min(1)
3417 .set_description("Maximum number of PG per OSD, a factor of 'mon_max_pg_per_osd'")
3418 .set_long_description("OSD will refuse to instantiate PG if the number of PG it serves exceeds this number.")
3419 .add_see_also("mon_max_pg_per_osd"),
3420
94b18763
FG
3421 Option("osd_pg_log_trim_max", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3422 .set_default(10000)
3423 .set_description("maximum number of entries to remove at once from the PG log")
3424 .add_service("osd")
3425 .add_see_also("osd_min_pg_log_entries")
3426 .add_see_also("osd_max_pg_log_entries"),
3427
d2e6a577
FG
3428 Option("osd_op_complaint_time", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3429 .set_default(30)
3430 .set_description(""),
3431
3432 Option("osd_command_max_records", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3433 .set_default(256)
3434 .set_description(""),
3435
3436 Option("osd_max_pg_blocked_by", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3437 .set_default(16)
3438 .set_description(""),
3439
3440 Option("osd_op_log_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3441 .set_default(5)
3442 .set_description(""),
3443
d2e6a577
FG
3444 Option("osd_backoff_on_unfound", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3445 .set_default(true)
3446 .set_description(""),
3447
3448 Option("osd_backoff_on_degraded", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3449 .set_default(false)
3450 .set_description(""),
3451
d2e6a577
FG
3452 Option("osd_backoff_on_peering", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3453 .set_default(false)
3454 .set_description(""),
3455
3efd9988
FG
3456 Option("osd_debug_shutdown", Option::TYPE_BOOL, Option::LEVEL_DEV)
3457 .set_default(false)
3458 .set_description("Turn up debug levels during shutdown"),
3459
d2e6a577
FG
3460 Option("osd_debug_crash_on_ignored_backoff", Option::TYPE_BOOL, Option::LEVEL_DEV)
3461 .set_default(false)
3462 .set_description(""),
3463
3464 Option("osd_debug_inject_dispatch_delay_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3465 .set_default(0)
3466 .set_description(""),
3467
3468 Option("osd_debug_inject_dispatch_delay_duration", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3469 .set_default(.1)
3470 .set_description(""),
3471
3472 Option("osd_debug_drop_ping_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3473 .set_default(0)
3474 .set_description(""),
3475
3476 Option("osd_debug_drop_ping_duration", Option::TYPE_INT, Option::LEVEL_DEV)
3477 .set_default(0)
3478 .set_description(""),
3479
3480 Option("osd_debug_op_order", Option::TYPE_BOOL, Option::LEVEL_DEV)
3481 .set_default(false)
3482 .set_description(""),
3483
3484 Option("osd_debug_verify_missing_on_start", Option::TYPE_BOOL, Option::LEVEL_DEV)
3485 .set_default(false)
3486 .set_description(""),
3487
94b18763 3488 Option("osd_debug_verify_snaps", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
3489 .set_default(false)
3490 .set_description(""),
3491
3492 Option("osd_debug_verify_stray_on_activate", Option::TYPE_BOOL, Option::LEVEL_DEV)
3493 .set_default(false)
3494 .set_description(""),
3495
3496 Option("osd_debug_skip_full_check_in_backfill_reservation", Option::TYPE_BOOL, Option::LEVEL_DEV)
3497 .set_default(false)
3498 .set_description(""),
3499
3500 Option("osd_debug_reject_backfill_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3501 .set_default(0)
3502 .set_description(""),
c07f9fc5 3503
d2e6a577
FG
3504 Option("osd_debug_inject_copyfrom_error", Option::TYPE_BOOL, Option::LEVEL_DEV)
3505 .set_default(false)
3506 .set_description(""),
c07f9fc5 3507
d2e6a577
FG
3508 Option("osd_debug_misdirected_ops", Option::TYPE_BOOL, Option::LEVEL_DEV)
3509 .set_default(false)
3510 .set_description(""),
c07f9fc5 3511
d2e6a577
FG
3512 Option("osd_debug_skip_full_check_in_recovery", Option::TYPE_BOOL, Option::LEVEL_DEV)
3513 .set_default(false)
3514 .set_description(""),
c07f9fc5 3515
d2e6a577
FG
3516 Option("osd_debug_random_push_read_error", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3517 .set_default(0)
3518 .set_description(""),
c07f9fc5 3519
d2e6a577
FG
3520 Option("osd_debug_verify_cached_snaps", Option::TYPE_BOOL, Option::LEVEL_DEV)
3521 .set_default(false)
3522 .set_description(""),
c07f9fc5 3523
28e407b8
AA
3524 Option("osd_debug_deep_scrub_sleep", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3525 .set_default(0)
3526 .set_description("Inject an expensive sleep during deep scrub IO to make it easier to induce preemption"),
3527
11fdf7f2
TL
3528 Option("osd_debug_no_acting_change", Option::TYPE_BOOL, Option::LEVEL_DEV)
3529 .set_default(false),
3530 Option("osd_debug_no_purge_strays", Option::TYPE_BOOL, Option::LEVEL_DEV)
3531 .set_default(false),
3532
eafe8130
TL
3533 Option("osd_debug_pretend_recovery_active", Option::TYPE_BOOL, Option::LEVEL_DEV)
3534 .set_default(false)
3535 .set_description(""),
3536
d2e6a577
FG
3537 Option("osd_enable_op_tracker", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3538 .set_default(true)
3539 .set_description(""),
c07f9fc5 3540
d2e6a577
FG
3541 Option("osd_num_op_tracker_shard", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3542 .set_default(32)
3543 .set_description(""),
c07f9fc5 3544
d2e6a577
FG
3545 Option("osd_op_history_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3546 .set_default(20)
3547 .set_description(""),
c07f9fc5 3548
d2e6a577
FG
3549 Option("osd_op_history_duration", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3550 .set_default(600)
3551 .set_description(""),
c07f9fc5 3552
d2e6a577
FG
3553 Option("osd_op_history_slow_op_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3554 .set_default(20)
3555 .set_description(""),
c07f9fc5 3556
d2e6a577
FG
3557 Option("osd_op_history_slow_op_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3558 .set_default(10.0)
3559 .set_description(""),
c07f9fc5 3560
d2e6a577
FG
3561 Option("osd_target_transaction_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3562 .set_default(30)
3563 .set_description(""),
c07f9fc5 3564
f64942e4
AA
3565 Option("osd_delete_sleep", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3566 .set_default(0)
11fdf7f2
TL
3567 .set_description("Time in seconds to sleep before next removal transaction (overrides values below)"),
3568
3569 Option("osd_delete_sleep_hdd", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3570 .set_default(5)
3571 .set_description("Time in seconds to sleep before next removal transaction for HDDs"),
3572
3573 Option("osd_delete_sleep_ssd", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
adb31ebb 3574 .set_default(1)
11fdf7f2
TL
3575 .set_description("Time in seconds to sleep before next removal transaction for SSDs"),
3576
3577 Option("osd_delete_sleep_hybrid", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
adb31ebb 3578 .set_default(1)
11fdf7f2 3579 .set_description("Time in seconds to sleep before next removal transaction when data is on HDD and journal is on SSD"),
f64942e4 3580
d2e6a577
FG
3581 Option("osd_failsafe_full_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3582 .set_default(.97)
3583 .set_description(""),
c07f9fc5 3584
92f5a8d4
TL
3585 Option("osd_fast_shutdown", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3586 .set_default(true)
3587 .set_description("Fast, immediate shutdown")
3588 .set_long_description("Setting this to false makes the OSD do a slower teardown of all state when it receives a SIGINT or SIGTERM or when shutting down for any other reason. That slow shutdown is primarilyy useful for doing memory leak checking with valgrind."),
3589
d2e6a577
FG
3590 Option("osd_fast_fail_on_connection_refused", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3591 .set_default(true)
3592 .set_description(""),
c07f9fc5 3593
d2e6a577
FG
3594 Option("osd_pg_object_context_cache_count", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3595 .set_default(64)
3596 .set_description(""),
c07f9fc5 3597
d2e6a577
FG
3598 Option("osd_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3599 .set_default(false)
3600 .set_description(""),
c07f9fc5 3601
d2e6a577
FG
3602 Option("osd_function_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3603 .set_default(false)
3604 .set_description(""),
c07f9fc5 3605
d2e6a577
FG
3606 Option("osd_fast_info", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3607 .set_default(true)
3608 .set_description(""),
c07f9fc5 3609
d2e6a577
FG
3610 Option("osd_debug_pg_log_writeout", Option::TYPE_BOOL, Option::LEVEL_DEV)
3611 .set_default(false)
3612 .set_description(""),
c07f9fc5 3613
d2e6a577
FG
3614 Option("osd_loop_before_reset_tphandle", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3615 .set_default(64)
3616 .set_description(""),
c07f9fc5 3617
d2e6a577
FG
3618 Option("threadpool_default_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3619 .set_default(60)
3620 .set_description(""),
c07f9fc5 3621
d2e6a577
FG
3622 Option("threadpool_empty_queue_max_wait", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3623 .set_default(2)
3624 .set_description(""),
c07f9fc5 3625
d2e6a577
FG
3626 Option("leveldb_log_to_ceph_log", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3627 .set_default(true)
3628 .set_description(""),
c07f9fc5 3629
11fdf7f2 3630 Option("leveldb_write_buffer_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 3631 .set_default(8_M)
d2e6a577 3632 .set_description(""),
c07f9fc5 3633
11fdf7f2 3634 Option("leveldb_cache_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 3635 .set_default(128_M)
d2e6a577 3636 .set_description(""),
c07f9fc5 3637
11fdf7f2 3638 Option("leveldb_block_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577
FG
3639 .set_default(0)
3640 .set_description(""),
c07f9fc5 3641
d2e6a577
FG
3642 Option("leveldb_bloom_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3643 .set_default(0)
3644 .set_description(""),
c07f9fc5 3645
d2e6a577
FG
3646 Option("leveldb_max_open_files", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3647 .set_default(0)
3648 .set_description(""),
c07f9fc5 3649
d2e6a577
FG
3650 Option("leveldb_compression", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3651 .set_default(true)
3652 .set_description(""),
c07f9fc5 3653
d2e6a577
FG
3654 Option("leveldb_paranoid", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3655 .set_default(false)
3656 .set_description(""),
3657
3658 Option("leveldb_log", Option::TYPE_STR, Option::LEVEL_ADVANCED)
3659 .set_default("/dev/null")
3660 .set_description(""),
3661
3662 Option("leveldb_compact_on_mount", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3663 .set_default(false)
3664 .set_description(""),
3665
d2e6a577
FG
3666 Option("rocksdb_log_to_ceph_log", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3667 .set_default(true)
3668 .set_description(""),
3669
11fdf7f2 3670 Option("rocksdb_cache_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
f64942e4 3671 .set_default(512_M)
eafe8130 3672 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
3673 .set_description(""),
3674
3675 Option("rocksdb_cache_row_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3676 .set_default(0)
3677 .set_description(""),
3678
3679 Option("rocksdb_cache_shard_bits", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3680 .set_default(4)
3681 .set_description(""),
3682
3683 Option("rocksdb_cache_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
91327a77 3684 .set_default("binned_lru")
d2e6a577
FG
3685 .set_description(""),
3686
11fdf7f2 3687 Option("rocksdb_block_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 3688 .set_default(4_K)
d2e6a577
FG
3689 .set_description(""),
3690
3691 Option("rocksdb_perf", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3692 .set_default(false)
3693 .set_description(""),
3694
3695 Option("rocksdb_collect_compaction_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3696 .set_default(false)
3697 .set_description(""),
3698
3699 Option("rocksdb_collect_extended_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3700 .set_default(false)
3701 .set_description(""),
3702
3703 Option("rocksdb_collect_memory_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3704 .set_default(false)
3705 .set_description(""),
3706
9f95a23c
TL
3707 Option("rocksdb_delete_range_threshold", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3708 .set_default(1048576)
3709 .set_description("The number of keys required to invoke DeleteRange when deleting muliple keys."),
d2e6a577
FG
3710
3711 Option("rocksdb_bloom_bits_per_key", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3712 .set_default(20)
3713 .set_description("Number of bits per key to use for RocksDB's bloom filters.")
3714 .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."),
3715
3716 Option("rocksdb_cache_index_and_filter_blocks", Option::TYPE_BOOL, Option::LEVEL_DEV)
3717 .set_default(true)
3718 .set_description("Whether to cache indices and filters in block cache")
3719 .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."),
3720
3721 Option("rocksdb_cache_index_and_filter_blocks_with_high_priority", Option::TYPE_BOOL, Option::LEVEL_DEV)
3722 .set_default(true)
3723 .set_description("Whether to cache indices and filters in the block cache with high priority")
3724 .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."),
3725
3726 Option("rocksdb_pin_l0_filter_and_index_blocks_in_cache", Option::TYPE_BOOL, Option::LEVEL_DEV)
eafe8130 3727 .set_default(false)
d2e6a577
FG
3728 .set_description("Whether to pin Level 0 indices and bloom filters in the block cache")
3729 .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."),
3730
3731 Option("rocksdb_index_type", Option::TYPE_STR, Option::LEVEL_DEV)
3732 .set_default("binary_search")
3733 .set_description("Type of index for SST files: binary_search, hash_search, two_level")
3734 .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"),
3735
3736 Option("rocksdb_partition_filters", Option::TYPE_BOOL, Option::LEVEL_DEV)
3737 .set_default(false)
3738 .set_description("(experimental) partition SST index/filters into smaller blocks")
3739 .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"),
3740
11fdf7f2 3741 Option("rocksdb_metadata_block_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 3742 .set_default(4_K)
d2e6a577
FG
3743 .set_description("The block size for index partitions. (0 = rocksdb default)"),
3744
3745 Option("mon_rocksdb_options", Option::TYPE_STR, Option::LEVEL_ADVANCED)
28e407b8
AA
3746 .set_default("write_buffer_size=33554432,"
3747 "compression=kNoCompression,"
3748 "level_compaction_dynamic_level_bytes=true")
d2e6a577
FG
3749 .set_description(""),
3750
3751 Option("osd_client_op_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3752 .set_default(63)
3753 .set_description(""),
3754
3755 Option("osd_recovery_op_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3756 .set_default(3)
11fdf7f2
TL
3757 .set_description("Priority to use for recovery operations if not specified for the pool"),
3758
3759 Option("osd_peering_op_priority", Option::TYPE_UINT, Option::LEVEL_DEV)
3760 .set_default(255)
d2e6a577
FG
3761 .set_description(""),
3762
3763 Option("osd_snap_trim_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3764 .set_default(5)
3765 .set_description(""),
3766
11fdf7f2
TL
3767 Option("osd_snap_trim_cost", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
3768 .set_default(1<<20)
3769 .set_description(""),
3770
3771 Option("osd_pg_delete_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3772 .set_default(5)
3773 .set_description(""),
3774
3775 Option("osd_pg_delete_cost", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577
FG
3776 .set_default(1<<20)
3777 .set_description(""),
3778
3779 Option("osd_scrub_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3780 .set_default(5)
28e407b8 3781 .set_description("Priority for scrub operations in work queue"),
d2e6a577 3782
11fdf7f2 3783 Option("osd_scrub_cost", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 3784 .set_default(50<<20)
28e407b8 3785 .set_description("Cost for scrub operations in work queue"),
d2e6a577
FG
3786
3787 Option("osd_requested_scrub_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3788 .set_default(120)
3789 .set_description(""),
3790
3791 Option("osd_recovery_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3792 .set_default(5)
11fdf7f2
TL
3793 .set_description("Priority of recovery in the work queue")
3794 .set_long_description("Not related to a pool's recovery_priority"),
d2e6a577 3795
11fdf7f2 3796 Option("osd_recovery_cost", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577
FG
3797 .set_default(20<<20)
3798 .set_description(""),
3799
3800 Option("osd_recovery_op_warn_multiple", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3801 .set_default(16)
3802 .set_description(""),
3803
3804 Option("osd_mon_shutdown_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3805 .set_default(5)
3806 .set_description(""),
3807
3808 Option("osd_shutdown_pgref_assert", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3809 .set_default(false)
3810 .set_description(""),
3811
11fdf7f2 3812 Option("osd_max_object_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 3813 .set_default(128_M)
d2e6a577
FG
3814 .set_description(""),
3815
3816 Option("osd_max_object_name_len", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3817 .set_default(2048)
3818 .set_description(""),
3819
3820 Option("osd_max_object_namespace_len", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3821 .set_default(256)
3822 .set_description(""),
3823
3824 Option("osd_max_attr_name_len", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3825 .set_default(100)
3826 .set_description(""),
3827
3828 Option("osd_max_attr_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3829 .set_default(0)
3830 .set_description(""),
3831
3832 Option("osd_max_omap_entries_per_request", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
9f95a23c 3833 .set_default(1024)
d2e6a577 3834 .set_description(""),
c07f9fc5 3835
11fdf7f2
TL
3836 Option("osd_max_omap_bytes_per_request", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
3837 .set_default(1_G)
d2e6a577 3838 .set_description(""),
c07f9fc5 3839
9f95a23c
TL
3840 Option("osd_max_write_op_reply_len", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
3841 .set_default(32)
3842 .set_description("Max size of the per-op payload for requests with the RETURNVEC flag set")
3843 .set_long_description("This value caps the amount of data (per op; a request may have many ops) that will be sent back to the client and recorded in the PG log."),
3844
d2e6a577 3845 Option("osd_objectstore", Option::TYPE_STR, Option::LEVEL_ADVANCED)
11fdf7f2
TL
3846 .set_default("bluestore")
3847 .set_enum_allowed({"bluestore", "filestore", "memstore", "kstore"})
3848 .set_flag(Option::FLAG_CREATE)
3849 .set_description("backend type for an OSD (like filestore or bluestore)"),
c07f9fc5 3850
d2e6a577
FG
3851 Option("osd_objectstore_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3852 .set_default(false)
3853 .set_description(""),
c07f9fc5 3854
d2e6a577
FG
3855 Option("osd_objectstore_fuse", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3856 .set_default(false)
3857 .set_description(""),
c07f9fc5 3858
d2e6a577
FG
3859 Option("osd_bench_small_size_max_iops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3860 .set_default(100)
3861 .set_description(""),
c07f9fc5 3862
11fdf7f2
TL
3863 Option("osd_bench_large_size_max_throughput", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
3864 .set_default(100_M)
d2e6a577 3865 .set_description(""),
c07f9fc5 3866
11fdf7f2
TL
3867 Option("osd_bench_max_block_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
3868 .set_default(64_M)
d2e6a577 3869 .set_description(""),
c07f9fc5 3870
d2e6a577
FG
3871 Option("osd_bench_duration", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
3872 .set_default(30)
3873 .set_description(""),
c07f9fc5 3874
d2e6a577
FG
3875 Option("osd_blkin_trace_all", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3876 .set_default(false)
3877 .set_description(""),
c07f9fc5 3878
d2e6a577
FG
3879 Option("osdc_blkin_trace_all", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3880 .set_default(false)
3881 .set_description(""),
c07f9fc5 3882
d2e6a577
FG
3883 Option("osd_discard_disconnected_ops", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3884 .set_default(true)
3885 .set_description(""),
c07f9fc5 3886
11fdf7f2 3887 Option("osd_memory_target", Option::TYPE_SIZE, Option::LEVEL_BASIC)
91327a77 3888 .set_default(4_G)
92f5a8d4
TL
3889 .set_min(896_M)
3890 .set_flag(Option::FLAG_RUNTIME)
91327a77 3891 .add_see_also("bluestore_cache_autotune")
92f5a8d4
TL
3892 .add_see_also("osd_memory_cache_min")
3893 .add_see_also("osd_memory_base")
3894 .set_description("When tcmalloc and cache autotuning is enabled, try to keep this many bytes mapped in memory.")
3895 .set_long_description("The minimum value must be at least equal to osd_memory_base + osd_memory_cache_min."),
91327a77 3896
11fdf7f2
TL
3897 Option("osd_memory_target_cgroup_limit_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
3898 .set_default(0.8)
3899 .set_min_max(0.0, 1.0)
3900 .add_see_also("osd_memory_target")
3901 .set_description("Set the default value for osd_memory_target to the cgroup memory limit (if set) times this value")
3902 .set_long_description("A value of 0 disables this feature."),
3903
3904 Option("osd_memory_base", Option::TYPE_SIZE, Option::LEVEL_DEV)
91327a77 3905 .set_default(768_M)
92f5a8d4 3906 .set_flag(Option::FLAG_RUNTIME)
91327a77
AA
3907 .add_see_also("bluestore_cache_autotune")
3908 .set_description("When tcmalloc and cache autotuning is enabled, estimate the minimum amount of memory in bytes the OSD will need."),
3909
3910 Option("osd_memory_expected_fragmentation", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3911 .set_default(0.15)
f64942e4 3912 .set_min_max(0.0, 1.0)
92f5a8d4 3913 .set_flag(Option::FLAG_RUNTIME)
91327a77
AA
3914 .add_see_also("bluestore_cache_autotune")
3915 .set_description("When tcmalloc and cache autotuning is enabled, estimate the percent of memory fragmentation."),
3916
11fdf7f2 3917 Option("osd_memory_cache_min", Option::TYPE_SIZE, Option::LEVEL_DEV)
91327a77 3918 .set_default(128_M)
92f5a8d4
TL
3919 .set_min(128_M)
3920 .set_flag(Option::FLAG_RUNTIME)
91327a77
AA
3921 .add_see_also("bluestore_cache_autotune")
3922 .set_description("When tcmalloc and cache autotuning is enabled, set the minimum amount of memory used for caches."),
3923
3924 Option("osd_memory_cache_resize_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3925 .set_default(1)
3926 .add_see_also("bluestore_cache_autotune")
3927 .set_description("When tcmalloc and cache autotuning is enabled, wait this many seconds between resizing caches."),
3928
11fdf7f2 3929 Option("memstore_device_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 3930 .set_default(1_G)
d2e6a577 3931 .set_description(""),
c07f9fc5 3932
d2e6a577 3933 Option("memstore_page_set", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
35e4c445 3934 .set_default(false)
d2e6a577 3935 .set_description(""),
c07f9fc5 3936
11fdf7f2 3937 Option("memstore_page_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 3938 .set_default(64_K)
d2e6a577 3939 .set_description(""),
c07f9fc5 3940
9f95a23c
TL
3941 Option("memstore_debug_omit_block_device_write", Option::TYPE_BOOL, Option::LEVEL_DEV)
3942 .set_default(false)
3943 .add_see_also("bluestore_debug_omit_block_device_write")
3944 .set_description("write metadata only"),
3945
d2e6a577
FG
3946 Option("objectstore_blackhole", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3947 .set_default(false)
3948 .set_description(""),
c07f9fc5 3949
d2e6a577
FG
3950 // --------------------------
3951 // bluestore
c07f9fc5 3952
d2e6a577
FG
3953 Option("bdev_debug_inflight_ios", Option::TYPE_BOOL, Option::LEVEL_DEV)
3954 .set_default(false)
3955 .set_description(""),
c07f9fc5 3956
d2e6a577
FG
3957 Option("bdev_inject_crash", Option::TYPE_INT, Option::LEVEL_DEV)
3958 .set_default(0)
3959 .set_description(""),
c07f9fc5 3960
d2e6a577
FG
3961 Option("bdev_inject_crash_flush_delay", Option::TYPE_INT, Option::LEVEL_DEV)
3962 .set_default(2)
3963 .set_description(""),
c07f9fc5 3964
d2e6a577
FG
3965 Option("bdev_aio", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3966 .set_default(true)
3967 .set_description(""),
c07f9fc5 3968
d2e6a577
FG
3969 Option("bdev_aio_poll_ms", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3970 .set_default(250)
3971 .set_description(""),
c07f9fc5 3972
d2e6a577
FG
3973 Option("bdev_aio_max_queue_depth", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3974 .set_default(1024)
3975 .set_description(""),
c07f9fc5 3976
d2e6a577
FG
3977 Option("bdev_aio_reap_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
3978 .set_default(16)
3979 .set_description(""),
c07f9fc5 3980
11fdf7f2 3981 Option("bdev_block_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 3982 .set_default(4_K)
d2e6a577 3983 .set_description(""),
c07f9fc5 3984
d2e6a577
FG
3985 Option("bdev_debug_aio", Option::TYPE_BOOL, Option::LEVEL_DEV)
3986 .set_default(false)
3987 .set_description(""),
c07f9fc5 3988
d2e6a577
FG
3989 Option("bdev_debug_aio_suicide_timeout", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3990 .set_default(60.0)
3991 .set_description(""),
c07f9fc5 3992
11fdf7f2
TL
3993 Option("bdev_debug_aio_log_age", Option::TYPE_FLOAT, Option::LEVEL_DEV)
3994 .set_default(5.0)
3995 .set_description(""),
3996
d2e6a577
FG
3997 Option("bdev_nvme_unbind_from_kernel", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
3998 .set_default(false)
3999 .set_description(""),
c07f9fc5 4000
d2e6a577
FG
4001 Option("bdev_nvme_retry_count", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4002 .set_default(-1)
4003 .set_description(""),
c07f9fc5 4004
11fdf7f2
TL
4005 Option("bdev_enable_discard", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4006 .set_default(false)
4007 .set_description(""),
4008
4009 Option("bdev_async_discard", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4010 .set_default(false)
4011 .set_description(""),
adb31ebb
TL
4012
4013 Option("bdev_flock_retry_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4014 .set_default(0.1)
4015 .set_description("interval to retry the flock"),
4016
4017 Option("bdev_flock_retry", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4018 .set_default(3)
4019 .set_description("times to retry the flock"),
11fdf7f2
TL
4020
4021 Option("bluefs_alloc_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4022 .set_default(1_M)
eafe8130
TL
4023 .set_description("Allocation unit size for DB and WAL devices"),
4024
4025 Option("bluefs_shared_alloc_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
4026 .set_default(64_K)
4027 .set_description("Allocation unit size for primary/shared device"),
d2e6a577 4028
11fdf7f2 4029 Option("bluefs_max_prefetch", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4030 .set_default(1_M)
d2e6a577
FG
4031 .set_description(""),
4032
11fdf7f2 4033 Option("bluefs_min_log_runway", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4034 .set_default(1_M)
d2e6a577
FG
4035 .set_description(""),
4036
11fdf7f2 4037 Option("bluefs_max_log_runway", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577
FG
4038 .set_default(4194304)
4039 .set_description(""),
4040
4041 Option("bluefs_log_compact_min_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4042 .set_default(5.0)
4043 .set_description(""),
4044
11fdf7f2 4045 Option("bluefs_log_compact_min_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4046 .set_default(16_M)
d2e6a577
FG
4047 .set_description(""),
4048
11fdf7f2 4049 Option("bluefs_min_flush_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4050 .set_default(512_K)
d2e6a577
FG
4051 .set_description(""),
4052
4053 Option("bluefs_compact_log_sync", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4054 .set_default(false)
4055 .set_description(""),
4056
4057 Option("bluefs_buffered_io", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1911f103
TL
4058 .set_default(false)
4059 .set_description("Enabled buffered IO for bluefs reads.")
4060 .set_long_description("When this option is enabled, bluefs will in some cases perform buffered reads. This allows the kernel page cache to act as a secondary cache for things like RocksDB compaction. For example, if the rocksdb block cache isn't large enough to hold blocks from the compressed SST files itself, they can be read from page cache instead of from the disk. This option previously was enabled by default, however in some test cases it appears to cause excessive swap utilization by the linux kernel and a large negative performance impact after several hours of run time. Please exercise caution when enabling."),
d2e6a577
FG
4061
4062 Option("bluefs_sync_write", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4063 .set_default(false)
4064 .set_description(""),
4065
4066 Option("bluefs_allocator", Option::TYPE_STR, Option::LEVEL_DEV)
e306af50
TL
4067 .set_default("hybrid")
4068 .set_enum_allowed({"bitmap", "stupid", "avl", "hybrid"})
d2e6a577
FG
4069 .set_description(""),
4070
9f95a23c
TL
4071 Option("bluefs_log_replay_check_allocations", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4072 .set_default(true)
4073 .set_description("Enables checks for allocations consistency during log replay"),
d2e6a577 4074
f6b5b4d7
TL
4075 Option("bluefs_replay_recovery", Option::TYPE_BOOL, Option::LEVEL_DEV)
4076 .set_default(false)
4077 .set_description("Attempt to read bluefs log so large that it became unreadable.")
4078 .set_long_description("If BlueFS log grows to extreme sizes (200GB+) it is likely that it becames unreadable. "
4079 "This options enables heuristics that scans devices for missing data. "
4080 "DO NOT ENABLE BY DEFAULT"),
4081
4082 Option("bluefs_replay_recovery_disable_compact", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4083 .set_default(false)
4084 .set_description(""),
4085
cd265ab1
TL
4086 Option("bluefs_check_for_zeros", Option::TYPE_BOOL, Option::LEVEL_DEV)
4087 .set_default(false)
4088 .set_flag(Option::FLAG_RUNTIME)
4089 .set_description("Check data read for suspicious pages")
4090 .set_long_description("Looks into data read to check if there is a 4K block entirely filled with zeros. "
4091 "If this happens, we re-read data. If there is difference, we print error to log.")
4092 .add_see_also("bluestore_retry_disk_reads"),
4093
d2e6a577
FG
4094 Option("bluestore_bluefs", Option::TYPE_BOOL, Option::LEVEL_DEV)
4095 .set_default(true)
11fdf7f2 4096 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4097 .set_description("Use BlueFS to back rocksdb")
4098 .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."),
4099
4100 Option("bluestore_bluefs_env_mirror", Option::TYPE_BOOL, Option::LEVEL_DEV)
4101 .set_default(false)
11fdf7f2 4102 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4103 .set_description("Mirror bluefs data to file system for testing/validation"),
4104
11fdf7f2 4105 Option("bluestore_bluefs_min", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4106 .set_default(1_G)
d2e6a577
FG
4107 .set_description("minimum disk space allocated to BlueFS (e.g., at mkfs)"),
4108
11fdf7f2
TL
4109 Option("bluestore_bluefs_min_free", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
4110 .set_default(1_G)
3efd9988
FG
4111 .set_description("minimum free space allocated to BlueFS"),
4112
9f95a23c
TL
4113 Option("bluestore_bluefs_max_free", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
4114 .set_default(10_G)
4115 .set_description("Maximum free space allocated to BlueFS"),
4116
d2e6a577
FG
4117 Option("bluestore_bluefs_min_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4118 .set_default(.02)
4119 .set_description("Minimum fraction of free space devoted to BlueFS"),
4120
4121 Option("bluestore_bluefs_max_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4122 .set_default(.90)
4123 .set_description("Maximum fraction of free storage devoted to BlueFS"),
4124
4125 Option("bluestore_bluefs_gift_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4126 .set_default(.02)
4127 .set_description("Maximum fraction of free space to give to BlueFS at once"),
4128
4129 Option("bluestore_bluefs_reclaim_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4130 .set_default(.20)
4131 .set_description("Maximum fraction of free space to reclaim from BlueFS at once"),
4132
4133 Option("bluestore_bluefs_balance_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4134 .set_default(1)
4135 .set_description("How frequently (in seconds) to balance free space between BlueFS and BlueStore"),
4136
11fdf7f2 4137 Option("bluestore_bluefs_alloc_failure_dump_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
f64942e4 4138 .set_default(0)
11fdf7f2
TL
4139 .set_description("How frequently (in seconds) to dump allocator on"
4140 "BlueFS space allocation failure"),
4141
4142 Option("bluestore_bluefs_db_compatibility", Option::TYPE_BOOL, Option::LEVEL_DEV)
4143 .set_default(true)
4144 .set_description("Sync db with legacy bluefs extents info")
4145 .set_long_description("Enforces db sync with legacy bluefs extents information on close."
4146 " Enables downgrades to pre-nautilus releases"),
f64942e4 4147
11fdf7f2 4148 Option("bluestore_spdk_mem", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577 4149 .set_default(512)
11fdf7f2
TL
4150 .set_description("Amount of dpdk memory size in MB")
4151 .set_long_description("If running multiple SPDK instances per node, you must specify the amount of dpdk memory size in MB each instance will use, to make sure each instance uses its own dpdk memory"),
d2e6a577
FG
4152
4153 Option("bluestore_spdk_coremask", Option::TYPE_STR, Option::LEVEL_DEV)
11fdf7f2
TL
4154 .set_default("0x1")
4155 .set_description("A hexadecimal bit mask of the cores to run on. Note the core numbering can change between platforms and should be determined beforehand"),
d2e6a577
FG
4156
4157 Option("bluestore_spdk_max_io_completion", Option::TYPE_UINT, Option::LEVEL_DEV)
4158 .set_default(0)
11fdf7f2
TL
4159 .set_description("Maximal I/Os to be batched completed while checking queue pair completions, 0 means let spdk library determine it"),
4160
4161 Option("bluestore_spdk_io_sleep", Option::TYPE_UINT, Option::LEVEL_DEV)
4162 .set_default(5)
4163 .set_description("Time period to wait if there is no completed I/O from polling"),
d2e6a577
FG
4164
4165 Option("bluestore_block_path", Option::TYPE_STR, Option::LEVEL_DEV)
4166 .set_default("")
11fdf7f2 4167 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4168 .set_description("Path to block device/file"),
4169
11fdf7f2 4170 Option("bluestore_block_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
92f5a8d4 4171 .set_default(100_G)
11fdf7f2 4172 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4173 .set_description("Size of file to create for backing bluestore"),
4174
4175 Option("bluestore_block_create", Option::TYPE_BOOL, Option::LEVEL_DEV)
4176 .set_default(true)
11fdf7f2 4177 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4178 .set_description("Create bluestore_block_path if it doesn't exist")
4179 .add_see_also("bluestore_block_path").add_see_also("bluestore_block_size"),
4180
4181 Option("bluestore_block_db_path", Option::TYPE_STR, Option::LEVEL_DEV)
4182 .set_default("")
11fdf7f2 4183 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4184 .set_description("Path for db block device"),
4185
4186 Option("bluestore_block_db_size", Option::TYPE_UINT, Option::LEVEL_DEV)
4187 .set_default(0)
11fdf7f2 4188 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4189 .set_description("Size of file to create for bluestore_block_db_path"),
4190
4191 Option("bluestore_block_db_create", Option::TYPE_BOOL, Option::LEVEL_DEV)
4192 .set_default(false)
11fdf7f2 4193 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4194 .set_description("Create bluestore_block_db_path if it doesn't exist")
4195 .add_see_also("bluestore_block_db_path")
4196 .add_see_also("bluestore_block_db_size"),
4197
4198 Option("bluestore_block_wal_path", Option::TYPE_STR, Option::LEVEL_DEV)
4199 .set_default("")
11fdf7f2 4200 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4201 .set_description("Path to block device/file backing bluefs wal"),
4202
11fdf7f2 4203 Option("bluestore_block_wal_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 4204 .set_default(96_M)
11fdf7f2 4205 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4206 .set_description("Size of file to create for bluestore_block_wal_path"),
4207
4208 Option("bluestore_block_wal_create", Option::TYPE_BOOL, Option::LEVEL_DEV)
4209 .set_default(false)
11fdf7f2 4210 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4211 .set_description("Create bluestore_block_wal_path if it doesn't exist")
4212 .add_see_also("bluestore_block_wal_path")
4213 .add_see_also("bluestore_block_wal_size"),
4214
4215 Option("bluestore_block_preallocate_file", Option::TYPE_BOOL, Option::LEVEL_DEV)
4216 .set_default(false)
11fdf7f2 4217 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4218 .set_description("Preallocate file created via bluestore_block*_create"),
4219
11fdf7f2
TL
4220 Option("bluestore_ignore_data_csum", Option::TYPE_BOOL, Option::LEVEL_DEV)
4221 .set_default(false)
4222 .set_flag(Option::FLAG_RUNTIME)
4223 .set_description("Ignore checksum errors on read and do not generate an EIO error"),
4224
d2e6a577
FG
4225 Option("bluestore_csum_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4226 .set_default("crc32c")
4227 .set_enum_allowed({"none", "crc32c", "crc32c_16", "crc32c_8", "xxhash32", "xxhash64"})
11fdf7f2 4228 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4229 .set_description("Default checksum algorithm to use")
4230 .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."),
4231
f64942e4
AA
4232 Option("bluestore_retry_disk_reads", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4233 .set_default(3)
4234 .set_min_max(0, 255)
11fdf7f2 4235 .set_flag(Option::FLAG_RUNTIME)
f64942e4
AA
4236 .set_description("Number of read retries on checksum validation error")
4237 .set_long_description("Retries to read data from the disk this many times when checksum validation fails to handle spurious read errors gracefully."),
4238
d2e6a577
FG
4239 Option("bluestore_min_alloc_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4240 .set_default(0)
11fdf7f2 4241 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4242 .set_description("Minimum allocation size to allocate for an object")
4243 .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."),
4244
11fdf7f2 4245 Option("bluestore_min_alloc_size_hdd", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4246 .set_default(64_K)
11fdf7f2
TL
4247 .set_flag(Option::FLAG_CREATE)
4248 .set_description("Default min_alloc_size value for rotational media")
4249 .add_see_also("bluestore_min_alloc_size"),
d2e6a577 4250
11fdf7f2 4251 Option("bluestore_min_alloc_size_ssd", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
92f5a8d4 4252 .set_default(4_K)
11fdf7f2
TL
4253 .set_flag(Option::FLAG_CREATE)
4254 .set_description("Default min_alloc_size value for non-rotational (solid state) media")
4255 .add_see_also("bluestore_min_alloc_size"),
d2e6a577 4256
11fdf7f2 4257 Option("bluestore_max_alloc_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4258 .set_default(0)
11fdf7f2 4259 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4260 .set_description("Maximum size of a single allocation (0 for no max)"),
4261
11fdf7f2 4262 Option("bluestore_prefer_deferred_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4263 .set_default(0)
11fdf7f2 4264 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4265 .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."),
4266
11fdf7f2 4267 Option("bluestore_prefer_deferred_size_hdd", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4268 .set_default(32768)
11fdf7f2
TL
4269 .set_flag(Option::FLAG_RUNTIME)
4270 .set_description("Default bluestore_prefer_deferred_size for rotational media")
4271 .add_see_also("bluestore_prefer_deferred_size"),
d2e6a577 4272
11fdf7f2 4273 Option("bluestore_prefer_deferred_size_ssd", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4274 .set_default(0)
11fdf7f2
TL
4275 .set_flag(Option::FLAG_RUNTIME)
4276 .set_description("Default bluestore_prefer_deferred_size for non-rotational (solid state) media")
4277 .add_see_also("bluestore_prefer_deferred_size"),
d2e6a577
FG
4278
4279 Option("bluestore_compression_mode", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4280 .set_default("none")
4281 .set_enum_allowed({"none", "passive", "aggressive", "force"})
11fdf7f2 4282 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4283 .set_description("Default policy for using compression when pool does not specify")
4284 .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."),
4285
4286 Option("bluestore_compression_algorithm", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4287 .set_default("snappy")
4288 .set_enum_allowed({"", "snappy", "zlib", "zstd", "lz4"})
11fdf7f2 4289 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4290 .set_description("Default compression algorithm to use when writing object data")
4291 .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."),
4292
11fdf7f2 4293 Option("bluestore_compression_min_blob_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4294 .set_default(0)
11fdf7f2
TL
4295 .set_flag(Option::FLAG_RUNTIME)
4296 .set_description("Maximum chunk size to apply compression to when random access is expected for an object.")
4297 .set_long_description("Chunks larger than this are broken into smaller chunks before being compressed"),
d2e6a577 4298
11fdf7f2 4299 Option("bluestore_compression_min_blob_size_hdd", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4300 .set_default(128_K)
11fdf7f2
TL
4301 .set_flag(Option::FLAG_RUNTIME)
4302 .set_description("Default value of bluestore_compression_min_blob_size for rotational media")
4303 .add_see_also("bluestore_compression_min_blob_size"),
d2e6a577 4304
11fdf7f2 4305 Option("bluestore_compression_min_blob_size_ssd", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4306 .set_default(8_K)
11fdf7f2
TL
4307 .set_flag(Option::FLAG_RUNTIME)
4308 .set_description("Default value of bluestore_compression_min_blob_size for non-rotational (solid state) media")
4309 .add_see_also("bluestore_compression_min_blob_size"),
d2e6a577 4310
11fdf7f2 4311 Option("bluestore_compression_max_blob_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4312 .set_default(0)
11fdf7f2
TL
4313 .set_flag(Option::FLAG_RUNTIME)
4314 .set_description("Maximum chunk size to apply compression to when non-random access is expected for an object.")
4315 .set_long_description("Chunks larger than this are broken into smaller chunks before being compressed"),
d2e6a577 4316
11fdf7f2 4317 Option("bluestore_compression_max_blob_size_hdd", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4318 .set_default(512_K)
11fdf7f2
TL
4319 .set_flag(Option::FLAG_RUNTIME)
4320 .set_description("Default value of bluestore_compression_max_blob_size for rotational media")
4321 .add_see_also("bluestore_compression_max_blob_size"),
d2e6a577 4322
11fdf7f2 4323 Option("bluestore_compression_max_blob_size_ssd", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4324 .set_default(64_K)
11fdf7f2
TL
4325 .set_flag(Option::FLAG_RUNTIME)
4326 .set_description("Default value of bluestore_compression_max_blob_size for non-rotational (solid state) media")
4327 .add_see_also("bluestore_compression_max_blob_size"),
d2e6a577
FG
4328
4329 Option("bluestore_gc_enable_blob_threshold", Option::TYPE_INT, Option::LEVEL_DEV)
4330 .set_default(0)
11fdf7f2 4331 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4332 .set_description(""),
4333
4334 Option("bluestore_gc_enable_total_threshold", Option::TYPE_INT, Option::LEVEL_DEV)
4335 .set_default(0)
11fdf7f2 4336 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4337 .set_description(""),
4338
11fdf7f2 4339 Option("bluestore_max_blob_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577 4340 .set_default(0)
11fdf7f2
TL
4341 .set_flag(Option::FLAG_RUNTIME)
4342 .set_description("")
4343 .set_long_description("Bluestore blobs are collections of extents (ie on-disk data) originating from one or more objects. Blobs can be compressed, typically have checksum data, may be overwritten, may be shared (with an extent ref map), or split. This setting controls the maximum size a blob is allowed to be."),
d2e6a577 4344
11fdf7f2 4345 Option("bluestore_max_blob_size_hdd", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 4346 .set_default(512_K)
11fdf7f2
TL
4347 .set_flag(Option::FLAG_RUNTIME)
4348 .set_description("")
4349 .add_see_also("bluestore_max_blob_size"),
d2e6a577 4350
11fdf7f2 4351 Option("bluestore_max_blob_size_ssd", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 4352 .set_default(64_K)
11fdf7f2
TL
4353 .set_flag(Option::FLAG_RUNTIME)
4354 .set_description("")
4355 .add_see_also("bluestore_max_blob_size"),
d2e6a577
FG
4356
4357 Option("bluestore_compression_required_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4358 .set_default(.875)
11fdf7f2 4359 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4360 .set_description("Compression ratio required to store compressed data")
4361 .set_long_description("If we compress data and get less than this we discard the result and store the original uncompressed data."),
4362
11fdf7f2 4363 Option("bluestore_extent_map_shard_max_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4364 .set_default(1200)
4365 .set_description("Max size (bytes) for a single extent map shard before splitting"),
4366
11fdf7f2 4367 Option("bluestore_extent_map_shard_target_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4368 .set_default(500)
4369 .set_description("Target size (bytes) for a single extent map shard"),
4370
11fdf7f2 4371 Option("bluestore_extent_map_shard_min_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4372 .set_default(150)
4373 .set_description("Min size (bytes) for a single extent map shard before merging"),
4374
4375 Option("bluestore_extent_map_shard_target_size_slop", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4376 .set_default(.2)
4377 .set_description("Ratio above/below target for a shard when trying to align to an existing extent or blob boundary"),
4378
11fdf7f2 4379 Option("bluestore_extent_map_inline_shard_prealloc_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4380 .set_default(256)
4381 .set_description("Preallocated buffer for inline shards"),
4382
4383 Option("bluestore_cache_trim_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
94b18763 4384 .set_default(.05)
d2e6a577
FG
4385 .set_description("How frequently we trim the bluestore cache"),
4386
4387 Option("bluestore_cache_trim_max_skip_pinned", Option::TYPE_UINT, Option::LEVEL_DEV)
4388 .set_default(64)
4389 .set_description("Max pinned cache entries we consider before giving up"),
4390
4391 Option("bluestore_cache_type", Option::TYPE_STR, Option::LEVEL_DEV)
4392 .set_default("2q")
4393 .set_enum_allowed({"2q", "lru"})
4394 .set_description("Cache replacement algorithm"),
4395
4396 Option("bluestore_2q_cache_kin_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4397 .set_default(.5)
4398 .set_description("2Q paper suggests .5"),
4399
4400 Option("bluestore_2q_cache_kout_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4401 .set_default(.5)
4402 .set_description("2Q paper suggests .5"),
4403
11fdf7f2 4404 Option("bluestore_cache_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4405 .set_default(0)
4406 .set_description("Cache size (in bytes) for BlueStore")
4407 .set_long_description("This includes data and metadata cached by BlueStore as well as memory devoted to rocksdb's cache(s)."),
4408
11fdf7f2 4409 Option("bluestore_cache_size_hdd", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 4410 .set_default(1_G)
11fdf7f2
TL
4411 .set_description("Default bluestore_cache_size for rotational media")
4412 .add_see_also("bluestore_cache_size"),
d2e6a577 4413
11fdf7f2 4414 Option("bluestore_cache_size_ssd", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 4415 .set_default(3_G)
11fdf7f2
TL
4416 .set_description("Default bluestore_cache_size for non-rotational (solid state) media")
4417 .add_see_also("bluestore_cache_size"),
d2e6a577 4418
91327a77
AA
4419 Option("bluestore_cache_meta_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4420 .set_default(.4)
4421 .add_see_also("bluestore_cache_size")
d2e6a577
FG
4422 .set_description("Ratio of bluestore cache to devote to metadata"),
4423
91327a77
AA
4424 Option("bluestore_cache_kv_ratio", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4425 .set_default(.4)
4426 .add_see_also("bluestore_cache_size")
d2e6a577
FG
4427 .set_description("Ratio of bluestore cache to devote to kv database (rocksdb)"),
4428
91327a77
AA
4429 Option("bluestore_cache_autotune", Option::TYPE_BOOL, Option::LEVEL_DEV)
4430 .set_default(true)
4431 .add_see_also("bluestore_cache_size")
4432 .add_see_also("bluestore_cache_meta_ratio")
4433 .set_description("Automatically tune the ratio of caches while respecting min values."),
4434
91327a77
AA
4435 Option("bluestore_cache_autotune_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4436 .set_default(5)
4437 .add_see_also("bluestore_cache_autotune")
4438 .set_description("The number of seconds to wait between rebalances when cache autotune is enabled."),
d2e6a577 4439
9f95a23c
TL
4440 Option("bluestore_alloc_stats_dump_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4441 .set_default(3600 * 24)
4442 .set_description("The period (in second) for logging allocation statistics."),
4443
d2e6a577
FG
4444 Option("bluestore_kvbackend", Option::TYPE_STR, Option::LEVEL_DEV)
4445 .set_default("rocksdb")
11fdf7f2 4446 .set_flag(Option::FLAG_CREATE)
d2e6a577
FG
4447 .set_description("Key value database to use for bluestore"),
4448
11fdf7f2 4449 Option("bluestore_allocator", Option::TYPE_STR, Option::LEVEL_ADVANCED)
e306af50
TL
4450 .set_default("hybrid")
4451 .set_enum_allowed({"bitmap", "stupid", "avl", "hybrid"})
11fdf7f2
TL
4452 .set_description("Allocator policy")
4453 .set_long_description("Allocator to use for bluestore. Stupid should only be used for testing."),
d2e6a577 4454
11fdf7f2 4455 Option("bluestore_freelist_blocks_per_key", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4456 .set_default(128)
4457 .set_description("Block (and bits) per database key"),
4458
11fdf7f2 4459 Option("bluestore_bitmapallocator_blocks_per_zone", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4460 .set_default(1024)
4461 .set_description(""),
4462
11fdf7f2 4463 Option("bluestore_bitmapallocator_span_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4464 .set_default(1024)
4465 .set_description(""),
4466
4467 Option("bluestore_max_deferred_txc", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4468 .set_default(32)
4469 .set_description("Max transactions with deferred writes that can accumulate before we force flush deferred writes"),
4470
9f95a23c
TL
4471 Option("bluestore_max_defer_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4472 .set_default(3)
4473 .set_description("max duration to force deferred submit"),
4474
d2e6a577 4475 Option("bluestore_rocksdb_options", Option::TYPE_STR, Option::LEVEL_ADVANCED)
494da23a 4476 .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,max_background_compactions=2")
cd265ab1
TL
4477 .set_description("Full set of rocksdb settings to override"),
4478
4479 Option("bluestore_rocksdb_options_annex", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4480 .set_default("")
4481 .set_description("An addition to bluestore_rocksdb_options. Allows setting rocksdb options without repeating the existing defaults."),
d2e6a577 4482
11fdf7f2
TL
4483 Option("bluestore_rocksdb_cf", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4484 .set_default(false)
4485 .set_description("Enable use of rocksdb column families for bluestore metadata"),
4486
4487 Option("bluestore_rocksdb_cfs", Option::TYPE_STR, Option::LEVEL_DEV)
4488 .set_default("M= P= L=")
4489 .set_description("List of whitespace-separate key/value pairs where key is CF name and value is CF options"),
4490
d2e6a577
FG
4491 Option("bluestore_fsck_on_mount", Option::TYPE_BOOL, Option::LEVEL_DEV)
4492 .set_default(false)
4493 .set_description("Run fsck at mount"),
4494
4495 Option("bluestore_fsck_on_mount_deep", Option::TYPE_BOOL, Option::LEVEL_DEV)
494da23a
TL
4496 .set_default(false)
4497 .set_description("Run deep fsck at mount when bluestore_fsck_on_mount is set to true"),
d2e6a577 4498
eafe8130
TL
4499 Option("bluestore_fsck_quick_fix_on_mount", Option::TYPE_BOOL, Option::LEVEL_DEV)
4500 .set_default(true)
4501 .set_description("Do quick-fix for the store at mount"),
4502
d2e6a577
FG
4503 Option("bluestore_fsck_on_umount", Option::TYPE_BOOL, Option::LEVEL_DEV)
4504 .set_default(false)
4505 .set_description("Run fsck at umount"),
4506
4507 Option("bluestore_fsck_on_umount_deep", Option::TYPE_BOOL, Option::LEVEL_DEV)
494da23a
TL
4508 .set_default(false)
4509 .set_description("Run deep fsck at umount when bluestore_fsck_on_umount is set to true"),
d2e6a577
FG
4510
4511 Option("bluestore_fsck_on_mkfs", Option::TYPE_BOOL, Option::LEVEL_DEV)
4512 .set_default(true)
4513 .set_description("Run fsck after mkfs"),
4514
4515 Option("bluestore_fsck_on_mkfs_deep", Option::TYPE_BOOL, Option::LEVEL_DEV)
4516 .set_default(false)
4517 .set_description("Run deep fsck after mkfs"),
4518
4519 Option("bluestore_sync_submit_transaction", Option::TYPE_BOOL, Option::LEVEL_DEV)
4520 .set_default(false)
4521 .set_description("Try to submit metadata transaction to rocksdb in queuing thread context"),
4522
11fdf7f2 4523 Option("bluestore_fsck_read_bytes_cap", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
a8e16298 4524 .set_default(64_M)
11fdf7f2 4525 .set_flag(Option::FLAG_RUNTIME)
a8e16298
TL
4526 .set_description("Maximum bytes read at once by deep fsck"),
4527
eafe8130
TL
4528 Option("bluestore_fsck_quick_fix_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4529 .set_default(2)
4530 .set_description("Number of additional threads to perform quick-fix (shallow fsck) command"),
4531
11fdf7f2 4532 Option("bluestore_throttle_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4533 .set_default(64_M)
11fdf7f2 4534 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4535 .set_description("Maximum bytes in flight before we throttle IO submission"),
4536
11fdf7f2 4537 Option("bluestore_throttle_deferred_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4538 .set_default(128_M)
11fdf7f2 4539 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4540 .set_description("Maximum bytes for deferred writes before we throttle IO submission"),
4541
11fdf7f2 4542 Option("bluestore_throttle_cost_per_io", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4543 .set_default(0)
11fdf7f2 4544 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4545 .set_description("Overhead added to transaction cost (in bytes) for each IO"),
4546
4547 Option("bluestore_throttle_cost_per_io_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4548 .set_default(670000)
11fdf7f2
TL
4549 .set_flag(Option::FLAG_RUNTIME)
4550 .set_description("Default bluestore_throttle_cost_per_io for rotational media")
4551 .add_see_also("bluestore_throttle_cost_per_io"),
d2e6a577
FG
4552
4553 Option("bluestore_throttle_cost_per_io_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4554 .set_default(4000)
11fdf7f2
TL
4555 .set_flag(Option::FLAG_RUNTIME)
4556 .set_description("Default bluestore_throttle_cost_per_io for non-rotation (solid state) media")
4557 .add_see_also("bluestore_throttle_cost_per_io"),
d2e6a577
FG
4558
4559 Option("bluestore_deferred_batch_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4560 .set_default(0)
11fdf7f2 4561 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4562 .set_description("Max number of deferred writes before we flush the deferred write queue"),
4563
4564 Option("bluestore_deferred_batch_ops_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4565 .set_default(64)
11fdf7f2
TL
4566 .set_flag(Option::FLAG_RUNTIME)
4567 .set_description("Default bluestore_deferred_batch_ops for rotational media")
4568 .add_see_also("bluestore_deferred_batch_ops"),
d2e6a577
FG
4569
4570 Option("bluestore_deferred_batch_ops_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4571 .set_default(16)
11fdf7f2
TL
4572 .set_flag(Option::FLAG_RUNTIME)
4573 .set_description("Default bluestore_deferred_batch_ops for non-rotational (solid state) media")
4574 .add_see_also("bluestore_deferred_batch_ops"),
d2e6a577
FG
4575
4576 Option("bluestore_nid_prealloc", Option::TYPE_INT, Option::LEVEL_DEV)
4577 .set_default(1024)
4578 .set_description("Number of unique object ids to preallocate at a time"),
4579
4580 Option("bluestore_blobid_prealloc", Option::TYPE_UINT, Option::LEVEL_DEV)
4581 .set_default(10240)
4582 .set_description("Number of unique blob ids to preallocate at a time"),
4583
4584 Option("bluestore_clone_cow", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4585 .set_default(true)
11fdf7f2 4586 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4587 .set_description("Use copy-on-write when cloning objects (versus reading and rewriting them at clone time)"),
4588
4589 Option("bluestore_default_buffered_read", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4590 .set_default(true)
11fdf7f2 4591 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4592 .set_description("Cache read results by default (unless hinted NOCACHE or WONTNEED)"),
4593
4594 Option("bluestore_default_buffered_write", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4595 .set_default(false)
11fdf7f2 4596 .set_flag(Option::FLAG_RUNTIME)
d2e6a577
FG
4597 .set_description("Cache writes by default (unless hinted NOCACHE or WONTNEED)"),
4598
4599 Option("bluestore_debug_misc", Option::TYPE_BOOL, Option::LEVEL_DEV)
4600 .set_default(false)
4601 .set_description(""),
4602
4603 Option("bluestore_debug_no_reuse_blocks", Option::TYPE_BOOL, Option::LEVEL_DEV)
4604 .set_default(false)
4605 .set_description(""),
4606
4607 Option("bluestore_debug_small_allocations", Option::TYPE_INT, Option::LEVEL_DEV)
4608 .set_default(0)
4609 .set_description(""),
4610
9f95a23c
TL
4611 Option("bluestore_debug_too_many_blobs_threshold", Option::TYPE_INT, Option::LEVEL_DEV)
4612 .set_default(24*1024)
4613 .set_description(""),
4614
d2e6a577
FG
4615 Option("bluestore_debug_freelist", Option::TYPE_BOOL, Option::LEVEL_DEV)
4616 .set_default(false)
4617 .set_description(""),
4618
4619 Option("bluestore_debug_prefill", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4620 .set_default(0)
4621 .set_description("simulate fragmentation"),
4622
11fdf7f2 4623 Option("bluestore_debug_prefragment_max", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 4624 .set_default(1_M)
d2e6a577
FG
4625 .set_description(""),
4626
4627 Option("bluestore_debug_inject_read_err", Option::TYPE_BOOL, Option::LEVEL_DEV)
4628 .set_default(false)
4629 .set_description(""),
4630
4631 Option("bluestore_debug_randomize_serial_transaction", Option::TYPE_INT, Option::LEVEL_DEV)
4632 .set_default(0)
4633 .set_description(""),
4634
4635 Option("bluestore_debug_omit_block_device_write", Option::TYPE_BOOL, Option::LEVEL_DEV)
4636 .set_default(false)
4637 .set_description(""),
4638
4639 Option("bluestore_debug_fsck_abort", Option::TYPE_BOOL, Option::LEVEL_DEV)
4640 .set_default(false)
4641 .set_description(""),
4642
4643 Option("bluestore_debug_omit_kv_commit", Option::TYPE_BOOL, Option::LEVEL_DEV)
4644 .set_default(false)
4645 .set_description(""),
4646
4647 Option("bluestore_debug_permit_any_bdev_label", Option::TYPE_BOOL, Option::LEVEL_DEV)
4648 .set_default(false)
4649 .set_description(""),
4650
d2e6a577
FG
4651 Option("bluestore_debug_random_read_err", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4652 .set_default(0)
4653 .set_description(""),
c07f9fc5 4654
11fdf7f2
TL
4655 Option("bluestore_debug_inject_bug21040", Option::TYPE_BOOL, Option::LEVEL_DEV)
4656 .set_default(false)
4657 .set_description(""),
4658
f64942e4
AA
4659 Option("bluestore_debug_inject_csum_err_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4660 .set_default(0.0)
4661 .set_description("inject crc verification errors into bluestore device reads"),
4662
eafe8130
TL
4663 Option("bluestore_fsck_error_on_no_per_pool_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4664 .set_default(false)
4665 .set_description("Make fsck error (instead of warn) when bluestore lacks per-pool stats, e.g., after an upgrade"),
11fdf7f2
TL
4666
4667 Option("bluestore_warn_on_bluefs_spillover", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4668 .set_default(true)
4669 .set_description("Enable health indication on bluefs slow device usage"),
4670
81eedcae
TL
4671 Option("bluestore_warn_on_legacy_statfs", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4672 .set_default(true)
4673 .set_description("Enable health indication on lack of per-pool statfs reporting from bluestore"),
4674
9f95a23c
TL
4675 Option("bluestore_fsck_error_on_no_per_pool_omap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4676 .set_default(false)
4677 .set_description("Make fsck error (instead of warn) when objects without per-pool omap are found"),
4678
4679 Option("bluestore_warn_on_no_per_pool_omap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4680 .set_default(true)
4681 .set_description("Enable health indication on lack of per-pool omap"),
4682
11fdf7f2
TL
4683 Option("bluestore_log_op_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4684 .set_default(5)
4685 .set_description("log operation if it's slower than this age (seconds)"),
4686
4687 Option("bluestore_log_omap_iterator_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
494da23a 4688 .set_default(5)
11fdf7f2
TL
4689 .set_description("log omap iteration operation if it's slower than this age (seconds)"),
4690
494da23a
TL
4691 Option("bluestore_log_collection_list_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4692 .set_default(60)
4693 .set_description("log collection list operation if it's slower than this age (seconds)"),
4694
9f95a23c
TL
4695 Option("bluestore_debug_enforce_settings", Option::TYPE_STR, Option::LEVEL_DEV)
4696 .set_default("default")
4697 .set_enum_allowed({"default", "hdd", "ssd"})
4698 .set_description("Enforces specific hw profile settings")
4699 .set_long_description("'hdd' enforces settings intended for BlueStore above a rotational drive. 'ssd' enforces settings intended for BlueStore above a solid drive. 'default' - using settings for the actual hardware."),
4700
4701 Option("bluestore_avl_alloc_bf_threshold", Option::TYPE_UINT, Option::LEVEL_DEV)
4702 .set_default(131072)
4703 .set_description(""),
4704
4705 Option("bluestore_avl_alloc_bf_free_pct", Option::TYPE_UINT, Option::LEVEL_DEV)
4706 .set_default(4)
4707 .set_description(""),
4708
e306af50
TL
4709 Option("bluestore_hybrid_alloc_mem_cap", Option::TYPE_UINT, Option::LEVEL_DEV)
4710 .set_default(64_M)
4711 .set_description("Maximum RAM hybrid allocator should use before enabling bitmap supplement"),
4712
9f95a23c 4713 Option("bluestore_volume_selection_policy", Option::TYPE_STR, Option::LEVEL_DEV)
f91f0fd5 4714 .set_default("use_some_extra")
9f95a23c
TL
4715 .set_enum_allowed({ "rocksdb_original", "use_some_extra" })
4716 .set_description("Determines bluefs volume selection policy")
4717 .set_long_description("Determines bluefs volume selection policy. 'use_some_extra' policy allows to override RocksDB level granularity and put high level's data to faster device even when the level doesn't completely fit there"),
4718
4719 Option("bluestore_volume_selection_reserved_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4720 .set_flag(Option::FLAG_STARTUP)
4721 .set_default(2.0)
4722 .set_description("DB level size multiplier. Determines amount of space at DB device to bar from the usage when 'use some extra' policy is in action. Reserved size is determined as sum(L_max_size[0], L_max_size[L-1]) + L_max_size[L] * this_factor"),
4723
4724 Option("bluestore_volume_selection_reserved", Option::TYPE_INT, Option::LEVEL_ADVANCED)
4725 .set_flag(Option::FLAG_STARTUP)
4726 .set_default(0)
4727 .set_description("Space reserved at DB device and not allowed for 'use some extra' policy usage. Overrides 'bluestore_volume_selection_reserved_factor' setting and introduces straightforward limit."),
4728
4729 Option("bluestore_ioring", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4730 .set_default(false)
4731 .set_description("Enables Linux io_uring API instead of libaio"),
4732
adb31ebb
TL
4733 Option("bdev_ioring_hipri", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4734 .set_default(false)
4735 .set_description("Enables Linux io_uring API Use polled IO completions"),
4736
4737 Option("bdev_ioring_sqthread_poll", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4738 .set_default(false)
4739 .set_description("Enables Linux io_uring API Offload submission/completion to kernel thread"),
4740
4741 Option("bluestore_kv_sync_util_logging_s", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4742 .set_default(10.0)
4743 .set_flag(Option::FLAG_RUNTIME)
4744 .set_description("KV sync thread utilization logging period")
4745 .set_long_description("How often (in seconds) to print KV sync thread utilization, "
4746 "not logged when set to 0 or when utilization is 0%"),
4747
4748
d2e6a577
FG
4749 // -----------------------------------------
4750 // kstore
c07f9fc5 4751
d2e6a577
FG
4752 Option("kstore_max_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4753 .set_default(512)
4754 .set_description(""),
4755
11fdf7f2 4756 Option("kstore_max_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 4757 .set_default(64_M)
d2e6a577 4758 .set_description(""),
c07f9fc5 4759
d2e6a577
FG
4760 Option("kstore_backend", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4761 .set_default("rocksdb")
4762 .set_description(""),
c07f9fc5 4763
d2e6a577
FG
4764 Option("kstore_rocksdb_options", Option::TYPE_STR, Option::LEVEL_ADVANCED)
4765 .set_default("compression=kNoCompression")
11fdf7f2 4766 .set_description("Options to pass through when RocksDB is used as the KeyValueDB for kstore."),
c07f9fc5 4767
d2e6a577
FG
4768 Option("kstore_fsck_on_mount", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4769 .set_default(false)
11fdf7f2 4770 .set_description("Whether or not to run fsck on mount for kstore."),
c07f9fc5 4771
d2e6a577
FG
4772 Option("kstore_fsck_on_mount_deep", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4773 .set_default(true)
11fdf7f2 4774 .set_description("Whether or not to run deep fsck on mount for kstore"),
c07f9fc5 4775
d2e6a577
FG
4776 Option("kstore_nid_prealloc", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4777 .set_default(1024)
4778 .set_description(""),
c07f9fc5 4779
d2e6a577
FG
4780 Option("kstore_sync_transaction", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4781 .set_default(false)
4782 .set_description(""),
c07f9fc5 4783
d2e6a577
FG
4784 Option("kstore_sync_submit_transaction", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4785 .set_default(false)
4786 .set_description(""),
c07f9fc5 4787
d2e6a577
FG
4788 Option("kstore_onode_map_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4789 .set_default(1024)
4790 .set_description(""),
c07f9fc5 4791
11fdf7f2 4792 Option("kstore_default_stripe_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577
FG
4793 .set_default(65536)
4794 .set_description(""),
c07f9fc5 4795
d2e6a577
FG
4796 // ---------------------
4797 // filestore
c07f9fc5 4798
11fdf7f2
TL
4799 Option("filestore_rocksdb_options", Option::TYPE_STR, Option::LEVEL_DEV)
4800 .set_default("max_background_jobs=10,compaction_readahead_size=2097152,compression=kNoCompression")
4801 .set_description("Options to pass through when RocksDB is used as the KeyValueDB for filestore."),
c07f9fc5 4802
11fdf7f2 4803 Option("filestore_omap_backend", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577 4804 .set_default("rocksdb")
11fdf7f2
TL
4805 .set_enum_allowed({"leveldb", "rocksdb"})
4806 .set_description("The KeyValueDB to use for filestore metadata (ie omap)."),
c07f9fc5 4807
11fdf7f2 4808 Option("filestore_omap_backend_path", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577 4809 .set_default("")
11fdf7f2 4810 .set_description("The path where the filestore KeyValueDB should store it's database(s)."),
c07f9fc5 4811
d2e6a577
FG
4812 Option("filestore_wbthrottle_enable", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4813 .set_default(true)
11fdf7f2 4814 .set_description("Enabling throttling of operations to backing file system"),
c07f9fc5 4815
11fdf7f2 4816 Option("filestore_wbthrottle_btrfs_bytes_start_flusher", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4817 .set_default(41943040)
11fdf7f2 4818 .set_description("Start flushing (fsyncing) when this many bytes are written(btrfs)"),
c07f9fc5 4819
11fdf7f2 4820 Option("filestore_wbthrottle_btrfs_bytes_hard_limit", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4821 .set_default(419430400)
11fdf7f2 4822 .set_description("Block writes when this many bytes haven't been flushed (fsynced) (btrfs)"),
c07f9fc5 4823
d2e6a577
FG
4824 Option("filestore_wbthrottle_btrfs_ios_start_flusher", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4825 .set_default(500)
11fdf7f2 4826 .set_description("Start flushing (fsyncing) when this many IOs are written (brtrfs)"),
c07f9fc5 4827
d2e6a577
FG
4828 Option("filestore_wbthrottle_btrfs_ios_hard_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4829 .set_default(5000)
11fdf7f2 4830 .set_description("Block writes when this many IOs haven't been flushed (fsynced) (btrfs)"),
c07f9fc5 4831
d2e6a577
FG
4832 Option("filestore_wbthrottle_btrfs_inodes_start_flusher", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4833 .set_default(500)
11fdf7f2 4834 .set_description("Start flushing (fsyncing) when this many distinct inodes have been modified (btrfs)"),
c07f9fc5 4835
11fdf7f2 4836 Option("filestore_wbthrottle_xfs_bytes_start_flusher", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4837 .set_default(41943040)
11fdf7f2 4838 .set_description("Start flushing (fsyncing) when this many bytes are written(xfs)"),
c07f9fc5 4839
11fdf7f2 4840 Option("filestore_wbthrottle_xfs_bytes_hard_limit", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 4841 .set_default(419430400)
11fdf7f2 4842 .set_description("Block writes when this many bytes haven't been flushed (fsynced) (xfs)"),
c07f9fc5 4843
d2e6a577
FG
4844 Option("filestore_wbthrottle_xfs_ios_start_flusher", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4845 .set_default(500)
11fdf7f2 4846 .set_description("Start flushing (fsyncing) when this many IOs are written (xfs)"),
c07f9fc5 4847
d2e6a577
FG
4848 Option("filestore_wbthrottle_xfs_ios_hard_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4849 .set_default(5000)
11fdf7f2 4850 .set_description("Block writes when this many IOs haven't been flushed (fsynced) (xfs)"),
c07f9fc5 4851
d2e6a577
FG
4852 Option("filestore_wbthrottle_xfs_inodes_start_flusher", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4853 .set_default(500)
11fdf7f2 4854 .set_description("Start flushing (fsyncing) when this many distinct inodes have been modified (xfs)"),
c07f9fc5 4855
d2e6a577
FG
4856 Option("filestore_wbthrottle_btrfs_inodes_hard_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4857 .set_default(5000)
11fdf7f2 4858 .set_description("Block writing when this many inodes have outstanding writes (btrfs)"),
c07f9fc5 4859
d2e6a577
FG
4860 Option("filestore_wbthrottle_xfs_inodes_hard_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
4861 .set_default(5000)
11fdf7f2 4862 .set_description("Block writing when this many inodes have outstanding writes (xfs)"),
c07f9fc5 4863
11fdf7f2 4864 Option("filestore_odsync_write", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 4865 .set_default(false)
11fdf7f2 4866 .set_description("Write with O_DSYNC"),
c07f9fc5 4867
11fdf7f2 4868 Option("filestore_index_retry_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
4869 .set_default(0)
4870 .set_description(""),
c07f9fc5 4871
d2e6a577
FG
4872 Option("filestore_debug_inject_read_err", Option::TYPE_BOOL, Option::LEVEL_DEV)
4873 .set_default(false)
4874 .set_description(""),
c07f9fc5 4875
d2e6a577
FG
4876 Option("filestore_debug_random_read_err", Option::TYPE_FLOAT, Option::LEVEL_DEV)
4877 .set_default(0)
4878 .set_description(""),
c07f9fc5 4879
d2e6a577
FG
4880 Option("filestore_debug_omap_check", Option::TYPE_BOOL, Option::LEVEL_DEV)
4881 .set_default(false)
4882 .set_description(""),
c07f9fc5 4883
11fdf7f2 4884 Option("filestore_omap_header_cache_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4885 .set_default(1024)
4886 .set_description(""),
c07f9fc5 4887
11fdf7f2 4888 Option("filestore_max_inline_xattr_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4889 .set_default(0)
4890 .set_description(""),
c07f9fc5 4891
11fdf7f2 4892 Option("filestore_max_inline_xattr_size_xfs", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4893 .set_default(65536)
4894 .set_description(""),
c07f9fc5 4895
11fdf7f2 4896 Option("filestore_max_inline_xattr_size_btrfs", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4897 .set_default(2048)
4898 .set_description(""),
c07f9fc5 4899
11fdf7f2 4900 Option("filestore_max_inline_xattr_size_other", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4901 .set_default(512)
4902 .set_description(""),
c07f9fc5 4903
11fdf7f2 4904 Option("filestore_max_inline_xattrs", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
4905 .set_default(0)
4906 .set_description(""),
c07f9fc5 4907
11fdf7f2 4908 Option("filestore_max_inline_xattrs_xfs", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
4909 .set_default(10)
4910 .set_description(""),
c07f9fc5 4911
11fdf7f2 4912 Option("filestore_max_inline_xattrs_btrfs", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
4913 .set_default(10)
4914 .set_description(""),
c07f9fc5 4915
11fdf7f2 4916 Option("filestore_max_inline_xattrs_other", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
4917 .set_default(2)
4918 .set_description(""),
c07f9fc5 4919
11fdf7f2 4920 Option("filestore_max_xattr_value_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4921 .set_default(0)
4922 .set_description(""),
c07f9fc5 4923
11fdf7f2
TL
4924 Option("filestore_max_xattr_value_size_xfs", Option::TYPE_SIZE, Option::LEVEL_DEV)
4925 .set_default(64_K)
d2e6a577 4926 .set_description(""),
c07f9fc5 4927
11fdf7f2
TL
4928 Option("filestore_max_xattr_value_size_btrfs", Option::TYPE_SIZE, Option::LEVEL_DEV)
4929 .set_default(64_K)
d2e6a577 4930 .set_description(""),
c07f9fc5 4931
11fdf7f2
TL
4932 Option("filestore_max_xattr_value_size_other", Option::TYPE_SIZE, Option::LEVEL_DEV)
4933 .set_default(1_K)
d2e6a577 4934 .set_description(""),
c07f9fc5 4935
11fdf7f2 4936 Option("filestore_sloppy_crc", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
4937 .set_default(false)
4938 .set_description(""),
c07f9fc5 4939
11fdf7f2 4940 Option("filestore_sloppy_crc_block_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4941 .set_default(65536)
4942 .set_description(""),
c07f9fc5 4943
11fdf7f2 4944 Option("filestore_max_alloc_hint_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
d2e6a577
FG
4945 .set_default(1ULL << 20)
4946 .set_description(""),
c07f9fc5 4947
d2e6a577
FG
4948 Option("filestore_max_sync_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
4949 .set_default(5)
11fdf7f2 4950 .set_description("Period between calls to syncfs(2) and journal trims (seconds)"),
c07f9fc5 4951
11fdf7f2 4952 Option("filestore_min_sync_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577 4953 .set_default(.01)
11fdf7f2 4954 .set_description("Minimum period between calls to syncfs(2)"),
c07f9fc5 4955
11fdf7f2 4956 Option("filestore_btrfs_snap", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
4957 .set_default(true)
4958 .set_description(""),
c07f9fc5 4959
d2e6a577
FG
4960 Option("filestore_btrfs_clone_range", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4961 .set_default(true)
11fdf7f2 4962 .set_description("Use btrfs clone_range ioctl to efficiently duplicate objects"),
c07f9fc5 4963
11fdf7f2 4964 Option("filestore_zfs_snap", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
4965 .set_default(false)
4966 .set_description(""),
c07f9fc5 4967
11fdf7f2 4968 Option("filestore_fsync_flushes_journal_data", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
4969 .set_default(false)
4970 .set_description(""),
c07f9fc5 4971
d2e6a577
FG
4972 Option("filestore_fiemap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4973 .set_default(false)
11fdf7f2 4974 .set_description("Use fiemap ioctl(2) to determine which parts of objects are sparse"),
c07f9fc5 4975
d2e6a577
FG
4976 Option("filestore_punch_hole", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4977 .set_default(false)
11fdf7f2 4978 .set_description("Use fallocate(2) FALLOC_FL_PUNCH_HOLE to efficiently zero ranges of objects"),
c07f9fc5 4979
d2e6a577
FG
4980 Option("filestore_seek_data_hole", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4981 .set_default(false)
11fdf7f2 4982 .set_description("Use lseek(2) SEEK_HOLE and SEEK_DATA to determine which parts of objects are sparse"),
c07f9fc5 4983
d2e6a577
FG
4984 Option("filestore_splice", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4985 .set_default(false)
11fdf7f2 4986 .set_description("Use splice(2) to more efficiently copy data between files"),
c07f9fc5 4987
d2e6a577
FG
4988 Option("filestore_fadvise", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4989 .set_default(true)
11fdf7f2 4990 .set_description("Use posix_fadvise(2) to pass hints to file system"),
c07f9fc5 4991
d2e6a577
FG
4992 Option("filestore_collect_device_partition_information", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4993 .set_default(true)
11fdf7f2 4994 .set_description("Collect metadata about the backing file system on OSD startup"),
c07f9fc5 4995
d2e6a577
FG
4996 Option("filestore_xfs_extsize", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
4997 .set_default(false)
11fdf7f2 4998 .set_description("Use XFS extsize ioctl(2) to hint allocator about expected write sizes"),
c07f9fc5 4999
11fdf7f2 5000 Option("filestore_journal_parallel", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5001 .set_default(false)
5002 .set_description(""),
c07f9fc5 5003
11fdf7f2 5004 Option("filestore_journal_writeahead", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5005 .set_default(false)
5006 .set_description(""),
c07f9fc5 5007
11fdf7f2 5008 Option("filestore_journal_trailing", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5009 .set_default(false)
5010 .set_description(""),
c07f9fc5 5011
d2e6a577
FG
5012 Option("filestore_queue_max_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5013 .set_default(50)
11fdf7f2 5014 .set_description("Max IO operations in flight"),
c07f9fc5 5015
11fdf7f2
TL
5016 Option("filestore_queue_max_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
5017 .set_default(100_M)
5018 .set_description("Max (written) bytes in flight"),
c07f9fc5 5019
11fdf7f2 5020 Option("filestore_caller_concurrency", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
5021 .set_default(10)
5022 .set_description(""),
c07f9fc5 5023
d2e6a577 5024 Option("filestore_expected_throughput_bytes", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
11fdf7f2
TL
5025 .set_default(200_M)
5026 .set_description("Expected throughput of backend device (aids throttling calculations)"),
c07f9fc5 5027
d2e6a577
FG
5028 Option("filestore_expected_throughput_ops", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5029 .set_default(200)
11fdf7f2
TL
5030 .set_description("Expected through of backend device in IOPS (aids throttling calculations)"),
5031
5032 Option("filestore_queue_max_delay_multiple", Option::TYPE_FLOAT, Option::LEVEL_DEV)
5033 .set_default(0)
5034 .set_description(""),
5035
5036 Option("filestore_queue_high_delay_multiple", Option::TYPE_FLOAT, Option::LEVEL_DEV)
5037 .set_default(0)
5038 .set_description(""),
5039
5040 Option("filestore_queue_max_delay_multiple_bytes", Option::TYPE_FLOAT, Option::LEVEL_DEV)
5041 .set_default(0)
5042 .set_description(""),
5043
5044 Option("filestore_queue_high_delay_multiple_bytes", Option::TYPE_FLOAT, Option::LEVEL_DEV)
5045 .set_default(0)
d2e6a577 5046 .set_description(""),
c07f9fc5 5047
11fdf7f2 5048 Option("filestore_queue_max_delay_multiple_ops", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
5049 .set_default(0)
5050 .set_description(""),
c07f9fc5 5051
11fdf7f2 5052 Option("filestore_queue_high_delay_multiple_ops", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
5053 .set_default(0)
5054 .set_description(""),
c07f9fc5 5055
11fdf7f2 5056 Option("filestore_queue_low_threshhold", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
5057 .set_default(0.3)
5058 .set_description(""),
c07f9fc5 5059
11fdf7f2 5060 Option("filestore_queue_high_threshhold", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
5061 .set_default(0.9)
5062 .set_description(""),
c07f9fc5 5063
d2e6a577
FG
5064 Option("filestore_op_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5065 .set_default(2)
11fdf7f2 5066 .set_description("Threads used to apply changes to backing file system"),
c07f9fc5 5067
d2e6a577
FG
5068 Option("filestore_op_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5069 .set_default(60)
11fdf7f2 5070 .set_description("Seconds before a worker thread is considered stalled"),
c07f9fc5 5071
d2e6a577
FG
5072 Option("filestore_op_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5073 .set_default(180)
11fdf7f2 5074 .set_description("Seconds before a worker thread is considered dead"),
c07f9fc5 5075
d2e6a577
FG
5076 Option("filestore_commit_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5077 .set_default(600)
11fdf7f2 5078 .set_description("Seconds before backing file system is considered hung"),
c07f9fc5 5079
11fdf7f2 5080 Option("filestore_fiemap_threshold", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 5081 .set_default(4_K)
d2e6a577 5082 .set_description(""),
c07f9fc5 5083
11fdf7f2 5084 Option("filestore_merge_threshold", Option::TYPE_INT, Option::LEVEL_DEV)
1adf2230 5085 .set_default(-10)
d2e6a577 5086 .set_description(""),
c07f9fc5 5087
11fdf7f2 5088 Option("filestore_split_multiple", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
5089 .set_default(2)
5090 .set_description(""),
c07f9fc5 5091
11fdf7f2 5092 Option("filestore_split_rand_factor", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
5093 .set_default(20)
5094 .set_description(""),
c07f9fc5 5095
11fdf7f2 5096 Option("filestore_update_to", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
5097 .set_default(1000)
5098 .set_description(""),
c07f9fc5 5099
11fdf7f2 5100 Option("filestore_blackhole", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5101 .set_default(false)
5102 .set_description(""),
c07f9fc5 5103
11fdf7f2 5104 Option("filestore_fd_cache_size", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
5105 .set_default(128)
5106 .set_description(""),
c07f9fc5 5107
11fdf7f2 5108 Option("filestore_fd_cache_shards", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
5109 .set_default(16)
5110 .set_description(""),
c07f9fc5 5111
11fdf7f2 5112 Option("filestore_ondisk_finisher_threads", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
5113 .set_default(1)
5114 .set_description(""),
c07f9fc5 5115
11fdf7f2 5116 Option("filestore_apply_finisher_threads", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
5117 .set_default(1)
5118 .set_description(""),
c07f9fc5 5119
11fdf7f2 5120 Option("filestore_dump_file", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577
FG
5121 .set_default("")
5122 .set_description(""),
c07f9fc5 5123
d2e6a577
FG
5124 Option("filestore_kill_at", Option::TYPE_INT, Option::LEVEL_DEV)
5125 .set_default(0)
5126 .set_description(""),
c07f9fc5 5127
d2e6a577
FG
5128 Option("filestore_inject_stall", Option::TYPE_INT, Option::LEVEL_DEV)
5129 .set_default(0)
5130 .set_description(""),
c07f9fc5 5131
11fdf7f2 5132 Option("filestore_fail_eio", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5133 .set_default(true)
5134 .set_description(""),
c07f9fc5 5135
d2e6a577
FG
5136 Option("filestore_debug_verify_split", Option::TYPE_BOOL, Option::LEVEL_DEV)
5137 .set_default(false)
5138 .set_description(""),
c07f9fc5 5139
11fdf7f2 5140 Option("journal_dio", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5141 .set_default(true)
5142 .set_description(""),
c07f9fc5 5143
11fdf7f2 5144 Option("journal_aio", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5145 .set_default(true)
5146 .set_description(""),
c07f9fc5 5147
11fdf7f2 5148 Option("journal_force_aio", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5149 .set_default(false)
5150 .set_description(""),
c07f9fc5 5151
11fdf7f2 5152 Option("journal_block_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 5153 .set_default(4_K)
d2e6a577 5154 .set_description(""),
c07f9fc5 5155
11fdf7f2 5156 Option("journal_block_align", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5157 .set_default(true)
5158 .set_description(""),
c07f9fc5 5159
11fdf7f2 5160 Option("journal_write_header_frequency", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
5161 .set_default(0)
5162 .set_description(""),
c07f9fc5 5163
11fdf7f2
TL
5164 Option("journal_max_write_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
5165 .set_default(10_M)
5166 .set_description("Max bytes in flight to journal"),
c07f9fc5 5167
d2e6a577
FG
5168 Option("journal_max_write_entries", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5169 .set_default(100)
11fdf7f2 5170 .set_description("Max IOs in flight to journal"),
c07f9fc5 5171
11fdf7f2 5172 Option("journal_throttle_low_threshhold", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
5173 .set_default(0.6)
5174 .set_description(""),
c07f9fc5 5175
11fdf7f2 5176 Option("journal_throttle_high_threshhold", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
5177 .set_default(0.9)
5178 .set_description(""),
c07f9fc5 5179
11fdf7f2 5180 Option("journal_throttle_high_multiple", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
5181 .set_default(0)
5182 .set_description(""),
c07f9fc5 5183
11fdf7f2 5184 Option("journal_throttle_max_multiple", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
5185 .set_default(0)
5186 .set_description(""),
c07f9fc5 5187
11fdf7f2
TL
5188 Option("journal_align_min_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
5189 .set_default(64_K)
d2e6a577 5190 .set_description(""),
c07f9fc5 5191
11fdf7f2 5192 Option("journal_replay_from", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
5193 .set_default(0)
5194 .set_description(""),
c07f9fc5 5195
9f95a23c
TL
5196 Option("mgr_stats_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5197 .set_default((int64_t)PerfCountersBuilder::PRIO_USEFUL)
5198 .set_description("Lowest perfcounter priority collected by mgr")
5199 .set_long_description("Daemons only set perf counter data to the manager "
5200 "daemon if the counter has a priority higher than this.")
5201 .set_min_max((int64_t)PerfCountersBuilder::PRIO_DEBUGONLY,
5202 (int64_t)PerfCountersBuilder::PRIO_CRITICAL + 1),
3efd9988 5203
11fdf7f2 5204 Option("journal_zero_on_create", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5205 .set_default(false)
5206 .set_description(""),
c07f9fc5 5207
11fdf7f2 5208 Option("journal_ignore_corruption", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5209 .set_default(false)
5210 .set_description(""),
c07f9fc5 5211
11fdf7f2 5212 Option("journal_discard", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
5213 .set_default(false)
5214 .set_description(""),
c07f9fc5 5215
d2e6a577
FG
5216 Option("fio_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5217 .set_default("/tmp/fio")
5218 .set_description(""),
c07f9fc5 5219
f91f0fd5 5220 Option("rados_mon_op_timeout", Option::TYPE_SECS, Option::LEVEL_ADVANCED)
d2e6a577 5221 .set_default(0)
f91f0fd5
TL
5222 .set_description("timeout for operations handled by monitors such as statfs (0 is unlimited)")
5223 .set_flag(Option::FLAG_RUNTIME)
5224 .set_min(0),
c07f9fc5 5225
f91f0fd5 5226 Option("rados_osd_op_timeout", Option::TYPE_SECS, Option::LEVEL_ADVANCED)
d2e6a577 5227 .set_default(0)
f91f0fd5
TL
5228 .set_description("timeout for operations handled by osds such as write (0 is unlimited)")
5229 .set_flag(Option::FLAG_RUNTIME)
5230 .set_min(0),
c07f9fc5 5231
d2e6a577
FG
5232 Option("rados_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5233 .set_default(false)
5234 .set_description(""),
c07f9fc5 5235
9f95a23c
TL
5236 Option("cephadm_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5237 .set_default("/usr/sbin/cephadm")
5238 .add_service("mgr")
5239 .set_description("Path to cephadm utility"),
c07f9fc5 5240
d2e6a577 5241 Option("mgr_module_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
11fdf7f2 5242 .set_default(CEPH_DATADIR "/mgr")
3efd9988
FG
5243 .add_service("mgr")
5244 .set_description("Filesystem path to manager modules."),
c07f9fc5 5245
3efd9988 5246 Option("mgr_initial_modules", Option::TYPE_STR, Option::LEVEL_BASIC)
11fdf7f2
TL
5247 .set_default("restful iostat")
5248 .set_flag(Option::FLAG_NO_MON_UPDATE)
5249 .set_flag(Option::FLAG_CLUSTER_CREATE)
3efd9988
FG
5250 .add_service("mon")
5251 .set_description("List of manager modules to enable when the cluster is "
5252 "first started")
5253 .set_long_description("This list of module names is read by the monitor "
5254 "when the cluster is first started after installation, to populate "
5255 "the list of enabled manager modules. Subsequent updates are done using "
5256 "the 'mgr module [enable|disable]' commands. List may be comma "
5257 "or space separated."),
c07f9fc5 5258
d2e6a577
FG
5259 Option("mgr_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5260 .set_default("/var/lib/ceph/mgr/$cluster-$id")
11fdf7f2 5261 .set_flag(Option::FLAG_NO_MON_UPDATE)
3efd9988
FG
5262 .add_service("mgr")
5263 .set_description("Filesystem path to the ceph-mgr data directory, used to "
5264 "contain keyring."),
c07f9fc5 5265
11fdf7f2 5266 Option("mgr_tick_period", Option::TYPE_SECS, Option::LEVEL_ADVANCED)
d2e6a577 5267 .set_default(2)
3efd9988
FG
5268 .add_service("mgr")
5269 .set_description("Period in seconds of beacon messages to monitor"),
c07f9fc5 5270
3efd9988 5271 Option("mgr_stats_period", Option::TYPE_INT, Option::LEVEL_BASIC)
d2e6a577 5272 .set_default(5)
3efd9988
FG
5273 .add_service("mgr")
5274 .set_description("Period in seconds of OSD/MDS stats reports to manager")
5275 .set_long_description("Use this setting to control the granularity of "
5276 "time series data collection from daemons. Adjust "
5277 "upwards if the manager CPU load is too high, or "
5278 "if you simply do not require the most up to date "
5279 "performance counter data."),
5280
11fdf7f2 5281 Option("mgr_client_bytes", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 5282 .set_default(128_M)
3efd9988 5283 .add_service("mgr"),
c07f9fc5 5284
3efd9988 5285 Option("mgr_client_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577 5286 .set_default(512)
3efd9988 5287 .add_service("mgr"),
c07f9fc5 5288
11fdf7f2 5289 Option("mgr_osd_bytes", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 5290 .set_default(512_M)
3efd9988 5291 .add_service("mgr"),
c07f9fc5 5292
3efd9988 5293 Option("mgr_osd_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577 5294 .set_default(8192)
3efd9988 5295 .add_service("mgr"),
c07f9fc5 5296
11fdf7f2 5297 Option("mgr_mds_bytes", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 5298 .set_default(128_M)
3efd9988 5299 .add_service("mgr"),
c07f9fc5 5300
3efd9988 5301 Option("mgr_mds_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577 5302 .set_default(128)
3efd9988 5303 .add_service("mgr"),
c07f9fc5 5304
11fdf7f2 5305 Option("mgr_mon_bytes", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 5306 .set_default(128_M)
3efd9988 5307 .add_service("mgr"),
c07f9fc5 5308
3efd9988 5309 Option("mgr_mon_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577 5310 .set_default(128)
3efd9988 5311 .add_service("mgr"),
c07f9fc5 5312
3efd9988 5313 Option("mgr_connect_retry_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577 5314 .set_default(1.0)
3efd9988 5315 .add_service("common"),
c07f9fc5 5316
d2e6a577
FG
5317 Option("mgr_service_beacon_grace", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5318 .set_default(60.0)
3efd9988
FG
5319 .add_service("mgr")
5320 .set_description("Period in seconds from last beacon to manager dropping "
5321 "state about a monitored service (RGW, rbd-mirror etc)"),
c07f9fc5 5322
11fdf7f2
TL
5323 Option("mgr_client_service_daemon_unregister_timeout", Option::TYPE_FLOAT, Option::LEVEL_DEV)
5324 .set_default(1.0)
5325 .set_description("Time to wait during shutdown to deregister service with mgr"),
5326
5327 Option("mgr_debug_aggressive_pg_num_changes", Option::TYPE_BOOL, Option::LEVEL_DEV)
5328 .set_default(false)
5329 .set_description("Bypass most throttling and safety checks in pg[p]_num controller")
5330 .add_service("mgr"),
5331
3efd9988 5332 Option("mon_mgr_digest_period", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577 5333 .set_default(5)
3efd9988
FG
5334 .add_service("mon")
5335 .set_description("Period in seconds between monitor-to-manager "
5336 "health/status updates"),
c07f9fc5 5337
11fdf7f2 5338 Option("mon_mgr_beacon_grace", Option::TYPE_SECS, Option::LEVEL_ADVANCED)
d2e6a577 5339 .set_default(30)
3efd9988
FG
5340 .add_service("mon")
5341 .set_description("Period in seconds from last beacon to monitor marking "
5342 "a manager daemon as failed"),
c07f9fc5 5343
d2e6a577
FG
5344 Option("mon_mgr_inactive_grace", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5345 .set_default(60)
3efd9988
FG
5346 .add_service("mon")
5347 .set_description("Period in seconds after cluster creation during which "
5348 "cluster may have no active manager")
5349 .set_long_description("This grace period enables the cluster to come "
5350 "up cleanly without raising spurious health check "
5351 "failures about managers that aren't online yet"),
c07f9fc5 5352
d2e6a577 5353 Option("mon_mgr_mkfs_grace", Option::TYPE_INT, Option::LEVEL_ADVANCED)
11fdf7f2 5354 .set_default(120)
3efd9988
FG
5355 .add_service("mon")
5356 .set_description("Period in seconds that the cluster may have no active "
5357 "manager before this is reported as an ERR rather than "
5358 "a WARN"),
c07f9fc5 5359
d2e6a577
FG
5360 Option("throttler_perf_counter", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5361 .set_default(true)
5362 .set_description(""),
c07f9fc5 5363
d2e6a577
FG
5364 Option("event_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5365 .set_default(false)
5366 .set_description(""),
c07f9fc5 5367
9f95a23c
TL
5368 Option("bluestore_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5369 .set_default(false)
5370 .set_description("Enable bluestore event tracing."),
5371
5372 Option("bluestore_throttle_trace_rate", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
5373 .set_default(0)
5374 .set_description("Rate at which to sample bluestore transactions (per second)"),
5375
d2e6a577
FG
5376 Option("debug_deliberately_leak_memory", Option::TYPE_BOOL, Option::LEVEL_DEV)
5377 .set_default(false)
5378 .set_description(""),
11fdf7f2 5379
b32b8144
FG
5380 Option("debug_asserts_on_shutdown", Option::TYPE_BOOL,Option::LEVEL_DEV)
5381 .set_default(false)
5382 .set_description("Enable certain asserts to check for refcounting bugs on shutdown; see http://tracker.ceph.com/issues/21738"),
11fdf7f2
TL
5383
5384 Option("debug_asok_assert_abort", Option::TYPE_BOOL, Option::LEVEL_DEV)
5385 .set_default(false)
5386 .set_description("allow commands 'assert' and 'abort' via asok for testing crash dumps etc"),
5387
5388 Option("target_max_misplaced_ratio", Option::TYPE_FLOAT, Option::LEVEL_BASIC)
5389 .set_default(.05)
5390 .set_description("Max ratio of misplaced objects to target when throttling data rebalancing activity"),
5391
5392 Option("device_failure_prediction_mode", Option::TYPE_STR, Option::LEVEL_BASIC)
5393 .set_default("none")
5394 .set_flag(Option::FLAG_RUNTIME)
5395 .set_enum_allowed({"none", "local", "cloud"})
5396 .set_description("Method used to predict device failures")
5397 .set_long_description("To disable prediction, use 'none', 'local' uses a prediction model that runs inside the mgr daemon. 'cloud' will share metrics with a cloud service and query the service for devicelife expectancy."),
5398
5399 /* KRB Authentication. */
5400 Option("gss_ktab_client_file", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5401 .set_default("/var/lib/ceph/$name/gss_client_$name.ktab")
5402 .set_description("GSS/KRB5 Keytab file for client authentication")
5403 .add_service({"mon", "osd"})
5404 .set_long_description("This sets the full path for the GSS/Kerberos client keytab file location."),
5405
5406 Option("gss_target_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5407 .set_default("ceph")
5408 .set_description("")
5409 .add_service({"mon", "osd"})
5410 .set_long_description("This sets the gss target service name."),
eafe8130
TL
5411
5412 Option("debug_disable_randomized_ping", Option::TYPE_BOOL, Option::LEVEL_DEV)
5413 .set_default(false)
5414 .set_description("Disable heartbeat ping randomization for testing purposes"),
5415
5416 Option("debug_heartbeat_testing_span", Option::TYPE_INT, Option::LEVEL_DEV)
5417 .set_default(0)
5418 .set_description("Override 60 second periods for testing only"),
9f95a23c
TL
5419
5420 // ----------------------------
5421 // Crimson specific options
5422
5423 Option("crimson_osd_obc_lru_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5424 .set_default(10)
5425 .set_description("Number of obcs to cache")
5426
d2e6a577
FG
5427 });
5428}
c07f9fc5 5429
d2e6a577
FG
5430std::vector<Option> get_rgw_options() {
5431 return std::vector<Option>({
5432 Option("rgw_acl_grants_max_num", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5433 .set_default(100)
b32b8144 5434 .set_description("Max number of ACL grants in a single request"),
c07f9fc5 5435
11fdf7f2
TL
5436 Option("rgw_cors_rules_max_num", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5437 .set_default(100)
5438 .set_description("Max number of cors rules in a single request"),
5439
5440 Option("rgw_delete_multi_obj_max_num", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5441 .set_default(1000)
5442 .set_description("Max number of objects in a single multi-object delete request"),
5443
5444 Option("rgw_website_routing_rules_max_num", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5445 .set_default(50)
5446 .set_description("Max number of website routing rules in a single request"),
5447
5448 Option("rgw_rados_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5449 .set_default(false)
5450 .set_description("true if LTTng-UST tracepoints should be enabled"),
5451
5452 Option("rgw_op_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5453 .set_default(false)
5454 .set_description("true if LTTng-UST tracepoints should be enabled"),
5455
5456 Option("rgw_max_chunk_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144
FG
5457 .set_default(4_M)
5458 .set_description("Set RGW max chunk size")
5459 .set_long_description(
5460 "The chunk size is the size of RADOS I/O requests that RGW sends when accessing "
5461 "data objects. RGW read and write operation will never request more than this amount "
5462 "in a single request. This also defines the rgw object head size, as head operations "
5463 "need to be atomic, and anything larger than this would require more than a single "
5464 "operation."),
c07f9fc5 5465
11fdf7f2 5466 Option("rgw_put_obj_min_window_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144
FG
5467 .set_default(16_M)
5468 .set_description("The minimum RADOS write window size (in bytes).")
5469 .set_long_description(
5470 "The window size determines the total concurrent RADOS writes of a single rgw object. "
5471 "When writing an object RGW will send multiple chunks to RADOS. The total size of the "
5472 "writes does not exceed the window size. The window size can be automatically "
5473 "in order to better utilize the pipe.")
5474 .add_see_also({"rgw_put_obj_max_window_size", "rgw_max_chunk_size"}),
c07f9fc5 5475
11fdf7f2 5476 Option("rgw_put_obj_max_window_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144
FG
5477 .set_default(64_M)
5478 .set_description("The maximum RADOS write window size (in bytes).")
5479 .set_long_description("The window size may be dynamically adjusted, but will not surpass this value.")
5480 .add_see_also({"rgw_put_obj_min_window_size", "rgw_max_chunk_size"}),
c07f9fc5 5481
11fdf7f2 5482 Option("rgw_max_put_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144
FG
5483 .set_default(5_G)
5484 .set_description("Max size (in bytes) of regular (non multi-part) object upload.")
5485 .set_long_description(
5486 "Plain object upload is capped at this amount of data. In order to upload larger "
5487 "objects, a special upload mechanism is required. The S3 API provides the "
5488 "multi-part upload, and Swift provides DLO and SLO."),
c07f9fc5 5489
11fdf7f2 5490 Option("rgw_max_put_param_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144
FG
5491 .set_default(1_M)
5492 .set_description("The maximum size (in bytes) of data input of certain RESTful requests."),
c07f9fc5 5493
11fdf7f2 5494 Option("rgw_max_attr_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
3efd9988
FG
5495 .set_default(0)
5496 .set_description("The maximum length of metadata value. 0 skips the check"),
5497
11fdf7f2 5498 Option("rgw_max_attr_name_len", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
3efd9988
FG
5499 .set_default(0)
5500 .set_description("The maximum length of metadata name. 0 skips the check"),
5501
5502 Option("rgw_max_attrs_num_in_req", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5503 .set_default(0)
5504 .set_description("The maximum number of metadata items that can be put via single request"),
5505
b32b8144 5506 Option("rgw_override_bucket_index_max_shards", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577 5507 .set_default(0)
9f95a23c
TL
5508 .set_description("The default number of bucket index shards for newly-created "
5509 "buckets. This value overrides bucket_index_max_shards stored in the zone. "
5510 "Setting this value in the zone is preferred, because it applies globally "
5511 "to all radosgw daemons running in the zone."),
c07f9fc5 5512
d2e6a577 5513 Option("rgw_bucket_index_max_aio", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
9f95a23c 5514 .set_default(128)
b32b8144 5515 .set_description("Max number of concurrent RADOS requests when handling bucket shards."),
c07f9fc5 5516
d2e6a577
FG
5517 Option("rgw_enable_quota_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5518 .set_default(true)
b32b8144
FG
5519 .set_description("Enables the quota maintenance thread.")
5520 .set_long_description(
5521 "The quota maintenance thread is responsible for quota related maintenance work. "
5522 "The thread itself can be disabled, but in order for quota to work correctly, at "
5523 "least one RGW in each zone needs to have this thread running. Having the thread "
5524 "enabled on multiple RGW processes within the same zone can spread "
5525 "some of the maintenance work between them.")
5526 .add_see_also({"rgw_enable_gc_threads", "rgw_enable_lc_threads"}),
c07f9fc5 5527
d2e6a577
FG
5528 Option("rgw_enable_gc_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5529 .set_default(true)
b32b8144
FG
5530 .set_description("Enables the garbage collection maintenance thread.")
5531 .set_long_description(
5532 "The garbage collection maintenance thread is responsible for garbage collector "
5533 "maintenance work. The thread itself can be disabled, but in order for garbage "
5534 "collection to work correctly, at least one RGW in each zone needs to have this "
5535 "thread running. Having the thread enabled on multiple RGW processes within the "
5536 "same zone can spread some of the maintenance work between them.")
5537 .add_see_also({"rgw_enable_quota_threads", "rgw_enable_lc_threads"}),
c07f9fc5 5538
d2e6a577
FG
5539 Option("rgw_enable_lc_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5540 .set_default(true)
11fdf7f2 5541 .set_description("Enables the lifecycle maintenance thread. This is required on at least one rgw for each zone.")
b32b8144
FG
5542 .set_long_description(
5543 "The lifecycle maintenance thread is responsible for lifecycle related maintenance "
5544 "work. The thread itself can be disabled, but in order for lifecycle to work "
5545 "correctly, at least one RGW in each zone needs to have this thread running. Having"
5546 "the thread enabled on multiple RGW processes within the same zone can spread "
5547 "some of the maintenance work between them.")
5548 .add_see_also({"rgw_enable_gc_threads", "rgw_enable_quota_threads"}),
c07f9fc5 5549
d2e6a577
FG
5550 Option("rgw_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5551 .set_default("/var/lib/ceph/radosgw/$cluster-$id")
11fdf7f2 5552 .set_flag(Option::FLAG_NO_MON_UPDATE)
b32b8144
FG
5553 .set_description("Alternative location for RGW configuration.")
5554 .set_long_description(
5555 "If this is set, the different Ceph system configurables (such as the keyring file "
5556 "will be located in the path that is specified here. "),
c07f9fc5 5557
d2e6a577 5558 Option("rgw_enable_apis", Option::TYPE_STR, Option::LEVEL_ADVANCED)
92f5a8d4 5559 .set_default("s3, s3website, swift, swift_auth, admin, sts, iam, pubsub")
b32b8144 5560 .set_description("A list of set of RESTful APIs that rgw handles."),
c07f9fc5 5561
d2e6a577
FG
5562 Option("rgw_cache_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5563 .set_default(true)
b32b8144
FG
5564 .set_description("Enable RGW metadata cache.")
5565 .set_long_description(
5566 "The metadata cache holds metadata entries that RGW requires for processing "
5567 "requests. Metadata entries can be user info, bucket info, and bucket instance "
5568 "info. If not found in the cache, entries will be fetched from the backing "
5569 "RADOS store.")
5570 .add_see_also("rgw_cache_lru_size"),
c07f9fc5 5571
d2e6a577
FG
5572 Option("rgw_cache_lru_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5573 .set_default(10000)
b32b8144
FG
5574 .set_description("Max number of items in RGW metadata cache.")
5575 .set_long_description(
5576 "When full, the RGW metadata cache evicts least recently used entries.")
5577 .add_see_also("rgw_cache_enabled"),
c07f9fc5 5578
d2e6a577
FG
5579 Option("rgw_socket_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5580 .set_default("")
b32b8144
FG
5581 .set_description("RGW FastCGI socket path (for FastCGI over Unix domain sockets).")
5582 .add_see_also("rgw_fcgi_socket_backlog"),
c07f9fc5 5583
d2e6a577
FG
5584 Option("rgw_host", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5585 .set_default("")
b32b8144
FG
5586 .set_description("RGW FastCGI host name (for FastCGI over TCP)")
5587 .add_see_also({"rgw_port", "rgw_fcgi_socket_backlog"}),
c07f9fc5 5588
b32b8144 5589 Option("rgw_port", Option::TYPE_STR, Option::LEVEL_BASIC)
d2e6a577 5590 .set_default("")
b32b8144
FG
5591 .set_description("RGW FastCGI port number (for FastCGI over TCP)")
5592 .add_see_also({"rgw_host", "rgw_fcgi_socket_backlog"}),
c07f9fc5 5593
d2e6a577
FG
5594 Option("rgw_dns_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5595 .set_default("")
b32b8144
FG
5596 .set_description("The host name that RGW uses.")
5597 .set_long_description(
5598 "This is Needed for virtual hosting of buckets to work properly, unless configured "
5599 "via zonegroup configuration."),
c07f9fc5 5600
d2e6a577
FG
5601 Option("rgw_dns_s3website_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5602 .set_default("")
b32b8144
FG
5603 .set_description("The host name that RGW uses for static websites (S3)")
5604 .set_long_description(
5605 "This is needed for virtual hosting of buckets, unless configured via zonegroup "
5606 "configuration."),
9f95a23c
TL
5607
5608 Option("rgw_numa_node", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5609 .set_default(-1)
5610 .set_flag(Option::FLAG_STARTUP)
5611 .set_description("set rgw's cpu affinity to a numa node (-1 for none)"),
c07f9fc5 5612
11fdf7f2
TL
5613 Option("rgw_service_provider_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5614 .set_default("")
5615 .set_description("Service provider name which is contained in http response headers")
5616 .set_long_description(
5617 "As S3 or other cloud storage providers do, http response headers should contain the name of the provider. "
5618 "This name will be placed in http header 'Server'."),
5619
d2e6a577
FG
5620 Option("rgw_content_length_compat", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5621 .set_default(false)
b32b8144
FG
5622 .set_description("Multiple content length headers compatibility")
5623 .set_long_description(
5624 "Try to handle requests with abiguous multiple content length headers "
5625 "(Content-Length, Http-Content-Length)."),
c07f9fc5 5626
11fdf7f2
TL
5627 Option("rgw_relaxed_region_enforcement", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5628 .set_default(false)
5629 .set_description("Disable region constraint enforcement")
5630 .set_long_description(
5631 "Enable requests such as bucket creation to succeed irrespective of region restrictions (Jewel compat)."),
5632
d2e6a577
FG
5633 Option("rgw_lifecycle_work_time", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5634 .set_default("00:00-06:00")
b32b8144
FG
5635 .set_description("Lifecycle allowed work time")
5636 .set_long_description("Local time window in which the lifecycle maintenance thread can work."),
c07f9fc5 5637
b32b8144 5638 Option("rgw_lc_lock_max_time", Option::TYPE_INT, Option::LEVEL_DEV)
e306af50 5639 .set_default(90)
d2e6a577 5640 .set_description(""),
c07f9fc5 5641
11fdf7f2
TL
5642 Option("rgw_lc_thread_delay", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5643 .set_default(0)
5644 .set_description("Delay after processing of bucket listing chunks (i.e., per 1000 entries) in milliseconds"),
5645
e306af50
TL
5646 Option("rgw_lc_max_worker", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5647 .set_default(3)
5648 .set_description("Number of LCWorker tasks that will be run in parallel")
5649 .set_long_description(
5650 "Number of LCWorker tasks that will run in parallel--used to permit >1 "
5651 "bucket/index shards to be processed simultaneously"),
5652
5653 Option("rgw_lc_max_wp_worker", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5654 .set_default(3)
5655 .set_description("Number of workpool threads per LCWorker")
5656 .set_long_description(
5657 "Number of threads in per-LCWorker workpools--used to accelerate "
5658 "per-bucket processing"),
5659
d2e6a577
FG
5660 Option("rgw_lc_max_objs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5661 .set_default(32)
b32b8144
FG
5662 .set_description("Number of lifecycle data shards")
5663 .set_long_description(
e306af50
TL
5664 "Number of RADOS objects to use for storing lifecycle index. This "
5665 "affects concurrency of lifecycle maintenance, as shards can be "
5666 "processed in parallel."),
c07f9fc5 5667
91327a77
AA
5668 Option("rgw_lc_max_rules", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5669 .set_default(1000)
5670 .set_description("Max number of lifecycle rules set on one bucket")
5671 .set_long_description("Number of lifecycle rules set on one bucket should be limited."),
5672
d2e6a577
FG
5673 Option("rgw_lc_debug_interval", Option::TYPE_INT, Option::LEVEL_DEV)
5674 .set_default(-1)
5675 .set_description(""),
c07f9fc5 5676
d2e6a577
FG
5677 Option("rgw_mp_lock_max_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5678 .set_default(600)
b32b8144
FG
5679 .set_description("Multipart upload max completion time")
5680 .set_long_description(
5681 "Time length to allow completion of a multipart upload operation. This is done "
5682 "to prevent concurrent completions on the same object with the same upload id."),
c07f9fc5 5683
b32b8144 5684 Option("rgw_script_uri", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577
FG
5685 .set_default("")
5686 .set_description(""),
c07f9fc5 5687
b32b8144 5688 Option("rgw_request_uri", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577
FG
5689 .set_default("")
5690 .set_description(""),
c07f9fc5 5691
28e407b8
AA
5692 Option("rgw_ignore_get_invalid_range", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5693 .set_default(false)
5694 .set_description("Treat invalid (e.g., negative) range request as full")
5695 .set_long_description("Treat invalid (e.g., negative) range request "
5696 "as request for the full object (AWS compatibility)"),
5697
d2e6a577
FG
5698 Option("rgw_swift_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5699 .set_default("")
b32b8144
FG
5700 .set_description("Swift-auth storage URL")
5701 .set_long_description(
5702 "Used in conjunction with rgw internal swift authentication. This affects the "
5703 "X-Storage-Url response header value.")
5704 .add_see_also("rgw_swift_auth_entry"),
c07f9fc5 5705
d2e6a577
FG
5706 Option("rgw_swift_url_prefix", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5707 .set_default("swift")
b32b8144
FG
5708 .set_description("Swift URL prefix")
5709 .set_long_description("The URL path prefix for swift requests."),
c07f9fc5 5710
d2e6a577
FG
5711 Option("rgw_swift_auth_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5712 .set_default("")
b32b8144
FG
5713 .set_description("Swift auth URL")
5714 .set_long_description(
5715 "Default url to which RGW connects and verifies tokens for v1 auth (if not using "
5716 "internal swift auth)."),
c07f9fc5 5717
d2e6a577
FG
5718 Option("rgw_swift_auth_entry", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5719 .set_default("auth")
b32b8144
FG
5720 .set_description("Swift auth URL prefix")
5721 .set_long_description("URL path prefix for internal swift auth requests.")
5722 .add_see_also("rgw_swift_url"),
c07f9fc5 5723
d2e6a577
FG
5724 Option("rgw_swift_tenant_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5725 .set_default("")
b32b8144
FG
5726 .set_description("Swift tenant name")
5727 .set_long_description("Tenant name that is used when constructing the swift path.")
5728 .add_see_also("rgw_swift_account_in_url"),
c07f9fc5 5729
d2e6a577
FG
5730 Option("rgw_swift_account_in_url", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5731 .set_default(false)
b32b8144
FG
5732 .set_description("Swift account encoded in URL")
5733 .set_long_description("Whether the swift account is encoded in the uri path (AUTH_<account>).")
5734 .add_see_also("rgw_swift_tenant_name"),
c07f9fc5 5735
d2e6a577
FG
5736 Option("rgw_swift_enforce_content_length", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5737 .set_default(false)
b32b8144
FG
5738 .set_description("Send content length when listing containers (Swift)")
5739 .set_long_description(
5740 "Whether content length header is needed when listing containers. When this is "
5741 "set to false, RGW will send extra info for each entry in the response."),
c07f9fc5 5742
b32b8144 5743 Option("rgw_keystone_url", Option::TYPE_STR, Option::LEVEL_BASIC)
d2e6a577 5744 .set_default("")
b32b8144 5745 .set_description("The URL to the Keystone server."),
c07f9fc5 5746
d2e6a577
FG
5747 Option("rgw_keystone_admin_token", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5748 .set_default("")
11fdf7f2
TL
5749 .set_description("DEPRECATED: The admin token (shared secret) that is used for the Keystone requests."),
5750
5751 Option("rgw_keystone_admin_token_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5752 .set_default("")
5753 .set_description("Path to a file containing the admin token (shared secret) that is used for the Keystone requests."),
c07f9fc5 5754
d2e6a577
FG
5755 Option("rgw_keystone_admin_user", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5756 .set_default("")
b32b8144 5757 .set_description("Keystone admin user."),
c07f9fc5 5758
d2e6a577
FG
5759 Option("rgw_keystone_admin_password", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5760 .set_default("")
11fdf7f2
TL
5761 .set_description("DEPRECATED: Keystone admin password."),
5762
5763 Option("rgw_keystone_admin_password_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5764 .set_default("")
5765 .set_description("Path to a file containing the Keystone admin password."),
c07f9fc5 5766
d2e6a577
FG
5767 Option("rgw_keystone_admin_tenant", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5768 .set_default("")
b32b8144 5769 .set_description("Keystone admin user tenant."),
c07f9fc5 5770
d2e6a577
FG
5771 Option("rgw_keystone_admin_project", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5772 .set_default("")
b32b8144 5773 .set_description("Keystone admin user project (for Keystone v3)."),
c07f9fc5 5774
d2e6a577
FG
5775 Option("rgw_keystone_admin_domain", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5776 .set_default("")
b32b8144 5777 .set_description("Keystone admin user domain (for Keystone v3)."),
c07f9fc5 5778
d2e6a577
FG
5779 Option("rgw_keystone_barbican_user", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5780 .set_default("")
b32b8144 5781 .set_description("Keystone user to access barbican secrets."),
c07f9fc5 5782
d2e6a577
FG
5783 Option("rgw_keystone_barbican_password", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5784 .set_default("")
b32b8144 5785 .set_description("Keystone password for barbican user."),
c07f9fc5 5786
d2e6a577
FG
5787 Option("rgw_keystone_barbican_tenant", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5788 .set_default("")
b32b8144 5789 .set_description("Keystone barbican user tenant (Keystone v2.0)."),
c07f9fc5 5790
d2e6a577
FG
5791 Option("rgw_keystone_barbican_project", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5792 .set_default("")
b32b8144 5793 .set_description("Keystone barbican user project (Keystone v3)."),
c07f9fc5 5794
d2e6a577
FG
5795 Option("rgw_keystone_barbican_domain", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5796 .set_default("")
b32b8144 5797 .set_description("Keystone barbican user domain."),
c07f9fc5 5798
d2e6a577
FG
5799 Option("rgw_keystone_api_version", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5800 .set_default(2)
b32b8144 5801 .set_description("Version of Keystone API to use (2 or 3)."),
c07f9fc5 5802
d2e6a577
FG
5803 Option("rgw_keystone_accepted_roles", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5804 .set_default("Member, admin")
b32b8144 5805 .set_description("Only users with one of these roles will be served when doing Keystone authentication."),
c07f9fc5 5806
d2e6a577
FG
5807 Option("rgw_keystone_accepted_admin_roles", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5808 .set_default("")
b32b8144 5809 .set_description("List of roles allowing user to gain admin privileges (Keystone)."),
c07f9fc5 5810
d2e6a577
FG
5811 Option("rgw_keystone_token_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5812 .set_default(10000)
b32b8144
FG
5813 .set_description("Keystone token cache size")
5814 .set_long_description(
5815 "Max number of Keystone tokens that will be cached. Token that is not cached "
5816 "requires RGW to access the Keystone server when authenticating."),
c07f9fc5 5817
d2e6a577
FG
5818 Option("rgw_keystone_verify_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5819 .set_default(true)
b32b8144 5820 .set_description("Should RGW verify the Keystone server SSL certificate."),
c07f9fc5 5821
9f95a23c
TL
5822 Option("rgw_keystone_implicit_tenants", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5823 .set_default("false")
5824 .set_enum_allowed( { "false", "true", "swift", "s3", "both", "0", "1", "none" } )
b32b8144
FG
5825 .set_description("RGW Keystone implicit tenants creation")
5826 .set_long_description(
5827 "Implicitly create new users in their own tenant with the same name when "
9f95a23c 5828 "authenticating via Keystone. Can be limited to s3 or swift only."),
c07f9fc5 5829
d2e6a577
FG
5830 Option("rgw_cross_domain_policy", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5831 .set_default("<allow-access-from domain=\"*\" secure=\"false\" />")
b32b8144
FG
5832 .set_description("RGW handle cross domain policy")
5833 .set_long_description("Returned cross domain policy when accessing the crossdomain.xml "
5834 "resource (Swift compatiility)."),
c07f9fc5 5835
b32b8144 5836 Option("rgw_healthcheck_disabling_path", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577 5837 .set_default("")
b32b8144 5838 .set_description("Swift health check api can be disabled if a file can be accessed in this path."),
c07f9fc5 5839
d2e6a577
FG
5840 Option("rgw_s3_auth_use_rados", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5841 .set_default(true)
b32b8144 5842 .set_description("Should S3 authentication use credentials stored in RADOS backend."),
c07f9fc5 5843
d2e6a577
FG
5844 Option("rgw_s3_auth_use_keystone", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5845 .set_default(false)
b32b8144 5846 .set_description("Should S3 authentication use Keystone."),
c07f9fc5 5847
1adf2230 5848 Option("rgw_s3_auth_order", Option::TYPE_STR, Option::LEVEL_ADVANCED)
11fdf7f2 5849 .set_default("sts, external, local")
1adf2230
AA
5850 .set_description("Authentication strategy order to use for s3 authentication")
5851 .set_long_description(
5852 "Order of authentication strategies to try for s3 authentication, the allowed "
5853 "options are a comma separated list of engines external, local. The "
5854 "default order is to try all the externally configured engines before "
5855 "attempting local rados based authentication"),
5856
d2e6a577
FG
5857 Option("rgw_barbican_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5858 .set_default("")
b32b8144 5859 .set_description("URL to barbican server."),
c07f9fc5 5860
d2e6a577
FG
5861 Option("rgw_ldap_uri", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5862 .set_default("ldaps://<ldap.your.domain>")
b32b8144 5863 .set_description("Space-separated list of LDAP servers in URI format."),
c07f9fc5 5864
d2e6a577
FG
5865 Option("rgw_ldap_binddn", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5866 .set_default("uid=admin,cn=users,dc=example,dc=com")
b32b8144 5867 .set_description("LDAP entry RGW will bind with (user match)."),
c07f9fc5 5868
d2e6a577
FG
5869 Option("rgw_ldap_searchdn", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5870 .set_default("cn=users,cn=accounts,dc=example,dc=com")
b32b8144 5871 .set_description("LDAP search base (basedn)."),
c07f9fc5 5872
d2e6a577
FG
5873 Option("rgw_ldap_dnattr", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5874 .set_default("uid")
b32b8144 5875 .set_description("LDAP attribute containing RGW user names (to form binddns)."),
c07f9fc5 5876
d2e6a577
FG
5877 Option("rgw_ldap_secret", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5878 .set_default("/etc/openldap/secret")
b32b8144 5879 .set_description("Path to file containing credentials for rgw_ldap_binddn."),
c07f9fc5 5880
d2e6a577
FG
5881 Option("rgw_s3_auth_use_ldap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5882 .set_default(false)
b32b8144 5883 .set_description("Should S3 authentication use LDAP."),
c07f9fc5 5884
d2e6a577
FG
5885 Option("rgw_ldap_searchfilter", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5886 .set_default("")
b32b8144 5887 .set_description("LDAP search filter."),
c07f9fc5 5888
11fdf7f2
TL
5889 Option("rgw_opa_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5890 .set_default("")
5891 .set_description("URL to OPA server."),
5892
5893 Option("rgw_opa_token", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5894 .set_default("")
5895 .set_description("The Bearer token OPA uses to authenticate client requests."),
5896
5897 Option("rgw_opa_verify_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5898 .set_default(true)
5899 .set_description("Should RGW verify the OPA server SSL certificate."),
5900
5901 Option("rgw_use_opa_authz", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5902 .set_default(false)
5903 .set_description("Should OPA be used to authorize client requests."),
5904
d2e6a577
FG
5905 Option("rgw_admin_entry", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5906 .set_default("admin")
b32b8144 5907 .set_description("Path prefix to be used for accessing RGW RESTful admin API."),
c07f9fc5 5908
d2e6a577
FG
5909 Option("rgw_enforce_swift_acls", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5910 .set_default(true)
b32b8144
FG
5911 .set_description("RGW enforce swift acls")
5912 .set_long_description(
5913 "Should RGW enforce special Swift-only ACLs. Swift has a special ACL that gives "
5914 "permission to access all objects in a container."),
c07f9fc5 5915
d2e6a577 5916 Option("rgw_swift_token_expiration", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144
FG
5917 .set_default(1_day)
5918 .set_description("Expiration time (in seconds) for token generated through RGW Swift auth."),
c07f9fc5 5919
d2e6a577
FG
5920 Option("rgw_print_continue", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5921 .set_default(true)
b32b8144
FG
5922 .set_description("RGW support of 100-continue")
5923 .set_long_description(
5924 "Should RGW explicitly send 100 (continue) responses. This is mainly relevant when "
5925 "using FastCGI, as some FastCGI modules do not fully support this feature."),
c07f9fc5 5926
d2e6a577
FG
5927 Option("rgw_print_prohibited_content_length", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5928 .set_default(false)
b32b8144
FG
5929 .set_description("RGW RFC-7230 compatibility")
5930 .set_long_description(
5931 "Specifies whether RGW violates RFC 7230 and sends Content-Length with 204 or 304 "
5932 "statuses."),
c07f9fc5 5933
d2e6a577
FG
5934 Option("rgw_remote_addr_param", Option::TYPE_STR, Option::LEVEL_ADVANCED)
5935 .set_default("REMOTE_ADDR")
b32b8144
FG
5936 .set_description("HTTP header that holds the remote address in incoming requests.")
5937 .set_long_description(
5938 "RGW will use this header to extract requests origin. When RGW runs behind "
5939 "a reverse proxy, the remote address header will point at the proxy's address "
5940 "and not at the originator's address. Therefore it is sometimes possible to "
5941 "have the proxy add the originator's address in a separate HTTP header, which "
5942 "will allow RGW to log it correctly."
5943 )
5944 .add_see_also("rgw_enable_ops_log"),
c07f9fc5 5945
b32b8144 5946 Option("rgw_op_thread_timeout", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577 5947 .set_default(10*60)
b32b8144 5948 .set_description("Timeout for async rados coroutine operations."),
c07f9fc5 5949
b32b8144 5950 Option("rgw_op_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
5951 .set_default(0)
5952 .set_description(""),
c07f9fc5 5953
b32b8144 5954 Option("rgw_thread_pool_size", Option::TYPE_INT, Option::LEVEL_BASIC)
91327a77 5955 .set_default(512)
b32b8144
FG
5956 .set_description("RGW requests handling thread pool size.")
5957 .set_long_description(
5958 "This parameter determines the number of concurrent requests RGW can process "
5959 "when using either the civetweb, or the fastcgi frontends. The higher this "
5960 "number is, RGW will be able to deal with more concurrent requests at the "
5961 "cost of more resource utilization."),
c07f9fc5 5962
d2e6a577
FG
5963 Option("rgw_num_control_oids", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5964 .set_default(8)
b32b8144
FG
5965 .set_description("Number of control objects used for cross-RGW communication.")
5966 .set_long_description(
5967 "RGW uses certain control objects to send messages between different RGW "
5968 "processes running on the same zone. These messages include metadata cache "
5969 "invalidation info that is being sent when metadata is modified (such as "
5970 "user or bucket information). A higher number of control objects allows "
5971 "better concurrency of these messages, at the cost of more resource "
5972 "utilization."),
c07f9fc5 5973
d2e6a577
FG
5974 Option("rgw_num_rados_handles", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
5975 .set_default(1)
b32b8144
FG
5976 .set_description("Number of librados handles that RGW uses.")
5977 .set_long_description(
5978 "This param affects the number of separate librados handles it uses to "
5979 "connect to the RADOS backend, which directly affects the number of connections "
5980 "RGW will have to each OSD. A higher number affects resource utilization."),
c07f9fc5 5981
d2e6a577
FG
5982 Option("rgw_verify_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
5983 .set_default(true)
b32b8144
FG
5984 .set_description("Should RGW verify SSL when connecing to a remote HTTP server")
5985 .set_long_description(
5986 "RGW can send requests to other RGW servers (e.g., in multi-site sync work). "
5987 "This configurable selects whether RGW should verify the certificate for "
5988 "the remote peer and host.")
5989 .add_see_also("rgw_keystone_verify_ssl"),
c07f9fc5 5990
d2e6a577
FG
5991 Option("rgw_nfs_lru_lanes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5992 .set_default(5)
5993 .set_description(""),
c07f9fc5 5994
d2e6a577
FG
5995 Option("rgw_nfs_lru_lane_hiwat", Option::TYPE_INT, Option::LEVEL_ADVANCED)
5996 .set_default(911)
5997 .set_description(""),
c07f9fc5 5998
d2e6a577
FG
5999 Option("rgw_nfs_fhcache_partitions", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6000 .set_default(3)
6001 .set_description(""),
c07f9fc5 6002
d2e6a577
FG
6003 Option("rgw_nfs_fhcache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6004 .set_default(2017)
6005 .set_description(""),
c07f9fc5 6006
d2e6a577
FG
6007 Option("rgw_nfs_namespace_expire_secs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6008 .set_default(300)
6009 .set_min(1)
6010 .set_description(""),
6011
6012 Option("rgw_nfs_max_gc", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6013 .set_default(300)
6014 .set_min(1)
6015 .set_description(""),
6016
6017 Option("rgw_nfs_write_completion_interval_s", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6018 .set_default(10)
6019 .set_description(""),
6020
eafe8130
TL
6021 Option("rgw_nfs_s3_fast_attrs", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6022 .set_default(false)
6023 .set_description("use fast S3 attrs from bucket index (immutable only)")
6024 .set_long_description("use fast S3 attrs from bucket index (assumes NFS "
6025 "mounts are immutable)"),
6026
f6b5b4d7
TL
6027 Option("rgw_nfs_run_gc_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6028 .set_default(false)
6029 .set_description("run GC threads in librgw (default off)"),
6030
6031 Option("rgw_nfs_run_lc_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6032 .set_default(false)
6033 .set_description("run lifecycle threads in librgw (default off)"),
6034
6035 Option("rgw_nfs_run_quota_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6036 .set_default(false)
6037 .set_description("run quota threads in librgw (default off)"),
6038
6039 Option("rgw_nfs_run_sync_thread", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6040 .set_default(false)
6041 .set_description("run sync thread in librgw (default off)"),
6042
494da23a
TL
6043 Option("rgw_rados_pool_autoscale_bias", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6044 .set_default(4.0)
6045 .set_min_max(0.01, 100000.0)
6046 .set_description("pg_autoscale_bias value for RGW metadata (omap-heavy) pools"),
6047
6048 Option("rgw_rados_pool_pg_num_min", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6049 .set_default(8)
6050 .set_min_max(1, 1024)
6051 .set_description("pg_num_min value for RGW metadata (omap-heavy) pools"),
6052
9f95a23c
TL
6053 Option("rgw_rados_pool_recovery_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6054 .set_default(5)
6055 .set_min_max(-10, 10)
6056 .set_description("recovery_priority value for RGW metadata (omap-heavy) pools"),
6057
d2e6a577
FG
6058 Option("rgw_zone", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6059 .set_default("")
b32b8144
FG
6060 .set_description("Zone name")
6061 .add_see_also({"rgw_zonegroup", "rgw_realm"}),
d2e6a577
FG
6062
6063 Option("rgw_zone_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6064 .set_default(".rgw.root")
b32b8144
FG
6065 .set_description("Zone root pool name")
6066 .set_long_description(
6067 "The zone root pool, is the pool where the RGW zone configuration located."
6068 )
6069 .add_see_also({"rgw_zonegroup_root_pool", "rgw_realm_root_pool", "rgw_period_root_pool"}),
d2e6a577
FG
6070
6071 Option("rgw_default_zone_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6072 .set_default("default.zone")
b32b8144
FG
6073 .set_description("Default zone info object id")
6074 .set_long_description(
6075 "Name of the RADOS object that holds the default zone information."
6076 ),
d2e6a577
FG
6077
6078 Option("rgw_region", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6079 .set_default("")
b32b8144
FG
6080 .set_description("Region name")
6081 .set_long_description(
6082 "Obsolete config option. The rgw_zonegroup option should be used instead.")
6083 .add_see_also("rgw_zonegroup"),
d2e6a577
FG
6084
6085 Option("rgw_region_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6086 .set_default(".rgw.root")
b32b8144
FG
6087 .set_description("Region root pool")
6088 .set_long_description(
6089 "Obsolete config option. The rgw_zonegroup_root_pool should be used instead.")
6090 .add_see_also("rgw_zonegroup_root_pool"),
d2e6a577
FG
6091
6092 Option("rgw_default_region_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6093 .set_default("default.region")
b32b8144
FG
6094 .set_description("Default region info object id")
6095 .set_long_description(
6096 "Obsolete config option. The rgw_default_zonegroup_info_oid should be used instead.")
6097 .add_see_also("rgw_default_zonegroup_info_oid"),
d2e6a577
FG
6098
6099 Option("rgw_zonegroup", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6100 .set_default("")
b32b8144
FG
6101 .set_description("Zonegroup name")
6102 .add_see_also({"rgw_zone", "rgw_realm"}),
d2e6a577
FG
6103
6104 Option("rgw_zonegroup_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6105 .set_default(".rgw.root")
b32b8144
FG
6106 .set_description("Zonegroup root pool")
6107 .set_long_description(
6108 "The zonegroup root pool, is the pool where the RGW zonegroup configuration located."
6109 )
6110 .add_see_also({"rgw_zone_root_pool", "rgw_realm_root_pool", "rgw_period_root_pool"}),
d2e6a577
FG
6111
6112 Option("rgw_default_zonegroup_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6113 .set_default("default.zonegroup")
6114 .set_description(""),
6115
6116 Option("rgw_realm", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6117 .set_default("")
6118 .set_description(""),
6119
6120 Option("rgw_realm_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6121 .set_default(".rgw.root")
b32b8144
FG
6122 .set_description("Realm root pool")
6123 .set_long_description(
6124 "The realm root pool, is the pool where the RGW realm configuration located."
6125 )
6126 .add_see_also({"rgw_zonegroup_root_pool", "rgw_zone_root_pool", "rgw_period_root_pool"}),
d2e6a577
FG
6127
6128 Option("rgw_default_realm_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6129 .set_default("default.realm")
6130 .set_description(""),
6131
6132 Option("rgw_period_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6133 .set_default(".rgw.root")
b32b8144
FG
6134 .set_description("Period root pool")
6135 .set_long_description(
11fdf7f2 6136 "The period root pool, is the pool where the RGW period configuration located."
b32b8144
FG
6137 )
6138 .add_see_also({"rgw_zonegroup_root_pool", "rgw_zone_root_pool", "rgw_realm_root_pool"}),
d2e6a577 6139
b32b8144 6140 Option("rgw_period_latest_epoch_info_oid", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577
FG
6141 .set_default(".latest_epoch")
6142 .set_description(""),
6143
6144 Option("rgw_log_nonexistent_bucket", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6145 .set_default(false)
b32b8144
FG
6146 .set_description("Should RGW log operations on bucket that does not exist")
6147 .set_long_description(
6148 "This config option applies to the ops log. When this option is set, the ops log "
6149 "will log operations that are sent to non existing buckets. These operations "
6150 "inherently fail, and do not correspond to a specific user.")
6151 .add_see_also("rgw_enable_ops_log"),
d2e6a577
FG
6152
6153 Option("rgw_log_object_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6154 .set_default("%Y-%m-%d-%H-%i-%n")
b32b8144
FG
6155 .set_description("Ops log object name format")
6156 .set_long_description(
6157 "Defines the format of the RADOS objects names that ops log uses to store ops "
6158 "log data")
6159 .add_see_also("rgw_enable_ops_log"),
d2e6a577
FG
6160
6161 Option("rgw_log_object_name_utc", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6162 .set_default(false)
b32b8144
FG
6163 .set_description("Should ops log object name based on UTC")
6164 .set_long_description(
6165 "If set, the names of the RADOS objects that hold the ops log data will be based "
6166 "on UTC time zone. If not set, it will use the local time zone.")
6167 .add_see_also({"rgw_enable_ops_log", "rgw_log_object_name"}),
d2e6a577
FG
6168
6169 Option("rgw_usage_max_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6170 .set_default(32)
b32b8144
FG
6171 .set_description("Number of shards for usage log.")
6172 .set_long_description(
6173 "The number of RADOS objects that RGW will use in order to store the usage log "
6174 "data.")
6175 .add_see_also("rgw_enable_usage_log"),
d2e6a577
FG
6176
6177 Option("rgw_usage_max_user_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6178 .set_default(1)
6179 .set_min(1)
b32b8144
FG
6180 .set_description("Number of shards for single user in usage log")
6181 .set_long_description(
6182 "The number of shards that a single user will span over in the usage log.")
6183 .add_see_also("rgw_enable_usage_log"),
c07f9fc5 6184
d2e6a577
FG
6185 Option("rgw_enable_ops_log", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6186 .set_default(false)
b32b8144
FG
6187 .set_description("Enable ops log")
6188 .add_see_also({"rgw_log_nonexistent_bucket", "rgw_log_object_name", "rgw_ops_log_rados",
6189 "rgw_ops_log_socket_path"}),
c07f9fc5 6190
d2e6a577
FG
6191 Option("rgw_enable_usage_log", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6192 .set_default(false)
b32b8144
FG
6193 .set_description("Enable usage log")
6194 .add_see_also("rgw_usage_max_shards"),
c07f9fc5 6195
d2e6a577
FG
6196 Option("rgw_ops_log_rados", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6197 .set_default(true)
b32b8144
FG
6198 .set_description("Use RADOS for ops log")
6199 .set_long_description(
6200 "If set, RGW will store ops log information in RADOS.")
6201 .add_see_also({"rgw_enable_ops_log"}),
c07f9fc5 6202
d2e6a577
FG
6203 Option("rgw_ops_log_socket_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6204 .set_default("")
b32b8144
FG
6205 .set_description("Unix domain socket path for ops log.")
6206 .set_long_description(
6207 "Path to unix domain socket that RGW will listen for connection on. When connected, "
6208 "RGW will send ops log data through it.")
6209 .add_see_also({"rgw_enable_ops_log", "rgw_ops_log_data_backlog"}),
c07f9fc5 6210
11fdf7f2 6211 Option("rgw_ops_log_data_backlog", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 6212 .set_default(5 << 20)
b32b8144
FG
6213 .set_description("Ops log socket backlog")
6214 .set_long_description(
6215 "Maximum amount of data backlog that RGW can keep when ops log is configured to "
6216 "send info through unix domain socket. When data backlog is higher than this, "
6217 "ops log entries will be lost. In order to avoid ops log information loss, the "
6218 "listener needs to clear data (by reading it) quickly enough.")
6219 .add_see_also({"rgw_enable_ops_log", "rgw_ops_log_socket_path"}),
c07f9fc5 6220
d2e6a577
FG
6221 Option("rgw_fcgi_socket_backlog", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6222 .set_default(1024)
b32b8144
FG
6223 .set_description("FastCGI socket connection backlog")
6224 .set_long_description(
6225 "Size of FastCGI connection backlog. This reflects the maximum number of new "
6226 "connection requests that RGW can handle concurrently without dropping any. ")
6227 .add_see_also({"rgw_host", "rgw_socket_path"}),
c07f9fc5 6228
d2e6a577
FG
6229 Option("rgw_usage_log_flush_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6230 .set_default(1024)
b32b8144
FG
6231 .set_description("Number of entries in usage log before flushing")
6232 .set_long_description(
6233 "This is the max number of entries that will be held in the usage log, before it "
6234 "will be flushed to the backend. Note that the usage log is periodically flushed, "
6235 "even if number of entries does not reach this threshold. A usage log entry "
6236 "corresponds to one or more operations on a single bucket.i")
6237 .add_see_also({"rgw_enable_usage_log", "rgw_usage_log_tick_interval"}),
c07f9fc5 6238
d2e6a577
FG
6239 Option("rgw_usage_log_tick_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6240 .set_default(30)
b32b8144
FG
6241 .set_description("Number of seconds between usage log flush cycles")
6242 .set_long_description(
6243 "The number of seconds between consecutive usage log flushes. The usage log will "
6244 "also flush itself to the backend if the number of pending entries reaches a "
6245 "certain threshold.")
6246 .add_see_also({"rgw_enable_usage_log", "rgw_usage_log_flush_threshold"}),
c07f9fc5 6247
b32b8144 6248 Option("rgw_init_timeout", Option::TYPE_INT, Option::LEVEL_BASIC)
d2e6a577 6249 .set_default(300)
b32b8144
FG
6250 .set_description("Initialization timeout")
6251 .set_long_description(
6252 "The time length (in seconds) that RGW will allow for its initialization. RGW "
6253 "process will give up and quit if initialization is not complete after this amount "
6254 "of time."),
c07f9fc5 6255
b32b8144 6256 Option("rgw_mime_types_file", Option::TYPE_STR, Option::LEVEL_BASIC)
d2e6a577 6257 .set_default("/etc/mime.types")
b32b8144
FG
6258 .set_description("Path to local mime types file")
6259 .set_long_description(
6260 "The mime types file is needed in Swift when uploading an object. If object's "
6261 "content type is not specified, RGW will use data from this file to assign "
6262 "a content type to the object."),
c07f9fc5 6263
d2e6a577
FG
6264 Option("rgw_gc_max_objs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6265 .set_default(32)
b32b8144
FG
6266 .set_description("Number of shards for garbage collector data")
6267 .set_long_description(
6268 "The number of garbage collector data shards, is the number of RADOS objects that "
6269 "RGW will use to store the garbage collection information on.")
11fdf7f2 6270 .add_see_also({"rgw_gc_obj_min_wait", "rgw_gc_processor_max_time", "rgw_gc_processor_period", "rgw_gc_max_concurrent_io"}),
c07f9fc5 6271
d2e6a577 6272 Option("rgw_gc_obj_min_wait", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144 6273 .set_default(2_hr)
11fdf7f2 6274 .set_description("Garbage collection object expiration time")
b32b8144
FG
6275 .set_long_description(
6276 "The length of time (in seconds) that the RGW collector will wait before purging "
6277 "a deleted object's data. RGW will not remove object immediately, as object could "
6278 "still have readers. A mechanism exists to increase the object's expiration time "
9f95a23c 6279 "when it's being read. The recommended value of its lower limit is 30 minutes")
11fdf7f2 6280 .add_see_also({"rgw_gc_max_objs", "rgw_gc_processor_max_time", "rgw_gc_processor_period", "rgw_gc_max_concurrent_io"}),
c07f9fc5 6281
d2e6a577 6282 Option("rgw_gc_processor_max_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144
FG
6283 .set_default(1_hr)
6284 .set_description("Length of time GC processor can lease shard")
6285 .set_long_description(
6286 "Garbage collection thread in RGW process holds a lease on its data shards. These "
6287 "objects contain the information about the objects that need to be removed. RGW "
6288 "takes a lease in order to prevent multiple RGW processes from handling the same "
11fdf7f2 6289 "objects concurrently. This time signifies that maximum amount of time (in seconds) that RGW "
b32b8144
FG
6290 "is allowed to hold that lease. In the case where RGW goes down uncleanly, this "
6291 "is the amount of time where processing of that data shard will be blocked.")
11fdf7f2 6292 .add_see_also({"rgw_gc_max_objs", "rgw_gc_obj_min_wait", "rgw_gc_processor_period", "rgw_gc_max_concurrent_io"}),
c07f9fc5 6293
d2e6a577 6294 Option("rgw_gc_processor_period", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144
FG
6295 .set_default(1_hr)
6296 .set_description("Garbage collector cycle run time")
6297 .set_long_description(
6298 "The amount of time between the start of consecutive runs of the garbage collector "
6299 "threads. If garbage collector runs takes more than this period, it will not wait "
6300 "before running again.")
11fdf7f2
TL
6301 .add_see_also({"rgw_gc_max_objs", "rgw_gc_obj_min_wait", "rgw_gc_processor_max_time", "rgw_gc_max_concurrent_io", "rgw_gc_max_trim_chunk"}),
6302
6303 Option("rgw_gc_max_concurrent_io", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6304 .set_default(10)
6305 .set_description("Max concurrent RADOS IO operations for garbage collection")
6306 .set_long_description(
6307 "The maximum number of concurrent IO operations that the RGW garbage collection "
6308 "thread will use when purging old data.")
6309 .add_see_also({"rgw_gc_max_objs", "rgw_gc_obj_min_wait", "rgw_gc_processor_max_time", "rgw_gc_max_trim_chunk"}),
6310
6311 Option("rgw_gc_max_trim_chunk", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6312 .set_default(16)
6313 .set_description("Max number of keys to remove from garbage collector log in a single operation")
6314 .add_see_also({"rgw_gc_max_objs", "rgw_gc_obj_min_wait", "rgw_gc_processor_max_time", "rgw_gc_max_concurrent_io"}),
c07f9fc5 6315
9f95a23c
TL
6316 Option("rgw_gc_max_deferred_entries_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6317 .set_default(3072)
6318 .set_description("maximum allowed size of deferred entries in queue head for gc"),
6319
6320 Option("rgw_gc_max_queue_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6321 .set_default(134213632)
6322 .set_description("Maximum allowed queue size for gc")
6323 .set_long_description(
6324 "The maximum allowed size of each gc queue, and its value should not "
6325 "be greater than (osd_max_object_size - rgw_gc_max_deferred_entries_size - 1K).")
6326 .add_see_also({"osd_max_object_size", "rgw_gc_max_deferred_entries_size"}),
6327
6328 Option("rgw_gc_max_deferred", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6329 .set_default(50)
6330 .set_description("Number of maximum deferred data entries to be stored in queue for gc"),
6331
d2e6a577
FG
6332 Option("rgw_s3_success_create_obj_status", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6333 .set_default(0)
b32b8144
FG
6334 .set_description("HTTP return code override for object creation")
6335 .set_long_description(
11fdf7f2 6336 "If not zero, this is the HTTP return code that will be returned on a successful S3 "
b32b8144 6337 "object creation."),
c07f9fc5 6338
d2e6a577
FG
6339 Option("rgw_resolve_cname", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6340 .set_default(false)
b32b8144
FG
6341 .set_description("Support vanity domain names via CNAME")
6342 .set_long_description(
6343 "If true, RGW will query DNS when detecting that it's serving a request that was "
6344 "sent to a host in another domain. If a CNAME record is configured for that domain "
6345 "it will use it instead. This gives user to have the ability of creating a unique "
6346 "domain of their own to point at data in their bucket."),
c07f9fc5 6347
11fdf7f2 6348 Option("rgw_obj_stripe_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144
FG
6349 .set_default(4_M)
6350 .set_description("RGW object stripe size")
6351 .set_long_description(
6352 "The size of an object stripe for RGW objects. This is the maximum size a backing "
6353 "RADOS object will have. RGW objects that are larger than this will span over "
6354 "multiple objects."),
c07f9fc5 6355
d2e6a577
FG
6356 Option("rgw_extended_http_attrs", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6357 .set_default("")
b32b8144
FG
6358 .set_description("RGW support extended HTTP attrs")
6359 .set_long_description(
6360 "Add new set of attributes that could be set on an object. These extra attributes "
6361 "can be set through HTTP header fields when putting the objects. If set, these "
6362 "attributes will return as HTTP fields when doing GET/HEAD on the object."),
c07f9fc5 6363
d2e6a577
FG
6364 Option("rgw_exit_timeout_secs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6365 .set_default(120)
b32b8144
FG
6366 .set_description("RGW shutdown timeout")
6367 .set_long_description("Number of seconds to wait for a process before exiting unconditionally."),
c07f9fc5 6368
11fdf7f2 6369 Option("rgw_get_obj_window_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144
FG
6370 .set_default(16_M)
6371 .set_description("RGW object read window size")
6372 .set_long_description("The window size in bytes for a single object read request"),
c07f9fc5 6373
11fdf7f2 6374 Option("rgw_get_obj_max_req_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144
FG
6375 .set_default(4_M)
6376 .set_description("RGW object read chunk size")
6377 .set_long_description(
6378 "The maximum request size of a single object read operation sent to RADOS"),
c07f9fc5 6379
d2e6a577
FG
6380 Option("rgw_relaxed_s3_bucket_names", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6381 .set_default(false)
b32b8144
FG
6382 .set_description("RGW enable relaxed S3 bucket names")
6383 .set_long_description("RGW enable relaxed S3 bucket name rules for US region buckets."),
c07f9fc5 6384
d2e6a577
FG
6385 Option("rgw_defer_to_bucket_acls", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6386 .set_default("")
b32b8144
FG
6387 .set_description("Bucket ACLs override object ACLs")
6388 .set_long_description(
6389 "If not empty, a string that selects that mode of operation. 'recurse' will use "
6390 "bucket's ACL for the authorizaton. 'full-control' will allow users that users "
6391 "that have full control permission on the bucket have access to the object."),
c07f9fc5 6392
d2e6a577
FG
6393 Option("rgw_list_buckets_max_chunk", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6394 .set_default(1000)
b32b8144
FG
6395 .set_description("Max number of buckets to retrieve in a single listing operation")
6396 .set_long_description(
6397 "When RGW fetches lists of user's buckets from the backend, this is the max number "
6398 "of entries it will try to retrieve in a single operation. Note that the backend "
6399 "may choose to return a smaller number of entries."),
c07f9fc5 6400
d2e6a577
FG
6401 Option("rgw_md_log_max_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6402 .set_default(64)
b32b8144
FG
6403 .set_description("RGW number of metadata log shards")
6404 .set_long_description(
6405 "The number of shards the RGW metadata log entries will reside in. This affects "
6406 "the metadata sync parallelism as a shard can only be processed by a single "
6407 "RGW at a time"),
c07f9fc5 6408
b32b8144 6409 Option("rgw_curl_wait_timeout_ms", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
6410 .set_default(1000)
6411 .set_description(""),
c07f9fc5 6412
1adf2230
AA
6413 Option("rgw_curl_low_speed_limit", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6414 .set_default(1024)
6415 .set_long_description(
6416 "It contains the average transfer speed in bytes per second that the "
6417 "transfer should be below during rgw_curl_low_speed_time seconds for libcurl "
6418 "to consider it to be too slow and abort. Set it zero to disable this."),
6419
6420 Option("rgw_curl_low_speed_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
91327a77 6421 .set_default(300)
1adf2230
AA
6422 .set_long_description(
6423 "It contains the time in number seconds that the transfer speed should be below "
6424 "the rgw_curl_low_speed_limit for the library to consider it too slow and abort. "
6425 "Set it zero to disable this."),
6426
d2e6a577
FG
6427 Option("rgw_copy_obj_progress", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6428 .set_default(true)
b32b8144
FG
6429 .set_description("Send progress report through copy operation")
6430 .set_long_description(
6431 "If true, RGW will send progress information when copy operation is executed. "),
c07f9fc5 6432
11fdf7f2 6433 Option("rgw_copy_obj_progress_every_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144
FG
6434 .set_default(1_M)
6435 .set_description("Send copy-object progress info after these many bytes"),
c07f9fc5 6436
adb31ebb
TL
6437 Option("rgw_sync_obj_etag_verify", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6438 .set_default(false)
6439 .set_description("Verify if the object copied from remote is identical to its source")
6440 .set_long_description(
6441 "If true, this option computes the MD5 checksum of the data which is written at the "
6442 "destination and checks if it is identical to the ETAG stored in the source. "
6443 "It ensures integrity of the objects fetched from a remote server over HTTP including "
6444 "multisite sync."),
6445
d2e6a577
FG
6446 Option("rgw_obj_tombstone_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6447 .set_default(1000)
b32b8144
FG
6448 .set_description("Max number of entries to keep in tombstone cache")
6449 .set_long_description(
6450 "The tombstone cache is used when doing a multi-zone data sync. RGW keeps "
6451 "there information about removed objects which is needed in order to prevent "
6452 "re-syncing of objects that were already removed."),
c07f9fc5 6453
d2e6a577
FG
6454 Option("rgw_data_log_window", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6455 .set_default(30)
b32b8144
FG
6456 .set_description("Data log time window")
6457 .set_long_description(
6458 "The data log keeps information about buckets that have objectst that were "
6459 "modified within a specific timeframe. The sync process then knows which buckets "
6460 "are needed to be scanned for data sync."),
c07f9fc5 6461
b32b8144 6462 Option("rgw_data_log_changes_size", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577 6463 .set_default(1000)
b32b8144
FG
6464 .set_description("Max size of pending changes in data log")
6465 .set_long_description(
6466 "RGW will trigger update to the data log if the number of pending entries reached "
6467 "this number."),
c07f9fc5 6468
d2e6a577
FG
6469 Option("rgw_data_log_num_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6470 .set_default(128)
b32b8144
FG
6471 .set_description("Number of data log shards")
6472 .set_long_description(
6473 "The number of shards the RGW data log entries will reside in. This affects the "
6474 "data sync parallelism as a shard can only be processed by a single RGW at a time."),
c07f9fc5 6475
b32b8144 6476 Option("rgw_data_log_obj_prefix", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577
FG
6477 .set_default("data_log")
6478 .set_description(""),
c07f9fc5 6479
d2e6a577
FG
6480 Option("rgw_bucket_quota_ttl", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6481 .set_default(600)
b32b8144
FG
6482 .set_description("Bucket quota stats cache TTL")
6483 .set_long_description(
6484 "Length of time for bucket stats to be cached within RGW instance."),
c07f9fc5 6485
b32b8144 6486 Option("rgw_bucket_quota_soft_threshold", Option::TYPE_FLOAT, Option::LEVEL_BASIC)
d2e6a577 6487 .set_default(0.95)
b32b8144
FG
6488 .set_description("RGW quota soft threshold")
6489 .set_long_description(
6490 "Threshold from which RGW doesn't rely on cached info for quota "
6491 "decisions. This is done for higher accuracy of the quota mechanism at "
6492 "cost of performance, when getting close to the quota limit. The value "
6493 "configured here is the ratio between the data usage to the max usage "
6494 "as specified by the quota."),
c07f9fc5 6495
d2e6a577
FG
6496 Option("rgw_bucket_quota_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6497 .set_default(10000)
b32b8144
FG
6498 .set_description("RGW quota stats cache size")
6499 .set_long_description(
6500 "Maximum number of entries in the quota stats cache."),
c07f9fc5 6501
b32b8144 6502 Option("rgw_bucket_default_quota_max_objects", Option::TYPE_INT, Option::LEVEL_BASIC)
d2e6a577 6503 .set_default(-1)
b32b8144
FG
6504 .set_description("Default quota for max objects in a bucket")
6505 .set_long_description(
6506 "The default quota configuration for max number of objects in a bucket. A "
6507 "negative number means 'unlimited'."),
c07f9fc5 6508
d2e6a577
FG
6509 Option("rgw_bucket_default_quota_max_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6510 .set_default(-1)
b32b8144
FG
6511 .set_description("Default quota for total size in a bucket")
6512 .set_long_description(
6513 "The default quota configuration for total size of objects in a bucket. A "
6514 "negative number means 'unlimited'."),
c07f9fc5 6515
d2e6a577
FG
6516 Option("rgw_expose_bucket", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6517 .set_default(false)
b32b8144
FG
6518 .set_description("Send Bucket HTTP header with the response")
6519 .set_long_description(
6520 "If true, RGW will send a Bucket HTTP header with the responses. The header will "
6521 "contain the name of the bucket the operation happened on."),
c07f9fc5 6522
b32b8144 6523 Option("rgw_frontends", Option::TYPE_STR, Option::LEVEL_BASIC)
11fdf7f2 6524 .set_default("beast port=7480")
b32b8144
FG
6525 .set_description("RGW frontends configuration")
6526 .set_long_description(
6527 "A comma delimited list of frontends configuration. Each configuration contains "
6528 "the type of the frontend followed by an optional space delimited set of "
6529 "key=value config parameters."),
c07f9fc5 6530
9f95a23c
TL
6531 Option("rgw_frontend_defaults", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6532 .set_default("beast ssl_certificate=config://rgw/cert/$realm/$zone.crt ssl_private_key=config://rgw/cert/$realm/$zone.key")
6533 .set_description("RGW frontends default configuration")
6534 .set_long_description(
6535 "A comma delimited list of default frontends configuration."),
6536
d2e6a577
FG
6537 Option("rgw_user_quota_bucket_sync_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6538 .set_default(180)
b32b8144
FG
6539 .set_description("User quota bucket sync interval")
6540 .set_long_description(
6541 "Time period for accumulating modified buckets before syncing these stats."),
c07f9fc5 6542
d2e6a577 6543 Option("rgw_user_quota_sync_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144
FG
6544 .set_default(1_day)
6545 .set_description("User quota sync interval")
6546 .set_long_description(
6547 "Time period for accumulating modified buckets before syncing entire user stats."),
c07f9fc5 6548
d2e6a577
FG
6549 Option("rgw_user_quota_sync_idle_users", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6550 .set_default(false)
b32b8144
FG
6551 .set_description("Should sync idle users quota")
6552 .set_long_description(
6553 "Whether stats for idle users be fully synced."),
c07f9fc5 6554
d2e6a577 6555 Option("rgw_user_quota_sync_wait_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
b32b8144
FG
6556 .set_default(1_day)
6557 .set_description("User quota full-sync wait time")
6558 .set_long_description(
6559 "Minimum time between two full stats sync for non-idle users."),
c07f9fc5 6560
b32b8144 6561 Option("rgw_user_default_quota_max_objects", Option::TYPE_INT, Option::LEVEL_BASIC)
d2e6a577 6562 .set_default(-1)
b32b8144
FG
6563 .set_description("User quota max objects")
6564 .set_long_description(
6565 "The default quota configuration for total number of objects for a single user. A "
6566 "negative number means 'unlimited'."),
c07f9fc5 6567
b32b8144 6568 Option("rgw_user_default_quota_max_size", Option::TYPE_INT, Option::LEVEL_BASIC)
d2e6a577 6569 .set_default(-1)
b32b8144
FG
6570 .set_description("User quota max size")
6571 .set_long_description(
6572 "The default quota configuration for total size of objects for a single user. A "
6573 "negative number means 'unlimited'."),
c07f9fc5 6574
11fdf7f2 6575 Option("rgw_multipart_min_part_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144
FG
6576 .set_default(5_M)
6577 .set_description("Minimum S3 multipart-upload part size")
6578 .set_long_description(
6579 "When doing a multipart upload, each part (other than the last part) should be "
6580 "at least this size."),
c07f9fc5 6581
d2e6a577
FG
6582 Option("rgw_multipart_part_upload_limit", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6583 .set_default(10000)
b32b8144 6584 .set_description("Max number of parts in multipart upload"),
c07f9fc5 6585
d2e6a577
FG
6586 Option("rgw_max_slo_entries", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6587 .set_default(1000)
b32b8144 6588 .set_description("Max number of entries in Swift Static Large Object manifest"),
c07f9fc5 6589
b32b8144
FG
6590 Option("rgw_olh_pending_timeout_sec", Option::TYPE_INT, Option::LEVEL_DEV)
6591 .set_default(1_hr)
6592 .set_description("Max time for pending OLH change to complete")
6593 .set_long_description(
6594 "OLH is a versioned object's logical head. Operations on it are journaled and "
6595 "as pending before completion. If an operation doesn't complete with this amount "
6596 "of seconds, we remove the operation from the journal."),
c07f9fc5 6597
b32b8144 6598 Option("rgw_user_max_buckets", Option::TYPE_INT, Option::LEVEL_BASIC)
d2e6a577 6599 .set_default(1000)
b32b8144
FG
6600 .set_description("Max number of buckets per user")
6601 .set_long_description(
f6b5b4d7
TL
6602 "A user can create at most this number of buckets. Zero means "
6603 "no limit; a negative value means users cannot create any new "
6604 "buckets, although users will retain buckets already created."),
c07f9fc5 6605
d2e6a577 6606 Option("rgw_objexp_gc_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
b32b8144
FG
6607 .set_default(10_min)
6608 .set_description("Swift objects expirer garbage collector interval"),
c07f9fc5 6609
d2e6a577
FG
6610 Option("rgw_objexp_hints_num_shards", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6611 .set_default(127)
b32b8144
FG
6612 .set_description("Number of object expirer data shards")
6613 .set_long_description(
6614 "The number of shards the (Swift) object expirer will store its data on."),
c07f9fc5 6615
b32b8144 6616 Option("rgw_objexp_chunk_size", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
6617 .set_default(100)
6618 .set_description(""),
c07f9fc5 6619
b32b8144 6620 Option("rgw_enable_static_website", Option::TYPE_BOOL, Option::LEVEL_BASIC)
d2e6a577 6621 .set_default(false)
b32b8144
FG
6622 .set_description("Enable static website APIs")
6623 .set_long_description(
6624 "This configurable controls whether RGW handles the website control APIs. RGW can "
6625 "server static websites if s3website hostnames are configured, and unrelated to "
6626 "this configurable."),
c07f9fc5 6627
494da23a
TL
6628 Option("rgw_user_unique_email", Option::TYPE_BOOL, Option::LEVEL_BASIC)
6629 .set_default(true)
6630 .set_description("Require local RGW users to have unique email addresses")
6631 .set_long_description(
6632 "Enforce builtin user accounts to have unique email addresses. This "
6633 "setting is historical. In future, non-enforcement of email address "
6634 "uniqueness is likely to become the default."),
6635
b32b8144 6636 Option("rgw_log_http_headers", Option::TYPE_STR, Option::LEVEL_BASIC)
d2e6a577 6637 .set_default("")
b32b8144
FG
6638 .set_description("List of HTTP headers to log")
6639 .set_long_description(
6640 "A comma delimited list of HTTP headers to log when seen, ignores case (e.g., "
6641 "http_x_forwarded_for)."),
c07f9fc5 6642
d2e6a577
FG
6643 Option("rgw_num_async_rados_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6644 .set_default(32)
b32b8144
FG
6645 .set_description("Number of concurrent RADOS operations in multisite sync")
6646 .set_long_description(
6647 "The number of concurrent RADOS IO operations that will be triggered for handling "
6648 "multisite sync operations. This includes control related work, and not the actual "
6649 "sync operations."),
c07f9fc5 6650
d2e6a577
FG
6651 Option("rgw_md_notify_interval_msec", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6652 .set_default(200)
b32b8144
FG
6653 .set_description("Length of time to aggregate metadata changes")
6654 .set_long_description(
6655 "Length of time (in milliseconds) in which the master zone aggregates all the "
11fdf7f2 6656 "metadata changes that occurred, before sending notifications to all the other "
b32b8144 6657 "zones."),
c07f9fc5 6658
d2e6a577
FG
6659 Option("rgw_run_sync_thread", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6660 .set_default(true)
b32b8144 6661 .set_description("Should run sync thread"),
c07f9fc5 6662
b32b8144 6663 Option("rgw_sync_lease_period", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
6664 .set_default(120)
6665 .set_description(""),
c07f9fc5 6666
d2e6a577
FG
6667 Option("rgw_sync_log_trim_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6668 .set_default(1200)
b32b8144
FG
6669 .set_description("Sync log trim interval")
6670 .set_long_description(
6671 "Time in seconds between attempts to trim sync logs."),
6672
6673 Option("rgw_sync_log_trim_max_buckets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6674 .set_default(16)
6675 .set_description("Maximum number of buckets to trim per interval")
6676 .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.")
6677 .add_see_also("rgw_sync_log_trim_interval")
6678 .add_see_also("rgw_sync_log_trim_min_cold_buckets")
6679 .add_see_also("rgw_sync_log_trim_concurrent_buckets"),
6680
6681 Option("rgw_sync_log_trim_min_cold_buckets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6682 .set_default(4)
6683 .set_description("Minimum number of cold buckets to trim per interval")
6684 .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.")
6685 .add_see_also("rgw_sync_log_trim_interval")
6686 .add_see_also("rgw_sync_log_trim_max_buckets")
6687 .add_see_also("rgw_sync_log_trim_concurrent_buckets"),
6688
6689 Option("rgw_sync_log_trim_concurrent_buckets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6690 .set_default(4)
6691 .set_description("Maximum number of buckets to trim in parallel")
6692 .add_see_also("rgw_sync_log_trim_interval")
6693 .add_see_also("rgw_sync_log_trim_max_buckets")
6694 .add_see_also("rgw_sync_log_trim_min_cold_buckets"),
c07f9fc5 6695
d2e6a577
FG
6696 Option("rgw_sync_data_inject_err_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
6697 .set_default(0)
6698 .set_description(""),
c07f9fc5 6699
d2e6a577
FG
6700 Option("rgw_sync_meta_inject_err_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
6701 .set_default(0)
6702 .set_description(""),
c07f9fc5 6703
11fdf7f2
TL
6704 Option("rgw_sync_trace_history_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
6705 .set_default(4096)
6706 .set_description("Sync trace history size")
6707 .set_long_description(
6708 "Maximum number of complete sync trace entries to keep."),
6709
6710 Option("rgw_sync_trace_per_node_log_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6711 .set_default(32)
6712 .set_description("Sync trace per-node log size")
6713 .set_long_description(
6714 "The number of log entries to keep per sync-trace node."),
6715
6716 Option("rgw_sync_trace_servicemap_update_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6717 .set_default(10)
6718 .set_description("Sync-trace service-map update interval")
6719 .set_long_description(
6720 "Number of seconds between service-map updates of sync-trace events."),
6721
d2e6a577
FG
6722 Option("rgw_period_push_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6723 .set_default(2)
b32b8144
FG
6724 .set_description("Period push interval")
6725 .set_long_description(
6726 "Number of seconds to wait before retrying 'period push' operation."),
c07f9fc5 6727
d2e6a577
FG
6728 Option("rgw_period_push_interval_max", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6729 .set_default(30)
b32b8144
FG
6730 .set_description("Period push maximum interval")
6731 .set_long_description(
6732 "The max number of seconds to wait before retrying 'period push' after exponential "
6733 "backoff."),
c07f9fc5 6734
d2e6a577
FG
6735 Option("rgw_safe_max_objects_per_shard", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6736 .set_default(100*1024)
b32b8144
FG
6737 .set_description("Safe number of objects per shard")
6738 .set_long_description(
6739 "This is the max number of objects per bucket index shard that RGW considers "
6740 "safe. RGW will warn if it identifies a bucket where its per-shard count is "
6741 "higher than a percentage of this number.")
6742 .add_see_also("rgw_shard_warning_threshold"),
c07f9fc5 6743
d2e6a577
FG
6744 Option("rgw_shard_warning_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
6745 .set_default(90)
b32b8144
FG
6746 .set_description("Warn about max objects per shard")
6747 .set_long_description(
6748 "Warn if number of objects per shard in a specific bucket passed this percentage "
6749 "of the safe number.")
6750 .add_see_also("rgw_safe_max_objects_per_shard"),
c07f9fc5 6751
d2e6a577
FG
6752 Option("rgw_swift_versioning_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6753 .set_default(false)
b32b8144 6754 .set_description("Enable Swift versioning"),
c07f9fc5 6755
d2e6a577
FG
6756 Option("rgw_swift_custom_header", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6757 .set_default("")
b32b8144
FG
6758 .set_description("Enable swift custom header")
6759 .set_long_description(
6760 "If not empty, specifies a name of HTTP header that can include custom data. When "
6761 "uploading an object, if this header is passed RGW will store this header info "
6762 "and it will be available when listing the bucket."),
c07f9fc5 6763
d2e6a577
FG
6764 Option("rgw_swift_need_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6765 .set_default(true)
b32b8144 6766 .set_description("Enable stats on bucket listing in Swift"),
c07f9fc5 6767
11fdf7f2 6768 Option("rgw_reshard_num_logs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 6769 .set_default(16)
11fdf7f2
TL
6770 .set_min(1)
6771 .set_description("")
6772 .add_service("rgw"),
c07f9fc5 6773
11fdf7f2
TL
6774 Option("rgw_reshard_bucket_lock_duration", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6775 .set_default(360)
6776 .set_min(30)
6777 .set_description("Number of seconds the timeout on the reshard locks (bucket reshard lock and reshard log lock) are set to. As a reshard proceeds these locks can be renewed/extended. If too short, reshards cannot complete and will fail, causing a future reshard attempt. If too long a hung or crashed reshard attempt will keep the bucket locked for an extended period, not allowing RGW to detect the failed reshard attempt and recover.")
6778 .add_tag("performance")
6779 .add_service("rgw"),
9f95a23c 6780
11fdf7f2
TL
6781 Option("rgw_reshard_batch_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6782 .set_default(64)
6783 .set_min(8)
6784 .set_description("Number of reshard entries to batch together before sending the operations to the CLS back-end")
6785 .add_tag("performance")
6786 .add_service("rgw"),
6787
6788 Option("rgw_reshard_max_aio", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6789 .set_default(128)
6790 .set_min(16)
6791 .set_description("Maximum number of outstanding asynchronous I/O operations to allow at a time during resharding")
6792 .add_tag("performance")
6793 .add_service("rgw"),
c07f9fc5 6794
f64942e4
AA
6795 Option("rgw_trust_forwarded_https", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6796 .set_default(false)
6797 .set_description("Trust Forwarded and X-Forwarded-Proto headers")
6798 .set_long_description(
6799 "When a proxy in front of radosgw is used for ssl termination, radosgw "
6800 "does not know whether incoming http connections are secure. Enable "
6801 "this option to trust the Forwarded and X-Forwarded-Proto headers sent "
6802 "by the proxy when determining whether the connection is secure. This "
6803 "is required for some features, such as server side encryption.")
6804 .add_see_also("rgw_crypt_require_ssl"),
6805
d2e6a577
FG
6806 Option("rgw_crypt_require_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6807 .set_default(true)
b32b8144 6808 .set_description("Requests including encryption key headers must be sent over ssl"),
c07f9fc5 6809
b32b8144 6810 Option("rgw_crypt_default_encryption_key", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577
FG
6811 .set_default("")
6812 .set_description(""),
6813
9f95a23c
TL
6814 Option("rgw_crypt_s3_kms_backend", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6815 .set_default("barbican")
6816 .set_enum_allowed({"barbican", "vault", "testing"})
6817 .set_description(
6818 "Where the SSE-KMS encryption keys are stored. Supported KMS "
6819 "systems are OpenStack Barbican ('barbican', the default) and HashiCorp "
6820 "Vault ('vault')."),
6821
b32b8144 6822 Option("rgw_crypt_s3_kms_encryption_keys", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577
FG
6823 .set_default("")
6824 .set_description(""),
6825
9f95a23c
TL
6826 Option("rgw_crypt_vault_auth", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6827 .set_default("token")
6828 .set_enum_allowed({"token", "agent"})
6829 .set_description(
6830 "Type of authentication method to be used with Vault. ")
6831 .add_see_also({
6832 "rgw_crypt_s3_kms_backend",
6833 "rgw_crypt_vault_addr",
6834 "rgw_crypt_vault_token_file"}),
6835
6836 Option("rgw_crypt_vault_token_file", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6837 .set_default("")
6838 .set_description(
6839 "If authentication method is 'token', provide a path to the token file, "
6840 "which for security reasons should readable only by Rados Gateway.")
6841 .add_see_also({
6842 "rgw_crypt_s3_kms_backend",
6843 "rgw_crypt_vault_auth",
6844 "rgw_crypt_vault_addr"}),
6845
6846 Option("rgw_crypt_vault_addr", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6847 .set_default("")
6848 .set_description("Vault server base address.")
6849 .add_see_also({
6850 "rgw_crypt_s3_kms_backend",
6851 "rgw_crypt_vault_auth",
6852 "rgw_crypt_vault_prefix"}),
6853
6854 Option("rgw_crypt_vault_prefix", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6855 .set_default("")
6856 .set_description("Vault secret URL prefix, which can be used to restrict "
6857 "access to a particular subset of the Vault secret space.")
6858 .add_see_also({
6859 "rgw_crypt_s3_kms_backend",
6860 "rgw_crypt_vault_addr",
6861 "rgw_crypt_vault_auth"}),
6862
6863
6864 Option("rgw_crypt_vault_secret_engine", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6865 .set_enum_allowed({"kv", "transit"})
6866 .set_default("transit")
6867 .set_description(
6868 "Vault Secret Engine to be used to retrieve encryption keys.")
6869 .add_see_also({
6870 "rgw_crypt_s3_kms_backend",
6871 "rgw_crypt_vault_auth",
6872 "rgw_crypt_vault_addr"}),
6873
6874 Option("rgw_crypt_vault_namespace", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6875 .set_default("")
6876 .set_description("Vault Namespace to be used to select your tenant")
6877 .add_see_also({
6878 "rgw_crypt_s3_kms_backend",
6879 "rgw_crypt_vault_auth",
6880 "rgw_crypt_vault_addr"}),
6881
d2e6a577
FG
6882 Option("rgw_crypt_suppress_logs", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6883 .set_default(true)
b32b8144 6884 .set_description("Suppress logs that might print client key"),
d2e6a577
FG
6885
6886 Option("rgw_list_bucket_min_readahead", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6887 .set_default(1000)
b32b8144 6888 .set_description("Minimum number of entries to request from rados for bucket listing"),
c07f9fc5 6889
d2e6a577
FG
6890 Option("rgw_rest_getusage_op_compat", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6891 .set_default(false)
b32b8144 6892 .set_description("REST GetUsage request backward compatibility"),
c07f9fc5 6893
d2e6a577
FG
6894 Option("rgw_torrent_flag", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
6895 .set_default(false)
28e407b8
AA
6896 .set_description("When true, uploaded objects will calculate and store "
6897 "a SHA256 hash of object data so the object can be "
6898 "retrieved as a torrent file"),
c07f9fc5 6899
d2e6a577
FG
6900 Option("rgw_torrent_tracker", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6901 .set_default("")
11fdf7f2 6902 .set_description("Torrent field announce and announce list"),
c07f9fc5 6903
d2e6a577
FG
6904 Option("rgw_torrent_createby", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6905 .set_default("")
b32b8144 6906 .set_description("torrent field created by"),
c07f9fc5 6907
d2e6a577
FG
6908 Option("rgw_torrent_comment", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6909 .set_default("")
b32b8144 6910 .set_description("Torrent field comment"),
c07f9fc5 6911
d2e6a577
FG
6912 Option("rgw_torrent_encoding", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6913 .set_default("")
b32b8144 6914 .set_description("torrent field encoding"),
c07f9fc5 6915
d2e6a577
FG
6916 Option("rgw_data_notify_interval_msec", Option::TYPE_INT, Option::LEVEL_ADVANCED)
6917 .set_default(200)
6918 .set_description("data changes notification interval to followers"),
c07f9fc5 6919
d2e6a577
FG
6920 Option("rgw_torrent_origin", Option::TYPE_STR, Option::LEVEL_ADVANCED)
6921 .set_default("")
b32b8144 6922 .set_description("Torrent origin"),
c07f9fc5 6923
11fdf7f2 6924 Option("rgw_torrent_sha_unit", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577
FG
6925 .set_default(512*1024)
6926 .set_description(""),
c07f9fc5 6927
b32b8144 6928 Option("rgw_dynamic_resharding", Option::TYPE_BOOL, Option::LEVEL_BASIC)
181888fb 6929 .set_default(true)
b32b8144
FG
6930 .set_description("Enable dynamic resharding")
6931 .set_long_description(
6932 "If true, RGW will dynamicall increase the number of shards in buckets that have "
6933 "a high number of objects per shard.")
9f95a23c
TL
6934 .add_see_also("rgw_max_objs_per_shard")
6935 .add_see_also("rgw_max_dynamic_shards"),
c07f9fc5 6936
11fdf7f2 6937 Option("rgw_max_objs_per_shard", Option::TYPE_UINT, Option::LEVEL_BASIC)
d2e6a577 6938 .set_default(100000)
b32b8144
FG
6939 .set_description("Max objects per shard for dynamic resharding")
6940 .set_long_description(
6941 "This is the max number of objects per bucket index shard that RGW will "
6942 "allow with dynamic resharding. RGW will trigger an automatic reshard operation "
6943 "on the bucket if it exceeds this number.")
9f95a23c
TL
6944 .add_see_also("rgw_dynamic_resharding")
6945 .add_see_also("rgw_max_dynamic_shards"),
6946
6947 Option("rgw_max_dynamic_shards", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
6948 .set_default(1999)
6949 .set_min(1)
6950 .set_description("Max shards that dynamic resharding can create")
6951 .set_long_description(
6952 "This is the maximum number of bucket index shards that dynamic "
6953 "sharding is able to create on its own. This does not limit user "
6954 "requested resharding. Ideally this value is a prime number.")
6955 .add_see_also("rgw_dynamic_resharding")
6956 .add_see_also("rgw_max_objs_per_shard"),
c07f9fc5 6957
d2e6a577 6958 Option("rgw_reshard_thread_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
b32b8144 6959 .set_default(10_min)
9f95a23c 6960 .set_min(10)
11fdf7f2 6961 .set_description("Number of seconds between processing of reshard log entries"),
b32b8144
FG
6962
6963 Option("rgw_cache_expiry_interval", Option::TYPE_UINT,
6964 Option::LEVEL_ADVANCED)
11fdf7f2
TL
6965 .set_default(15_min)
6966 .set_description("Number of seconds before entries in the cache are "
6967 "assumed stale and re-fetched. Zero is never.")
b32b8144
FG
6968 .add_tag("performance")
6969 .add_service("rgw")
11fdf7f2 6970 .set_long_description("The Rados Gateway stores metadata and objects in "
b32b8144
FG
6971 "an internal cache. This should be kept consistent "
6972 "by the OSD's relaying notify events between "
6973 "multiple watching RGW processes. In the event "
6974 "that this notification protocol fails, bounding "
6975 "the length of time that any data in the cache will "
6976 "be assumed valid will ensure that any RGW instance "
6977 "that falls out of sync will eventually recover. "
6978 "This seems to be an issue mostly for large numbers "
6979 "of RGW instances under heavy use. If you would like "
6980 "to turn off cache expiry, set this value to zero."),
6981
11fdf7f2
TL
6982 Option("rgw_inject_notify_timeout_probability", Option::TYPE_FLOAT,
6983 Option::LEVEL_DEV)
6984 .set_default(0)
6985 .add_tag("fault injection")
6986 .add_tag("testing")
6987 .add_service("rgw")
6988 .set_min_max(0.0, 1.0)
6989 .set_description("Likelihood of ignoring a notify")
6990 .set_long_description("This is the probability that the RGW cache will "
6991 "ignore a cache notify message. It exists to help "
6992 "with the development and testing of cache "
6993 "consistency and recovery improvements. Please "
6994 "do not set it in a production cluster, as it "
6995 "actively causes failures. Set this to a floating "
6996 "point value between 0 and 1."),
6997 Option("rgw_max_notify_retries", Option::TYPE_UINT,
6998 Option::LEVEL_ADVANCED)
6999 .set_default(3)
7000 .add_tag("error recovery")
7001 .add_service("rgw")
7002 .set_description("Number of attempts to notify peers before giving up.")
7003 .set_long_description("The number of times we will attempt to update "
7004 "a peer's cache in the event of error before giving "
7005 "up. This is unlikely to be an issue unless your "
7006 "cluster is very heavily loaded. Beware that "
7007 "increasing this value may cause some operations to "
7008 "take longer in exceptional cases and thus may, "
7009 "rarely, cause clients to time out."),
7010 Option("rgw_sts_entry", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7011 .set_default("sts")
7012 .set_description("STS URL prefix")
7013 .set_long_description("URL path prefix for internal STS requests."),
7014
7015 Option("rgw_sts_key", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7016 .set_default("sts")
7017 .set_description("STS Key")
7018 .set_long_description("Key used for encrypting/ decrypting session token."),
7019
7020 Option("rgw_s3_auth_use_sts", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7021 .set_default(false)
7022 .set_description("Should S3 authentication use STS."),
7023
7024 Option("rgw_sts_max_session_duration", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7025 .set_default(43200)
7026 .set_description("Session token max duration")
7027 .set_long_description("Max duration in seconds for which the session token is valid."),
7028
f64942e4
AA
7029 Option("rgw_max_listing_results", Option::TYPE_UINT,
7030 Option::LEVEL_ADVANCED)
7031 .set_default(1000)
7032 .set_min_max(1, 100000)
7033 .add_service("rgw")
7034 .set_description("Upper bound on results in listing operations, ListBucket max-keys")
7035 .set_long_description("This caps the maximum permitted value for listing-like operations in RGW S3. "
7036 "Affects ListBucket(max-keys), "
7037 "ListBucketVersions(max-keys), "
9f95a23c 7038 "ListBucketMultipartUploads(max-uploads), "
f64942e4 7039 "ListMultipartUploadParts(max-parts)"),
11fdf7f2
TL
7040
7041 Option("rgw_sts_token_introspection_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7042 .set_default("")
7043 .set_description("STS Web Token introspection URL")
7044 .set_long_description("URL for introspecting an STS Web Token."),
7045
7046 Option("rgw_sts_client_id", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7047 .set_default("")
7048 .set_description("Client Id")
7049 .set_long_description("Client Id needed for introspecting a Web Token."),
7050
7051 Option("rgw_sts_client_secret", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7052 .set_default("")
7053 .set_description("Client Secret")
7054 .set_long_description("Client Secret needed for introspecting a Web Token."),
7055
7056 Option("rgw_max_concurrent_requests", Option::TYPE_INT, Option::LEVEL_BASIC)
7057 .set_default(1024)
7058 .set_description("Maximum number of concurrent HTTP requests.")
7059 .set_long_description(
7060 "Maximum number of concurrent HTTP requests that the beast frontend "
7061 "will process. Tuning this can help to limit memory usage under heavy "
7062 "load.")
7063 .add_tag("performance")
7064 .add_see_also("rgw_frontends"),
7065
7066 Option("rgw_scheduler_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7067 .set_default("throttler")
7068 .set_description("Set the type of dmclock scheduler, defaults to throttler "
7069 "Other valid values are dmclock which is experimental"),
7070
7071 Option("rgw_dmclock_admin_res", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7072 .set_default(100.0)
7073 .set_description("mclock reservation for admin requests")
7074 .add_see_also("rgw_dmclock_admin_wgt")
7075 .add_see_also("rgw_dmclock_admin_lim"),
7076
7077 Option("rgw_dmclock_admin_wgt", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7078 .set_default(100.0)
7079 .set_description("mclock weight for admin requests")
7080 .add_see_also("rgw_dmclock_admin_res")
7081 .add_see_also("rgw_dmclock_admin_lim"),
7082
7083 Option("rgw_dmclock_admin_lim", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7084 .set_default(0.0)
7085 .set_description("mclock limit for admin requests")
7086 .add_see_also("rgw_dmclock_admin_res")
7087 .add_see_also("rgw_dmclock_admin_wgt"),
7088
7089 Option("rgw_dmclock_auth_res", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7090 .set_default(200.0)
7091 .set_description("mclock reservation for object data requests")
7092 .add_see_also("rgw_dmclock_auth_wgt")
7093 .add_see_also("rgw_dmclock_auth_lim"),
7094
7095 Option("rgw_dmclock_auth_wgt", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7096 .set_default(100.0)
7097 .set_description("mclock weight for object data requests")
7098 .add_see_also("rgw_dmclock_auth_res")
7099 .add_see_also("rgw_dmclock_auth_lim"),
7100
7101 Option("rgw_dmclock_auth_lim", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7102 .set_default(0.0)
7103 .set_description("mclock limit for object data requests")
7104 .add_see_also("rgw_dmclock_auth_res")
7105 .add_see_also("rgw_dmclock_auth_wgt"),
7106
7107 Option("rgw_dmclock_data_res", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7108 .set_default(500.0)
7109 .set_description("mclock reservation for object data requests")
7110 .add_see_also("rgw_dmclock_data_wgt")
7111 .add_see_also("rgw_dmclock_data_lim"),
7112
7113 Option("rgw_dmclock_data_wgt", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7114 .set_default(500.0)
7115 .set_description("mclock weight for object data requests")
7116 .add_see_also("rgw_dmclock_data_res")
7117 .add_see_also("rgw_dmclock_data_lim"),
7118
7119 Option("rgw_dmclock_data_lim", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7120 .set_default(0.0)
7121 .set_description("mclock limit for object data requests")
7122 .add_see_also("rgw_dmclock_data_res")
7123 .add_see_also("rgw_dmclock_data_wgt"),
7124
7125 Option("rgw_dmclock_metadata_res", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7126 .set_default(500.0)
7127 .set_description("mclock reservation for metadata requests")
7128 .add_see_also("rgw_dmclock_metadata_wgt")
7129 .add_see_also("rgw_dmclock_metadata_lim"),
7130
7131 Option("rgw_dmclock_metadata_wgt", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7132 .set_default(500.0)
7133 .set_description("mclock weight for metadata requests")
7134 .add_see_also("rgw_dmclock_metadata_res")
7135 .add_see_also("rgw_dmclock_metadata_lim"),
7136
7137 Option("rgw_dmclock_metadata_lim", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7138 .set_default(0.0)
7139 .set_description("mclock limit for metadata requests")
7140 .add_see_also("rgw_dmclock_metadata_res")
7141 .add_see_also("rgw_dmclock_metadata_wgt"),
d2e6a577
FG
7142 });
7143}
c07f9fc5 7144
d2e6a577
FG
7145static std::vector<Option> get_rbd_options() {
7146 return std::vector<Option>({
7147 Option("rbd_default_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7148 .set_default("rbd")
181888fb 7149 .set_description("default pool for storing new images")
d2e6a577 7150 .set_validator([](std::string *value, std::string *error_message){
11fdf7f2
TL
7151 std::regex pattern("^[^@/]+$");
7152 if (!std::regex_match (*value, pattern)) {
d2e6a577
FG
7153 *value = "rbd";
7154 *error_message = "invalid RBD default pool, resetting to 'rbd'";
7155 }
7156 return 0;
7157 }),
7158
7159 Option("rbd_default_data_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7160 .set_default("")
181888fb 7161 .set_description("default pool for storing data blocks for new images")
d2e6a577 7162 .set_validator([](std::string *value, std::string *error_message){
11fdf7f2
TL
7163 std::regex pattern("^[^@/]*$");
7164 if (!std::regex_match (*value, pattern)) {
d2e6a577
FG
7165 *value = "";
7166 *error_message = "ignoring invalid RBD data pool";
7167 }
7168 return 0;
7169 }),
7170
7171 Option("rbd_default_features", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7172 .set_default("layering,exclusive-lock,object-map,fast-diff,deep-flatten")
181888fb
FG
7173 .set_description("default v2 image features for new images")
7174 .set_long_description(
7175 "RBD features are only applicable for v2 images. This setting accepts "
7176 "either an integer bitmask value or comma-delimited string of RBD "
7177 "feature names. This setting is always internally stored as an integer "
7178 "bitmask value. The mapping between feature bitmask value and feature "
7179 "name is as follows: +1 -> layering, +2 -> striping, "
7180 "+4 -> exclusive-lock, +8 -> object-map, +16 -> fast-diff, "
7181 "+32 -> deep-flatten, +64 -> journaling, +128 -> data-pool")
11fdf7f2
TL
7182 .set_flag(Option::FLAG_RUNTIME)
7183 .set_validator([](std::string *value, std::string *error_message) {
7184 ostringstream ss;
7185 uint64_t features = librbd::rbd_features_from_string(*value, &ss);
7186 // Leave this in integer form to avoid breaking Cinder. Someday
7187 // we would like to present this in string form instead...
7188 *value = stringify(features);
7189 if (ss.str().size()) {
7190 return -EINVAL;
7191 }
7192 return 0;
7193 }),
7194
7195 Option("rbd_op_threads", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7196 .set_default(1)
181888fb 7197 .set_description("number of threads to utilize for internal processing"),
d2e6a577 7198
11fdf7f2 7199 Option("rbd_op_thread_timeout", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7200 .set_default(60)
181888fb 7201 .set_description("time in seconds for detecting a hung thread"),
d2e6a577 7202
9f95a23c
TL
7203 Option("rbd_disable_zero_copy_writes", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7204 .set_default(true)
7205 .set_description("Disable the use of zero-copy writes to ensure unstable "
7206 "writes from clients cannot cause a CRC mismatch"),
7207
d2e6a577
FG
7208 Option("rbd_non_blocking_aio", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7209 .set_default(true)
181888fb 7210 .set_description("process AIO ops from a dispatch thread to prevent blocking"),
d2e6a577
FG
7211
7212 Option("rbd_cache", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7213 .set_default(true)
181888fb 7214 .set_description("whether to enable caching (writeback unless rbd_cache_max_dirty is 0)"),
d2e6a577 7215
9f95a23c
TL
7216 Option("rbd_cache_policy", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7217 .set_enum_allowed({"writethrough", "writeback", "writearound"})
7218 .set_default("writearound")
7219 .set_description("cache policy for handling writes."),
7220
d2e6a577
FG
7221 Option("rbd_cache_writethrough_until_flush", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7222 .set_default(true)
181888fb
FG
7223 .set_description("whether to make writeback caching writethrough until "
7224 "flush is called, to be sure the user of librbd will send "
7225 "flushes so that writeback is safe"),
d2e6a577 7226
11fdf7f2
TL
7227 Option("rbd_cache_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
7228 .set_default(32_M)
181888fb 7229 .set_description("cache size in bytes"),
d2e6a577 7230
11fdf7f2
TL
7231 Option("rbd_cache_max_dirty", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
7232 .set_default(24_M)
181888fb 7233 .set_description("dirty limit in bytes - set to 0 for write-through caching"),
d2e6a577 7234
11fdf7f2
TL
7235 Option("rbd_cache_target_dirty", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
7236 .set_default(16_M)
181888fb 7237 .set_description("target dirty limit in bytes"),
d2e6a577
FG
7238
7239 Option("rbd_cache_max_dirty_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7240 .set_default(1.0)
181888fb 7241 .set_description("seconds in cache before writeback starts"),
d2e6a577 7242
11fdf7f2 7243 Option("rbd_cache_max_dirty_object", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7244 .set_default(0)
181888fb 7245 .set_description("dirty limit for objects - set to 0 for auto calculate from rbd_cache_size"),
d2e6a577
FG
7246
7247 Option("rbd_cache_block_writes_upfront", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7248 .set_default(false)
181888fb 7249 .set_description("whether to block writes to the cache before the aio_write call completes"),
d2e6a577 7250
9f95a23c
TL
7251 Option("rbd_parent_cache_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7252 .set_default(false)
7253 .set_description("whether to enable rbd shared ro cache"),
7254
11fdf7f2 7255 Option("rbd_concurrent_management_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577
FG
7256 .set_default(10)
7257 .set_min(1)
181888fb 7258 .set_description("how many operations can be in flight for a management operation like deleting or resizing an image"),
c07f9fc5 7259
d2e6a577
FG
7260 Option("rbd_balance_snap_reads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7261 .set_default(false)
181888fb 7262 .set_description("distribute snap read requests to random OSD"),
c07f9fc5 7263
d2e6a577
FG
7264 Option("rbd_localize_snap_reads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7265 .set_default(false)
181888fb 7266 .set_description("localize snap read requests to closest OSD"),
c07f9fc5 7267
d2e6a577
FG
7268 Option("rbd_balance_parent_reads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7269 .set_default(false)
181888fb 7270 .set_description("distribute parent read requests to random OSD"),
c07f9fc5 7271
d2e6a577
FG
7272 Option("rbd_localize_parent_reads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7273 .set_default(false)
181888fb 7274 .set_description("localize parent requests to closest OSD"),
c07f9fc5 7275
11fdf7f2 7276 Option("rbd_sparse_read_threshold_bytes", Option::TYPE_SIZE,
b32b8144
FG
7277 Option::LEVEL_ADVANCED)
7278 .set_default(64_K)
7279 .set_description("threshold for issuing a sparse-read")
7280 .set_long_description("minimum number of sequential bytes to read against "
7281 "an object before issuing a sparse-read request to "
11fdf7f2 7282 "the cluster. 0 implies it must be a full object read "
b32b8144
FG
7283 "to issue a sparse-read, 1 implies always use "
7284 "sparse-read, and any value larger than the maximum "
7285 "object size will disable sparse-read for all "
7286 "requests"),
7287
11fdf7f2 7288 Option("rbd_readahead_trigger_requests", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7289 .set_default(10)
181888fb 7290 .set_description("number of sequential requests necessary to trigger readahead"),
c07f9fc5 7291
11fdf7f2 7292 Option("rbd_readahead_max_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 7293 .set_default(512_K)
181888fb 7294 .set_description("set to 0 to disable readahead"),
c07f9fc5 7295
11fdf7f2 7296 Option("rbd_readahead_disable_after_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 7297 .set_default(50_M)
181888fb 7298 .set_description("how many bytes are read in total before readahead is disabled"),
c07f9fc5 7299
d2e6a577
FG
7300 Option("rbd_clone_copy_on_read", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7301 .set_default(false)
181888fb 7302 .set_description("copy-up parent image blocks to clone upon read request"),
c07f9fc5 7303
d2e6a577
FG
7304 Option("rbd_blacklist_on_break_lock", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7305 .set_default(true)
181888fb 7306 .set_description("whether to blacklist clients whose lock was broken"),
c07f9fc5 7307
11fdf7f2 7308 Option("rbd_blacklist_expire_seconds", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7309 .set_default(0)
181888fb 7310 .set_description("number of seconds to blacklist - set to 0 for OSD default"),
c07f9fc5 7311
11fdf7f2 7312 Option("rbd_request_timed_out_seconds", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7313 .set_default(30)
181888fb 7314 .set_description("number of seconds before maintenance request times out"),
c07f9fc5 7315
d2e6a577 7316 Option("rbd_skip_partial_discard", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
11fdf7f2
TL
7317 .set_default(true)
7318 .set_description("skip discard (zero) of unaligned extents within an object"),
7319
7320 Option("rbd_discard_granularity_bytes", Option::TYPE_UINT,
7321 Option::LEVEL_ADVANCED)
7322 .set_default(64_K)
7323 .set_min_max(4_K, 32_M)
7324 .set_validator([](std::string *value, std::string *error_message){
7325 uint64_t f = strict_si_cast<uint64_t>(value->c_str(), error_message);
7326 if (!error_message->empty()) {
7327 return -EINVAL;
7328 } else if (!isp2(f)) {
7329 *error_message = "value must be a power of two";
7330 return -EINVAL;
7331 }
7332 return 0;
7333 })
7334 .set_description("minimum aligned size of discard operations"),
c07f9fc5 7335
d2e6a577
FG
7336 Option("rbd_enable_alloc_hint", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7337 .set_default(true)
181888fb 7338 .set_description("when writing a object, it will issue a hint to osd backend to indicate the expected size object need"),
c07f9fc5 7339
92f5a8d4
TL
7340 Option("rbd_compression_hint", Option::TYPE_STR, Option::LEVEL_BASIC)
7341 .set_enum_allowed({"none", "compressible", "incompressible"})
7342 .set_default("none")
7343 .set_description("Compression hint to send to the OSDs during writes")
7344 .set_flag(Option::FLAG_RUNTIME),
7345
9f95a23c
TL
7346 Option("rbd_read_from_replica_policy", Option::TYPE_STR, Option::LEVEL_BASIC)
7347 .set_enum_allowed({"default", "balance", "localize"})
7348 .set_default("default")
7349 .set_description("Read replica policy send to the OSDS during reads")
7350 .set_flag(Option::FLAG_RUNTIME),
7351
d2e6a577
FG
7352 Option("rbd_tracing", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7353 .set_default(false)
181888fb 7354 .set_description("true if LTTng-UST tracepoints should be enabled"),
c07f9fc5 7355
d2e6a577
FG
7356 Option("rbd_blkin_trace_all", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7357 .set_default(false)
181888fb 7358 .set_description("create a blkin trace for all RBD requests"),
c07f9fc5 7359
d2e6a577
FG
7360 Option("rbd_validate_pool", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7361 .set_default(true)
181888fb 7362 .set_description("validate empty pools for RBD compatibility"),
c07f9fc5 7363
d2e6a577
FG
7364 Option("rbd_validate_names", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7365 .set_default(true)
181888fb 7366 .set_description("validate new image names for RBD compatibility"),
d2e6a577
FG
7367
7368 Option("rbd_auto_exclusive_lock_until_manual_request", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7369 .set_default(true)
181888fb 7370 .set_description("automatically acquire/release exclusive lock until it is explicitly requested"),
d2e6a577 7371
11fdf7f2
TL
7372 Option("rbd_move_to_trash_on_remove", Option::TYPE_BOOL, Option::LEVEL_BASIC)
7373 .set_default(false)
7374 .set_description("automatically move images to the trash when deleted"),
7375
7376 Option("rbd_move_to_trash_on_remove_expire_seconds", Option::TYPE_UINT, Option::LEVEL_BASIC)
7377 .set_default(0)
7378 .set_description("default number of seconds to protect deleted images in the trash"),
7379
9f95a23c
TL
7380 Option("rbd_move_parent_to_trash_on_remove", Option::TYPE_BOOL, Option::LEVEL_BASIC)
7381 .set_default(false)
7382 .set_description("move parent with clone format v2 children to the trash when deleted"),
7383
d2e6a577
FG
7384 Option("rbd_mirroring_resync_after_disconnect", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7385 .set_default(false)
181888fb 7386 .set_description("automatically start image resync after mirroring is disconnected due to being laggy"),
d2e6a577 7387
11fdf7f2
TL
7388 Option("rbd_mirroring_delete_delay", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7389 .set_default(0)
7390 .set_description("time-delay in seconds for rbd-mirror delete propagation"),
7391
7392 Option("rbd_mirroring_replay_delay", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7393 .set_default(0)
181888fb 7394 .set_description("time-delay in seconds for rbd-mirror asynchronous replication"),
d2e6a577 7395
9f95a23c
TL
7396 Option("rbd_mirroring_max_mirroring_snapshots", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7397 .set_default(3)
7398 .set_min(3)
7399 .set_description("mirroring snapshots limit"),
7400
11fdf7f2 7401 Option("rbd_default_format", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7402 .set_default(2)
181888fb 7403 .set_description("default image format for new images"),
d2e6a577 7404
11fdf7f2 7405 Option("rbd_default_order", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7406 .set_default(22)
181888fb 7407 .set_description("default order (data block object size) for new images"),
d2e6a577
FG
7408
7409 Option("rbd_default_stripe_count", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7410 .set_default(0)
181888fb 7411 .set_description("default stripe count for new images"),
d2e6a577 7412
11fdf7f2 7413 Option("rbd_default_stripe_unit", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 7414 .set_default(0)
181888fb 7415 .set_description("default stripe width for new images"),
d2e6a577
FG
7416
7417 Option("rbd_default_map_options", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7418 .set_default("")
181888fb 7419 .set_description("default krbd map options"),
c07f9fc5 7420
11fdf7f2
TL
7421 Option("rbd_default_clone_format", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7422 .set_enum_allowed({"1", "2", "auto"})
7423 .set_default("auto")
7424 .set_description("default internal format for handling clones")
7425 .set_long_description("This sets the internal format for tracking cloned "
7426 "images. The setting of '1' requires attaching to "
7427 "protected snapshots that cannot be removed until "
7428 "the clone is removed/flattened. The setting of '2' "
7429 "will allow clones to be attached to any snapshot "
7430 "and permits removing in-use parent snapshots but "
7431 "requires Mimic or later clients. The default "
7432 "setting of 'auto' will use the v2 format if the "
7433 "cluster is configured to require mimic or later "
7434 "clients.")
7435 .set_flag(Option::FLAG_RUNTIME),
7436
d2e6a577 7437 Option("rbd_journal_order", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
a8e16298 7438 .set_min_max(12, 26)
d2e6a577 7439 .set_default(24)
181888fb 7440 .set_description("default order (object size) for journal data objects"),
c07f9fc5 7441
d2e6a577
FG
7442 Option("rbd_journal_splay_width", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7443 .set_default(4)
181888fb 7444 .set_description("number of active journal objects"),
c07f9fc5 7445
d2e6a577
FG
7446 Option("rbd_journal_commit_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7447 .set_default(5)
181888fb 7448 .set_description("commit time interval, seconds"),
c07f9fc5 7449
494da23a
TL
7450 Option("rbd_journal_object_writethrough_until_flush", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7451 .set_default(true)
7452 .set_description("when enabled, the rbd_journal_object_flush* configuration "
7453 "options are ignored until the first flush so that batched "
7454 "journal IO is known to be safe for consistency"),
7455
11fdf7f2 7456 Option("rbd_journal_object_flush_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7457 .set_default(0)
181888fb 7458 .set_description("maximum number of pending commits per journal object"),
c07f9fc5 7459
11fdf7f2 7460 Option("rbd_journal_object_flush_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
494da23a 7461 .set_default(1_M)
181888fb 7462 .set_description("maximum number of pending bytes per journal object"),
c07f9fc5 7463
d2e6a577
FG
7464 Option("rbd_journal_object_flush_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7465 .set_default(0)
181888fb 7466 .set_description("maximum age (in seconds) for pending commits"),
c07f9fc5 7467
11fdf7f2
TL
7468 Option("rbd_journal_object_max_in_flight_appends", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7469 .set_default(0)
7470 .set_description("maximum number of in-flight appends per journal object"),
7471
d2e6a577
FG
7472 Option("rbd_journal_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7473 .set_default("")
181888fb 7474 .set_description("pool for journal objects"),
c07f9fc5 7475
11fdf7f2 7476 Option("rbd_journal_max_payload_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 7477 .set_default(16384)
181888fb 7478 .set_description("maximum journal payload size before splitting"),
c07f9fc5 7479
11fdf7f2 7480 Option("rbd_journal_max_concurrent_object_sets", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7481 .set_default(0)
181888fb 7482 .set_description("maximum number of object sets a journal client can be behind before it is automatically unregistered"),
11fdf7f2
TL
7483
7484 Option("rbd_qos_iops_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7485 .set_default(0)
7486 .set_description("the desired limit of IO operations per second"),
7487
7488 Option("rbd_qos_bps_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7489 .set_default(0)
7490 .set_description("the desired limit of IO bytes per second"),
7491
7492 Option("rbd_qos_read_iops_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7493 .set_default(0)
7494 .set_description("the desired limit of read operations per second"),
7495
7496 Option("rbd_qos_write_iops_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7497 .set_default(0)
7498 .set_description("the desired limit of write operations per second"),
7499
7500 Option("rbd_qos_read_bps_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7501 .set_default(0)
7502 .set_description("the desired limit of read bytes per second"),
7503
7504 Option("rbd_qos_write_bps_limit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7505 .set_default(0)
7506 .set_description("the desired limit of write bytes per second"),
7507
7508 Option("rbd_qos_iops_burst", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7509 .set_default(0)
7510 .set_description("the desired burst limit of IO operations"),
7511
7512 Option("rbd_qos_bps_burst", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7513 .set_default(0)
7514 .set_description("the desired burst limit of IO bytes"),
7515
7516 Option("rbd_qos_read_iops_burst", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7517 .set_default(0)
7518 .set_description("the desired burst limit of read operations"),
7519
7520 Option("rbd_qos_write_iops_burst", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7521 .set_default(0)
7522 .set_description("the desired burst limit of write operations"),
7523
7524 Option("rbd_qos_read_bps_burst", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7525 .set_default(0)
7526 .set_description("the desired burst limit of read bytes"),
7527
7528 Option("rbd_qos_write_bps_burst", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7529 .set_default(0)
7530 .set_description("the desired burst limit of write bytes"),
7531
7532 Option("rbd_qos_schedule_tick_min", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7533 .set_default(50)
7534 .set_min(1)
7535 .set_description("minimum schedule tick (in milliseconds) for QoS"),
7536
7537 Option("rbd_discard_on_zeroed_write_same", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7538 .set_default(true)
7539 .set_description("discard data on zeroed write same instead of writing zero"),
7540
7541 Option("rbd_mtime_update_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7542 .set_default(60)
7543 .set_min(0)
7544 .set_description("RBD Image modify timestamp refresh interval. Set to 0 to disable modify timestamp update."),
7545
7546 Option("rbd_atime_update_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7547 .set_default(60)
7548 .set_min(0)
7549 .set_description("RBD Image access timestamp refresh interval. Set to 0 to disable access timestamp update."),
9f95a23c
TL
7550
7551 Option("rbd_io_scheduler", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7552 .set_default("simple")
7553 .set_enum_allowed({"none", "simple"})
7554 .set_description("RBD IO scheduler"),
7555
7556 Option("rbd_io_scheduler_simple_max_delay", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7557 .set_default(0)
7558 .set_min(0)
7559 .set_description("maximum io delay (in milliseconds) for simple io scheduler (if set to 0 dalay is calculated based on latency stats)"),
7560
7561 Option("rbd_rwl_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7562 .set_default(false)
7563 .set_description("enable persistent write back cache for this volume"),
7564
7565 Option("rbd_rwl_log_periodic_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7566 .set_default(false)
7567 .set_description("emit periodic perf stats to debug log"),
7568
7569 Option("rbd_rwl_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7570 .set_default(1073741824)
7571 .set_min(1073741824)
7572 .set_description("size of the persistent write back cache for this volume"),
7573
7574 Option("rbd_rwl_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7575 .set_default("/tmp")
7576 .set_description("location of the persistent write back cache in a DAX-enabled filesystem on persistent memory"),
f6b5b4d7
TL
7577
7578 Option("rbd_config_pool_override_update_timestamp", Option::TYPE_UINT,
7579 Option::LEVEL_DEV)
7580 .set_default(0)
7581 .set_description("timestamp of last update to pool-level config overrides"),
7582
181888fb
FG
7583 });
7584}
c07f9fc5 7585
181888fb
FG
7586static std::vector<Option> get_rbd_mirror_options() {
7587 return std::vector<Option>({
d2e6a577
FG
7588 Option("rbd_mirror_journal_commit_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7589 .set_default(5)
181888fb 7590 .set_description("commit time interval, seconds"),
c07f9fc5 7591
d2e6a577
FG
7592 Option("rbd_mirror_journal_poll_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7593 .set_default(5)
181888fb 7594 .set_description("maximum age (in seconds) between successive journal polls"),
c07f9fc5 7595
d2e6a577
FG
7596 Option("rbd_mirror_sync_point_update_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7597 .set_default(30)
181888fb 7598 .set_description("number of seconds between each update of the image sync point object number"),
c07f9fc5 7599
d2e6a577
FG
7600 Option("rbd_mirror_concurrent_image_syncs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7601 .set_default(5)
181888fb 7602 .set_description("maximum number of image syncs in parallel"),
c07f9fc5 7603
11fdf7f2 7604 Option("rbd_mirror_pool_replayers_refresh_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7605 .set_default(30)
181888fb 7606 .set_description("interval to refresh peers in rbd-mirror daemon"),
c07f9fc5 7607
11fdf7f2
TL
7608 Option("rbd_mirror_concurrent_image_deletions", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7609 .set_default(1)
7610 .set_min(1)
7611 .set_description("maximum number of image deletions in parallel"),
7612
d2e6a577
FG
7613 Option("rbd_mirror_delete_retry_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7614 .set_default(30)
11fdf7f2 7615 .set_description("interval to check and retry the failed deletion requests"),
c07f9fc5 7616
11fdf7f2 7617 Option("rbd_mirror_image_state_check_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577
FG
7618 .set_default(30)
7619 .set_min(1)
181888fb 7620 .set_description("interval to get images from pool watcher and set sources in replayer"),
d2e6a577 7621
11fdf7f2 7622 Option("rbd_mirror_leader_heartbeat_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577
FG
7623 .set_default(5)
7624 .set_min(1)
181888fb 7625 .set_description("interval (in seconds) between mirror leader heartbeats"),
d2e6a577 7626
11fdf7f2 7627 Option("rbd_mirror_leader_max_missed_heartbeats", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7628 .set_default(2)
181888fb 7629 .set_description("number of missed heartbeats for non-lock owner to attempt to acquire lock"),
d2e6a577 7630
11fdf7f2 7631 Option("rbd_mirror_leader_max_acquire_attempts_before_break", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
d2e6a577 7632 .set_default(3)
181888fb 7633 .set_description("number of failed attempts to acquire lock after missing heartbeats before breaking lock"),
11fdf7f2
TL
7634
7635 Option("rbd_mirror_image_policy_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7636 .set_default("simple")
7637 .set_enum_allowed({"none", "simple"})
7638 .set_description("active/active policy type for mapping images to instances"),
7639
7640 Option("rbd_mirror_image_policy_migration_throttle", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7641 .set_default(300)
7642 .set_description("number of seconds after which an image can be reshuffled (migrated) again"),
7643
7644 Option("rbd_mirror_image_policy_update_throttle_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7645 .set_default(1)
7646 .set_min(1)
7647 .set_description("interval (in seconds) to throttle images for mirror daemon peer updates"),
7648
7649 Option("rbd_mirror_image_policy_rebalance_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7650 .set_default(0)
7651 .set_description("number of seconds policy should be idle before trigerring reshuffle (rebalance) of images"),
7652
7653 Option("rbd_mirror_perf_stats_prio", Option::TYPE_INT, Option::LEVEL_ADVANCED)
7654 .set_default((int64_t)PerfCountersBuilder::PRIO_USEFUL)
7655 .set_description("Priority level for mirror daemon replication perf counters")
7656 .set_long_description("The daemon will send perf counter data to the "
7657 "manager daemon if the priority is not lower than "
7658 "mgr_stats_threshold.")
7659 .set_min_max((int64_t)PerfCountersBuilder::PRIO_DEBUGONLY,
7660 (int64_t)PerfCountersBuilder::PRIO_CRITICAL + 1),
9f95a23c
TL
7661
7662 Option("rbd_mirror_image_perf_stats_prio", Option::TYPE_INT, Option::LEVEL_ADVANCED)
7663 .set_default((int64_t)PerfCountersBuilder::PRIO_USEFUL)
7664 .set_description("Priority level for mirror daemon per-image replication perf counters")
7665 .set_long_description("The daemon will send per-image perf counter data to the "
7666 "manager daemon if the priority is not lower than "
7667 "mgr_stats_threshold.")
7668 .set_min_max((int64_t)PerfCountersBuilder::PRIO_DEBUGONLY,
7669 (int64_t)PerfCountersBuilder::PRIO_CRITICAL + 1),
7670
7671 Option("rbd_mirror_memory_autotune", Option::TYPE_BOOL, Option::LEVEL_DEV)
7672 .set_default(true)
7673 .add_see_also("rbd_mirror_memory_target")
7674 .set_description("Automatically tune the ratio of caches while respecting min values."),
7675
7676 Option("rbd_mirror_memory_target", Option::TYPE_SIZE, Option::LEVEL_BASIC)
7677 .set_default(4_G)
7678 .add_see_also("rbd_mirror_memory_autotune")
7679 .set_description("When tcmalloc and cache autotuning is enabled, try to keep this many bytes mapped in memory."),
7680
7681 Option("rbd_mirror_memory_base", Option::TYPE_SIZE, Option::LEVEL_DEV)
7682 .set_default(768_M)
7683 .add_see_also("rbd_mirror_memory_autotune")
7684 .set_description("When tcmalloc and cache autotuning is enabled, estimate the minimum amount of memory in bytes the rbd-mirror daemon will need."),
7685
7686 Option("rbd_mirror_memory_expected_fragmentation", Option::TYPE_FLOAT, Option::LEVEL_DEV)
7687 .set_default(0.15)
7688 .set_min_max(0.0, 1.0)
7689 .add_see_also("rbd_mirror_memory_autotune")
7690 .set_description("When tcmalloc and cache autotuning is enabled, estimate the percent of memory fragmentation."),
7691
7692 Option("rbd_mirror_memory_cache_min", Option::TYPE_SIZE, Option::LEVEL_DEV)
7693 .set_default(128_M)
7694 .add_see_also("rbd_mirror_memory_autotune")
7695 .set_description("When tcmalloc and cache autotuning is enabled, set the minimum amount of memory used for cache."),
7696
7697 Option("rbd_mirror_memory_cache_resize_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
7698 .set_default(5)
7699 .add_see_also("rbd_mirror_memory_autotune")
7700 .set_description("When tcmalloc and cache autotuning is enabled, wait this many seconds between resizing caches."),
7701
7702 Option("rbd_mirror_memory_cache_autotune_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
7703 .set_default(30)
7704 .add_see_also("rbd_mirror_memory_autotune")
7705 .set_description("The number of seconds to wait between rebalances when cache autotune is enabled."),
7706 });
7707}
7708
7709static std::vector<Option> get_immutable_object_cache_options() {
7710 return std::vector<Option>({
7711 Option("immutable_object_cache_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
f6b5b4d7 7712 .set_default("/tmp/ceph_immutable_object_cache")
9f95a23c
TL
7713 .set_description("immutable object cache data dir"),
7714
7715 Option("immutable_object_cache_sock", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7716 .set_default("/var/run/ceph/immutable_object_cache_sock")
7717 .set_description("immutable object cache domain socket"),
7718
7719 Option("immutable_object_cache_max_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
7720 .set_default(1_G)
7721 .set_description("max immutable object cache data size"),
7722
7723 Option("immutable_object_cache_max_inflight_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7724 .set_default(128)
7725 .set_description("max inflight promoting requests for immutable object cache daemon"),
7726
7727 Option("immutable_object_cache_client_dedicated_thread_num", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7728 .set_default(2)
7729 .set_description("immutable object cache client dedicated thread number"),
7730
7731 Option("immutable_object_cache_watermark", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7732 .set_default(0.1)
7733 .set_description("immutable object cache water mark"),
d2e6a577
FG
7734 });
7735}
7736
7737std::vector<Option> get_mds_options() {
7738 return std::vector<Option>({
9f95a23c
TL
7739 Option("mds_numa_node", Option::TYPE_INT, Option::LEVEL_ADVANCED)
7740 .set_default(-1)
7741 .set_flag(Option::FLAG_STARTUP)
7742 .set_description("set mds's cpu affinity to a numa node (-1 for none)"),
7743
d2e6a577
FG
7744 Option("mds_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
7745 .set_default("/var/lib/ceph/mds/$cluster-$id")
11fdf7f2
TL
7746 .set_flag(Option::FLAG_NO_MON_UPDATE)
7747 .set_description("path to MDS data and keyring"),
c07f9fc5 7748
9f95a23c
TL
7749 Option("mds_join_fs", Option::TYPE_STR, Option::LEVEL_BASIC)
7750 .set_default("")
7751 .set_description("file system MDS prefers to join")
7752 .set_long_description("This setting indicates which file system name the MDS should prefer to join (affinity). The monitors will try to have the MDS cluster safely reach a state where all MDS have strong affinity, even via failovers to a standby.")
7753 .set_flag(Option::FLAG_RUNTIME),
7754
11fdf7f2
TL
7755 Option("mds_max_xattr_pairs_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
7756 .set_default(64_K)
7757 .set_description("maximum aggregate size of extended attributes on a file"),
c07f9fc5 7758
eafe8130
TL
7759 Option("mds_cache_trim_interval", Option::TYPE_SECS, Option::LEVEL_ADVANCED)
7760 .set_default(1)
92f5a8d4
TL
7761 .set_description("interval in seconds between cache trimming")
7762 .set_flag(Option::FLAG_RUNTIME),
7763
7764 Option("mds_cache_release_free_interval", Option::TYPE_SECS, Option::LEVEL_DEV)
7765 .set_default(10)
7766 .set_description("interval in seconds between heap releases")
7767 .set_flag(Option::FLAG_RUNTIME),
eafe8130 7768
11fdf7f2 7769 Option("mds_cache_memory_limit", Option::TYPE_SIZE, Option::LEVEL_BASIC)
9f95a23c 7770 .set_default(4_G)
181888fb 7771 .set_description("target maximum memory usage of MDS cache")
9f95a23c 7772 .set_flag(Option::FLAG_RUNTIME)
181888fb
FG
7773 .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."),
7774
7775 Option("mds_cache_reservation", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7776 .set_default(.05)
9f95a23c
TL
7777 .set_description("amount of memory to reserve for future cached objects")
7778 .set_flag(Option::FLAG_RUNTIME),
181888fb
FG
7779
7780 Option("mds_health_cache_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7781 .set_default(1.5)
7782 .set_description("threshold for cache size to generate health warning"),
c07f9fc5 7783
d2e6a577
FG
7784 Option("mds_cache_mid", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7785 .set_default(.7)
11fdf7f2 7786 .set_description("midpoint for MDS cache LRU"),
c07f9fc5 7787
a8e16298
TL
7788 Option("mds_cache_trim_decay_rate", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7789 .set_default(1)
9f95a23c
TL
7790 .set_description("decay rate for trimming MDS cache throttle")
7791 .set_flag(Option::FLAG_RUNTIME),
a8e16298 7792
11fdf7f2 7793 Option("mds_cache_trim_threshold", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
a8e16298 7794 .set_default(64_K)
9f95a23c
TL
7795 .set_description("threshold for number of dentries that can be trimmed")
7796 .set_flag(Option::FLAG_RUNTIME),
a8e16298 7797
d2e6a577
FG
7798 Option("mds_max_file_recover", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7799 .set_default(32)
11fdf7f2 7800 .set_description("maximum number of files to recover file sizes in parallel"),
c07f9fc5 7801
d2e6a577
FG
7802 Option("mds_dir_max_commit_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
7803 .set_default(10)
11fdf7f2 7804 .set_description("maximum size in megabytes for a RADOS write to a directory"),
c07f9fc5 7805
d2e6a577
FG
7806 Option("mds_dir_keys_per_op", Option::TYPE_INT, Option::LEVEL_ADVANCED)
7807 .set_default(16384)
11fdf7f2 7808 .set_description("number of directory entries to read in one RADOS operation"),
c07f9fc5 7809
d2e6a577
FG
7810 Option("mds_decay_halflife", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7811 .set_default(5)
11fdf7f2 7812 .set_description("rate of decay for temperature counters on each directory for balancing"),
c07f9fc5 7813
d2e6a577
FG
7814 Option("mds_beacon_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7815 .set_default(4)
11fdf7f2 7816 .set_description("interval in seconds between MDS beacons to monitors"),
c07f9fc5 7817
d2e6a577
FG
7818 Option("mds_beacon_grace", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7819 .set_default(15)
11fdf7f2 7820 .set_description("tolerance in seconds for missed MDS beacons to monitors"),
c07f9fc5 7821
f64942e4
AA
7822 Option("mds_heartbeat_grace", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7823 .set_default(15)
7824 .set_description("tolerance in seconds for MDS internal heartbeat"),
7825
d2e6a577
FG
7826 Option("mds_enforce_unique_name", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7827 .set_default(true)
11fdf7f2 7828 .set_description("require MDS name is unique in the cluster"),
c07f9fc5 7829
d2e6a577
FG
7830 Option("mds_session_blacklist_on_timeout", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7831 .set_default(true)
11fdf7f2 7832 .set_description("blacklist clients whose sessions have become stale"),
c07f9fc5 7833
d2e6a577
FG
7834 Option("mds_session_blacklist_on_evict", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7835 .set_default(true)
11fdf7f2 7836 .set_description("blacklist clients that have been evicted"),
c07f9fc5 7837
d2e6a577
FG
7838 Option("mds_sessionmap_keys_per_op", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7839 .set_default(1024)
11fdf7f2 7840 .set_description("number of omap keys to read from the SessionMap in one operation"),
c07f9fc5 7841
11fdf7f2 7842 Option("mds_recall_max_caps", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
a8e16298 7843 .set_default(5000)
9f95a23c
TL
7844 .set_description("maximum number of caps to recall from client session in single recall")
7845 .set_flag(Option::FLAG_RUNTIME),
a8e16298
TL
7846
7847 Option("mds_recall_max_decay_rate", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7848 .set_default(2.5)
9f95a23c
TL
7849 .set_description("decay rate for throttle on recalled caps on a session")
7850 .set_flag(Option::FLAG_RUNTIME),
a8e16298 7851
11fdf7f2 7852 Option("mds_recall_max_decay_threshold", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
a8e16298 7853 .set_default(16_K)
9f95a23c
TL
7854 .set_description("decay threshold for throttle on recalled caps on a session")
7855 .set_flag(Option::FLAG_RUNTIME),
a8e16298 7856
11fdf7f2 7857 Option("mds_recall_global_max_decay_threshold", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
a8e16298 7858 .set_default(64_K)
9f95a23c
TL
7859 .set_description("decay threshold for throttle on recalled caps globally")
7860 .set_flag(Option::FLAG_RUNTIME),
a8e16298 7861
11fdf7f2 7862 Option("mds_recall_warning_threshold", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
a8e16298 7863 .set_default(32_K)
9f95a23c
TL
7864 .set_description("decay threshold for warning on slow session cap recall")
7865 .set_flag(Option::FLAG_RUNTIME),
a8e16298
TL
7866
7867 Option("mds_recall_warning_decay_rate", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7868 .set_default(60.0)
9f95a23c
TL
7869 .set_description("decay rate for warning on slow session cap recall")
7870 .set_flag(Option::FLAG_RUNTIME),
c07f9fc5 7871
92f5a8d4
TL
7872 Option("mds_session_cache_liveness_decay_rate", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7873 .add_see_also("mds_session_cache_liveness_magnitude")
7874 .set_default(5_min)
7875 .set_description("decay rate for session liveness leading to preemptive cap recall")
9f95a23c 7876 .set_flag(Option::FLAG_RUNTIME)
92f5a8d4
TL
7877 .set_long_description("This determines how long a session needs to be quiescent before the MDS begins preemptively recalling capabilities. The default of 5 minutes will cause 10 halvings of the decay counter after 1 hour, or 1/1024. The default magnitude of 10 (1^10 or 1024) is chosen so that the MDS considers a previously chatty session (approximately) to be quiescent after 1 hour."),
7878
7879 Option("mds_session_cache_liveness_magnitude", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
7880 .add_see_also("mds_session_cache_liveness_decay_rate")
7881 .set_default(10)
7882 .set_description("decay magnitude for preemptively recalling caps on quiet client")
9f95a23c 7883 .set_flag(Option::FLAG_RUNTIME)
92f5a8d4
TL
7884 .set_long_description("This is the order of magnitude difference (in base 2) of the internal liveness decay counter and the number of capabilities the session holds. When this difference occurs, the MDS treats the session as quiescent and begins recalling capabilities."),
7885
adb31ebb
TL
7886 Option("mds_session_cap_acquisition_decay_rate", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7887 .set_default(10)
7888 .set_description("decay rate for session readdir caps leading to readdir throttle")
7889 .set_flag(Option::FLAG_RUNTIME)
7890 .set_long_description("The half-life for the session cap acquisition counter of caps acquired by readdir. This is used for throttling readdir requests from clients slow to release caps."),
7891
7892 Option("mds_session_cap_acquisition_throttle", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7893 .set_default(500000)
7894 .set_description("throttle point for cap acquisition decay counter"),
7895
7896 Option("mds_session_max_caps_throttle_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7897 .set_default(1.1)
7898 .set_description("ratio of mds_max_maps_per_client that client must exceed before readdir may be throttled by cap acquisition throttle"),
7899
7900 Option("mds_cap_acquisition_throttle_retry_request_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7901 .set_default(0.5)
7902 .set_description("timeout in seconds after which a client request is retried due to cap acquisition throttling"),
7903
11fdf7f2 7904 Option("mds_freeze_tree_timeout", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
7905 .set_default(30)
7906 .set_description(""),
c07f9fc5 7907
d2e6a577
FG
7908 Option("mds_health_summarize_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
7909 .set_default(10)
11fdf7f2 7910 .set_description("threshold of number of clients to summarize late client recall"),
c07f9fc5 7911
d2e6a577
FG
7912 Option("mds_reconnect_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7913 .set_default(45)
11fdf7f2 7914 .set_description("timeout in seconds to wait for clients to reconnect during MDS reconnect recovery state"),
c07f9fc5 7915
d2e6a577
FG
7916 Option("mds_tick_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7917 .set_default(5)
11fdf7f2 7918 .set_description("time in seconds between upkeep tasks"),
c07f9fc5 7919
11fdf7f2 7920 Option("mds_dirstat_min_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
7921 .set_default(1)
7922 .set_description(""),
c07f9fc5 7923
d2e6a577
FG
7924 Option("mds_scatter_nudge_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7925 .set_default(5)
11fdf7f2 7926 .set_description("minimum interval between scatter lock updates"),
c07f9fc5 7927
d2e6a577
FG
7928 Option("mds_client_prealloc_inos", Option::TYPE_INT, Option::LEVEL_ADVANCED)
7929 .set_default(1000)
11fdf7f2 7930 .set_description("number of unused inodes to pre-allocate to clients for file creation"),
c07f9fc5 7931
9f95a23c
TL
7932 Option("mds_client_delegate_inos_pct", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
7933 .set_default(50)
7934 .set_flag(Option::FLAG_RUNTIME)
7935 .set_description("percentage of preallocated inos to delegate to client"),
7936
d2e6a577
FG
7937 Option("mds_early_reply", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7938 .set_default(true)
11fdf7f2 7939 .set_description("additional reply to clients that metadata requests are complete but not yet durable"),
c07f9fc5 7940
92f5a8d4
TL
7941 Option("mds_replay_unsafe_with_closed_session", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7942 .set_default(false)
f91f0fd5 7943 .set_flag(Option::FLAG_STARTUP)
92f5a8d4
TL
7944 .set_description("complete all the replay request when mds is restarted, no matter the session is closed or not"),
7945
d2e6a577
FG
7946 Option("mds_default_dir_hash", Option::TYPE_INT, Option::LEVEL_ADVANCED)
7947 .set_default(CEPH_STR_HASH_RJENKINS)
11fdf7f2 7948 .set_description("hash function to select directory fragment for dentry name"),
c07f9fc5 7949
11fdf7f2 7950 Option("mds_log_pause", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
7951 .set_default(false)
7952 .set_description(""),
c07f9fc5 7953
11fdf7f2 7954 Option("mds_log_skip_corrupt_events", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
7955 .set_default(false)
7956 .set_description(""),
c07f9fc5 7957
d2e6a577
FG
7958 Option("mds_log_max_events", Option::TYPE_INT, Option::LEVEL_ADVANCED)
7959 .set_default(-1)
11fdf7f2 7960 .set_description("maximum number of events in the MDS journal (-1 is unlimited)"),
c07f9fc5 7961
d2e6a577
FG
7962 Option("mds_log_events_per_segment", Option::TYPE_INT, Option::LEVEL_ADVANCED)
7963 .set_default(1024)
11fdf7f2 7964 .set_description("maximum number of events in an MDS journal segment"),
c07f9fc5 7965
11fdf7f2 7966 Option("mds_log_segment_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 7967 .set_default(0)
11fdf7f2 7968 .set_description("size in bytes of each MDS log segment"),
c07f9fc5 7969
d2e6a577 7970 Option("mds_log_max_segments", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
94b18763 7971 .set_default(128)
11fdf7f2 7972 .set_description("maximum number of segments which may be untrimmed"),
c07f9fc5 7973
f91f0fd5
TL
7974 Option("mds_log_warn_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7975 .set_default(2.0)
7976 .set_min(1.0)
7977 .set_flag(Option::FLAG_RUNTIME)
7978 .set_description("trigger MDS_HEALTH_TRIM warning when the mds log is longer than mds_log_max_segments * mds_log_warn_factor"),
7979
d2e6a577
FG
7980 Option("mds_bal_export_pin", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7981 .set_default(true)
11fdf7f2 7982 .set_description("allow setting directory export pins to particular ranks"),
c07f9fc5 7983
f6b5b4d7
TL
7984 Option("mds_export_ephemeral_random", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7985 .set_default(false)
7986 .set_flag(Option::FLAG_RUNTIME)
7987 .set_description("allow ephemeral random pinning of the loaded subtrees")
7988 .set_long_description("probabilistically pin the loaded directory inode and the subtree beneath it to an MDS based on the consistent hash of the inode number. The higher this value the more likely the loaded subtrees get pinned"),
7989
7990 Option("mds_export_ephemeral_random_max", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
7991 .set_default(0.01)
7992 .set_flag(Option::FLAG_RUNTIME)
7993 .set_description("the maximum percent permitted for random ephemeral pin policy")
7994 .set_min_max(0.0, 1.0)
7995 .add_see_also("mds_export_ephemeral_random"),
7996
7997 Option("mds_export_ephemeral_distributed", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
7998 .set_default(false)
7999 .set_flag(Option::FLAG_RUNTIME)
8000 .set_description("allow ephemeral distributed pinning of the loaded subtrees")
8001 .set_long_description("pin the immediate child directories of the loaded directory inode based on the consistent hash of the child's inode number. "),
8002
d2e6a577
FG
8003 Option("mds_bal_sample_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8004 .set_default(3.0)
11fdf7f2 8005 .set_description("interval in seconds between balancer ticks"),
c07f9fc5 8006
d2e6a577
FG
8007 Option("mds_bal_replicate_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8008 .set_default(8000)
11fdf7f2 8009 .set_description("hot popularity threshold to replicate a subtree"),
c07f9fc5 8010
d2e6a577
FG
8011 Option("mds_bal_unreplicate_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8012 .set_default(0)
11fdf7f2 8013 .set_description("cold popularity threshold to merge subtrees"),
c07f9fc5 8014
d2e6a577
FG
8015 Option("mds_bal_split_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8016 .set_default(10000)
11fdf7f2 8017 .set_description("minimum size of directory fragment before splitting"),
c07f9fc5 8018
d2e6a577
FG
8019 Option("mds_bal_split_rd", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8020 .set_default(25000)
11fdf7f2 8021 .set_description("hot read popularity threshold for splitting a directory fragment"),
c07f9fc5 8022
d2e6a577
FG
8023 Option("mds_bal_split_wr", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8024 .set_default(10000)
11fdf7f2 8025 .set_description("hot write popularity threshold for splitting a directory fragment"),
c07f9fc5 8026
d2e6a577
FG
8027 Option("mds_bal_split_bits", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8028 .set_default(3)
11fdf7f2
TL
8029 .set_min_max(1, 24)
8030 .set_description("power of two child fragments for a fragment on split"),
c07f9fc5 8031
d2e6a577
FG
8032 Option("mds_bal_merge_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8033 .set_default(50)
11fdf7f2 8034 .set_description("size of fragments where merging should occur"),
c07f9fc5 8035
d2e6a577
FG
8036 Option("mds_bal_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8037 .set_default(10)
11fdf7f2 8038 .set_description("interval between MDS balancer cycles"),
c07f9fc5 8039
d2e6a577
FG
8040 Option("mds_bal_fragment_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8041 .set_default(5)
11fdf7f2 8042 .set_description("delay in seconds before interrupting client IO to perform splits"),
c07f9fc5 8043
d2e6a577
FG
8044 Option("mds_bal_fragment_size_max", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8045 .set_default(10000*10)
11fdf7f2 8046 .set_description("maximum size of a directory fragment before new creat/links fail"),
c07f9fc5 8047
d2e6a577
FG
8048 Option("mds_bal_fragment_fast_factor", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8049 .set_default(1.5)
11fdf7f2
TL
8050 .set_description("ratio of mds_bal_split_size at which fast fragment splitting occurs"),
8051
8052 Option("mds_bal_fragment_dirs", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8053 .set_default(true)
8054 .set_description("enable directory fragmentation")
8055 .set_long_description("Directory fragmentation is a standard feature of CephFS that allows sharding directories across multiple objects for performance and stability. Additionally, this allows fragments to be distributed across multiple active MDSs to increase throughput. Disabling (new) fragmentation should only be done in exceptional circumstances and may lead to performance issues."),
c07f9fc5 8056
d2e6a577
FG
8057 Option("mds_bal_idle_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8058 .set_default(0)
11fdf7f2 8059 .set_description("idle metadata popularity threshold before rebalancing"),
c07f9fc5 8060
11fdf7f2 8061 Option("mds_bal_max", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8062 .set_default(-1)
8063 .set_description(""),
c07f9fc5 8064
11fdf7f2 8065 Option("mds_bal_max_until", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8066 .set_default(-1)
8067 .set_description(""),
c07f9fc5 8068
11fdf7f2 8069 Option("mds_bal_mode", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8070 .set_default(0)
8071 .set_description(""),
c07f9fc5 8072
11fdf7f2 8073 Option("mds_bal_min_rebalance", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577 8074 .set_default(.1)
11fdf7f2 8075 .set_description("amount overloaded over internal target before balancer begins offloading"),
c07f9fc5 8076
11fdf7f2 8077 Option("mds_bal_min_start", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
8078 .set_default(.2)
8079 .set_description(""),
c07f9fc5 8080
11fdf7f2 8081 Option("mds_bal_need_min", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
8082 .set_default(.8)
8083 .set_description(""),
c07f9fc5 8084
11fdf7f2 8085 Option("mds_bal_need_max", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
8086 .set_default(1.2)
8087 .set_description(""),
c07f9fc5 8088
11fdf7f2 8089 Option("mds_bal_midchunk", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
8090 .set_default(.3)
8091 .set_description(""),
c07f9fc5 8092
11fdf7f2 8093 Option("mds_bal_minchunk", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
8094 .set_default(.001)
8095 .set_description(""),
c07f9fc5 8096
d2e6a577
FG
8097 Option("mds_bal_target_decay", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8098 .set_default(10.0)
11fdf7f2 8099 .set_description("rate of decay for export targets communicated to clients"),
c07f9fc5 8100
f91f0fd5
TL
8101 Option("mds_oft_prefetch_dirfrags", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8102 .set_default(true)
8103 .set_description("prefetch dirfrags recorded in open file table on startup")
8104 .set_flag(Option::FLAG_STARTUP),
8105
d2e6a577
FG
8106 Option("mds_replay_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8107 .set_default(1.0)
11fdf7f2 8108 .set_description("time in seconds between replay of updates to journal by standby replay MDS"),
c07f9fc5 8109
11fdf7f2 8110 Option("mds_shutdown_check", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8111 .set_default(0)
8112 .set_description(""),
c07f9fc5 8113
11fdf7f2 8114 Option("mds_thrash_exports", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8115 .set_default(0)
8116 .set_description(""),
c07f9fc5 8117
11fdf7f2 8118 Option("mds_thrash_fragments", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8119 .set_default(0)
8120 .set_description(""),
c07f9fc5 8121
11fdf7f2 8122 Option("mds_dump_cache_on_map", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
8123 .set_default(false)
8124 .set_description(""),
c07f9fc5 8125
11fdf7f2 8126 Option("mds_dump_cache_after_rejoin", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
8127 .set_default(false)
8128 .set_description(""),
c07f9fc5 8129
11fdf7f2 8130 Option("mds_verify_scatter", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
8131 .set_default(false)
8132 .set_description(""),
c07f9fc5 8133
d2e6a577
FG
8134 Option("mds_debug_scatterstat", Option::TYPE_BOOL, Option::LEVEL_DEV)
8135 .set_default(false)
8136 .set_description(""),
c07f9fc5 8137
d2e6a577
FG
8138 Option("mds_debug_frag", Option::TYPE_BOOL, Option::LEVEL_DEV)
8139 .set_default(false)
8140 .set_description(""),
c07f9fc5 8141
d2e6a577
FG
8142 Option("mds_debug_auth_pins", Option::TYPE_BOOL, Option::LEVEL_DEV)
8143 .set_default(false)
8144 .set_description(""),
c07f9fc5 8145
d2e6a577
FG
8146 Option("mds_debug_subtrees", Option::TYPE_BOOL, Option::LEVEL_DEV)
8147 .set_default(false)
8148 .set_description(""),
c07f9fc5 8149
d2e6a577
FG
8150 Option("mds_kill_mdstable_at", Option::TYPE_INT, Option::LEVEL_DEV)
8151 .set_default(0)
8152 .set_description(""),
c07f9fc5 8153
11fdf7f2 8154 Option("mds_max_export_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
91327a77 8155 .set_default(20_M)
b32b8144
FG
8156 .set_description(""),
8157
d2e6a577
FG
8158 Option("mds_kill_export_at", Option::TYPE_INT, Option::LEVEL_DEV)
8159 .set_default(0)
8160 .set_description(""),
c07f9fc5 8161
d2e6a577
FG
8162 Option("mds_kill_import_at", Option::TYPE_INT, Option::LEVEL_DEV)
8163 .set_default(0)
8164 .set_description(""),
c07f9fc5 8165
d2e6a577
FG
8166 Option("mds_kill_link_at", Option::TYPE_INT, Option::LEVEL_DEV)
8167 .set_default(0)
8168 .set_description(""),
c07f9fc5 8169
d2e6a577
FG
8170 Option("mds_kill_rename_at", Option::TYPE_INT, Option::LEVEL_DEV)
8171 .set_default(0)
8172 .set_description(""),
c07f9fc5 8173
d2e6a577
FG
8174 Option("mds_kill_openc_at", Option::TYPE_INT, Option::LEVEL_DEV)
8175 .set_default(0)
8176 .set_description(""),
c07f9fc5 8177
d2e6a577
FG
8178 Option("mds_kill_journal_at", Option::TYPE_INT, Option::LEVEL_DEV)
8179 .set_default(0)
8180 .set_description(""),
c07f9fc5 8181
d2e6a577
FG
8182 Option("mds_kill_journal_expire_at", Option::TYPE_INT, Option::LEVEL_DEV)
8183 .set_default(0)
8184 .set_description(""),
c07f9fc5 8185
d2e6a577
FG
8186 Option("mds_kill_journal_replay_at", Option::TYPE_INT, Option::LEVEL_DEV)
8187 .set_default(0)
8188 .set_description(""),
c07f9fc5 8189
11fdf7f2 8190 Option("mds_journal_format", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
8191 .set_default(1)
8192 .set_description(""),
c07f9fc5 8193
d2e6a577
FG
8194 Option("mds_kill_create_at", Option::TYPE_INT, Option::LEVEL_DEV)
8195 .set_default(0)
8196 .set_description(""),
c07f9fc5 8197
d2e6a577
FG
8198 Option("mds_inject_traceless_reply_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
8199 .set_default(0)
8200 .set_description(""),
c07f9fc5 8201
11fdf7f2 8202 Option("mds_wipe_sessions", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
8203 .set_default(0)
8204 .set_description(""),
c07f9fc5 8205
11fdf7f2 8206 Option("mds_wipe_ino_prealloc", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
8207 .set_default(0)
8208 .set_description(""),
c07f9fc5 8209
11fdf7f2 8210 Option("mds_skip_ino", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8211 .set_default(0)
8212 .set_description(""),
c07f9fc5 8213
d2e6a577
FG
8214 Option("mds_enable_op_tracker", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8215 .set_default(true)
11fdf7f2 8216 .set_description("track remote operation progression and statistics"),
c07f9fc5 8217
d2e6a577
FG
8218 Option("mds_op_history_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8219 .set_default(20)
11fdf7f2 8220 .set_description("maximum size for list of historical operations"),
c07f9fc5 8221
d2e6a577
FG
8222 Option("mds_op_history_duration", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8223 .set_default(600)
11fdf7f2 8224 .set_description("expiration time in seconds of historical operations"),
c07f9fc5 8225
d2e6a577
FG
8226 Option("mds_op_complaint_time", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8227 .set_default(30)
11fdf7f2 8228 .set_description("time in seconds to consider an operation blocked after no updates"),
c07f9fc5 8229
11fdf7f2 8230 Option("mds_op_log_threshold", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8231 .set_default(5)
8232 .set_description(""),
c07f9fc5 8233
d2e6a577
FG
8234 Option("mds_snap_min_uid", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8235 .set_default(0)
11fdf7f2 8236 .set_description("minimum uid of client to perform snapshots"),
c07f9fc5 8237
d2e6a577
FG
8238 Option("mds_snap_max_uid", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8239 .set_default(4294967294)
11fdf7f2 8240 .set_description("maximum uid of client to perform snapshots"),
c07f9fc5 8241
d2e6a577
FG
8242 Option("mds_snap_rstat", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8243 .set_default(false)
11fdf7f2 8244 .set_description("enabled nested rstat for snapshots"),
c07f9fc5 8245
11fdf7f2 8246 Option("mds_verify_backtrace", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
8247 .set_default(1)
8248 .set_description(""),
c07f9fc5 8249
11fdf7f2 8250 Option("mds_max_completed_flushes", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
8251 .set_default(100000)
8252 .set_description(""),
c07f9fc5 8253
11fdf7f2 8254 Option("mds_max_completed_requests", Option::TYPE_UINT, Option::LEVEL_DEV)
d2e6a577
FG
8255 .set_default(100000)
8256 .set_description(""),
c07f9fc5 8257
d2e6a577
FG
8258 Option("mds_action_on_write_error", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8259 .set_default(1)
11fdf7f2 8260 .set_description("action to take when MDS cannot write to RADOS (0:ignore, 1:read-only, 2:suicide)"),
c07f9fc5 8261
d2e6a577
FG
8262 Option("mds_mon_shutdown_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8263 .set_default(5)
11fdf7f2 8264 .set_description("time to wait for mon to receive damaged MDS rank notification"),
c07f9fc5 8265
d2e6a577
FG
8266 Option("mds_max_purge_files", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8267 .set_default(64)
11fdf7f2 8268 .set_description("maximum number of deleted files to purge in parallel"),
c07f9fc5 8269
d2e6a577
FG
8270 Option("mds_max_purge_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8271 .set_default(8192)
11fdf7f2 8272 .set_description("maximum number of purge operations performed in parallel"),
c07f9fc5 8273
d2e6a577
FG
8274 Option("mds_max_purge_ops_per_pg", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8275 .set_default(0.5)
11fdf7f2 8276 .set_description("number of parallel purge operations performed per PG"),
c07f9fc5 8277
11fdf7f2 8278 Option("mds_purge_queue_busy_flush_period", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577
FG
8279 .set_default(1.0)
8280 .set_description(""),
c07f9fc5 8281
d2e6a577
FG
8282 Option("mds_root_ino_uid", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8283 .set_default(0)
11fdf7f2 8284 .set_description("default uid for new root directory"),
c07f9fc5 8285
d2e6a577
FG
8286 Option("mds_root_ino_gid", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8287 .set_default(0)
11fdf7f2 8288 .set_description("default gid for new root directory"),
c07f9fc5 8289
d2e6a577
FG
8290 Option("mds_max_scrub_ops_in_progress", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8291 .set_default(5)
11fdf7f2 8292 .set_description("maximum number of scrub operations performed in parallel"),
c07f9fc5 8293
9f95a23c
TL
8294 Option("mds_forward_all_requests_to_auth", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8295 .set_default(false)
8296 .set_flag(Option::FLAG_RUNTIME)
8297 .set_description("always process op on auth mds"),
8298
d2e6a577
FG
8299 Option("mds_damage_table_max_entries", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8300 .set_default(10000)
11fdf7f2 8301 .set_description("maximum number of damage table entries"),
d2e6a577
FG
8302
8303 Option("mds_client_writeable_range_max_inc_objs", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8304 .set_default(1024)
11fdf7f2
TL
8305 .set_description("maximum number of objects in writeable range of a file for a client"),
8306
3efd9988
FG
8307 Option("mds_min_caps_per_client", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8308 .set_default(100)
8309 .set_description("minimum number of capabilities a client may hold"),
8310
f91f0fd5
TL
8311 Option("mds_min_caps_working_set", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8312 .set_default(10000)
8313 .set_flag(Option::FLAG_RUNTIME)
8314 .set_description("number of capabilities a client may hold without cache pressure warnings generated"),
8315
a8e16298
TL
8316 Option("mds_max_caps_per_client", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8317 .set_default(1_M)
8318 .set_description("maximum number of capabilities a client may hold"),
8319
94b18763
FG
8320 Option("mds_hack_allow_loading_invalid_metadata", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8321 .set_default(0)
8322 .set_description("INTENTIONALLY CAUSE DATA LOSS by bypasing checks for invalid metadata on disk. Allows testing repair tools."),
28e407b8 8323
494da23a
TL
8324 Option("mds_defer_session_stale", Option::TYPE_BOOL, Option::LEVEL_DEV)
8325 .set_default(true),
8326
28e407b8
AA
8327 Option("mds_inject_migrator_session_race", Option::TYPE_BOOL, Option::LEVEL_DEV)
8328 .set_default(false),
1adf2230 8329
91327a77
AA
8330 Option("mds_request_load_average_decay_rate", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8331 .set_default(60)
8332 .set_description("rate of decay in seconds for calculating request load average"),
8333
8334 Option("mds_cap_revoke_eviction_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8335 .set_default(0)
8336 .set_description("number of seconds after which clients which have not responded to cap revoke messages by the MDS are evicted."),
f64942e4 8337
11fdf7f2
TL
8338 Option("mds_max_retries_on_remount_failure", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8339 .set_default(5)
8340 .set_description("number of consecutive failed remount attempts for invalidating kernel dcache after which client would abort."),
8341
8342 Option("mds_dump_cache_threshold_formatter", Option::TYPE_SIZE, Option::LEVEL_DEV)
f64942e4
AA
8343 .set_default(1_G)
8344 .set_description("threshold for cache usage to disallow \"dump cache\" operation to formatter")
8345 .set_long_description("Disallow MDS from dumping caches to formatter via \"dump cache\" command if cache usage exceeds this threshold."),
8346
11fdf7f2 8347 Option("mds_dump_cache_threshold_file", Option::TYPE_SIZE, Option::LEVEL_DEV)
f64942e4
AA
8348 .set_default(0)
8349 .set_description("threshold for cache usage to disallow \"dump cache\" operation to file")
8350 .set_long_description("Disallow MDS from dumping caches to file via \"dump cache\" command if cache usage exceeds this threshold."),
9f95a23c
TL
8351
8352 Option("mds_task_status_update_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
8353 .set_default(2.0)
8354 .set_description("task status update interval to manager")
8355 .set_long_description("interval (in seconds) for sending mds task status to ceph manager"),
8356
8357 Option("mds_max_snaps_per_dir", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
8358 .set_default(100)
8359 .set_min_max(0, 4096)
8360 .set_flag(Option::FLAG_RUNTIME)
8361 .set_description("max snapshots per directory")
8362 .set_long_description("maximum number of snapshots that can be created per directory"),
d2e6a577
FG
8363 });
8364}
c07f9fc5 8365
d2e6a577
FG
8366std::vector<Option> get_mds_client_options() {
8367 return std::vector<Option>({
11fdf7f2 8368 Option("client_cache_size", Option::TYPE_SIZE, Option::LEVEL_BASIC)
d2e6a577 8369 .set_default(16384)
28e407b8 8370 .set_description("soft maximum number of directory entries in client cache"),
c07f9fc5 8371
d2e6a577
FG
8372 Option("client_cache_mid", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8373 .set_default(.75)
28e407b8 8374 .set_description("mid-point of client cache LRU"),
c07f9fc5 8375
28e407b8 8376 Option("client_use_random_mds", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577 8377 .set_default(false)
28e407b8 8378 .set_description("issue new requests to a random active MDS"),
c07f9fc5 8379
d2e6a577
FG
8380 Option("client_mount_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8381 .set_default(300.0)
28e407b8 8382 .set_description("timeout for mounting CephFS (seconds)"),
c07f9fc5 8383
28e407b8 8384 Option("client_tick_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
d2e6a577 8385 .set_default(1.0)
28e407b8 8386 .set_description("seconds between client upkeep ticks"),
c07f9fc5 8387
28e407b8 8388 Option("client_trace", Option::TYPE_STR, Option::LEVEL_DEV)
d2e6a577 8389 .set_default("")
28e407b8 8390 .set_description("file containing trace of client operations"),
c07f9fc5 8391
11fdf7f2 8392 Option("client_readahead_min", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 8393 .set_default(128*1024)
28e407b8 8394 .set_description("minimum bytes to readahead in a file"),
c07f9fc5 8395
11fdf7f2 8396 Option("client_readahead_max_bytes", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
d2e6a577 8397 .set_default(0)
28e407b8 8398 .set_description("maximum bytes to readahead in a file (zero is unlimited)"),
c07f9fc5 8399
d2e6a577
FG
8400 Option("client_readahead_max_periods", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8401 .set_default(4)
28e407b8 8402 .set_description("maximum stripe periods to readahead in a file"),
c07f9fc5 8403
d2e6a577
FG
8404 Option("client_reconnect_stale", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8405 .set_default(false)
28e407b8 8406 .set_description("reconnect when the session becomes stale"),
c07f9fc5 8407
d2e6a577
FG
8408 Option("client_snapdir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
8409 .set_default(".snap")
28e407b8 8410 .set_description("pseudo directory for snapshot access to a directory"),
c07f9fc5 8411
d2e6a577
FG
8412 Option("client_mountpoint", Option::TYPE_STR, Option::LEVEL_ADVANCED)
8413 .set_default("/")
28e407b8 8414 .set_description("default mount-point"),
c07f9fc5 8415
d2e6a577
FG
8416 Option("client_mount_uid", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8417 .set_default(-1)
28e407b8 8418 .set_description("uid to mount as"),
c07f9fc5 8419
d2e6a577
FG
8420 Option("client_mount_gid", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8421 .set_default(-1)
28e407b8 8422 .set_description("gid to mount as"),
c07f9fc5 8423
28e407b8
AA
8424 /* RADOS client option */
8425 Option("client_notify_timeout", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8426 .set_default(10)
8427 .set_description(""),
c07f9fc5 8428
28e407b8
AA
8429 /* RADOS client option */
8430 Option("osd_client_watch_timeout", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8431 .set_default(30)
8432 .set_description(""),
c07f9fc5 8433
28e407b8 8434 Option("client_caps_release_delay", Option::TYPE_INT, Option::LEVEL_DEV)
d2e6a577
FG
8435 .set_default(5)
8436 .set_description(""),
c07f9fc5 8437
d2e6a577
FG
8438 Option("client_quota_df", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8439 .set_default(true)
28e407b8 8440 .set_description("show quota usage for statfs (df)"),
c07f9fc5 8441
d2e6a577
FG
8442 Option("client_oc", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8443 .set_default(true)
28e407b8 8444 .set_description("enable object caching"),
c07f9fc5 8445
11fdf7f2 8446 Option("client_oc_size", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 8447 .set_default(200_M)
28e407b8 8448 .set_description("maximum size of object cache"),
c07f9fc5 8449
11fdf7f2 8450 Option("client_oc_max_dirty", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 8451 .set_default(100_M)
28e407b8 8452 .set_description("maximum size of dirty pages in object cache"),
c07f9fc5 8453
11fdf7f2 8454 Option("client_oc_target_dirty", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
b32b8144 8455 .set_default(8_M)
28e407b8 8456 .set_description("target size of dirty pages object cache"),
c07f9fc5 8457
d2e6a577
FG
8458 Option("client_oc_max_dirty_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
8459 .set_default(5.0)
28e407b8 8460 .set_description("maximum age of dirty pages in object cache (seconds)"),
c07f9fc5 8461
d2e6a577
FG
8462 Option("client_oc_max_objects", Option::TYPE_INT, Option::LEVEL_ADVANCED)
8463 .set_default(1000)
28e407b8 8464 .set_description("maximum number of objects in cache"),
c07f9fc5 8465
d2e6a577
FG
8466 Option("client_debug_getattr_caps", Option::TYPE_BOOL, Option::LEVEL_DEV)
8467 .set_default(false)
8468 .set_description(""),
8469
8470 Option("client_debug_force_sync_read", Option::TYPE_BOOL, Option::LEVEL_DEV)
8471 .set_default(false)
8472 .set_description(""),
c07f9fc5 8473
d2e6a577
FG
8474 Option("client_debug_inject_tick_delay", Option::TYPE_INT, Option::LEVEL_DEV)
8475 .set_default(0)
8476 .set_description(""),
c07f9fc5 8477
11fdf7f2 8478 Option("client_max_inline_size", Option::TYPE_SIZE, Option::LEVEL_DEV)
b32b8144 8479 .set_default(4_K)
d2e6a577 8480 .set_description(""),
c07f9fc5 8481
d2e6a577
FG
8482 Option("client_inject_release_failure", Option::TYPE_BOOL, Option::LEVEL_DEV)
8483 .set_default(false)
8484 .set_description(""),
c07f9fc5 8485
d2e6a577
FG
8486 Option("client_inject_fixed_oldest_tid", Option::TYPE_BOOL, Option::LEVEL_DEV)
8487 .set_default(false)
8488 .set_description(""),
c07f9fc5 8489
d2e6a577
FG
8490 Option("client_metadata", Option::TYPE_STR, Option::LEVEL_ADVANCED)
8491 .set_default("")
28e407b8 8492 .set_description("metadata key=value comma-delimited pairs appended to session metadata"),
c07f9fc5 8493
d2e6a577
FG
8494 Option("client_acl_type", Option::TYPE_STR, Option::LEVEL_ADVANCED)
8495 .set_default("")
28e407b8 8496 .set_description("ACL type to enforce (none or \"posix_acl\")"),
c07f9fc5 8497
d2e6a577
FG
8498 Option("client_permissions", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8499 .set_default(true)
28e407b8 8500 .set_description("client-enforced permission checking"),
c07f9fc5 8501
d2e6a577
FG
8502 Option("client_dirsize_rbytes", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8503 .set_default(true)
28e407b8
AA
8504 .set_description("set the directory size as the number of file bytes recursively used")
8505 .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."),
c07f9fc5 8506
11fdf7f2
TL
8507 Option("client_force_lazyio", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8508 .set_default(false)
8509 .set_description(""),
8510
8511 // note: the max amount of "in flight" dirty data is roughly (max - target)
d2e6a577
FG
8512 Option("fuse_use_invalidate_cb", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8513 .set_default(true)
11fdf7f2 8514 .set_description("use fuse 2.8+ invalidate callback to keep page cache consistent"),
c07f9fc5 8515
d2e6a577
FG
8516 Option("fuse_disable_pagecache", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8517 .set_default(false)
28e407b8 8518 .set_description("disable page caching in the kernel for this FUSE mount"),
c07f9fc5 8519
d2e6a577
FG
8520 Option("fuse_allow_other", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8521 .set_default(true)
28e407b8 8522 .set_description("pass allow_other to FUSE on mount"),
c07f9fc5 8523
d2e6a577
FG
8524 Option("fuse_default_permissions", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8525 .set_default(false)
92f5a8d4
TL
8526 .set_description("pass default_permisions to FUSE on mount")
8527 .set_flag(Option::FLAG_STARTUP),
c07f9fc5 8528
d2e6a577 8529 Option("fuse_big_writes", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
1911f103 8530 .set_default(true)
11fdf7f2
TL
8531 .set_description("big_writes is deprecated in libfuse 3.0.0"),
8532
8533 Option("fuse_max_write", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
8534 .set_default(0)
8535 .set_description("set the maximum number of bytes in a single write operation")
8536 .set_long_description("Set the maximum number of bytes in a single write operation that may pass atomically through FUSE. The FUSE default is 128kB and may be indicated by setting this option to 0."),
c07f9fc5 8537
d2e6a577
FG
8538 Option("fuse_atomic_o_trunc", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8539 .set_default(true)
28e407b8 8540 .set_description("pass atomic_o_trunc flag to FUSE on mount"),
c07f9fc5 8541
e306af50 8542 Option("fuse_debug", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
d2e6a577 8543 .set_default(false)
e306af50
TL
8544 .set_flag(Option::FLAG_STARTUP)
8545 .set_flag(Option::FLAG_NO_MON_UPDATE)
8546 .set_description("enable debugging for the libfuse"),
c07f9fc5 8547
d2e6a577
FG
8548 Option("fuse_multithreaded", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8549 .set_default(true)
28e407b8 8550 .set_description("allow parallel processing through FUSE library"),
c07f9fc5 8551
d2e6a577
FG
8552 Option("fuse_require_active_mds", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8553 .set_default(true)
28e407b8 8554 .set_description("require active MDSs in the file system when mounting"),
c07f9fc5 8555
d2e6a577
FG
8556 Option("fuse_syncfs_on_mksnap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8557 .set_default(true)
28e407b8 8558 .set_description("synchronize all local metadata/file changes after snapshot"),
c07f9fc5 8559
d2e6a577 8560 Option("fuse_set_user_groups", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
181888fb
FG
8561 .set_default(true)
8562 .set_description("check for ceph-fuse to consider supplementary groups for permissions"),
c07f9fc5 8563
28e407b8 8564 Option("client_try_dentry_invalidate", Option::TYPE_BOOL, Option::LEVEL_DEV)
181888fb 8565 .set_default(false)
d2e6a577 8566 .set_description(""),
c07f9fc5 8567
b32b8144
FG
8568 Option("client_die_on_failed_remount", Option::TYPE_BOOL, Option::LEVEL_DEV)
8569 .set_default(false)
d2e6a577 8570 .set_description(""),
c07f9fc5 8571
b32b8144
FG
8572 Option("client_die_on_failed_dentry_invalidate", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8573 .set_default(true)
8574 .set_description("kill the client when no dentry invalidation options are available")
8575 .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."),
8576
d2e6a577
FG
8577 Option("client_check_pool_perm", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
8578 .set_default(true)
28e407b8 8579 .set_description("confirm access to inode's data pool/namespace described in file layout"),
d2e6a577 8580
28e407b8 8581 Option("client_use_faked_inos", Option::TYPE_BOOL, Option::LEVEL_DEV)
d2e6a577
FG
8582 .set_default(false)
8583 .set_description(""),
8584
9f95a23c
TL
8585 Option("client_fs", Option::TYPE_STR, Option::LEVEL_ADVANCED)
8586 .set_flag(Option::FLAG_STARTUP)
d2e6a577 8587 .set_default("")
11fdf7f2
TL
8588 .set_description("CephFS file system name to mount")
8589 .set_long_description("Use this with ceph-fuse, or with any process "
8590 "that uses libcephfs. Programs using libcephfs may also pass "
8591 "the filesystem name into mount(), which will override this setting. "
8592 "If no filesystem name is given in mount() or this setting, the default "
8593 "filesystem will be mounted (usually the first created)."),
8594
9f95a23c
TL
8595 /* Alias for client_fs. Deprecated */
8596 Option("client_mds_namespace", Option::TYPE_STR, Option::LEVEL_DEV)
8597 .set_flag(Option::FLAG_STARTUP)
8598 .set_default(""),
8599
11fdf7f2
TL
8600 Option("fake_statfs_for_testing", Option::TYPE_INT, Option::LEVEL_DEV)
8601 .set_default(0)
8602 .set_description("Set a value for kb and compute kb_used from total of num_bytes"),
81eedcae
TL
8603
8604 Option("debug_allow_any_pool_priority", Option::TYPE_BOOL, Option::LEVEL_DEV)
8605 .set_default(false)
8606 .set_description("Allow any pool priority to be set to test conversion to new range"),
f6b5b4d7
TL
8607
8608 Option("client_shutdown_timeout", Option::TYPE_SECS, Option::LEVEL_ADVANCED)
8609 .set_flag(Option::FLAG_RUNTIME)
8610 .set_default(30)
8611 .set_min(0)
8612 .set_description("timeout for shutting down CephFS")
8613 .set_long_description("Timeout for shutting down CephFS via unmount or shutdown.")
8614 .add_tag("client")
d2e6a577
FG
8615 });
8616}
c07f9fc5
FG
8617
8618
9f95a23c
TL
8619std::vector<Option> get_cephfs_shell_options() {
8620 return std::vector<Option>({
8621 Option("allow_ansi", Option::TYPE_STR, Option::LEVEL_BASIC)
8622 .set_default("Terminal")
8623 .set_description("Allow ANSI escape sequences in output. Values: "
8624 "Terminal, Always, Never"),
8625
8626 Option("colors", Option::TYPE_STR, Option::LEVEL_BASIC)
8627 .set_default("Terminal")
8628 .set_description("Colouring CephFS shell input and output. Values: "
8629 "Terminal, Always, Never"),
8630
8631 Option("continuation_prompt", Option::TYPE_STR, Option::LEVEL_BASIC)
8632 .set_default(">")
8633 .set_description("Prompt string when a command continue to second line"),
8634
8635 Option("debug_shell", Option::TYPE_BOOL, Option::LEVEL_BASIC)
8636 .set_default(false)
8637 .set_description("Allow tracebacks on error for CephFS Shell"),
8638
8639 Option("echo", Option::TYPE_BOOL, Option::LEVEL_BASIC)
8640 .set_default(false)
8641 .set_description("Print command issued on prompt before execution"),
8642
8643 Option("editor", Option::TYPE_STR, Option::LEVEL_BASIC)
8644 .set_default("vim")
8645 .set_description("Default text editor for shell"),
8646
8647 Option("feedback_to_output", Option::TYPE_BOOL, Option::LEVEL_BASIC)
8648 .set_default(false)
8649 .set_description("include '|' and '>' in result"),
8650
8651 Option("max_completion_items", Option::TYPE_INT, Option::LEVEL_BASIC)
8652 .set_default(50)
8653 .set_description("Maximum number of items to be displayed by tab "
8654 "completion"),
8655
8656 Option("prompt", Option::TYPE_STR, Option::LEVEL_BASIC)
8657 .set_default("\x1b[01;33mCephFS:~\x1b[96m/\x1b[0m\x1b[01;33m>>>\x1b[00m ")
8658 .set_description("Whether non-essential feedback should be printed."),
8659
8660 Option("quiet", Option::TYPE_BOOL, Option::LEVEL_BASIC)
8661 .set_default(false)
8662 .set_description("Whether non-essential feedback should be printed."),
8663
8664 Option("timing", Option::TYPE_BOOL, Option::LEVEL_BASIC)
8665 .set_default(false)
8666 .set_description("Whether execution time should be reported"),
8667 });
8668}
8669
c07f9fc5
FG
8670static std::vector<Option> build_options()
8671{
d2e6a577 8672 std::vector<Option> result = get_global_options();
c07f9fc5 8673
d2e6a577 8674 auto ingest = [&result](std::vector<Option>&& options, const char* svc) {
11fdf7f2 8675 for (auto &o : options) {
c07f9fc5 8676 o.add_service(svc);
11fdf7f2 8677 result.push_back(std::move(o));
c07f9fc5
FG
8678 }
8679 };
8680
d2e6a577
FG
8681 ingest(get_rgw_options(), "rgw");
8682 ingest(get_rbd_options(), "rbd");
181888fb 8683 ingest(get_rbd_mirror_options(), "rbd-mirror");
9f95a23c 8684 ingest(get_immutable_object_cache_options(), "immutable-objet-cache");
d2e6a577
FG
8685 ingest(get_mds_options(), "mds");
8686 ingest(get_mds_client_options(), "mds_client");
9f95a23c 8687 ingest(get_cephfs_shell_options(), "cephfs-shell");
c07f9fc5
FG
8688
8689 return result;
8690}
8691
8692const std::vector<Option> ceph_options = build_options();