]> git.proxmox.com Git - ceph.git/blame - ceph/src/common/legacy_config_opts.h
update sources to 12.2.7
[ceph.git] / ceph / src / common / legacy_config_opts.h
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 * Ceph - scalable distributed file system
5 *
6 * Copyright (C) 2004-2006 Sage Weil <sage@newdream.net>
7 *
8 * This is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License version 2.1, as published by the Free Software
11 * Foundation. See file COPYING.
12 *
13 */
14
15/* note: no header guard */
16OPTION(host, OPT_STR) // "" means that ceph will use short hostname
c07f9fc5
FG
17OPTION(public_addr, OPT_ADDR)
18OPTION(public_bind_addr, OPT_ADDR)
19OPTION(cluster_addr, OPT_ADDR)
20OPTION(public_network, OPT_STR)
21OPTION(cluster_network, OPT_STR)
c07f9fc5
FG
22OPTION(lockdep, OPT_BOOL)
23OPTION(lockdep_force_backtrace, OPT_BOOL) // always gather current backtrace at every lock
24OPTION(run_dir, OPT_STR) // the "/var/run/ceph" dir, created on daemon startup
25OPTION(admin_socket, OPT_STR) // default changed by common_preinit()
26OPTION(admin_socket_mode, OPT_STR) // permission bits to set for admin socket file, e.g., "0775", "0755"
27
28OPTION(daemonize, OPT_BOOL) // default changed by common_preinit()
29OPTION(setuser, OPT_STR) // uid or user name
30OPTION(setgroup, OPT_STR) // gid or group name
31OPTION(setuser_match_path, OPT_STR) // make setuser/group conditional on this path matching ownership
32OPTION(pid_file, OPT_STR) // default changed by common_preinit()
33OPTION(chdir, OPT_STR)
34OPTION(restapi_log_level, OPT_STR) // default set by Python code
35OPTION(restapi_base_url, OPT_STR) // "
36OPTION(fatal_signal_handlers, OPT_BOOL)
37SAFE_OPTION(erasure_code_dir, OPT_STR) // default location for erasure-code plugins
38
39OPTION(log_file, OPT_STR) // default changed by common_preinit()
40OPTION(log_max_new, OPT_INT) // default changed by common_preinit()
41OPTION(log_max_recent, OPT_INT) // default changed by common_preinit()
42OPTION(log_to_stderr, OPT_BOOL) // default changed by common_preinit()
43OPTION(err_to_stderr, OPT_BOOL) // default changed by common_preinit()
44OPTION(log_to_syslog, OPT_BOOL)
45OPTION(err_to_syslog, OPT_BOOL)
46OPTION(log_flush_on_exit, OPT_BOOL) // default changed by common_preinit()
47OPTION(log_stop_at_utilization, OPT_FLOAT) // stop logging at (near) full
48OPTION(log_to_graylog, OPT_BOOL)
49OPTION(err_to_graylog, OPT_BOOL)
50OPTION(log_graylog_host, OPT_STR)
51OPTION(log_graylog_port, OPT_INT)
52
53// options will take k/v pairs, or single-item that will be assumed as general
54// default for all, regardless of channel.
55// e.g., "info" would be taken as the same as "default=info"
56// also, "default=daemon audit=local0" would mean
57// "default all to 'daemon', override 'audit' with 'local0'
58OPTION(clog_to_monitors, OPT_STR)
59OPTION(clog_to_syslog, OPT_STR)
60OPTION(clog_to_syslog_level, OPT_STR) // this level and above
61OPTION(clog_to_syslog_facility, OPT_STR)
62OPTION(clog_to_graylog, OPT_STR)
63OPTION(clog_to_graylog_host, OPT_STR)
64OPTION(clog_to_graylog_port, OPT_STR)
65
66OPTION(mon_cluster_log_to_syslog, OPT_STR)
67OPTION(mon_cluster_log_to_syslog_level, OPT_STR) // this level and above
68OPTION(mon_cluster_log_to_syslog_facility, OPT_STR)
69OPTION(mon_cluster_log_file, OPT_STR)
70OPTION(mon_cluster_log_file_level, OPT_STR)
71OPTION(mon_cluster_log_to_graylog, OPT_STR)
72OPTION(mon_cluster_log_to_graylog_host, OPT_STR)
73OPTION(mon_cluster_log_to_graylog_port, OPT_STR)
74
75OPTION(enable_experimental_unrecoverable_data_corrupting_features, OPT_STR)
76
77SAFE_OPTION(plugin_dir, OPT_STR)
78
79OPTION(xio_trace_mempool, OPT_BOOL) // mempool allocation counters
80OPTION(xio_trace_msgcnt, OPT_BOOL) // incoming/outgoing msg counters
81OPTION(xio_trace_xcon, OPT_BOOL) // Xio message encode/decode trace
82OPTION(xio_queue_depth, OPT_INT) // depth of Accelio msg queue
83OPTION(xio_mp_min, OPT_INT) // default min mempool size
84OPTION(xio_mp_max_64, OPT_INT) // max 64-byte chunks (buffer is 40)
85OPTION(xio_mp_max_256, OPT_INT) // max 256-byte chunks
86OPTION(xio_mp_max_1k, OPT_INT) // max 1K chunks
87OPTION(xio_mp_max_page, OPT_INT) // max 1K chunks
88OPTION(xio_mp_max_hint, OPT_INT) // max size-hint chunks
89OPTION(xio_portal_threads, OPT_INT) // xio portal threads per messenger
90OPTION(xio_max_conns_per_portal, OPT_INT) // max xio_connections per portal/ctx
91OPTION(xio_transport_type, OPT_STR) // xio transport type: {rdma or tcp}
92OPTION(xio_max_send_inline, OPT_INT) // xio maximum threshold to send inline
93
94OPTION(compressor_zlib_isal, OPT_BOOL)
95OPTION(compressor_zlib_level, OPT_INT) //regular zlib compression level, not applicable to isa-l optimized version
96
97OPTION(async_compressor_enabled, OPT_BOOL)
98OPTION(async_compressor_type, OPT_STR)
99OPTION(async_compressor_threads, OPT_INT)
100OPTION(async_compressor_thread_timeout, OPT_INT)
101OPTION(async_compressor_thread_suicide_timeout, OPT_INT)
102
103OPTION(plugin_crypto_accelerator, OPT_STR)
104
105OPTION(mempool_debug, OPT_BOOL)
106
107
108
109OPTION(key, OPT_STR)
110OPTION(keyfile, OPT_STR)
111OPTION(keyring, OPT_STR)
112OPTION(heartbeat_interval, OPT_INT)
113OPTION(heartbeat_file, OPT_STR)
114OPTION(heartbeat_inject_failure, OPT_INT) // force an unhealthy heartbeat for N seconds
115OPTION(perf, OPT_BOOL) // enable internal perf counters
116
117SAFE_OPTION(ms_type, OPT_STR) // messenger backend. It will be modified in runtime, so use SAFE_OPTION
118OPTION(ms_public_type, OPT_STR) // messenger backend
119OPTION(ms_cluster_type, OPT_STR) // messenger backend
120OPTION(ms_tcp_nodelay, OPT_BOOL)
121OPTION(ms_tcp_rcvbuf, OPT_INT)
122OPTION(ms_tcp_prefetch_max_size, OPT_INT) // max prefetch size, we limit this to avoid extra memcpy
123OPTION(ms_initial_backoff, OPT_DOUBLE)
124OPTION(ms_max_backoff, OPT_DOUBLE)
125OPTION(ms_crc_data, OPT_BOOL)
126OPTION(ms_crc_header, OPT_BOOL)
127OPTION(ms_die_on_bad_msg, OPT_BOOL)
128OPTION(ms_die_on_unhandled_msg, OPT_BOOL)
129OPTION(ms_die_on_old_message, OPT_BOOL) // assert if we get a dup incoming message and shouldn't have (may be triggered by pre-541cd3c64be0dfa04e8a2df39422e0eb9541a428 code)
130OPTION(ms_die_on_skipped_message, OPT_BOOL) // assert if we skip a seq (kernel client does this intentionally)
131OPTION(ms_dispatch_throttle_bytes, OPT_U64)
132OPTION(ms_bind_ipv6, OPT_BOOL)
133OPTION(ms_bind_port_min, OPT_INT)
134OPTION(ms_bind_port_max, OPT_INT)
135OPTION(ms_bind_retry_count, OPT_INT) // If binding fails, how many times do we retry to bind
136OPTION(ms_bind_retry_delay, OPT_INT) // Delay between attemps to bind
137OPTION(ms_bind_before_connect, OPT_BOOL)
138OPTION(ms_tcp_listen_backlog, OPT_INT)
139OPTION(ms_rwthread_stack_bytes, OPT_U64)
140OPTION(ms_tcp_read_timeout, OPT_U64)
141OPTION(ms_pq_max_tokens_per_priority, OPT_U64)
142OPTION(ms_pq_min_cost, OPT_U64)
143OPTION(ms_inject_socket_failures, OPT_U64)
144SAFE_OPTION(ms_inject_delay_type, OPT_STR) // "osd mds mon client" allowed
145OPTION(ms_inject_delay_msg_type, OPT_STR) // the type of message to delay). This is an additional restriction on the general type filter ms_inject_delay_type.
146OPTION(ms_inject_delay_max, OPT_DOUBLE) // seconds
147OPTION(ms_inject_delay_probability, OPT_DOUBLE) // range [0, 1]
148OPTION(ms_inject_internal_delays, OPT_DOUBLE) // seconds
149OPTION(ms_dump_on_send, OPT_BOOL) // hexdump msg to log on send
150OPTION(ms_dump_corrupt_message_level, OPT_INT) // debug level to hexdump undecodeable messages at
151OPTION(ms_async_op_threads, OPT_U64) // number of worker processing threads for async messenger created on init
152OPTION(ms_async_max_op_threads, OPT_U64) // max number of worker processing threads for async messenger
153OPTION(ms_async_set_affinity, OPT_BOOL)
154// example: ms_async_affinity_cores = 0,1
155// The number of coreset is expected to equal to ms_async_op_threads, otherwise
156// extra op threads will loop ms_async_affinity_cores again.
157// If ms_async_affinity_cores is empty, all threads will be bind to current running
158// core
159OPTION(ms_async_affinity_cores, OPT_STR)
160OPTION(ms_async_rdma_device_name, OPT_STR)
161OPTION(ms_async_rdma_enable_hugepage, OPT_BOOL)
162OPTION(ms_async_rdma_buffer_size, OPT_INT)
163OPTION(ms_async_rdma_send_buffers, OPT_U32)
164OPTION(ms_async_rdma_receive_buffers, OPT_U32)
165OPTION(ms_async_rdma_port_num, OPT_U32)
166OPTION(ms_async_rdma_polling_us, OPT_U32)
167OPTION(ms_async_rdma_local_gid, OPT_STR) // GID format: "fe80:0000:0000:0000:7efe:90ff:fe72:6efe", no zero folding
168OPTION(ms_async_rdma_roce_ver, OPT_INT) // 0=RoCEv1, 1=RoCEv2, 2=RoCEv1.5
169OPTION(ms_async_rdma_sl, OPT_INT) // in RoCE, this means PCP
170OPTION(ms_async_rdma_dscp, OPT_INT) // in RoCE, this means DSCP
171
172OPTION(ms_dpdk_port_id, OPT_INT)
173SAFE_OPTION(ms_dpdk_coremask, OPT_STR) // it is modified in unittest so that use SAFE_OPTION to declare
174OPTION(ms_dpdk_memory_channel, OPT_STR)
175OPTION(ms_dpdk_hugepages, OPT_STR)
176OPTION(ms_dpdk_pmd, OPT_STR)
177SAFE_OPTION(ms_dpdk_host_ipv4_addr, OPT_STR)
178SAFE_OPTION(ms_dpdk_gateway_ipv4_addr, OPT_STR)
179SAFE_OPTION(ms_dpdk_netmask_ipv4_addr, OPT_STR)
180OPTION(ms_dpdk_lro, OPT_BOOL)
181OPTION(ms_dpdk_hw_flow_control, OPT_BOOL)
182// Weighing of a hardware network queue relative to a software queue (0=no work, 1= equal share)")
183OPTION(ms_dpdk_hw_queue_weight, OPT_FLOAT)
184OPTION(ms_dpdk_debug_allow_loopback, OPT_BOOL)
185OPTION(ms_dpdk_rx_buffer_count_per_core, OPT_INT)
186
187OPTION(inject_early_sigterm, OPT_BOOL)
188
189OPTION(mon_data, OPT_STR)
190OPTION(mon_initial_members, OPT_STR) // list of initial cluster mon ids; if specified, need majority to form initial quorum and create new cluster
191OPTION(mon_compact_on_start, OPT_BOOL) // compact leveldb on ceph-mon start
192OPTION(mon_compact_on_bootstrap, OPT_BOOL) // trigger leveldb compaction on bootstrap
193OPTION(mon_compact_on_trim, OPT_BOOL) // compact (a prefix) when we trim old states
194OPTION(mon_osd_cache_size, OPT_INT) // the size of osdmaps cache, not to rely on underlying store's cache
195
196OPTION(mon_cpu_threads, OPT_INT)
197OPTION(mon_osd_mapping_pgs_per_chunk, OPT_INT)
198OPTION(mon_osd_max_creating_pgs, OPT_INT)
199OPTION(mon_tick_interval, OPT_INT)
200OPTION(mon_session_timeout, OPT_INT) // must send keepalive or subscribe
201OPTION(mon_subscribe_interval, OPT_DOUBLE) // for legacy clients only
202OPTION(mon_delta_reset_interval, OPT_DOUBLE) // seconds of inactivity before we reset the pg delta to 0
203OPTION(mon_osd_laggy_halflife, OPT_INT) // (seconds) how quickly our laggy estimations decay
204OPTION(mon_osd_laggy_weight, OPT_DOUBLE) // weight for new 'samples's in laggy estimations
205OPTION(mon_osd_laggy_max_interval, OPT_INT) // maximum value of laggy_interval in laggy estimations
206OPTION(mon_osd_adjust_heartbeat_grace, OPT_BOOL) // true if we should scale based on laggy estimations
207OPTION(mon_osd_adjust_down_out_interval, OPT_BOOL) // true if we should scale based on laggy estimations
208OPTION(mon_osd_auto_mark_in, OPT_BOOL) // mark any booting osds 'in'
209OPTION(mon_osd_auto_mark_auto_out_in, OPT_BOOL) // mark booting auto-marked-out osds 'in'
210OPTION(mon_osd_auto_mark_new_in, OPT_BOOL) // mark booting new osds 'in'
211OPTION(mon_osd_destroyed_out_interval, OPT_INT) // seconds
212OPTION(mon_osd_down_out_interval, OPT_INT) // seconds
213OPTION(mon_osd_down_out_subtree_limit, OPT_STR) // smallest crush unit/type that we will not automatically mark out
214OPTION(mon_osd_min_up_ratio, OPT_DOUBLE) // min osds required to be up to mark things down
215OPTION(mon_osd_min_in_ratio, OPT_DOUBLE) // min osds required to be in to mark things out
216OPTION(mon_osd_warn_op_age, OPT_DOUBLE) // max op age before we generate a warning (make it a power of 2)
217OPTION(mon_osd_err_op_age_ratio, OPT_DOUBLE) // when to generate an error, as multiple of mon_osd_warn_op_age
218OPTION(mon_osd_max_split_count, OPT_INT) // largest number of PGs per "involved" OSD to let split create
219OPTION(mon_osd_allow_primary_temp, OPT_BOOL) // allow primary_temp to be set in the osdmap
220OPTION(mon_osd_allow_primary_affinity, OPT_BOOL) // allow primary_affinity to be set in the osdmap
221OPTION(mon_osd_prime_pg_temp, OPT_BOOL) // prime osdmap with pg mapping changes
222OPTION(mon_osd_prime_pg_temp_max_time, OPT_FLOAT) // max time to spend priming
223OPTION(mon_osd_prime_pg_temp_max_estimate, OPT_FLOAT) // max estimate of pg total before we do all pgs in parallel
224OPTION(mon_osd_pool_ec_fast_read, OPT_BOOL) // whether turn on fast read on the pool or not
c07f9fc5
FG
225OPTION(mon_election_timeout, OPT_FLOAT) // on election proposer, max waiting time for all ACKs
226OPTION(mon_lease, OPT_FLOAT) // lease interval
227OPTION(mon_lease_renew_interval_factor, OPT_FLOAT) // on leader, to renew the lease
228OPTION(mon_lease_ack_timeout_factor, OPT_FLOAT) // on leader, if lease isn't acked by all peons
229OPTION(mon_accept_timeout_factor, OPT_FLOAT) // on leader, if paxos update isn't accepted
230
231OPTION(mon_clock_drift_allowed, OPT_FLOAT) // allowed clock drift between monitors
232OPTION(mon_clock_drift_warn_backoff, OPT_FLOAT) // exponential backoff for clock drift warnings
233OPTION(mon_timecheck_interval, OPT_FLOAT) // on leader, timecheck (clock drift check) interval (seconds)
234OPTION(mon_timecheck_skew_interval, OPT_FLOAT) // on leader, timecheck (clock drift check) interval when in presence of a skew (seconds)
c07f9fc5 235OPTION(mon_pg_min_inactive, OPT_U64) // the number of PGs which have to be inactive longer than 'mon_pg_stuck_threshold' before health goes into ERR. 0 means disabled, never go into ERR.
c07f9fc5
FG
236OPTION(mon_pg_warn_max_object_skew, OPT_FLOAT) // max skew few average in objects per pg
237OPTION(mon_pg_warn_min_objects, OPT_INT) // do not warn below this object #
238OPTION(mon_pg_warn_min_pool_objects, OPT_INT) // do not warn on pools below this object #
239OPTION(mon_pg_check_down_all_threshold, OPT_FLOAT) // threshold of down osds after which we check all pgs
240OPTION(mon_cache_target_full_warn_ratio, OPT_FLOAT) // position between pool cache_target_full and max where we start warning
241OPTION(mon_osd_full_ratio, OPT_FLOAT) // what % full makes an OSD "full"
242OPTION(mon_osd_backfillfull_ratio, OPT_FLOAT) // what % full makes an OSD backfill full (backfill halted)
243OPTION(mon_osd_nearfull_ratio, OPT_FLOAT) // what % full makes an OSD near full
244OPTION(mon_osd_initial_require_min_compat_client, OPT_STR)
245OPTION(mon_allow_pool_delete, OPT_BOOL) // allow pool deletion
246OPTION(mon_fake_pool_delete, OPT_BOOL) // fake pool deletion (add _DELETED suffix)
247OPTION(mon_globalid_prealloc, OPT_U32) // how many globalids to prealloc
248OPTION(mon_osd_report_timeout, OPT_INT) // grace period before declaring unresponsive OSDs dead
249OPTION(mon_force_standby_active, OPT_BOOL) // should mons force standby-replay mds to be active
250OPTION(mon_warn_on_legacy_crush_tunables, OPT_BOOL) // warn if crush tunables are too old (older than mon_min_crush_required_version)
251OPTION(mon_crush_min_required_version, OPT_STR)
252OPTION(mon_warn_on_crush_straw_calc_version_zero, OPT_BOOL) // warn if crush straw_calc_version==0
253OPTION(mon_warn_on_osd_down_out_interval_zero, OPT_BOOL) // warn if 'mon_osd_down_out_interval == 0'
254OPTION(mon_warn_on_cache_pools_without_hit_sets, OPT_BOOL)
255OPTION(mon_min_osdmap_epochs, OPT_INT)
256OPTION(mon_max_pgmap_epochs, OPT_INT)
257OPTION(mon_max_log_epochs, OPT_INT)
258OPTION(mon_max_mdsmap_epochs, OPT_INT)
259OPTION(mon_max_osd, OPT_INT)
260OPTION(mon_probe_timeout, OPT_DOUBLE)
261OPTION(mon_client_bytes, OPT_U64) // client msg data allowed in memory (in bytes)
c07f9fc5
FG
262OPTION(mon_log_max_summary, OPT_U64)
263OPTION(mon_daemon_bytes, OPT_U64) // mds, osd message memory cap (in bytes)
264OPTION(mon_max_log_entries_per_event, OPT_INT)
265OPTION(mon_reweight_min_pgs_per_osd, OPT_U64) // min pgs per osd for reweight-by-pg command
266OPTION(mon_reweight_min_bytes_per_osd, OPT_U64) // min bytes per osd for reweight-by-utilization command
267OPTION(mon_reweight_max_osds, OPT_INT) // max osds to change per reweight-by-* command
268OPTION(mon_reweight_max_change, OPT_DOUBLE)
269OPTION(mon_health_data_update_interval, OPT_FLOAT)
270OPTION(mon_health_to_clog, OPT_BOOL)
271OPTION(mon_health_to_clog_interval, OPT_INT)
272OPTION(mon_health_to_clog_tick_interval, OPT_DOUBLE)
273OPTION(mon_health_preluminous_compat, OPT_BOOL)
c07f9fc5
FG
274OPTION(mon_data_avail_crit, OPT_INT)
275OPTION(mon_data_avail_warn, OPT_INT)
276OPTION(mon_data_size_warn, OPT_U64) // issue a warning when the monitor's data store goes over 15GB (in bytes)
277OPTION(mon_warn_not_scrubbed, OPT_INT)
278OPTION(mon_warn_not_deep_scrubbed, OPT_INT)
279OPTION(mon_scrub_interval, OPT_INT) // once a day
280OPTION(mon_scrub_timeout, OPT_INT) // let's give it 5 minutes; why not.
281OPTION(mon_scrub_max_keys, OPT_INT) // max number of keys to scrub each time
282OPTION(mon_scrub_inject_crc_mismatch, OPT_DOUBLE) // probability of injected crc mismatch [0.0, 1.0]
283OPTION(mon_scrub_inject_missing_keys, OPT_DOUBLE) // probability of injected missing keys [0.0, 1.0]
284OPTION(mon_config_key_max_entry_size, OPT_INT) // max num bytes per config-key entry
285OPTION(mon_sync_timeout, OPT_DOUBLE)
286OPTION(mon_sync_max_payload_size, OPT_U32) // max size for a sync chunk payload (say)
287OPTION(mon_sync_debug, OPT_BOOL) // enable sync-specific debug
288OPTION(mon_inject_sync_get_chunk_delay, OPT_DOUBLE) // inject N second delay on each get_chunk request
289OPTION(mon_osd_min_down_reporters, OPT_INT) // number of OSDs from different subtrees who need to report a down OSD for it to count
290OPTION(mon_osd_reporter_subtree_level , OPT_STR) // in which level of parent bucket the reporters are counted
291OPTION(mon_osd_force_trim_to, OPT_INT) // force mon to trim maps to this point, regardless of min_last_epoch_clean (dangerous)
292OPTION(mon_mds_force_trim_to, OPT_INT) // force mon to trim mdsmaps to this point (dangerous)
293OPTION(mon_mds_skip_sanity, OPT_BOOL) // skip safety assertions on FSMap (in case of bugs where we want to continue anyway)
b32b8144 294OPTION(mon_osd_snap_trim_queue_warn_on, OPT_INT)
c07f9fc5
FG
295
296// monitor debug options
297OPTION(mon_debug_deprecated_as_obsolete, OPT_BOOL) // consider deprecated commands as obsolete
298
299// dump transactions
300OPTION(mon_debug_dump_transactions, OPT_BOOL)
301OPTION(mon_debug_dump_json, OPT_BOOL)
302OPTION(mon_debug_dump_location, OPT_STR)
303OPTION(mon_debug_no_require_luminous, OPT_BOOL)
304OPTION(mon_debug_no_require_bluestore_for_ec_overwrites, OPT_BOOL)
305OPTION(mon_debug_no_initial_persistent_features, OPT_BOOL)
306OPTION(mon_inject_transaction_delay_max, OPT_DOUBLE) // seconds
307OPTION(mon_inject_transaction_delay_probability, OPT_DOUBLE) // range [0, 1]
308
309OPTION(mon_sync_provider_kill_at, OPT_INT) // kill the sync provider at a specific point in the work flow
310OPTION(mon_sync_requester_kill_at, OPT_INT) // kill the sync requester at a specific point in the work flow
311OPTION(mon_force_quorum_join, OPT_BOOL) // force monitor to join quorum even if it has been previously removed from the map
312OPTION(mon_keyvaluedb, OPT_STR) // type of keyvaluedb backend
313
314// UNSAFE -- TESTING ONLY! Allows addition of a cache tier with preexisting snaps
315OPTION(mon_debug_unsafe_allow_tier_with_nonempty_snaps, OPT_BOOL)
316OPTION(mon_osd_blacklist_default_expire, OPT_DOUBLE) // default one hour
317OPTION(mon_osd_crush_smoke_test, OPT_BOOL)
318
319OPTION(paxos_stash_full_interval, OPT_INT) // how often (in commits) to stash a full copy of the PaxosService state
320OPTION(paxos_max_join_drift, OPT_INT) // max paxos iterations before we must first sync the monitor stores
321OPTION(paxos_propose_interval, OPT_DOUBLE) // gather updates for this long before proposing a map update
322OPTION(paxos_min_wait, OPT_DOUBLE) // min time to gather updates for after period of inactivity
323OPTION(paxos_min, OPT_INT) // minimum number of paxos states to keep around
324OPTION(paxos_trim_min, OPT_INT) // number of extra proposals tolerated before trimming
325OPTION(paxos_trim_max, OPT_INT) // max number of extra proposals to trim at a time
326OPTION(paxos_service_trim_min, OPT_INT) // minimum amount of versions to trigger a trim (0 disables it)
327OPTION(paxos_service_trim_max, OPT_INT) // maximum amount of versions to trim during a single proposal (0 disables it)
328OPTION(paxos_kill_at, OPT_INT)
329OPTION(auth_cluster_required, OPT_STR) // required of mon, mds, osd daemons
330OPTION(auth_service_required, OPT_STR) // required by daemons of clients
331OPTION(auth_client_required, OPT_STR) // what clients require of daemons
332OPTION(auth_supported, OPT_STR) // deprecated; default value for above if they are not defined.
333OPTION(max_rotating_auth_attempts, OPT_INT)
28e407b8 334OPTION(cephx_require_signatures, OPT_BOOL)
c07f9fc5
FG
335OPTION(cephx_cluster_require_signatures, OPT_BOOL)
336OPTION(cephx_service_require_signatures, OPT_BOOL)
28e407b8
AA
337OPTION(cephx_require_version, OPT_INT)
338OPTION(cephx_cluster_require_version, OPT_INT)
339OPTION(cephx_service_require_version, OPT_INT)
c07f9fc5
FG
340OPTION(cephx_sign_messages, OPT_BOOL) // Default to signing session messages if supported
341OPTION(auth_mon_ticket_ttl, OPT_DOUBLE)
342OPTION(auth_service_ticket_ttl, OPT_DOUBLE)
343OPTION(auth_debug, OPT_BOOL) // if true, assert when weird things happen
344OPTION(mon_client_hunt_parallel, OPT_U32) // how many mons to try to connect to in parallel during hunt
345OPTION(mon_client_hunt_interval, OPT_DOUBLE) // try new mon every N seconds until we connect
346OPTION(mon_client_ping_interval, OPT_DOUBLE) // ping every N seconds
347OPTION(mon_client_ping_timeout, OPT_DOUBLE) // fail if we don't hear back
348OPTION(mon_client_hunt_interval_backoff, OPT_DOUBLE) // each time we reconnect to a monitor, double our timeout
349OPTION(mon_client_hunt_interval_max_multiple, OPT_DOUBLE) // up to a max of 10*default (30 seconds)
350OPTION(mon_client_max_log_entries_per_message, OPT_INT)
351OPTION(mon_max_pool_pg_num, OPT_INT)
352OPTION(mon_pool_quota_warn_threshold, OPT_INT) // percent of quota at which to issue warnings
353OPTION(mon_pool_quota_crit_threshold, OPT_INT) // percent of quota at which to issue errors
354OPTION(client_cache_size, OPT_INT)
355OPTION(client_cache_mid, OPT_FLOAT)
356OPTION(client_use_random_mds, OPT_BOOL)
357OPTION(client_mount_timeout, OPT_DOUBLE)
358OPTION(client_tick_interval, OPT_DOUBLE)
359OPTION(client_trace, OPT_STR)
360OPTION(client_readahead_min, OPT_LONGLONG) // readahead at _least_ this much.
361OPTION(client_readahead_max_bytes, OPT_LONGLONG) // default unlimited
362OPTION(client_readahead_max_periods, OPT_LONGLONG) // as multiple of file layout period (object size * num stripes)
363OPTION(client_reconnect_stale, OPT_BOOL) // automatically reconnect stale session
364OPTION(client_snapdir, OPT_STR)
365OPTION(client_mountpoint, OPT_STR)
366OPTION(client_mount_uid, OPT_INT)
367OPTION(client_mount_gid, OPT_INT)
368OPTION(client_notify_timeout, OPT_INT) // in seconds
369OPTION(osd_client_watch_timeout, OPT_INT) // in seconds
370OPTION(client_caps_release_delay, OPT_INT) // in seconds
371OPTION(client_quota_df, OPT_BOOL) // use quota for df on subdir mounts
372OPTION(client_oc, OPT_BOOL)
373OPTION(client_oc_size, OPT_INT) // MB * n
374OPTION(client_oc_max_dirty, OPT_INT) // MB * n (dirty OR tx.. bigish)
375OPTION(client_oc_target_dirty, OPT_INT) // target dirty (keep this smallish)
376OPTION(client_oc_max_dirty_age, OPT_DOUBLE) // max age in cache before writeback
377OPTION(client_oc_max_objects, OPT_INT) // max objects in cache
378OPTION(client_debug_getattr_caps, OPT_BOOL) // check if MDS reply contains wanted caps
379OPTION(client_debug_force_sync_read, OPT_BOOL) // always read synchronously (go to osds)
380OPTION(client_debug_inject_tick_delay, OPT_INT) // delay the client tick for a number of seconds
381OPTION(client_max_inline_size, OPT_U64)
382OPTION(client_inject_release_failure, OPT_BOOL) // synthetic client bug for testing
383OPTION(client_inject_fixed_oldest_tid, OPT_BOOL) // synthetic client bug for testing
384OPTION(client_metadata, OPT_STR)
385OPTION(client_acl_type, OPT_STR)
386OPTION(client_permissions, OPT_BOOL)
387OPTION(client_dirsize_rbytes, OPT_BOOL)
388
389// note: the max amount of "in flight" dirty data is roughly (max - target)
390OPTION(fuse_use_invalidate_cb, OPT_BOOL) // use fuse 2.8+ invalidate callback to keep page cache consistent
391OPTION(fuse_disable_pagecache, OPT_BOOL)
392OPTION(fuse_allow_other, OPT_BOOL)
393OPTION(fuse_default_permissions, OPT_BOOL)
394OPTION(fuse_big_writes, OPT_BOOL)
395OPTION(fuse_atomic_o_trunc, OPT_BOOL)
396OPTION(fuse_debug, OPT_BOOL)
397OPTION(fuse_multithreaded, OPT_BOOL)
398OPTION(fuse_require_active_mds, OPT_BOOL) // if ceph_fuse requires active mds server
399OPTION(fuse_syncfs_on_mksnap, OPT_BOOL)
c07f9fc5
FG
400
401OPTION(client_try_dentry_invalidate, OPT_BOOL) // the client should try to use dentry invaldation instead of remounting, on kernels it believes that will work for
c07f9fc5
FG
402OPTION(client_check_pool_perm, OPT_BOOL)
403OPTION(client_use_faked_inos, OPT_BOOL)
404OPTION(client_mds_namespace, OPT_STR)
405
406OPTION(crush_location, OPT_STR) // whitespace-separated list of key=value pairs describing crush location
407OPTION(crush_location_hook, OPT_STR)
408OPTION(crush_location_hook_timeout, OPT_INT)
409
410OPTION(objecter_tick_interval, OPT_DOUBLE)
411OPTION(objecter_timeout, OPT_DOUBLE) // before we ask for a map
412OPTION(objecter_inflight_op_bytes, OPT_U64) // max in-flight data (both directions)
413OPTION(objecter_inflight_ops, OPT_U64) // max in-flight ios
414OPTION(objecter_completion_locks_per_session, OPT_U64) // num of completion locks per each session, for serializing same object responses
415OPTION(objecter_inject_no_watch_ping, OPT_BOOL) // suppress watch pings
416OPTION(objecter_retry_writes_after_first_reply, OPT_BOOL) // ignore the first reply for each write, and resend the osd op instead
417OPTION(objecter_debug_inject_relock_delay, OPT_BOOL)
418
419// Max number of deletes at once in a single Filer::purge call
420OPTION(filer_max_purge_ops, OPT_U32)
421// Max number of truncate at once in a single Filer::truncate call
422OPTION(filer_max_truncate_ops, OPT_U32)
423
424OPTION(journaler_write_head_interval, OPT_INT)
425OPTION(journaler_prefetch_periods, OPT_INT) // * journal object size
426OPTION(journaler_prezero_periods, OPT_INT) // * journal object size
427OPTION(mds_data, OPT_STR)
428OPTION(mds_max_file_size, OPT_U64) // Used when creating new CephFS. Change with 'ceph mds set max_file_size <size>' afterwards
429// max xattr kv pairs size for each dir/file
430OPTION(mds_max_xattr_pairs_size, OPT_U32)
c07f9fc5
FG
431OPTION(mds_max_file_recover, OPT_U32)
432OPTION(mds_dir_max_commit_size, OPT_INT) // MB
433OPTION(mds_dir_keys_per_op, OPT_INT)
434OPTION(mds_decay_halflife, OPT_FLOAT)
435OPTION(mds_beacon_interval, OPT_FLOAT)
436OPTION(mds_beacon_grace, OPT_FLOAT)
437OPTION(mds_enforce_unique_name, OPT_BOOL)
c07f9fc5 438
b32b8144 439OPTION(mds_session_timeout, OPT_FLOAT) // cap bits and leases time out if client unresponsive or not returning its caps
c07f9fc5
FG
440OPTION(mds_session_blacklist_on_timeout, OPT_BOOL) // whether to blacklist clients whose sessions are dropped due to timeout
441OPTION(mds_session_blacklist_on_evict, OPT_BOOL) // whether to blacklist clients whose sessions are dropped via admin commands
442
443OPTION(mds_sessionmap_keys_per_op, OPT_U32) // how many sessions should I try to load/store in a single OMAP operation?
c07f9fc5
FG
444OPTION(mds_recall_state_timeout, OPT_FLOAT) // detect clients which aren't trimming caps
445OPTION(mds_freeze_tree_timeout, OPT_FLOAT) // detecting freeze tree deadlock
446OPTION(mds_session_autoclose, OPT_FLOAT) // autoclose idle session
447OPTION(mds_health_summarize_threshold, OPT_INT) // collapse N-client health metrics to a single 'many'
c07f9fc5
FG
448OPTION(mds_reconnect_timeout, OPT_FLOAT) // seconds to wait for clients during mds restart
449 // make it (mds_session_timeout - mds_beacon_grace)
450OPTION(mds_tick_interval, OPT_FLOAT)
451OPTION(mds_dirstat_min_interval, OPT_FLOAT) // try to avoid propagating more often than this
452OPTION(mds_scatter_nudge_interval, OPT_FLOAT) // how quickly dirstat changes propagate up the hierarchy
453OPTION(mds_client_prealloc_inos, OPT_INT)
454OPTION(mds_early_reply, OPT_BOOL)
455OPTION(mds_default_dir_hash, OPT_INT)
456OPTION(mds_log_pause, OPT_BOOL)
457OPTION(mds_log_skip_corrupt_events, OPT_BOOL)
458OPTION(mds_log_max_events, OPT_INT)
459OPTION(mds_log_events_per_segment, OPT_INT)
460OPTION(mds_log_segment_size, OPT_INT) // segment size for mds log, default to default file_layout_t
461OPTION(mds_log_max_segments, OPT_U32)
c07f9fc5
FG
462OPTION(mds_bal_export_pin, OPT_BOOL) // allow clients to pin directory trees to ranks
463OPTION(mds_bal_sample_interval, OPT_DOUBLE) // every 3 seconds
464OPTION(mds_bal_replicate_threshold, OPT_FLOAT)
465OPTION(mds_bal_unreplicate_threshold, OPT_FLOAT)
466OPTION(mds_bal_frag, OPT_BOOL)
467OPTION(mds_bal_split_size, OPT_INT)
468OPTION(mds_bal_split_rd, OPT_FLOAT)
469OPTION(mds_bal_split_wr, OPT_FLOAT)
470OPTION(mds_bal_split_bits, OPT_INT)
471OPTION(mds_bal_merge_size, OPT_INT)
472OPTION(mds_bal_interval, OPT_INT) // seconds
473OPTION(mds_bal_fragment_interval, OPT_INT) // seconds
474OPTION(mds_bal_fragment_size_max, OPT_INT) // order of magnitude higher than split size
475OPTION(mds_bal_fragment_fast_factor, OPT_FLOAT) // multiple of size_max that triggers immediate split
476OPTION(mds_bal_idle_threshold, OPT_FLOAT)
477OPTION(mds_bal_max, OPT_INT)
478OPTION(mds_bal_max_until, OPT_INT)
479OPTION(mds_bal_mode, OPT_INT)
480OPTION(mds_bal_min_rebalance, OPT_FLOAT) // must be this much above average before we export anything
481OPTION(mds_bal_min_start, OPT_FLOAT) // if we need less than this, we don't do anything
482OPTION(mds_bal_need_min, OPT_FLOAT) // take within this range of what we need
483OPTION(mds_bal_need_max, OPT_FLOAT)
484OPTION(mds_bal_midchunk, OPT_FLOAT) // any sub bigger than this taken in full
485OPTION(mds_bal_minchunk, OPT_FLOAT) // never take anything smaller than this
486OPTION(mds_bal_target_decay, OPT_DOUBLE) // target decay half-life in MDSMap (2x larger is approx. 2x slower)
487OPTION(mds_replay_interval, OPT_FLOAT) // time to wait before starting replay again
488OPTION(mds_shutdown_check, OPT_INT)
489OPTION(mds_thrash_exports, OPT_INT)
490OPTION(mds_thrash_fragments, OPT_INT)
491OPTION(mds_dump_cache_on_map, OPT_BOOL)
492OPTION(mds_dump_cache_after_rejoin, OPT_BOOL)
493OPTION(mds_verify_scatter, OPT_BOOL)
494OPTION(mds_debug_scatterstat, OPT_BOOL)
495OPTION(mds_debug_frag, OPT_BOOL)
496OPTION(mds_debug_auth_pins, OPT_BOOL)
497OPTION(mds_debug_subtrees, OPT_BOOL)
498OPTION(mds_kill_mdstable_at, OPT_INT)
499OPTION(mds_kill_export_at, OPT_INT)
500OPTION(mds_kill_import_at, OPT_INT)
501OPTION(mds_kill_link_at, OPT_INT)
502OPTION(mds_kill_rename_at, OPT_INT)
503OPTION(mds_kill_openc_at, OPT_INT)
504OPTION(mds_kill_journal_expire_at, OPT_INT)
505OPTION(mds_kill_journal_replay_at, OPT_INT)
506OPTION(mds_journal_format, OPT_U32) // Default to most recent JOURNAL_FORMAT_*
507OPTION(mds_kill_create_at, OPT_INT)
508OPTION(mds_inject_traceless_reply_probability, OPT_DOUBLE) /* percentage
509 of MDS modify replies to skip sending the
510 client a trace on [0-1]*/
511OPTION(mds_wipe_sessions, OPT_BOOL)
512OPTION(mds_wipe_ino_prealloc, OPT_BOOL)
513OPTION(mds_skip_ino, OPT_INT)
514OPTION(mds_standby_for_name, OPT_STR)
515OPTION(mds_standby_for_rank, OPT_INT)
516OPTION(mds_standby_for_fscid, OPT_INT)
517OPTION(mds_standby_replay, OPT_BOOL)
518OPTION(mds_enable_op_tracker, OPT_BOOL) // enable/disable MDS op tracking
519OPTION(mds_op_history_size, OPT_U32) // Max number of completed ops to track
520OPTION(mds_op_history_duration, OPT_U32) // Oldest completed op to track
521OPTION(mds_op_complaint_time, OPT_FLOAT) // how many seconds old makes an op complaint-worthy
522OPTION(mds_op_log_threshold, OPT_INT) // how many op log messages to show in one go
523OPTION(mds_snap_min_uid, OPT_U32) // The minimum UID required to create a snapshot
524OPTION(mds_snap_max_uid, OPT_U32) // The maximum UID allowed to create a snapshot
525OPTION(mds_snap_rstat, OPT_BOOL) // enable/disbale nested stat for snapshot
526OPTION(mds_verify_backtrace, OPT_U32)
527// detect clients which aren't trimming completed requests
528OPTION(mds_max_completed_flushes, OPT_U32)
529OPTION(mds_max_completed_requests, OPT_U32)
530
531OPTION(mds_action_on_write_error, OPT_U32) // 0: ignore; 1: force readonly; 2: crash
532OPTION(mds_mon_shutdown_timeout, OPT_DOUBLE)
533
534// Maximum number of concurrent stray files to purge
535OPTION(mds_max_purge_files, OPT_U32)
536// Maximum number of concurrent RADOS ops to issue in purging
537OPTION(mds_max_purge_ops, OPT_U32)
538// Maximum number of concurrent RADOS ops to issue in purging, scaled by PG count
539OPTION(mds_max_purge_ops_per_pg, OPT_FLOAT)
540
541OPTION(mds_purge_queue_busy_flush_period, OPT_FLOAT)
542
543OPTION(mds_root_ino_uid, OPT_INT) // The UID of / on new filesystems
544OPTION(mds_root_ino_gid, OPT_INT) // The GID of / on new filesystems
545
546OPTION(mds_max_scrub_ops_in_progress, OPT_INT) // the number of simultaneous scrubs allowed
547
548// Maximum number of damaged frags/dentries before whole MDS rank goes damaged
549OPTION(mds_damage_table_max_entries, OPT_INT)
550
551// Maximum increment for client writable range, counted by number of objects
552OPTION(mds_client_writeable_range_max_inc_objs, OPT_U32)
553
554// verify backend can support configured max object name length
555OPTION(osd_check_max_object_name_len_on_startup, OPT_BOOL)
556
557// Maximum number of backfills to or from a single osd
558OPTION(osd_max_backfills, OPT_U64)
559
560// Minimum recovery priority (255 = max, smaller = lower)
561OPTION(osd_min_recovery_priority, OPT_INT)
562
563// Seconds to wait before retrying refused backfills
564OPTION(osd_backfill_retry_interval, OPT_DOUBLE)
565
566// Seconds to wait before retrying refused recovery
567OPTION(osd_recovery_retry_interval, OPT_DOUBLE)
568
569// max agent flush ops
570OPTION(osd_agent_max_ops, OPT_INT)
571OPTION(osd_agent_max_low_ops, OPT_INT)
572OPTION(osd_agent_min_evict_effort, OPT_FLOAT)
573OPTION(osd_agent_quantize_effort, OPT_FLOAT)
574OPTION(osd_agent_delay_time, OPT_FLOAT)
575
576// osd ignore history.last_epoch_started in find_best_info
577OPTION(osd_find_best_info_ignore_history_les, OPT_BOOL)
578
579// decay atime and hist histograms after how many objects go by
580OPTION(osd_agent_hist_halflife, OPT_INT)
581
582// must be this amount over the threshold to enable,
583// this amount below the threshold to disable.
584OPTION(osd_agent_slop, OPT_FLOAT)
585
586OPTION(osd_uuid, OPT_UUID)
587OPTION(osd_data, OPT_STR)
588OPTION(osd_journal, OPT_STR)
589OPTION(osd_journal_size, OPT_INT) // in mb
590OPTION(osd_journal_flush_on_shutdown, OPT_BOOL) // Flush journal to data store on shutdown
591// flags for specific control purpose during osd mount() process.
592// e.g., can be 1 to skip over replaying journal
593// or 2 to skip over mounting omap or 3 to skip over both.
594// This might be helpful in case the journal is totally corrupted
595// and we still want to bring the osd daemon back normally, etc.
596OPTION(osd_os_flags, OPT_U32)
597OPTION(osd_max_write_size, OPT_INT)
598OPTION(osd_max_pgls, OPT_U64) // max number of pgls entries to return
599OPTION(osd_client_message_size_cap, OPT_U64) // client data allowed in-memory (in bytes)
600OPTION(osd_client_message_cap, OPT_U64) // num client messages allowed in-memory
601OPTION(osd_pg_bits, OPT_INT) // bits per osd
602OPTION(osd_pgp_bits, OPT_INT) // bits per osd
603OPTION(osd_crush_update_weight_set, OPT_BOOL) // update weight set while updating weights
604OPTION(osd_crush_chooseleaf_type, OPT_INT) // 1 = host
605OPTION(osd_pool_use_gmt_hitset, OPT_BOOL) // try to use gmt for hitset archive names if all osds in cluster support it.
606OPTION(osd_crush_update_on_start, OPT_BOOL)
607OPTION(osd_class_update_on_start, OPT_BOOL) // automatically set device class on start
608OPTION(osd_crush_initial_weight, OPT_DOUBLE) // if >=0, the initial weight is for newly added osds.
609OPTION(osd_pool_default_crush_rule, OPT_INT)
610OPTION(osd_pool_erasure_code_stripe_unit, OPT_U32) // in bytes
611OPTION(osd_pool_default_size, OPT_INT)
612OPTION(osd_pool_default_min_size, OPT_INT) // 0 means no specific default; ceph will use size-size/2
613OPTION(osd_pool_default_pg_num, OPT_INT) // number of PGs for new pools. Configure in global or mon section of ceph.conf
614OPTION(osd_pool_default_pgp_num, OPT_INT) // number of PGs for placement purposes. Should be equal to pg_num
615OPTION(osd_pool_default_type, OPT_STR)
616OPTION(osd_pool_default_erasure_code_profile, OPT_STR) // default properties of osd pool create
617OPTION(osd_erasure_code_plugins, OPT_STR) // list of erasure code plugins
618
619// Allows the "peered" state for recovery and backfill below min_size
620OPTION(osd_allow_recovery_below_min_size, OPT_BOOL)
621
622OPTION(osd_pool_default_flags, OPT_INT) // default flags for new pools
623OPTION(osd_pool_default_flag_hashpspool, OPT_BOOL) // use new pg hashing to prevent pool/pg overlap
624OPTION(osd_pool_default_flag_nodelete, OPT_BOOL) // pool can't be deleted
625OPTION(osd_pool_default_flag_nopgchange, OPT_BOOL) // pool's pg and pgp num can't be changed
626OPTION(osd_pool_default_flag_nosizechange, OPT_BOOL) // pool's size and min size can't be changed
627OPTION(osd_pool_default_hit_set_bloom_fpp, OPT_FLOAT)
628OPTION(osd_pool_default_cache_target_dirty_ratio, OPT_FLOAT)
629OPTION(osd_pool_default_cache_target_dirty_high_ratio, OPT_FLOAT)
630OPTION(osd_pool_default_cache_target_full_ratio, OPT_FLOAT)
631OPTION(osd_pool_default_cache_min_flush_age, OPT_INT) // seconds
632OPTION(osd_pool_default_cache_min_evict_age, OPT_INT) // seconds
633OPTION(osd_pool_default_cache_max_evict_check_size, OPT_INT) // max size to check for eviction
634OPTION(osd_hit_set_min_size, OPT_INT) // min target size for a HitSet
635OPTION(osd_hit_set_max_size, OPT_INT) // max target size for a HitSet
636OPTION(osd_hit_set_namespace, OPT_STR) // rados namespace for hit_set tracking
637
638// conservative default throttling values
639OPTION(osd_tier_promote_max_objects_sec, OPT_U64)
640OPTION(osd_tier_promote_max_bytes_sec, OPT_U64)
641
642OPTION(osd_tier_default_cache_mode, OPT_STR)
643OPTION(osd_tier_default_cache_hit_set_count, OPT_INT)
644OPTION(osd_tier_default_cache_hit_set_period, OPT_INT)
645OPTION(osd_tier_default_cache_hit_set_type, OPT_STR)
646OPTION(osd_tier_default_cache_min_read_recency_for_promote, OPT_INT) // number of recent HitSets the object must appear in to be promoted (on read)
647OPTION(osd_tier_default_cache_min_write_recency_for_promote, OPT_INT) // number of recent HitSets the object must appear in to be promoted (on write)
648OPTION(osd_tier_default_cache_hit_set_grade_decay_rate, OPT_INT)
649OPTION(osd_tier_default_cache_hit_set_search_last_n, OPT_INT)
650
651OPTION(osd_map_dedup, OPT_BOOL)
652OPTION(osd_map_max_advance, OPT_INT) // make this < cache_size!
653OPTION(osd_map_cache_size, OPT_INT)
654OPTION(osd_map_message_max, OPT_INT) // max maps per MOSDMap message
655OPTION(osd_map_share_max_epochs, OPT_INT) // cap on # of inc maps we send to peers, clients
656OPTION(osd_inject_bad_map_crc_probability, OPT_FLOAT)
657OPTION(osd_inject_failure_on_pg_removal, OPT_BOOL)
658// shutdown the OSD if stuatus flipping more than max_markdown_count times in recent max_markdown_period seconds
659OPTION(osd_max_markdown_period , OPT_INT)
660OPTION(osd_max_markdown_count, OPT_INT)
661
662OPTION(osd_peering_wq_threads, OPT_INT)
663OPTION(osd_peering_wq_batch_size, OPT_U64)
664OPTION(osd_op_pq_max_tokens_per_priority, OPT_U64)
665OPTION(osd_op_pq_min_cost, OPT_U64)
666OPTION(osd_disk_threads, OPT_INT)
667OPTION(osd_disk_thread_ioprio_class, OPT_STR) // rt realtime be best effort idle
668OPTION(osd_disk_thread_ioprio_priority, OPT_INT) // 0-7
669OPTION(osd_recover_clone_overlap, OPT_BOOL) // preserve clone_overlap during recovery/migration
670OPTION(osd_op_num_threads_per_shard, OPT_INT)
671OPTION(osd_op_num_threads_per_shard_hdd, OPT_INT)
672OPTION(osd_op_num_threads_per_shard_ssd, OPT_INT)
673OPTION(osd_op_num_shards, OPT_INT)
674OPTION(osd_op_num_shards_hdd, OPT_INT)
675OPTION(osd_op_num_shards_ssd, OPT_INT)
676
677// PrioritzedQueue (prio), Weighted Priority Queue (wpq ; default),
678// mclock_opclass, mclock_client, or debug_random. "mclock_opclass"
679// and "mclock_client" are based on the mClock/dmClock algorithm
680// (Gulati, et al. 2010). "mclock_opclass" prioritizes based on the
681// class the operation belongs to. "mclock_client" does the same but
682// also works to ienforce fairness between clients. "debug_random"
683// chooses among all four with equal probability.
684OPTION(osd_op_queue, OPT_STR)
685
686OPTION(osd_op_queue_cut_off, OPT_STR) // Min priority to go to strict queue. (low, high)
687
688// mClock priority queue parameters for five types of ops
689OPTION(osd_op_queue_mclock_client_op_res, OPT_DOUBLE)
690OPTION(osd_op_queue_mclock_client_op_wgt, OPT_DOUBLE)
691OPTION(osd_op_queue_mclock_client_op_lim, OPT_DOUBLE)
692OPTION(osd_op_queue_mclock_osd_subop_res, OPT_DOUBLE)
693OPTION(osd_op_queue_mclock_osd_subop_wgt, OPT_DOUBLE)
694OPTION(osd_op_queue_mclock_osd_subop_lim, OPT_DOUBLE)
695OPTION(osd_op_queue_mclock_snap_res, OPT_DOUBLE)
696OPTION(osd_op_queue_mclock_snap_wgt, OPT_DOUBLE)
697OPTION(osd_op_queue_mclock_snap_lim, OPT_DOUBLE)
698OPTION(osd_op_queue_mclock_recov_res, OPT_DOUBLE)
699OPTION(osd_op_queue_mclock_recov_wgt, OPT_DOUBLE)
700OPTION(osd_op_queue_mclock_recov_lim, OPT_DOUBLE)
701OPTION(osd_op_queue_mclock_scrub_res, OPT_DOUBLE)
702OPTION(osd_op_queue_mclock_scrub_wgt, OPT_DOUBLE)
703OPTION(osd_op_queue_mclock_scrub_lim, OPT_DOUBLE)
704
705OPTION(osd_ignore_stale_divergent_priors, OPT_BOOL) // do not assert on divergent_prior entries which aren't in the log and whose on-disk objects are newer
706
707// Set to true for testing. Users should NOT set this.
708// If set to true even after reading enough shards to
709// decode the object, any error will be reported.
710OPTION(osd_read_ec_check_for_errors, OPT_BOOL) // return error if any ec shard has an error
711
712// Only use clone_overlap for recovery if there are fewer than
713// osd_recover_clone_overlap_limit entries in the overlap set
714OPTION(osd_recover_clone_overlap_limit, OPT_INT)
715
716OPTION(osd_backfill_scan_min, OPT_INT)
717OPTION(osd_backfill_scan_max, OPT_INT)
718OPTION(osd_op_thread_timeout, OPT_INT)
719OPTION(osd_op_thread_suicide_timeout, OPT_INT)
720OPTION(osd_recovery_thread_timeout, OPT_INT)
721OPTION(osd_recovery_thread_suicide_timeout, OPT_INT)
722OPTION(osd_recovery_sleep, OPT_FLOAT) // seconds to sleep between recovery ops
723OPTION(osd_recovery_sleep_hdd, OPT_FLOAT)
724OPTION(osd_recovery_sleep_ssd, OPT_FLOAT)
725OPTION(osd_snap_trim_sleep, OPT_DOUBLE)
726OPTION(osd_scrub_invalid_stats, OPT_BOOL)
727OPTION(osd_remove_thread_timeout, OPT_INT)
728OPTION(osd_remove_thread_suicide_timeout, OPT_INT)
729OPTION(osd_command_thread_timeout, OPT_INT)
730OPTION(osd_command_thread_suicide_timeout, OPT_INT)
731OPTION(osd_heartbeat_addr, OPT_ADDR)
732OPTION(osd_heartbeat_interval, OPT_INT) // (seconds) how often we ping peers
733
734// (seconds) how long before we decide a peer has failed
735// This setting is read by the MONs and OSDs and has to be set to a equal value in both settings of the configuration
736OPTION(osd_heartbeat_grace, OPT_INT)
737OPTION(osd_heartbeat_min_peers, OPT_INT) // minimum number of peers
738OPTION(osd_heartbeat_use_min_delay_socket, OPT_BOOL) // prio the heartbeat tcp socket and set dscp as CS6 on it if true
739OPTION(osd_heartbeat_min_size, OPT_INT) // the minimum size of OSD heartbeat messages to send
740
741// max number of parallel snap trims/pg
742OPTION(osd_pg_max_concurrent_snap_trims, OPT_U64)
743// max number of trimming pgs
744OPTION(osd_max_trimming_pgs, OPT_U64)
745
746// minimum number of peers that must be reachable to mark ourselves
747// back up after being wrongly marked down.
748OPTION(osd_heartbeat_min_healthy_ratio, OPT_FLOAT)
749
750OPTION(osd_mon_heartbeat_interval, OPT_INT) // (seconds) how often to ping monitor if no peers
751OPTION(osd_mon_report_interval_max, OPT_INT)
752OPTION(osd_mon_report_interval_min, OPT_INT) // pg stats, failures, up_thru, boot.
753OPTION(osd_mon_report_max_in_flight, OPT_INT) // max updates in flight
754OPTION(osd_beacon_report_interval, OPT_INT) // (second) how often to send beacon message to monitor
755OPTION(osd_pg_stat_report_interval_max, OPT_INT) // report pg stats for any given pg at least this often
756OPTION(osd_mon_ack_timeout, OPT_DOUBLE) // time out a mon if it doesn't ack stats
757OPTION(osd_stats_ack_timeout_factor, OPT_DOUBLE) // multiples of mon_ack_timeout
758OPTION(osd_stats_ack_timeout_decay, OPT_DOUBLE)
759OPTION(osd_default_data_pool_replay_window, OPT_INT)
760OPTION(osd_auto_mark_unfound_lost, OPT_BOOL)
761OPTION(osd_recovery_delay_start, OPT_FLOAT)
762OPTION(osd_recovery_max_active, OPT_U64)
763OPTION(osd_recovery_max_single_start, OPT_U64)
764OPTION(osd_recovery_max_chunk, OPT_U64) // max size of push chunk
765OPTION(osd_recovery_max_omap_entries_per_chunk, OPT_U64) // max number of omap entries per chunk; 0 to disable limit
766OPTION(osd_copyfrom_max_chunk, OPT_U64) // max size of a COPYFROM chunk
767OPTION(osd_push_per_object_cost, OPT_U64) // push cost per object
768OPTION(osd_max_push_cost, OPT_U64) // max size of push message
769OPTION(osd_max_push_objects, OPT_U64) // max objects in single push op
770OPTION(osd_recovery_forget_lost_objects, OPT_BOOL) // off for now
771OPTION(osd_max_scrubs, OPT_INT)
772OPTION(osd_scrub_during_recovery, OPT_BOOL) // Allow new scrubs to start while recovery is active on the OSD
773OPTION(osd_scrub_begin_hour, OPT_INT)
774OPTION(osd_scrub_end_hour, OPT_INT)
28e407b8
AA
775OPTION(osd_scrub_begin_week_day, OPT_INT)
776OPTION(osd_scrub_end_week_day, OPT_INT)
c07f9fc5
FG
777OPTION(osd_scrub_load_threshold, OPT_FLOAT)
778OPTION(osd_scrub_min_interval, OPT_FLOAT) // if load is low
779OPTION(osd_scrub_max_interval, OPT_FLOAT) // regardless of load
780OPTION(osd_scrub_interval_randomize_ratio, OPT_FLOAT) // randomize the scheduled scrub in the span of [min,min*(1+randomize_ratio))
781OPTION(osd_scrub_backoff_ratio, OPT_DOUBLE) // the probability to back off the scheduled scrub
782OPTION(osd_scrub_chunk_min, OPT_INT)
783OPTION(osd_scrub_chunk_max, OPT_INT)
784OPTION(osd_scrub_sleep, OPT_FLOAT) // sleep between [deep]scrub ops
785OPTION(osd_scrub_auto_repair, OPT_BOOL) // whether auto-repair inconsistencies upon deep-scrubbing
786OPTION(osd_scrub_auto_repair_num_errors, OPT_U32) // only auto-repair when number of errors is below this threshold
787OPTION(osd_deep_scrub_interval, OPT_FLOAT) // once a week
788OPTION(osd_deep_scrub_randomize_ratio, OPT_FLOAT) // scrubs will randomly become deep scrubs at this rate (0.15 -> 15% of scrubs are deep)
789OPTION(osd_deep_scrub_stride, OPT_INT)
28e407b8 790OPTION(osd_deep_scrub_keys, OPT_INT)
c07f9fc5 791OPTION(osd_deep_scrub_update_digest_min_age, OPT_INT) // objects must be this old (seconds) before we update the whole-object digest on scrub
28e407b8
AA
792OPTION(osd_skip_data_digest, OPT_BOOL)
793OPTION(osd_distrust_data_digest, OPT_BOOL)
794OPTION(osd_deep_scrub_large_omap_object_key_threshold, OPT_U64)
795OPTION(osd_deep_scrub_large_omap_object_value_sum_threshold, OPT_U64)
c07f9fc5
FG
796OPTION(osd_class_dir, OPT_STR) // where rados plugins are stored
797OPTION(osd_open_classes_on_start, OPT_BOOL)
798OPTION(osd_class_load_list, OPT_STR) // list of object classes allowed to be loaded (allow all: *)
799OPTION(osd_class_default_list, OPT_STR) // list of object classes with default execute perm (allow all: *)
800OPTION(osd_check_for_log_corruption, OPT_BOOL)
801OPTION(osd_use_stale_snap, OPT_BOOL)
802OPTION(osd_rollback_to_cluster_snap, OPT_STR)
803OPTION(osd_default_notify_timeout, OPT_U32) // default notify timeout in seconds
804OPTION(osd_kill_backfill_at, OPT_INT)
805
806// Bounds how infrequently a new map epoch will be persisted for a pg
807OPTION(osd_pg_epoch_persisted_max_stale, OPT_U32) // make this < map_cache_size!
808
809OPTION(osd_min_pg_log_entries, OPT_U32) // number of entries to keep in the pg log when trimming it
810OPTION(osd_max_pg_log_entries, OPT_U32) // max entries, say when degraded, before we trim
811OPTION(osd_pg_log_dups_tracked, OPT_U32) // how many versions back to track combined in both pglog's regular + dup logs
812OPTION(osd_force_recovery_pg_log_entries_factor, OPT_FLOAT) // max entries factor before force recovery
813OPTION(osd_pg_log_trim_min, OPT_U32)
94b18763 814OPTION(osd_pg_log_trim_max, OPT_U32)
c07f9fc5
FG
815OPTION(osd_op_complaint_time, OPT_FLOAT) // how many seconds old makes an op complaint-worthy
816OPTION(osd_command_max_records, OPT_INT)
817OPTION(osd_max_pg_blocked_by, OPT_U32) // max peer osds to report that are blocking our progress
818OPTION(osd_op_log_threshold, OPT_INT) // how many op log messages to show in one go
819OPTION(osd_verify_sparse_read_holes, OPT_BOOL) // read fiemap-reported holes and verify they are zeros
820OPTION(osd_backoff_on_unfound, OPT_BOOL) // object unfound
821OPTION(osd_backoff_on_degraded, OPT_BOOL) // [mainly for debug?] object unreadable/writeable
822OPTION(osd_backoff_on_down, OPT_BOOL) // pg in down/incomplete state
823OPTION(osd_backoff_on_peering, OPT_BOOL) // [debug] pg peering
824OPTION(osd_debug_crash_on_ignored_backoff, OPT_BOOL) // crash osd if client ignores a backoff; useful for debugging
825OPTION(osd_debug_inject_dispatch_delay_probability, OPT_DOUBLE)
826OPTION(osd_debug_inject_dispatch_delay_duration, OPT_DOUBLE)
827OPTION(osd_debug_drop_ping_probability, OPT_DOUBLE)
828OPTION(osd_debug_drop_ping_duration, OPT_INT)
829OPTION(osd_debug_op_order, OPT_BOOL)
830OPTION(osd_debug_verify_missing_on_start, OPT_BOOL)
94b18763 831OPTION(osd_debug_verify_snaps, OPT_BOOL)
c07f9fc5
FG
832OPTION(osd_debug_verify_stray_on_activate, OPT_BOOL)
833OPTION(osd_debug_skip_full_check_in_backfill_reservation, OPT_BOOL)
834OPTION(osd_debug_reject_backfill_probability, OPT_DOUBLE)
835OPTION(osd_debug_inject_copyfrom_error, OPT_BOOL) // inject failure during copyfrom completion
836OPTION(osd_debug_misdirected_ops, OPT_BOOL)
837OPTION(osd_debug_skip_full_check_in_recovery, OPT_BOOL)
838OPTION(osd_debug_random_push_read_error, OPT_DOUBLE)
839OPTION(osd_debug_verify_cached_snaps, OPT_BOOL)
28e407b8 840OPTION(osd_debug_deep_scrub_sleep, OPT_FLOAT)
c07f9fc5
FG
841OPTION(osd_enable_op_tracker, OPT_BOOL) // enable/disable OSD op tracking
842OPTION(osd_num_op_tracker_shard, OPT_U32) // The number of shards for holding the ops
843OPTION(osd_op_history_size, OPT_U32) // Max number of completed ops to track
844OPTION(osd_op_history_duration, OPT_U32) // Oldest completed op to track
845OPTION(osd_op_history_slow_op_size, OPT_U32) // Max number of slow ops to track
846OPTION(osd_op_history_slow_op_threshold, OPT_DOUBLE) // track the op if over this threshold
847OPTION(osd_target_transaction_size, OPT_INT) // to adjust various transactions that batch smaller items
848OPTION(osd_failsafe_full_ratio, OPT_FLOAT) // what % full makes an OSD "full" (failsafe)
849OPTION(osd_fast_fail_on_connection_refused, OPT_BOOL) // immediately mark OSDs as down once they refuse to accept connections
850
851OPTION(osd_pg_object_context_cache_count, OPT_INT)
852OPTION(osd_tracing, OPT_BOOL) // true if LTTng-UST tracepoints should be enabled
853OPTION(osd_function_tracing, OPT_BOOL) // true if function instrumentation should use LTTng
854
855OPTION(osd_fast_info, OPT_BOOL) // use fast info attr, if we can
856
857// determines whether PGLog::check() compares written out log to stored log
858OPTION(osd_debug_pg_log_writeout, OPT_BOOL)
859OPTION(osd_loop_before_reset_tphandle, OPT_U32) // Max number of loop before we reset thread-pool's handle
860// default timeout while caling WaitInterval on an empty queue
861OPTION(threadpool_default_timeout, OPT_INT)
862// default wait time for an empty queue before pinging the hb timeout
863OPTION(threadpool_empty_queue_max_wait, OPT_INT)
864
865OPTION(leveldb_log_to_ceph_log, OPT_BOOL)
866OPTION(leveldb_write_buffer_size, OPT_U64) // leveldb write buffer size
867OPTION(leveldb_cache_size, OPT_U64) // leveldb cache size
868OPTION(leveldb_block_size, OPT_U64) // leveldb block size
869OPTION(leveldb_bloom_size, OPT_INT) // leveldb bloom bits per entry
870OPTION(leveldb_max_open_files, OPT_INT) // leveldb max open files
871OPTION(leveldb_compression, OPT_BOOL) // leveldb uses compression
872OPTION(leveldb_paranoid, OPT_BOOL) // leveldb paranoid flag
873OPTION(leveldb_log, OPT_STR) // enable leveldb log file
874OPTION(leveldb_compact_on_mount, OPT_BOOL)
875
876OPTION(kinetic_host, OPT_STR) // hostname or ip address of a kinetic drive to use
877OPTION(kinetic_port, OPT_INT) // port number of the kinetic drive
878OPTION(kinetic_user_id, OPT_INT) // kinetic user to authenticate as
879OPTION(kinetic_hmac_key, OPT_STR) // kinetic key to authenticate with
880OPTION(kinetic_use_ssl, OPT_BOOL) // whether to secure kinetic traffic with TLS
881
882
883OPTION(rocksdb_separate_wal_dir, OPT_BOOL) // use $path.wal for wal
884SAFE_OPTION(rocksdb_db_paths, OPT_STR) // path,size( path,size)*
885OPTION(rocksdb_log_to_ceph_log, OPT_BOOL) // log to ceph log
886OPTION(rocksdb_cache_size, OPT_U64) // rocksdb cache size (unless set by bluestore/etc)
887OPTION(rocksdb_cache_row_ratio, OPT_FLOAT) // ratio of cache for row (vs block)
888OPTION(rocksdb_cache_shard_bits, OPT_INT) // rocksdb block cache shard bits, 4 bit -> 16 shards
889OPTION(rocksdb_cache_type, OPT_STR) // 'lru' or 'clock'
890OPTION(rocksdb_block_size, OPT_INT) // default rocksdb block size
891OPTION(rocksdb_perf, OPT_BOOL) // Enabling this will have 5-10% impact on performance for the stats collection
892OPTION(rocksdb_collect_compaction_stats, OPT_BOOL) //For rocksdb, this behavior will be an overhead of 5%~10%, collected only rocksdb_perf is enabled.
893OPTION(rocksdb_collect_extended_stats, OPT_BOOL) //For rocksdb, this behavior will be an overhead of 5%~10%, collected only rocksdb_perf is enabled.
894OPTION(rocksdb_collect_memory_stats, OPT_BOOL) //For rocksdb, this behavior will be an overhead of 5%~10%, collected only rocksdb_perf is enabled.
895OPTION(rocksdb_enable_rmrange, OPT_BOOL) // see https://github.com/facebook/rocksdb/blob/master/include/rocksdb/db.h#L253
896
897// rocksdb options that will be used for omap(if omap_backend is rocksdb)
898OPTION(filestore_rocksdb_options, OPT_STR)
899// rocksdb options that will be used in monstore
900OPTION(mon_rocksdb_options, OPT_STR)
901
902/**
903 * osd_*_priority adjust the relative priority of client io, recovery io,
904 * snaptrim io, etc
905 *
906 * osd_*_priority determines the ratio of available io between client and
907 * recovery. Each option may be set between
908 * 1..63.
909 */
910OPTION(osd_client_op_priority, OPT_U32)
911OPTION(osd_recovery_op_priority, OPT_U32)
912
913OPTION(osd_snap_trim_priority, OPT_U32)
914OPTION(osd_snap_trim_cost, OPT_U32) // set default cost equal to 1MB io
915
916OPTION(osd_scrub_priority, OPT_U32)
917// set default cost equal to 50MB io
918OPTION(osd_scrub_cost, OPT_U32)
919// set requested scrub priority higher than scrub priority to make the
920// requested scrubs jump the queue of scheduled scrubs
921OPTION(osd_requested_scrub_priority, OPT_U32)
922
923OPTION(osd_recovery_priority, OPT_U32)
924// set default cost equal to 20MB io
925OPTION(osd_recovery_cost, OPT_U32)
926
927/**
928 * osd_recovery_op_warn_multiple scales the normal warning threshhold,
929 * osd_op_complaint_time, so that slow recovery ops won't cause noise
930 */
931OPTION(osd_recovery_op_warn_multiple, OPT_U32)
932
933// Max time to wait between notifying mon of shutdown and shutting down
934OPTION(osd_mon_shutdown_timeout, OPT_DOUBLE)
935OPTION(osd_shutdown_pgref_assert, OPT_BOOL) // crash if the OSD has stray PG refs on shutdown
936
937OPTION(osd_max_object_size, OPT_U64) // OSD's maximum object size
938OPTION(osd_max_object_name_len, OPT_U32) // max rados object name len
939OPTION(osd_max_object_namespace_len, OPT_U32) // max rados object namespace len
940OPTION(osd_max_attr_name_len, OPT_U32) // max rados attr name len; cannot go higher than 100 chars for file system backends
941OPTION(osd_max_attr_size, OPT_U64)
942
943OPTION(osd_max_omap_entries_per_request, OPT_U64)
944OPTION(osd_max_omap_bytes_per_request, OPT_U64)
945
946OPTION(osd_objectstore, OPT_STR) // ObjectStore backend type
947OPTION(osd_objectstore_tracing, OPT_BOOL) // true if LTTng-UST tracepoints should be enabled
948OPTION(osd_objectstore_fuse, OPT_BOOL)
949
950OPTION(osd_bench_small_size_max_iops, OPT_U32) // 100 IOPS
951OPTION(osd_bench_large_size_max_throughput, OPT_U64) // 100 MB/s
952OPTION(osd_bench_max_block_size, OPT_U64) // cap the block size at 64MB
953OPTION(osd_bench_duration, OPT_U32) // duration of 'osd bench', capped at 30s to avoid triggering timeouts
954
955OPTION(osd_blkin_trace_all, OPT_BOOL) // create a blkin trace for all osd requests
956OPTION(osdc_blkin_trace_all, OPT_BOOL) // create a blkin trace for all objecter requests
957
958OPTION(osd_discard_disconnected_ops, OPT_BOOL)
959
960OPTION(memstore_device_bytes, OPT_U64)
961OPTION(memstore_page_set, OPT_BOOL)
962OPTION(memstore_page_size, OPT_U64)
963
964OPTION(bdev_debug_inflight_ios, OPT_BOOL)
965OPTION(bdev_inject_crash, OPT_INT) // if N>0, then ~ 1/N IOs will complete before we crash on flush.
966OPTION(bdev_inject_crash_flush_delay, OPT_INT) // wait N more seconds on flush
967OPTION(bdev_aio, OPT_BOOL)
968OPTION(bdev_aio_poll_ms, OPT_INT) // milliseconds
969OPTION(bdev_aio_max_queue_depth, OPT_INT)
970OPTION(bdev_aio_reap_max, OPT_INT)
971OPTION(bdev_block_size, OPT_INT)
972OPTION(bdev_debug_aio, OPT_BOOL)
973OPTION(bdev_debug_aio_suicide_timeout, OPT_FLOAT)
974
975// if yes, osd will unbind all NVMe devices from kernel driver and bind them
976// to the uio_pci_generic driver. The purpose is to prevent the case where
977// NVMe driver is loaded while osd is running.
978OPTION(bdev_nvme_unbind_from_kernel, OPT_BOOL)
979OPTION(bdev_nvme_retry_count, OPT_INT) // -1 means by default which is 4
980
981OPTION(objectstore_blackhole, OPT_BOOL)
982
983OPTION(bluefs_alloc_size, OPT_U64)
984OPTION(bluefs_max_prefetch, OPT_U64)
985OPTION(bluefs_min_log_runway, OPT_U64) // alloc when we get this low
986OPTION(bluefs_max_log_runway, OPT_U64) // alloc this much at a time
987OPTION(bluefs_log_compact_min_ratio, OPT_FLOAT) // before we consider
988OPTION(bluefs_log_compact_min_size, OPT_U64) // before we consider
989OPTION(bluefs_min_flush_size, OPT_U64) // ignore flush until its this big
990OPTION(bluefs_compact_log_sync, OPT_BOOL) // sync or async log compaction?
991OPTION(bluefs_buffered_io, OPT_BOOL)
992OPTION(bluefs_sync_write, OPT_BOOL)
993OPTION(bluefs_allocator, OPT_STR) // stupid | bitmap
994OPTION(bluefs_preextend_wal_files, OPT_BOOL) // this *requires* that rocksdb has recycling enabled
995
996OPTION(bluestore_bluefs, OPT_BOOL)
997OPTION(bluestore_bluefs_env_mirror, OPT_BOOL) // mirror to normal Env for debug
998OPTION(bluestore_bluefs_min, OPT_U64) // 1gb
999OPTION(bluestore_bluefs_min_ratio, OPT_FLOAT) // min fs free / total free
1000OPTION(bluestore_bluefs_max_ratio, OPT_FLOAT) // max fs free / total free
1001OPTION(bluestore_bluefs_gift_ratio, OPT_FLOAT) // how much to add at a time
1002OPTION(bluestore_bluefs_reclaim_ratio, OPT_FLOAT) // how much to reclaim at a time
1003OPTION(bluestore_bluefs_balance_interval, OPT_FLOAT) // how often (sec) to balance free space between bluefs and bluestore
1004// If you want to use spdk driver, you need to specify NVMe serial number here
1005// with "spdk:" prefix.
1006// Users can use 'lspci -vvv -d 8086:0953 | grep "Device Serial Number"' to
1007// get the serial number of Intel(R) Fultondale NVMe controllers.
1008// Example:
1009// bluestore_block_path = spdk:55cd2e404bd73932
1010// If you want to run multiple SPDK instances per node, you must specify the
1011// amount of dpdk memory size in MB each instance will use, to make sure each
1012// instance uses its own dpdk memory
1013OPTION(bluestore_spdk_mem, OPT_U32)
1014// A hexadecimal bit mask of the cores to run on. Note the core numbering can change between platforms and should be determined beforehand.
1015OPTION(bluestore_spdk_coremask, OPT_STR)
1016// Specify the maximal I/Os to be batched completed while checking queue pair completions.
1017// Default value 0 means that let SPDK nvme library determine the value.
1018OPTION(bluestore_spdk_max_io_completion, OPT_U32)
1019OPTION(bluestore_block_path, OPT_STR)
1020OPTION(bluestore_block_size, OPT_U64) // 10gb for testing
1021OPTION(bluestore_block_create, OPT_BOOL)
1022OPTION(bluestore_block_db_path, OPT_STR)
1023OPTION(bluestore_block_db_size, OPT_U64) // rocksdb ssts (hot/warm)
1024OPTION(bluestore_block_db_create, OPT_BOOL)
1025OPTION(bluestore_block_wal_path, OPT_STR)
1026OPTION(bluestore_block_wal_size, OPT_U64) // rocksdb wal
1027OPTION(bluestore_block_wal_create, OPT_BOOL)
1028OPTION(bluestore_block_preallocate_file, OPT_BOOL) //whether preallocate space if block/db_path/wal_path is file rather that block device.
1029OPTION(bluestore_csum_type, OPT_STR) // none|xxhash32|xxhash64|crc32c|crc32c_16|crc32c_8
1030OPTION(bluestore_csum_min_block, OPT_U32)
1031OPTION(bluestore_csum_max_block, OPT_U32)
1032OPTION(bluestore_min_alloc_size, OPT_U32)
1033OPTION(bluestore_min_alloc_size_hdd, OPT_U32)
1034OPTION(bluestore_min_alloc_size_ssd, OPT_U32)
1035OPTION(bluestore_max_alloc_size, OPT_U32)
1036OPTION(bluestore_prefer_deferred_size, OPT_U32)
1037OPTION(bluestore_prefer_deferred_size_hdd, OPT_U32)
1038OPTION(bluestore_prefer_deferred_size_ssd, OPT_U32)
1039OPTION(bluestore_compression_mode, OPT_STR) // force|aggressive|passive|none
1040OPTION(bluestore_compression_algorithm, OPT_STR)
1041OPTION(bluestore_compression_min_blob_size, OPT_U32)
1042OPTION(bluestore_compression_min_blob_size_hdd, OPT_U32)
1043OPTION(bluestore_compression_min_blob_size_ssd, OPT_U32)
1044OPTION(bluestore_compression_max_blob_size, OPT_U32)
1045OPTION(bluestore_compression_max_blob_size_hdd, OPT_U32)
1046OPTION(bluestore_compression_max_blob_size_ssd, OPT_U32)
1047/*
1048 * Specifies minimum expected amount of saved allocation units
1049 * per single blob to enable compressed blobs garbage collection
1050 *
1051 */
1052OPTION(bluestore_gc_enable_blob_threshold, OPT_INT)
1053/*
1054 * Specifies minimum expected amount of saved allocation units
1055 * per all blobsb to enable compressed blobs garbage collection
1056 *
1057 */
1058OPTION(bluestore_gc_enable_total_threshold, OPT_INT)
1059
1060OPTION(bluestore_max_blob_size, OPT_U32)
1061OPTION(bluestore_max_blob_size_hdd, OPT_U32)
1062OPTION(bluestore_max_blob_size_ssd, OPT_U32)
1063/*
1064 * Require the net gain of compression at least to be at this ratio,
1065 * otherwise we don't compress.
1066 * And ask for compressing at least 12.5%(1/8) off, by default.
1067 */
1068OPTION(bluestore_compression_required_ratio, OPT_DOUBLE)
1069OPTION(bluestore_extent_map_shard_max_size, OPT_U32)
1070OPTION(bluestore_extent_map_shard_target_size, OPT_U32)
1071OPTION(bluestore_extent_map_shard_min_size, OPT_U32)
1072OPTION(bluestore_extent_map_shard_target_size_slop, OPT_DOUBLE)
1073OPTION(bluestore_extent_map_inline_shard_prealloc_size, OPT_U32)
1074OPTION(bluestore_cache_trim_interval, OPT_DOUBLE)
1075OPTION(bluestore_cache_trim_max_skip_pinned, OPT_U32) // skip this many onodes pinned in cache before we give up
1076OPTION(bluestore_cache_type, OPT_STR) // lru, 2q
1077OPTION(bluestore_2q_cache_kin_ratio, OPT_DOUBLE) // kin page slot size / max page slot size
1078OPTION(bluestore_2q_cache_kout_ratio, OPT_DOUBLE) // number of kout page slot / total number of page slot
1079OPTION(bluestore_cache_size, OPT_U64)
1080OPTION(bluestore_cache_size_hdd, OPT_U64)
1081OPTION(bluestore_cache_size_ssd, OPT_U64)
1082OPTION(bluestore_cache_meta_ratio, OPT_DOUBLE)
1083OPTION(bluestore_cache_kv_ratio, OPT_DOUBLE)
94b18763 1084OPTION(bluestore_cache_kv_max, OPT_INT) // limit the maximum amount of cache for the kv store
c07f9fc5
FG
1085OPTION(bluestore_kvbackend, OPT_STR)
1086OPTION(bluestore_allocator, OPT_STR) // stupid | bitmap
1087OPTION(bluestore_freelist_blocks_per_key, OPT_INT)
1088OPTION(bluestore_bitmapallocator_blocks_per_zone, OPT_INT) // must be power of 2 aligned, e.g., 512, 1024, 2048...
1089OPTION(bluestore_bitmapallocator_span_size, OPT_INT) // must be power of 2 aligned, e.g., 512, 1024, 2048...
1090OPTION(bluestore_max_deferred_txc, OPT_U64)
1091OPTION(bluestore_rocksdb_options, OPT_STR)
1092OPTION(bluestore_fsck_on_mount, OPT_BOOL)
1093OPTION(bluestore_fsck_on_mount_deep, OPT_BOOL)
1094OPTION(bluestore_fsck_on_umount, OPT_BOOL)
1095OPTION(bluestore_fsck_on_umount_deep, OPT_BOOL)
1096OPTION(bluestore_fsck_on_mkfs, OPT_BOOL)
1097OPTION(bluestore_fsck_on_mkfs_deep, OPT_BOOL)
1098OPTION(bluestore_sync_submit_transaction, OPT_BOOL) // submit kv txn in queueing thread (not kv_sync_thread)
1099OPTION(bluestore_throttle_bytes, OPT_U64)
1100OPTION(bluestore_throttle_deferred_bytes, OPT_U64)
1101OPTION(bluestore_throttle_cost_per_io_hdd, OPT_U64)
1102OPTION(bluestore_throttle_cost_per_io_ssd, OPT_U64)
1103OPTION(bluestore_throttle_cost_per_io, OPT_U64)
1104OPTION(bluestore_deferred_batch_ops, OPT_U64)
1105OPTION(bluestore_deferred_batch_ops_hdd, OPT_U64)
1106OPTION(bluestore_deferred_batch_ops_ssd, OPT_U64)
1107OPTION(bluestore_nid_prealloc, OPT_INT)
1108OPTION(bluestore_blobid_prealloc, OPT_U64)
1109OPTION(bluestore_clone_cow, OPT_BOOL) // do copy-on-write for clones
1110OPTION(bluestore_default_buffered_read, OPT_BOOL)
1111OPTION(bluestore_default_buffered_write, OPT_BOOL)
1112OPTION(bluestore_debug_misc, OPT_BOOL)
1113OPTION(bluestore_debug_no_reuse_blocks, OPT_BOOL)
1114OPTION(bluestore_debug_small_allocations, OPT_INT)
1115OPTION(bluestore_debug_freelist, OPT_BOOL)
1116OPTION(bluestore_debug_prefill, OPT_FLOAT)
1117OPTION(bluestore_debug_prefragment_max, OPT_INT)
1118OPTION(bluestore_debug_inject_read_err, OPT_BOOL)
1119OPTION(bluestore_debug_randomize_serial_transaction, OPT_INT)
1120OPTION(bluestore_debug_omit_block_device_write, OPT_BOOL)
1121OPTION(bluestore_debug_fsck_abort, OPT_BOOL)
1122OPTION(bluestore_debug_omit_kv_commit, OPT_BOOL)
1123OPTION(bluestore_debug_permit_any_bdev_label, OPT_BOOL)
1124OPTION(bluestore_shard_finishers, OPT_BOOL)
1125OPTION(bluestore_debug_random_read_err, OPT_DOUBLE)
1126
1127OPTION(kstore_max_ops, OPT_U64)
1128OPTION(kstore_max_bytes, OPT_U64)
1129OPTION(kstore_backend, OPT_STR)
1130OPTION(kstore_rocksdb_options, OPT_STR)
1131OPTION(kstore_fsck_on_mount, OPT_BOOL)
1132OPTION(kstore_fsck_on_mount_deep, OPT_BOOL)
1133OPTION(kstore_nid_prealloc, OPT_U64)
1134OPTION(kstore_sync_transaction, OPT_BOOL)
1135OPTION(kstore_sync_submit_transaction, OPT_BOOL)
1136OPTION(kstore_onode_map_size, OPT_U64)
1137OPTION(kstore_default_stripe_size, OPT_INT)
1138
1139OPTION(filestore_omap_backend, OPT_STR)
1140OPTION(filestore_omap_backend_path, OPT_STR)
1141
1142/// filestore wb throttle limits
1143OPTION(filestore_wbthrottle_enable, OPT_BOOL)
1144OPTION(filestore_wbthrottle_btrfs_bytes_start_flusher, OPT_U64)
1145OPTION(filestore_wbthrottle_btrfs_bytes_hard_limit, OPT_U64)
1146OPTION(filestore_wbthrottle_btrfs_ios_start_flusher, OPT_U64)
1147OPTION(filestore_wbthrottle_btrfs_ios_hard_limit, OPT_U64)
1148OPTION(filestore_wbthrottle_btrfs_inodes_start_flusher, OPT_U64)
1149OPTION(filestore_wbthrottle_xfs_bytes_start_flusher, OPT_U64)
1150OPTION(filestore_wbthrottle_xfs_bytes_hard_limit, OPT_U64)
1151OPTION(filestore_wbthrottle_xfs_ios_start_flusher, OPT_U64)
1152OPTION(filestore_wbthrottle_xfs_ios_hard_limit, OPT_U64)
1153OPTION(filestore_wbthrottle_xfs_inodes_start_flusher, OPT_U64)
1154
1155/// These must be less than the fd limit
1156OPTION(filestore_wbthrottle_btrfs_inodes_hard_limit, OPT_U64)
1157OPTION(filestore_wbthrottle_xfs_inodes_hard_limit, OPT_U64)
1158
1159//Introduce a O_DSYNC write in the filestore
1160OPTION(filestore_odsync_write, OPT_BOOL)
1161
1162// Tests index failure paths
1163OPTION(filestore_index_retry_probability, OPT_DOUBLE)
1164
1165// Allow object read error injection
1166OPTION(filestore_debug_inject_read_err, OPT_BOOL)
1167OPTION(filestore_debug_random_read_err, OPT_DOUBLE)
1168
1169OPTION(filestore_debug_omap_check, OPT_BOOL) // Expensive debugging check on sync
1170OPTION(filestore_omap_header_cache_size, OPT_INT)
1171
1172// Use omap for xattrs for attrs over
1173// filestore_max_inline_xattr_size or
1174OPTION(filestore_max_inline_xattr_size, OPT_U32) //Override
1175OPTION(filestore_max_inline_xattr_size_xfs, OPT_U32)
1176OPTION(filestore_max_inline_xattr_size_btrfs, OPT_U32)
1177OPTION(filestore_max_inline_xattr_size_other, OPT_U32)
1178
1179// for more than filestore_max_inline_xattrs attrs
1180OPTION(filestore_max_inline_xattrs, OPT_U32) //Override
1181OPTION(filestore_max_inline_xattrs_xfs, OPT_U32)
1182OPTION(filestore_max_inline_xattrs_btrfs, OPT_U32)
1183OPTION(filestore_max_inline_xattrs_other, OPT_U32)
1184
1185// max xattr value size
1186OPTION(filestore_max_xattr_value_size, OPT_U32) //Override
1187OPTION(filestore_max_xattr_value_size_xfs, OPT_U32)
1188OPTION(filestore_max_xattr_value_size_btrfs, OPT_U32)
1189// ext4 allows 4k xattrs total including some smallish extra fields and the
1190// keys. We're allowing 2 512 inline attrs in addition some some filestore
1191// replay attrs. After accounting for those, we still need to fit up to
1192// two attrs of this value. That means we need this value to be around 1k
1193// to be safe. This is hacky, but it's not worth complicating the code
1194// to work around ext4's total xattr limit.
1195OPTION(filestore_max_xattr_value_size_other, OPT_U32)
1196
1197OPTION(filestore_sloppy_crc, OPT_BOOL) // track sloppy crcs
1198OPTION(filestore_sloppy_crc_block_size, OPT_INT)
1199
1200OPTION(filestore_max_alloc_hint_size, OPT_U64) // bytes
1201
1202OPTION(filestore_max_sync_interval, OPT_DOUBLE) // seconds
1203OPTION(filestore_min_sync_interval, OPT_DOUBLE) // seconds
1204OPTION(filestore_btrfs_snap, OPT_BOOL)
1205OPTION(filestore_btrfs_clone_range, OPT_BOOL)
1206OPTION(filestore_zfs_snap, OPT_BOOL) // zfsonlinux is still unstable
1207OPTION(filestore_fsync_flushes_journal_data, OPT_BOOL)
1208OPTION(filestore_fiemap, OPT_BOOL) // (try to) use fiemap
1209OPTION(filestore_punch_hole, OPT_BOOL)
1210OPTION(filestore_seek_data_hole, OPT_BOOL) // (try to) use seek_data/hole
1211OPTION(filestore_splice, OPT_BOOL)
1212OPTION(filestore_fadvise, OPT_BOOL)
1213//collect device partition information for management application to use
1214OPTION(filestore_collect_device_partition_information, OPT_BOOL)
1215
1216// (try to) use extsize for alloc hint NOTE: extsize seems to trigger
1217// data corruption in xfs prior to kernel 3.5. filestore will
1218// implicity disable this if it cannot confirm the kernel is newer
1219// than that.
1220// NOTE: This option involves a tradeoff: When disabled, fragmentation is
1221// worse, but large sequential writes are faster. When enabled, large
1222// sequential writes are slower, but fragmentation is reduced.
1223OPTION(filestore_xfs_extsize, OPT_BOOL)
1224
1225OPTION(filestore_journal_parallel, OPT_BOOL)
1226OPTION(filestore_journal_writeahead, OPT_BOOL)
1227OPTION(filestore_journal_trailing, OPT_BOOL)
1228OPTION(filestore_queue_max_ops, OPT_U64)
1229OPTION(filestore_queue_max_bytes, OPT_U64)
1230
1231OPTION(filestore_caller_concurrency, OPT_INT)
1232
1233/// Expected filestore throughput in B/s
1234OPTION(filestore_expected_throughput_bytes, OPT_DOUBLE)
1235/// Expected filestore throughput in ops/s
1236OPTION(filestore_expected_throughput_ops, OPT_DOUBLE)
1237
1238/// Filestore max delay multiple. Defaults to 0 (disabled)
1239OPTION(filestore_queue_max_delay_multiple, OPT_DOUBLE)
1240/// Filestore high delay multiple. Defaults to 0 (disabled)
1241OPTION(filestore_queue_high_delay_multiple, OPT_DOUBLE)
1242
1243/// Use above to inject delays intended to keep the op queue between low and high
1244OPTION(filestore_queue_low_threshhold, OPT_DOUBLE)
1245OPTION(filestore_queue_high_threshhold, OPT_DOUBLE)
1246
1247OPTION(filestore_op_threads, OPT_INT)
1248OPTION(filestore_op_thread_timeout, OPT_INT)
1249OPTION(filestore_op_thread_suicide_timeout, OPT_INT)
1250OPTION(filestore_commit_timeout, OPT_FLOAT)
1251OPTION(filestore_fiemap_threshold, OPT_INT)
1252OPTION(filestore_merge_threshold, OPT_INT)
1253OPTION(filestore_split_multiple, OPT_INT)
1254OPTION(filestore_split_rand_factor, OPT_U32) // randomize the split threshold by adding 16 * [0)
1255OPTION(filestore_update_to, OPT_INT)
1256OPTION(filestore_blackhole, OPT_BOOL) // drop any new transactions on the floor
1257OPTION(filestore_fd_cache_size, OPT_INT) // FD lru size
1258OPTION(filestore_fd_cache_shards, OPT_INT) // FD number of shards
1259OPTION(filestore_ondisk_finisher_threads, OPT_INT)
1260OPTION(filestore_apply_finisher_threads, OPT_INT)
1261OPTION(filestore_dump_file, OPT_STR) // file onto which store transaction dumps
1262OPTION(filestore_kill_at, OPT_INT) // inject a failure at the n'th opportunity
1263OPTION(filestore_inject_stall, OPT_INT) // artificially stall for N seconds in op queue thread
1264OPTION(filestore_fail_eio, OPT_BOOL) // fail/crash on EIO
1265OPTION(filestore_debug_verify_split, OPT_BOOL)
1266OPTION(journal_dio, OPT_BOOL)
1267OPTION(journal_aio, OPT_BOOL)
1268OPTION(journal_force_aio, OPT_BOOL)
1269OPTION(journal_block_size, OPT_INT)
1270
1271// max bytes to search ahead in journal searching for corruption
1272OPTION(journal_max_corrupt_search, OPT_U64)
1273OPTION(journal_block_align, OPT_BOOL)
1274OPTION(journal_write_header_frequency, OPT_U64)
1275OPTION(journal_max_write_bytes, OPT_INT)
1276OPTION(journal_max_write_entries, OPT_INT)
1277
1278/// Target range for journal fullness
1279OPTION(journal_throttle_low_threshhold, OPT_DOUBLE)
1280OPTION(journal_throttle_high_threshhold, OPT_DOUBLE)
1281
1282/// Multiple over expected at high_threshhold. Defaults to 0 (disabled).
1283OPTION(journal_throttle_high_multiple, OPT_DOUBLE)
1284/// Multiple over expected at max. Defaults to 0 (disabled).
1285OPTION(journal_throttle_max_multiple, OPT_DOUBLE)
1286
1287OPTION(journal_align_min_size, OPT_INT) // align data payloads >= this.
1288OPTION(journal_replay_from, OPT_INT)
1289OPTION(journal_zero_on_create, OPT_BOOL)
1290OPTION(journal_ignore_corruption, OPT_BOOL) // assume journal is not corrupt
1291OPTION(journal_discard, OPT_BOOL) //using ssd disk as journal, whether support discard nouse journal-data.
1292
1293OPTION(fio_dir, OPT_STR) // fio data directory for fio-objectstore
1294
1295OPTION(rados_mon_op_timeout, OPT_DOUBLE) // how many seconds to wait for a response from the monitor before returning an error from a rados operation. 0 means no limit.
1296OPTION(rados_osd_op_timeout, OPT_DOUBLE) // how many seconds to wait for a response from osds before returning an error from a rados operation. 0 means no limit.
1297OPTION(rados_tracing, OPT_BOOL) // true if LTTng-UST tracepoints should be enabled
1298
c07f9fc5
FG
1299OPTION(nss_db_path, OPT_STR) // path to nss db
1300
1301
1302OPTION(rgw_max_chunk_size, OPT_INT)
1303OPTION(rgw_put_obj_min_window_size, OPT_INT)
1304OPTION(rgw_put_obj_max_window_size, OPT_INT)
1305OPTION(rgw_max_put_size, OPT_U64)
1306OPTION(rgw_max_put_param_size, OPT_U64) // max input size for PUT requests accepting json/xml params
1307
1308/**
1309 * override max bucket index shards in zone configuration (if not zero)
1310 *
1311 * Represents the number of shards for the bucket index object, a value of zero
1312 * indicates there is no sharding. By default (no sharding, the name of the object
1313 * is '.dir.{marker}', with sharding, the name is '.dir.{markder}.{sharding_id}',
1314 * sharding_id is zero-based value. It is not recommended to set a too large value
1315 * (e.g. thousand) as it increases the cost for bucket listing.
1316 */
1317OPTION(rgw_override_bucket_index_max_shards, OPT_U32)
1318
1319/**
1320 * Represents the maximum AIO pending requests for the bucket index object shards.
1321 */
1322OPTION(rgw_bucket_index_max_aio, OPT_U32)
1323
1324/**
1325 * whether or not the quota/gc threads should be started
1326 */
1327OPTION(rgw_enable_quota_threads, OPT_BOOL)
1328OPTION(rgw_enable_gc_threads, OPT_BOOL)
1329OPTION(rgw_enable_lc_threads, OPT_BOOL)
1330
1331
1332OPTION(rgw_data, OPT_STR)
1333OPTION(rgw_enable_apis, OPT_STR)
1334OPTION(rgw_cache_enabled, OPT_BOOL) // rgw cache enabled
1335OPTION(rgw_cache_lru_size, OPT_INT) // num of entries in rgw cache
1336OPTION(rgw_socket_path, OPT_STR) // path to unix domain socket, if not specified, rgw will not run as external fcgi
1337OPTION(rgw_host, OPT_STR) // host for radosgw, can be an IP, default is 0.0.0.0
1338OPTION(rgw_port, OPT_STR) // port to listen, format as "8080" "5000", if not specified, rgw will not run external fcgi
1339OPTION(rgw_dns_name, OPT_STR) // hostname suffix on buckets
1340OPTION(rgw_dns_s3website_name, OPT_STR) // hostname suffix on buckets for s3-website endpoint
1341OPTION(rgw_content_length_compat, OPT_BOOL) // Check both HTTP_CONTENT_LENGTH and CONTENT_LENGTH in fcgi env
1342OPTION(rgw_lifecycle_work_time, OPT_STR) //job process lc at 00:00-06:00s
1343OPTION(rgw_lc_lock_max_time, OPT_INT) // total run time for a single lc processor work
1344OPTION(rgw_lc_max_objs, OPT_INT)
1345OPTION(rgw_lc_debug_interval, OPT_INT) // Debug run interval, in seconds
1346OPTION(rgw_script_uri, OPT_STR) // alternative value for SCRIPT_URI if not set in request
1347OPTION(rgw_request_uri, OPT_STR) // alternative value for REQUEST_URI if not set in request
28e407b8 1348OPTION(rgw_ignore_get_invalid_range, OPT_BOOL) // treat invalid (e.g., negative) range requests as full
c07f9fc5
FG
1349OPTION(rgw_swift_url, OPT_STR) // the swift url, being published by the internal swift auth
1350OPTION(rgw_swift_url_prefix, OPT_STR) // entry point for which a url is considered a swift url
1351OPTION(rgw_swift_auth_url, OPT_STR) // default URL to go and verify tokens for v1 auth (if not using internal swift auth)
1352OPTION(rgw_swift_auth_entry, OPT_STR) // entry point for which a url is considered a swift auth url
1353OPTION(rgw_swift_tenant_name, OPT_STR) // tenant name to use for swift access
1354OPTION(rgw_swift_account_in_url, OPT_BOOL) // assume that URL always contain the account (aka tenant) part
1355OPTION(rgw_swift_enforce_content_length, OPT_BOOL) // enforce generation of Content-Length even in cost of performance or scalability
1356OPTION(rgw_keystone_url, OPT_STR) // url for keystone server
1357OPTION(rgw_keystone_admin_token, OPT_STR) // keystone admin token (shared secret)
1358OPTION(rgw_keystone_admin_user, OPT_STR) // keystone admin user name
1359OPTION(rgw_keystone_admin_password, OPT_STR) // keystone admin user password
1360OPTION(rgw_keystone_admin_tenant, OPT_STR) // keystone admin user tenant (for keystone v2.0)
1361OPTION(rgw_keystone_admin_project, OPT_STR) // keystone admin user project (for keystone v3)
1362OPTION(rgw_keystone_admin_domain, OPT_STR) // keystone admin user domain
1363OPTION(rgw_keystone_barbican_user, OPT_STR) // keystone user to access barbican secrets
1364OPTION(rgw_keystone_barbican_password, OPT_STR) // keystone password for barbican user
1365OPTION(rgw_keystone_barbican_tenant, OPT_STR) // keystone barbican user tenant (for keystone v2.0)
1366OPTION(rgw_keystone_barbican_project, OPT_STR) // keystone barbican user project (for keystone v3)
1367OPTION(rgw_keystone_barbican_domain, OPT_STR) // keystone barbican user domain
1368OPTION(rgw_keystone_api_version, OPT_INT) // Version of Keystone API to use (2 or 3)
1369OPTION(rgw_keystone_accepted_roles, OPT_STR) // roles required to serve requests
1370OPTION(rgw_keystone_accepted_admin_roles, OPT_STR) // list of roles allowing an user to gain admin privileges
1371OPTION(rgw_keystone_token_cache_size, OPT_INT) // max number of entries in keystone token cache
1372OPTION(rgw_keystone_revocation_interval, OPT_INT) // seconds between tokens revocation check
1373OPTION(rgw_keystone_verify_ssl, OPT_BOOL) // should we try to verify keystone's ssl
c07f9fc5
FG
1374OPTION(rgw_cross_domain_policy, OPT_STR)
1375OPTION(rgw_healthcheck_disabling_path, OPT_STR) // path that existence causes the healthcheck to respond 503
1376OPTION(rgw_s3_auth_use_rados, OPT_BOOL) // should we try to use the internal credentials for s3?
1377OPTION(rgw_s3_auth_use_keystone, OPT_BOOL) // should we try to use keystone for s3?
c07f9fc5
FG
1378OPTION(rgw_barbican_url, OPT_STR) // url for barbican server
1379
1380/* OpenLDAP-style LDAP parameter strings */
1381/* rgw_ldap_uri space-separated list of LDAP servers in URI format */
1382OPTION(rgw_ldap_uri, OPT_STR)
1383/* rgw_ldap_binddn LDAP entry RGW will bind with (user match) */
1384OPTION(rgw_ldap_binddn, OPT_STR)
1385/* rgw_ldap_searchdn LDAP search base (basedn) */
1386OPTION(rgw_ldap_searchdn, OPT_STR)
1387/* rgw_ldap_dnattr LDAP attribute containing RGW user names (to form binddns)*/
1388OPTION(rgw_ldap_dnattr, OPT_STR)
1389/* rgw_ldap_secret file containing credentials for rgw_ldap_binddn */
1390OPTION(rgw_ldap_secret, OPT_STR)
1391/* rgw_s3_auth_use_ldap use LDAP for RGW auth? */
1392OPTION(rgw_s3_auth_use_ldap, OPT_BOOL)
1393/* rgw_ldap_searchfilter LDAP search filter */
1394OPTION(rgw_ldap_searchfilter, OPT_STR)
1395
1396OPTION(rgw_admin_entry, OPT_STR) // entry point for which a url is considered an admin request
1397OPTION(rgw_enforce_swift_acls, OPT_BOOL)
1398OPTION(rgw_swift_token_expiration, OPT_INT) // time in seconds for swift token expiration
1399OPTION(rgw_print_continue, OPT_BOOL) // enable if 100-Continue works
1400OPTION(rgw_print_prohibited_content_length, OPT_BOOL) // violate RFC 7230 and send Content-Length in 204 and 304
1401OPTION(rgw_remote_addr_param, OPT_STR) // e.g. X-Forwarded-For, if you have a reverse proxy
1402OPTION(rgw_op_thread_timeout, OPT_INT)
1403OPTION(rgw_op_thread_suicide_timeout, OPT_INT)
1404OPTION(rgw_thread_pool_size, OPT_INT)
1405OPTION(rgw_num_control_oids, OPT_INT)
1406OPTION(rgw_num_rados_handles, OPT_U32)
1407OPTION(rgw_verify_ssl, OPT_BOOL) // should http_client try to verify ssl when sent https request
1408
1409/* The following are tunables for caches of RGW NFS (and other file
1410 * client) objects.
1411 *
1412 * The file handle cache is a partitioned hash table
1413 * (fhcache_partitions), each with a closed hash part and backing
1414 * b-tree mapping. The number of partions is expected to be a small
1415 * prime, the cache size something larger but less than 5K, the total
1416 * size of the cache is n_part * cache_size.
1417 */
1418OPTION(rgw_nfs_lru_lanes, OPT_INT)
1419OPTION(rgw_nfs_lru_lane_hiwat, OPT_INT)
1420OPTION(rgw_nfs_fhcache_partitions, OPT_INT)
1421OPTION(rgw_nfs_fhcache_size, OPT_INT) /* 3*2017=6051 */
1422OPTION(rgw_nfs_namespace_expire_secs, OPT_INT) /* namespace invalidate
1423 * timer */
1424OPTION(rgw_nfs_max_gc, OPT_INT) /* max gc events per cycle */
1425OPTION(rgw_nfs_write_completion_interval_s, OPT_INT) /* stateless (V3)
1426 * commit
1427 * delay */
1428
1429OPTION(rgw_zone, OPT_STR) // zone name
1430OPTION(rgw_zone_root_pool, OPT_STR) // pool where zone specific info is stored
1431OPTION(rgw_default_zone_info_oid, OPT_STR) // oid where default zone info is stored
1432OPTION(rgw_region, OPT_STR) // region name
1433OPTION(rgw_region_root_pool, OPT_STR) // pool where all region info is stored
1434OPTION(rgw_default_region_info_oid, OPT_STR) // oid where default region info is stored
1435OPTION(rgw_zonegroup, OPT_STR) // zone group name
1436OPTION(rgw_zonegroup_root_pool, OPT_STR) // pool where all zone group info is stored
1437OPTION(rgw_default_zonegroup_info_oid, OPT_STR) // oid where default zone group info is stored
1438OPTION(rgw_realm, OPT_STR) // realm name
1439OPTION(rgw_realm_root_pool, OPT_STR) // pool where all realm info is stored
1440OPTION(rgw_default_realm_info_oid, OPT_STR) // oid where default realm info is stored
1441OPTION(rgw_period_root_pool, OPT_STR) // pool where all period info is stored
1442OPTION(rgw_period_latest_epoch_info_oid, OPT_STR) // oid where current period info is stored
1443OPTION(rgw_log_nonexistent_bucket, OPT_BOOL)
1444OPTION(rgw_log_object_name, OPT_STR) // man date to see codes (a subset are supported)
1445OPTION(rgw_log_object_name_utc, OPT_BOOL)
1446OPTION(rgw_usage_max_shards, OPT_INT)
1447OPTION(rgw_usage_max_user_shards, OPT_INT)
1448OPTION(rgw_enable_ops_log, OPT_BOOL) // enable logging every rgw operation
1449OPTION(rgw_enable_usage_log, OPT_BOOL) // enable logging bandwidth usage
1450OPTION(rgw_ops_log_rados, OPT_BOOL) // whether ops log should go to rados
1451OPTION(rgw_ops_log_socket_path, OPT_STR) // path to unix domain socket where ops log can go
1452OPTION(rgw_ops_log_data_backlog, OPT_INT) // max data backlog for ops log
1453OPTION(rgw_fcgi_socket_backlog, OPT_INT) // socket backlog for fcgi
1454OPTION(rgw_usage_log_flush_threshold, OPT_INT) // threshold to flush pending log data
1455OPTION(rgw_usage_log_tick_interval, OPT_INT) // flush pending log data every X seconds
c07f9fc5
FG
1456OPTION(rgw_init_timeout, OPT_INT) // time in seconds
1457OPTION(rgw_mime_types_file, OPT_STR)
1458OPTION(rgw_gc_max_objs, OPT_INT)
1459OPTION(rgw_gc_obj_min_wait, OPT_INT) // wait time before object may be handled by gc
1460OPTION(rgw_gc_processor_max_time, OPT_INT) // total run time for a single gc processor work
1461OPTION(rgw_gc_processor_period, OPT_INT) // gc processor cycle time
1462OPTION(rgw_s3_success_create_obj_status, OPT_INT) // alternative success status response for create-obj (0 - default)
1463OPTION(rgw_resolve_cname, OPT_BOOL) // should rgw try to resolve hostname as a dns cname record
1464OPTION(rgw_obj_stripe_size, OPT_INT)
1465OPTION(rgw_extended_http_attrs, OPT_STR) // list of extended attrs that can be set on objects (beyond the default)
1466OPTION(rgw_exit_timeout_secs, OPT_INT) // how many seconds to wait for process to go down before exiting unconditionally
1467OPTION(rgw_get_obj_window_size, OPT_INT) // window size in bytes for single get obj request
1468OPTION(rgw_get_obj_max_req_size, OPT_INT) // max length of a single get obj rados op
1469OPTION(rgw_relaxed_s3_bucket_names, OPT_BOOL) // enable relaxed bucket name rules for US region buckets
1470OPTION(rgw_defer_to_bucket_acls, OPT_STR) // if the user has bucket perms)
1471OPTION(rgw_list_buckets_max_chunk, OPT_INT) // max buckets to retrieve in a single op when listing user buckets
1472OPTION(rgw_md_log_max_shards, OPT_INT) // max shards for metadata log
1473OPTION(rgw_num_zone_opstate_shards, OPT_INT) // max shards for keeping inter-region copy progress info
1474OPTION(rgw_opstate_ratelimit_sec, OPT_INT) // min time between opstate updates on a single upload (0 for disabling ratelimit)
1475OPTION(rgw_curl_wait_timeout_ms, OPT_INT) // timeout for certain curl calls
1476OPTION(rgw_copy_obj_progress, OPT_BOOL) // should dump progress during long copy operations?
1477OPTION(rgw_copy_obj_progress_every_bytes, OPT_INT) // min bytes between copy progress output
1478OPTION(rgw_obj_tombstone_cache_size, OPT_INT) // how many objects in tombstone cache, which is used in multi-zone sync to keep
1479 // track of removed objects' mtime
1480
1481OPTION(rgw_data_log_window, OPT_INT) // data log entries window (in seconds)
1482OPTION(rgw_data_log_changes_size, OPT_INT) // number of in-memory entries to hold for data changes log
1483OPTION(rgw_data_log_num_shards, OPT_INT) // number of objects to keep data changes log on
1484OPTION(rgw_data_log_obj_prefix, OPT_STR) //
1485OPTION(rgw_replica_log_obj_prefix, OPT_STR) //
1486
1487OPTION(rgw_bucket_quota_ttl, OPT_INT) // time for cached bucket stats to be cached within rgw instance
1488OPTION(rgw_bucket_quota_soft_threshold, OPT_DOUBLE) // threshold from which we don't rely on cached info for quota decisions
1489OPTION(rgw_bucket_quota_cache_size, OPT_INT) // number of entries in bucket quota cache
1490OPTION(rgw_bucket_default_quota_max_objects, OPT_INT) // number of objects allowed
1491OPTION(rgw_bucket_default_quota_max_size, OPT_LONGLONG) // Max size of object in bytes
1492
1493OPTION(rgw_expose_bucket, OPT_BOOL) // Return the bucket name in the 'Bucket' response header
1494
1495OPTION(rgw_frontends, OPT_STR) // rgw front ends
1496
1497OPTION(rgw_user_quota_bucket_sync_interval, OPT_INT) // time period for accumulating modified buckets before syncing stats
1498OPTION(rgw_user_quota_sync_interval, OPT_INT) // time period for accumulating modified buckets before syncing entire user stats
1499OPTION(rgw_user_quota_sync_idle_users, OPT_BOOL) // whether stats for idle users be fully synced
1500OPTION(rgw_user_quota_sync_wait_time, OPT_INT) // min time between two full stats sync for non-idle users
1501OPTION(rgw_user_default_quota_max_objects, OPT_INT) // number of objects allowed
1502OPTION(rgw_user_default_quota_max_size, OPT_LONGLONG) // Max size of object in bytes
1503
1504OPTION(rgw_multipart_min_part_size, OPT_INT) // min size for each part (except for last one) in multipart upload
1505OPTION(rgw_multipart_part_upload_limit, OPT_INT) // parts limit in multipart upload
1506
1507OPTION(rgw_max_slo_entries, OPT_INT) // default number of max entries in slo
1508
1509OPTION(rgw_olh_pending_timeout_sec, OPT_INT) // time until we retire a pending olh change
1510OPTION(rgw_user_max_buckets, OPT_INT) // global option to set max buckets count for all user
1511
1512OPTION(rgw_objexp_gc_interval, OPT_U32) // maximum time between round of expired objects garbage collecting
c07f9fc5
FG
1513OPTION(rgw_objexp_hints_num_shards, OPT_U32) // maximum number of parts in which the hint index is stored in
1514OPTION(rgw_objexp_chunk_size, OPT_U32) // maximum number of entries in a single operation when processing objexp data
1515
1516OPTION(rgw_enable_static_website, OPT_BOOL) // enable static website feature
1517OPTION(rgw_log_http_headers, OPT_STR) // list of HTTP headers to log when seen, ignores case (e.g., http_x_forwarded_for
1518
1519OPTION(rgw_num_async_rados_threads, OPT_INT) // num of threads to use for async rados operations
1520OPTION(rgw_md_notify_interval_msec, OPT_INT) // metadata changes notification interval to followers
1521OPTION(rgw_run_sync_thread, OPT_BOOL) // whether radosgw (not radosgw-admin) spawns the sync thread
1522OPTION(rgw_sync_lease_period, OPT_INT) // time in second for lease that rgw takes on a specific log (or log shard)
1523OPTION(rgw_sync_log_trim_interval, OPT_INT) // time in seconds between attempts to trim sync logs
1524
1525OPTION(rgw_sync_data_inject_err_probability, OPT_DOUBLE) // range [0, 1]
1526OPTION(rgw_sync_meta_inject_err_probability, OPT_DOUBLE) // range [0, 1]
1527
1528
1529OPTION(rgw_period_push_interval, OPT_DOUBLE) // seconds to wait before retrying "period push"
1530OPTION(rgw_period_push_interval_max, OPT_DOUBLE) // maximum interval after exponential backoff
1531
1532OPTION(rgw_safe_max_objects_per_shard, OPT_INT) // safe max loading
1533OPTION(rgw_shard_warning_threshold, OPT_DOUBLE) // pct of safe max
1534 // at which to warn
1535
1536OPTION(rgw_swift_versioning_enabled, OPT_BOOL) // whether swift object versioning feature is enabled
1537
c07f9fc5
FG
1538OPTION(rgw_crypt_require_ssl, OPT_BOOL) // requests including encryption key headers must be sent over ssl
1539OPTION(rgw_crypt_default_encryption_key, OPT_STR) // base64 encoded key for encryption of rgw objects
1540OPTION(rgw_crypt_s3_kms_encryption_keys, OPT_STR) // extra keys that may be used for aws:kms
1541 // defined as map "key1=YmluCmJvb3N0CmJvb3N0LQ== key2=b3V0CnNyYwpUZXN0aW5nCg=="
1542OPTION(rgw_crypt_suppress_logs, OPT_BOOL) // suppress logs that might print customer key
1543OPTION(rgw_list_bucket_min_readahead, OPT_INT) // minimum number of entries to read from rados for bucket listing
1544
1545OPTION(rgw_rest_getusage_op_compat, OPT_BOOL) // dump description of total stats for s3 GetUsage API
1546
1547OPTION(mutex_perf_counter, OPT_BOOL) // enable/disable mutex perf counter
1548OPTION(throttler_perf_counter, OPT_BOOL) // enable/disable throttler perf counter
1549
1550/* The following are tunables for torrent data */
1551OPTION(rgw_torrent_flag, OPT_BOOL) // produce torrent function flag
1552OPTION(rgw_torrent_tracker, OPT_STR) // torrent field annouce and annouce list
1553OPTION(rgw_torrent_createby, OPT_STR) // torrent field created by
1554OPTION(rgw_torrent_comment, OPT_STR) // torrent field comment
1555OPTION(rgw_torrent_encoding, OPT_STR) // torrent field encoding
1556OPTION(rgw_torrent_origin, OPT_STR) // torrent origin
1557OPTION(rgw_torrent_sha_unit, OPT_INT) // torrent field piece length 512K
1558
1559OPTION(event_tracing, OPT_BOOL) // true if LTTng-UST tracepoints should be enabled
1560
1561// This will be set to true when it is safe to start threads.
1562// Once it is true, it will never change.
1563OPTION(internal_safe_to_start_threads, OPT_BOOL)
1564
1565OPTION(debug_deliberately_leak_memory, OPT_BOOL)
1566
1567OPTION(rgw_swift_custom_header, OPT_STR) // option to enable swift custom headers
1568
1569OPTION(rgw_swift_need_stats, OPT_BOOL) // option to enable stats on bucket listing for swift
1570
1571/* resharding tunables */
1572OPTION(rgw_reshard_num_logs, OPT_INT)
1573OPTION(rgw_reshard_bucket_lock_duration, OPT_INT) // duration of lock on bucket obj during resharding
1574OPTION(rgw_dynamic_resharding, OPT_BOOL)
1575OPTION(rgw_max_objs_per_shard, OPT_INT)
1576OPTION(rgw_reshard_thread_interval, OPT_U32) // maximum time between rounds of reshard thread processing
1577
1578OPTION(rgw_acl_grants_max_num, OPT_INT) // According to AWS S3(http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html), An ACL can have up to 100 grants.