f->close_section();
}
+constexpr unsigned long long operator"" _min (unsigned long long min) {
+ return min * 60;
+}
+constexpr unsigned long long operator"" _hr (unsigned long long hr) {
+ return hr * 60 * 60;
+}
+constexpr unsigned long long operator"" _day (unsigned long long day) {
+ return day * 60 * 60 * 24;
+}
+constexpr unsigned long long operator"" _K (unsigned long long n) {
+ return n << 10;
+}
+constexpr unsigned long long operator"" _M (unsigned long long n) {
+ return n << 20;
+}
+constexpr unsigned long long operator"" _G (unsigned long long n) {
+ return n << 30;
+}
std::vector<Option> get_global_options() {
return std::vector<Option>({
.set_daemon_default(true)
.set_description("send critical error log lines to stderr"),
+ Option("log_stderr_prefix", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ .set_description("String to prefix log messages with when sent to stderr"),
+
Option("log_to_syslog", Option::TYPE_BOOL, Option::LEVEL_BASIC)
.set_default(false)
.set_description("send log lines to syslog facility"),
.set_default("12201")
.set_description(""),
+ Option("mon_cluster_log_to_stderr", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
+ .set_default(false)
+ .set_description("Send cluster log messages to stderr (prefixed by channel)"),
+
Option("mon_cluster_log_to_syslog", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("default=false")
.set_description(""),
.set_description(""),
Option("ms_tcp_prefetch_max_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(4096)
+ .set_default(4_K)
.set_description(""),
Option("ms_initial_backoff", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("ms_rwthread_stack_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1024 << 10)
+ .set_default(1_M)
.set_description(""),
Option("ms_tcp_read_timeout", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("ms_async_rdma_buffer_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(128 << 10)
+ .set_default(128_K)
.set_description(""),
Option("ms_async_rdma_send_buffers", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1024)
+ .set_default(1_K)
.set_description(""),
Option("ms_async_rdma_receive_buffers", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("mon_subscribe_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
- .set_default(24*3600)
+ .set_default(1_day)
.set_description(""),
Option("mon_delta_reset_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("mon_osd_laggy_halflife", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(60*60)
+ .set_default(1_hr)
.set_description(""),
Option("mon_osd_laggy_weight", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(false)
.set_description(""),
- Option("mon_stat_smooth_intervals", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("mon_stat_smooth_intervals", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_default(6)
- .set_description(""),
+ .set_min(1)
+ .add_service("mgr")
+ .set_description("number of PGMaps stats over which we calc the average read/write throughput of the whole cluster"),
Option("mon_election_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(5)
Option("mon_pg_stuck_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(60)
- .set_description(""),
+ .set_description("number of seconds after which pgs can be considered stuck inactive, unclean, etc")
+ .set_long_description("see doc/control.rst under dump_stuck for more info")
+ .add_service("mgr"),
Option("mon_pg_min_inactive", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_default(1)
Option("mon_pg_warn_max_object_skew", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(10.0)
- .set_description(""),
+ .set_description("max skew few average in objects per pg")
+ .add_service("mgr"),
Option("mon_pg_warn_min_objects", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(10000)
- .set_description(""),
+ .set_description("do not warn below this object #")
+ .add_service("mgr"),
Option("mon_pg_warn_min_pool_objects", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(1000)
- .set_description(""),
+ .set_description("do not warn on pools below this object #")
+ .add_service("mgr"),
Option("mon_pg_check_down_all_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(.5)
- .set_description(""),
+ .set_description("threshold of down osds after which we check all pgs")
+ .add_service("mgr"),
Option("mon_cache_target_full_warn_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(.66)
.set_default(500)
.set_description(""),
+ Option("mon_max_mgrmap_epochs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ .set_default(500)
+ .set_description(""),
+
Option("mon_max_osd", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(10000)
.set_description(""),
.set_description(""),
Option("mon_reweight_min_bytes_per_osd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(100*1024*1024)
+ .set_default(100_M)
.set_description(""),
Option("mon_reweight_max_osds", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("mon_health_to_clog_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(3600)
+ .set_default(1_hr)
.set_description(""),
Option("mon_health_to_clog_tick_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(true)
.set_description("Warn about the health JSON format change in preluminous JSON fields"),
- Option("mon_health_max_detail", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("mon_health_max_detail", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_default(50)
- .set_description(""),
+ .set_description("max detailed pgs to report in health detail"),
Option("mon_health_log_update_period", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(5)
.set_description(""),
Option("mon_data_size_warn", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(15ull*1024*1024*1024)
+ .set_default(15_G)
.set_description(""),
Option("mon_warn_not_scrubbed", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("mon_scrub_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(3600*24)
+ .set_default(1_day)
.set_description(""),
Option("mon_scrub_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(60*5)
+ .set_default(5_min)
.set_description(""),
Option("mon_scrub_max_keys", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("mon_config_key_max_entry_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(4096)
+ .set_default(4_K)
.set_description(""),
Option("mon_sync_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("mon_sync_max_payload_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1048576)
+ .set_default(1_M)
.set_description(""),
Option("mon_sync_debug", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default("host")
.set_description(""),
+ Option("mon_osd_snap_trim_queue_warn_on", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ .set_default(32768)
+ .set_description("Warn when snap trim queue is that large (or larger).")
+ .set_long_description("Warn when snap trim queue length for at least one PG crosses this value, as this is indicator of snap trimmer not keeping up, wasting disk space"),
+
Option("mon_osd_force_trim_to", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(0)
.set_description(""),
.set_description(""),
Option("mon_osd_blacklist_default_expire", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
- .set_default(60*60)
- .set_description(""),
+ .set_default(1_hr)
+ .set_description("Duration in seconds that blacklist entries for clients "
+ "remain in the OSD map"),
+
+ Option("mon_mds_blacklist_interval", Option::TYPE_FLOAT, Option::LEVEL_DEV)
+ .set_default(1_day)
+ .set_min(1_hr)
+ .set_description("Duration in seconds that blacklist entries for MDS "
+ "daemons remain in the OSD map"),
Option("mon_osd_crush_smoke_test", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
.set_description(""),
Option("auth_mon_ticket_ttl", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
- .set_default(60*60*12)
+ .set_default(12_hr)
.set_description(""),
Option("auth_service_ticket_ttl", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
- .set_default(60*60)
+ .set_default(1_hr)
.set_description(""),
Option("auth_debug", Option::TYPE_BOOL, Option::LEVEL_DEV)
Option("mon_pool_quota_warn_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(0)
- .set_description(""),
+ .set_description("percent of quota at which to issue warnings")
+ .add_service("mgr"),
Option("mon_pool_quota_crit_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(0)
- .set_description(""),
+ .set_description("percent of quota at which to issue errors")
+ .add_service("mgr"),
Option("crush_location", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
.set_description(""),
Option("objecter_inflight_op_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1024*1024*100)
+ .set_default(100_M)
.set_description(""),
Option("objecter_inflight_ops", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("osd_client_message_size_cap", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(500*1024L*1024L)
+ .set_default(500_M)
.set_description(""),
Option("osd_client_message_cap", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("osd_pool_erasure_code_stripe_unit", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(4096)
+ .set_default(4_K)
.set_description(""),
Option("osd_pool_default_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("osd_tier_promote_max_bytes_sec", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(5 * 1024*1024)
+ .set_default(5_M)
.set_description(""),
Option("osd_tier_default_cache_mode", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_description(""),
Option("osd_remove_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(60*60)
+ .set_default(1_hr)
.set_description(""),
Option("osd_remove_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(10*60*60)
+ .set_default(10_hr)
.set_description(""),
Option("osd_command_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(10*60)
+ .set_default(10_min)
.set_description(""),
Option("osd_command_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(15*60)
+ .set_default(15_min)
.set_description(""),
Option("osd_heartbeat_addr", Option::TYPE_ADDR, Option::LEVEL_ADVANCED)
.set_description(""),
Option("osd_recovery_max_omap_entries_per_chunk", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(64000)
+ .set_default(8096)
.set_description(""),
Option("osd_copyfrom_max_chunk", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("osd_scrub_min_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
- .set_default(60*60*24)
+ .set_default(1_day)
.set_description(""),
Option("osd_scrub_max_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
- .set_default(7*60*60*24)
+ .set_default(7_day)
.set_description(""),
Option("osd_scrub_interval_randomize_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("osd_deep_scrub_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
- .set_default(60*60*24*7)
+ .set_default(7_day)
.set_description(""),
Option("osd_deep_scrub_randomize_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("osd_deep_scrub_update_digest_min_age", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(2*60*60)
+ .set_default(2_hr)
.set_description(""),
Option("osd_class_dir", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_description(""),
Option("leveldb_write_buffer_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(8 *1024*1024)
+ .set_default(8_M)
.set_description(""),
Option("leveldb_cache_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(128 *1024*1024)
+ .set_default(128_M)
.set_description(""),
Option("leveldb_block_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("rocksdb_cache_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(128*1024*1024)
+ .set_default(128_M)
.set_description(""),
Option("rocksdb_cache_row_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("rocksdb_block_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(4*1024)
+ .set_default(4_K)
.set_description(""),
Option("rocksdb_perf", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_long_description("This is an experimental option for rocksdb that works in conjunction with two_level indices to avoid having to keep the entire filter/index in cache when cache_index_and_filter_blocks is true. The idea is to keep a much smaller top-level index in heap/cache and then opportunistically cache the lower level indices. See: https://github.com/facebook/rocksdb/wiki/Partitioned-Index-Filters"),
Option("rocksdb_metadata_block_size", Option::TYPE_UINT, Option::LEVEL_DEV)
- .set_default(4096)
+ .set_default(4_K)
.set_description("The block size for index partitions. (0 = rocksdb default)"),
Option("mon_rocksdb_options", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_description(""),
Option("osd_max_object_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(128*1024L*1024L)
+ .set_default(128_M)
.set_description(""),
Option("osd_max_object_name_len", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("memstore_device_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1024*1024*1024)
+ .set_default(1_G)
.set_description(""),
Option("memstore_page_set", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_description(""),
Option("memstore_page_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(64 << 10)
+ .set_default(64_K)
.set_description(""),
Option("objectstore_blackhole", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_description(""),
Option("bdev_block_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(4096)
+ .set_default(4_K)
.set_description(""),
Option("bdev_debug_aio", Option::TYPE_BOOL, Option::LEVEL_DEV)
.set_description(""),
Option("bluefs_alloc_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1048576)
+ .set_default(1_M)
.set_description(""),
Option("bluefs_max_prefetch", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1048576)
+ .set_default(1_M)
.set_description(""),
Option("bluefs_min_log_runway", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1048576)
+ .set_default(1_M)
.set_description(""),
Option("bluefs_max_log_runway", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("bluefs_log_compact_min_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(16*1048576)
+ .set_default(16_M)
.set_description(""),
Option("bluefs_min_flush_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(524288)
+ .set_default(512_K)
.set_description(""),
Option("bluefs_compact_log_sync", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_description("Mirror bluefs data to file system for testing/validation"),
Option("bluestore_bluefs_min", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1*1024*1024*1024)
+ .set_default(1_G)
.set_description("minimum disk space allocated to BlueFS (e.g., at mkfs)"),
Option("bluestore_bluefs_min_free", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_description("Path to block device/file"),
Option("bluestore_block_size", Option::TYPE_UINT, Option::LEVEL_DEV)
- .set_default(10ull * 1024*1024*1024)
+ .set_default(10_G)
.add_tag("mkfs")
.set_description("Size of file to create for backing bluestore"),
.set_description("Path to block device/file backing bluefs wal"),
Option("bluestore_block_wal_size", Option::TYPE_UINT, Option::LEVEL_DEV)
- .set_default(96 * 1024*1024)
+ .set_default(96_M)
.add_tag("mkfs")
.set_description("Size of file to create for bluestore_block_wal_path"),
.add_see_also("bluestore_csum_max_block"),
Option("bluestore_csum_max_block", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(64*1024)
+ .set_default(64_K)
.set_safe()
.set_description("Maximum block size to checksum")
.add_see_also("bluestore_csum_min_block"),
.set_long_description("A smaller allocation size generally means less data is read and then rewritten when a copy-on-write operation is triggered (e.g., when writing to something that was recently snapshotted). Similarly, less data is journaled before performing an overwrite (writes smaller than min_alloc_size must first pass through the BlueStore journal). Larger values of min_alloc_size reduce the amount of metadata required to describe the on-disk layout and reduce overall fragmentation."),
Option("bluestore_min_alloc_size_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(64*1024)
+ .set_default(64_K)
.add_tag("mkfs")
.set_description("Default min_alloc_size value for rotational media"),
Option("bluestore_min_alloc_size_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(16*1024)
+ .set_default(16_K)
.add_tag("mkfs")
.set_description("Default min_alloc_size value for non-rotational (solid state) media"),
.set_description("Chunks smaller than this are never compressed"),
Option("bluestore_compression_min_blob_size_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(128*1024)
+ .set_default(128_K)
.set_safe()
.set_description("Default value of bluestore_compression_min_blob_size for rotational media"),
Option("bluestore_compression_min_blob_size_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(8*1024)
+ .set_default(8_K)
.set_safe()
.set_description("Default value of bluestore_compression_min_blob_size for non-rotational (solid state) media"),
.set_description("Chunks larger than this are broken into smaller chunks before being compressed"),
Option("bluestore_compression_max_blob_size_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(512*1024)
+ .set_default(512_K)
.set_safe()
.set_description("Default value of bluestore_compression_max_blob_size for rotational media"),
Option("bluestore_compression_max_blob_size_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(64*1024)
+ .set_default(64_K)
.set_safe()
.set_description("Default value of bluestore_compression_max_blob_size for non-rotational (solid state) media"),
.set_description(""),
Option("bluestore_max_blob_size_hdd", Option::TYPE_UINT, Option::LEVEL_DEV)
- .set_default(512*1024)
+ .set_default(512_K)
.set_safe()
.set_description(""),
Option("bluestore_max_blob_size_ssd", Option::TYPE_UINT, Option::LEVEL_DEV)
- .set_default(64*1024)
+ .set_default(64_K)
.set_safe()
.set_description(""),
.set_long_description("This includes data and metadata cached by BlueStore as well as memory devoted to rocksdb's cache(s)."),
Option("bluestore_cache_size_hdd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1ull*1024*1024*1024)
+ .set_default(1_G)
.set_description("Default bluestore_cache_size for rotational media"),
Option("bluestore_cache_size_ssd", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(3ull*1024*1024*1024)
+ .set_default(3_G)
.set_description("Default bluestore_cache_size for non-rotational (solid state) media"),
Option("bluestore_cache_meta_ratio", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_description("Ratio of bluestore cache to devote to kv database (rocksdb)"),
Option("bluestore_cache_kv_max", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(512*1024*1024)
+ .set_default(512_M)
.set_description("Max memory (bytes) to devote to kv database (rocksdb)"),
Option("bluestore_kvbackend", Option::TYPE_STR, Option::LEVEL_DEV)
.set_description("Try to submit metadata transaction to rocksdb in queuing thread context"),
Option("bluestore_throttle_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(64*1024*1024)
+ .set_default(64_M)
.set_safe()
.set_description("Maximum bytes in flight before we throttle IO submission"),
Option("bluestore_throttle_deferred_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(128*1024*1024)
+ .set_default(128_M)
.set_safe()
.set_description("Maximum bytes for deferred writes before we throttle IO submission"),
.set_description("simulate fragmentation"),
Option("bluestore_debug_prefragment_max", Option::TYPE_INT, Option::LEVEL_DEV)
- .set_default(1048576)
+ .set_default(1_M)
.set_description(""),
Option("bluestore_debug_inject_read_err", Option::TYPE_BOOL, Option::LEVEL_DEV)
.set_description(""),
Option("kstore_max_bytes", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(64*1024*1024)
+ .set_default(64_M)
.set_description(""),
Option("kstore_backend", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default(600)
.set_description(""),
- Option("filestore_fiemap_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(4096)
+ Option("filestore_fiemap_threshold", Option::TYPE_INT, Option::LEVEL_DEV)
+ .set_default(4_K)
.set_description(""),
Option("filestore_merge_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(false)
.set_description(""),
- Option("journal_block_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(4096)
+ Option("journal_block_size", Option::TYPE_INT, Option::LEVEL_DEV)
+ .set_default(4_K)
.set_description(""),
Option("journal_max_corrupt_search", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
"performance counter data."),
Option("mgr_client_bytes", Option::TYPE_UINT, Option::LEVEL_DEV)
- .set_default(128*1048576)
+ .set_default(128_M)
.add_service("mgr"),
Option("mgr_client_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
.add_service("mgr"),
Option("mgr_osd_bytes", Option::TYPE_UINT, Option::LEVEL_DEV)
- .set_default(512*1048576)
+ .set_default(512_M)
.add_service("mgr"),
Option("mgr_osd_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
.add_service("mgr"),
Option("mgr_mds_bytes", Option::TYPE_UINT, Option::LEVEL_DEV)
- .set_default(128*1048576)
+ .set_default(128_M)
.add_service("mgr"),
Option("mgr_mds_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
.add_service("mgr"),
Option("mgr_mon_bytes", Option::TYPE_UINT, Option::LEVEL_DEV)
- .set_default(128*1048576)
+ .set_default(128_M)
.add_service("mgr"),
Option("mgr_mon_messages", Option::TYPE_UINT, Option::LEVEL_DEV)
Option("debug_deliberately_leak_memory", Option::TYPE_BOOL, Option::LEVEL_DEV)
.set_default(false)
.set_description(""),
+
+ Option("debug_asserts_on_shutdown", Option::TYPE_BOOL,Option::LEVEL_DEV)
+ .set_default(false)
+ .set_description("Enable certain asserts to check for refcounting bugs on shutdown; see http://tracker.ceph.com/issues/21738"),
});
}
return std::vector<Option>({
Option("rgw_acl_grants_max_num", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(100)
- .set_description(""),
+ .set_description("Max number of ACL grants in a single request"),
Option("rgw_max_chunk_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(4 * 1024 * 1024)
- .set_description(""),
+ .set_default(4_M)
+ .set_description("Set RGW max chunk size")
+ .set_long_description(
+ "The chunk size is the size of RADOS I/O requests that RGW sends when accessing "
+ "data objects. RGW read and write operation will never request more than this amount "
+ "in a single request. This also defines the rgw object head size, as head operations "
+ "need to be atomic, and anything larger than this would require more than a single "
+ "operation."),
Option("rgw_put_obj_min_window_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(16 * 1024 * 1024)
- .set_description(""),
+ .set_default(16_M)
+ .set_description("The minimum RADOS write window size (in bytes).")
+ .set_long_description(
+ "The window size determines the total concurrent RADOS writes of a single rgw object. "
+ "When writing an object RGW will send multiple chunks to RADOS. The total size of the "
+ "writes does not exceed the window size. The window size can be automatically "
+ "in order to better utilize the pipe.")
+ .add_see_also({"rgw_put_obj_max_window_size", "rgw_max_chunk_size"}),
Option("rgw_put_obj_max_window_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(64 * 1024 * 1024)
- .set_description(""),
+ .set_default(64_M)
+ .set_description("The maximum RADOS write window size (in bytes).")
+ .set_long_description("The window size may be dynamically adjusted, but will not surpass this value.")
+ .add_see_also({"rgw_put_obj_min_window_size", "rgw_max_chunk_size"}),
Option("rgw_max_put_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(5ULL*1024*1024*1024)
- .set_description(""),
+ .set_default(5_G)
+ .set_description("Max size (in bytes) of regular (non multi-part) object upload.")
+ .set_long_description(
+ "Plain object upload is capped at this amount of data. In order to upload larger "
+ "objects, a special upload mechanism is required. The S3 API provides the "
+ "multi-part upload, and Swift provides DLO and SLO."),
Option("rgw_max_put_param_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(1 * 1024 * 1024)
- .set_description(""),
+ .set_default(1_M)
+ .set_description("The maximum size (in bytes) of data input of certain RESTful requests."),
Option("rgw_max_attr_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_default(0)
.set_default(0)
.set_description("The maximum number of metadata items that can be put via single request"),
- Option("rgw_override_bucket_index_max_shards", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
+ Option("rgw_override_bucket_index_max_shards", Option::TYPE_UINT, Option::LEVEL_DEV)
.set_default(0)
.set_description(""),
Option("rgw_bucket_index_max_aio", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_default(8)
- .set_description(""),
+ .set_description("Max number of concurrent RADOS requests when handling bucket shards."),
Option("rgw_enable_quota_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Enables the quota maintenance thread.")
+ .set_long_description(
+ "The quota maintenance thread is responsible for quota related maintenance work. "
+ "The thread itself can be disabled, but in order for quota to work correctly, at "
+ "least one RGW in each zone needs to have this thread running. Having the thread "
+ "enabled on multiple RGW processes within the same zone can spread "
+ "some of the maintenance work between them.")
+ .add_see_also({"rgw_enable_gc_threads", "rgw_enable_lc_threads"}),
Option("rgw_enable_gc_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Enables the garbage collection maintenance thread.")
+ .set_long_description(
+ "The garbage collection maintenance thread is responsible for garbage collector "
+ "maintenance work. The thread itself can be disabled, but in order for garbage "
+ "collection to work correctly, at least one RGW in each zone needs to have this "
+ "thread running. Having the thread enabled on multiple RGW processes within the "
+ "same zone can spread some of the maintenance work between them.")
+ .add_see_also({"rgw_enable_quota_threads", "rgw_enable_lc_threads"}),
Option("rgw_enable_lc_threads", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Enables the lifecycle maintenance thread. This is required on at least on rgw for each zone.")
+ .set_long_description(
+ "The lifecycle maintenance thread is responsible for lifecycle related maintenance "
+ "work. The thread itself can be disabled, but in order for lifecycle to work "
+ "correctly, at least one RGW in each zone needs to have this thread running. Having"
+ "the thread enabled on multiple RGW processes within the same zone can spread "
+ "some of the maintenance work between them.")
+ .add_see_also({"rgw_enable_gc_threads", "rgw_enable_quota_threads"}),
Option("rgw_data", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("/var/lib/ceph/radosgw/$cluster-$id")
- .set_description(""),
+ .set_description("Alternative location for RGW configuration.")
+ .set_long_description(
+ "If this is set, the different Ceph system configurables (such as the keyring file "
+ "will be located in the path that is specified here. "),
Option("rgw_enable_apis", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("s3, s3website, swift, swift_auth, admin")
- .set_description(""),
+ .set_description("A list of set of RESTful APIs that rgw handles."),
Option("rgw_cache_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Enable RGW metadata cache.")
+ .set_long_description(
+ "The metadata cache holds metadata entries that RGW requires for processing "
+ "requests. Metadata entries can be user info, bucket info, and bucket instance "
+ "info. If not found in the cache, entries will be fetched from the backing "
+ "RADOS store.")
+ .add_see_also("rgw_cache_lru_size"),
Option("rgw_cache_lru_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(10000)
- .set_description(""),
+ .set_description("Max number of items in RGW metadata cache.")
+ .set_long_description(
+ "When full, the RGW metadata cache evicts least recently used entries.")
+ .add_see_also("rgw_cache_enabled"),
Option("rgw_socket_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("RGW FastCGI socket path (for FastCGI over Unix domain sockets).")
+ .add_see_also("rgw_fcgi_socket_backlog"),
Option("rgw_host", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("RGW FastCGI host name (for FastCGI over TCP)")
+ .add_see_also({"rgw_port", "rgw_fcgi_socket_backlog"}),
- Option("rgw_port", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_port", Option::TYPE_STR, Option::LEVEL_BASIC)
.set_default("")
- .set_description(""),
+ .set_description("RGW FastCGI port number (for FastCGI over TCP)")
+ .add_see_also({"rgw_host", "rgw_fcgi_socket_backlog"}),
Option("rgw_dns_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("The host name that RGW uses.")
+ .set_long_description(
+ "This is Needed for virtual hosting of buckets to work properly, unless configured "
+ "via zonegroup configuration."),
Option("rgw_dns_s3website_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("The host name that RGW uses for static websites (S3)")
+ .set_long_description(
+ "This is needed for virtual hosting of buckets, unless configured via zonegroup "
+ "configuration."),
Option("rgw_content_length_compat", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Multiple content length headers compatibility")
+ .set_long_description(
+ "Try to handle requests with abiguous multiple content length headers "
+ "(Content-Length, Http-Content-Length)."),
Option("rgw_lifecycle_work_time", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("00:00-06:00")
- .set_description(""),
+ .set_description("Lifecycle allowed work time")
+ .set_long_description("Local time window in which the lifecycle maintenance thread can work."),
- Option("rgw_lc_lock_max_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_lc_lock_max_time", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(60)
.set_description(""),
Option("rgw_lc_max_objs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(32)
- .set_description(""),
+ .set_description("Number of lifecycle data shards")
+ .set_long_description(
+ "Number of RADOS objects to use for storing lifecycle index. This can affect "
+ "concurrency of lifecycle maintenance, but requires multiple RGW processes "
+ "running on the zone to be utilized."),
Option("rgw_lc_debug_interval", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(-1)
Option("rgw_mp_lock_max_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(600)
- .set_description(""),
+ .set_description("Multipart upload max completion time")
+ .set_long_description(
+ "Time length to allow completion of a multipart upload operation. This is done "
+ "to prevent concurrent completions on the same object with the same upload id."),
- Option("rgw_script_uri", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_script_uri", Option::TYPE_STR, Option::LEVEL_DEV)
.set_default("")
.set_description(""),
- Option("rgw_request_uri", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_request_uri", Option::TYPE_STR, Option::LEVEL_DEV)
.set_default("")
.set_description(""),
Option("rgw_swift_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Swift-auth storage URL")
+ .set_long_description(
+ "Used in conjunction with rgw internal swift authentication. This affects the "
+ "X-Storage-Url response header value.")
+ .add_see_also("rgw_swift_auth_entry"),
Option("rgw_swift_url_prefix", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("swift")
- .set_description(""),
+ .set_description("Swift URL prefix")
+ .set_long_description("The URL path prefix for swift requests."),
Option("rgw_swift_auth_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Swift auth URL")
+ .set_long_description(
+ "Default url to which RGW connects and verifies tokens for v1 auth (if not using "
+ "internal swift auth)."),
Option("rgw_swift_auth_entry", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("auth")
- .set_description(""),
+ .set_description("Swift auth URL prefix")
+ .set_long_description("URL path prefix for internal swift auth requests.")
+ .add_see_also("rgw_swift_url"),
Option("rgw_swift_tenant_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Swift tenant name")
+ .set_long_description("Tenant name that is used when constructing the swift path.")
+ .add_see_also("rgw_swift_account_in_url"),
Option("rgw_swift_account_in_url", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Swift account encoded in URL")
+ .set_long_description("Whether the swift account is encoded in the uri path (AUTH_<account>).")
+ .add_see_also("rgw_swift_tenant_name"),
Option("rgw_swift_enforce_content_length", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Send content length when listing containers (Swift)")
+ .set_long_description(
+ "Whether content length header is needed when listing containers. When this is "
+ "set to false, RGW will send extra info for each entry in the response."),
- Option("rgw_keystone_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_keystone_url", Option::TYPE_STR, Option::LEVEL_BASIC)
.set_default("")
- .set_description(""),
+ .set_description("The URL to the Keystone server."),
Option("rgw_keystone_admin_token", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("The admin token (shared secret) that is used for the Keystone requests."),
Option("rgw_keystone_admin_user", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Keystone admin user."),
Option("rgw_keystone_admin_password", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Keystone admin password."),
Option("rgw_keystone_admin_tenant", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Keystone admin user tenant."),
Option("rgw_keystone_admin_project", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Keystone admin user project (for Keystone v3)."),
Option("rgw_keystone_admin_domain", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Keystone admin user domain (for Keystone v3)."),
Option("rgw_keystone_barbican_user", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Keystone user to access barbican secrets."),
Option("rgw_keystone_barbican_password", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Keystone password for barbican user."),
Option("rgw_keystone_barbican_tenant", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Keystone barbican user tenant (Keystone v2.0)."),
Option("rgw_keystone_barbican_project", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Keystone barbican user project (Keystone v3)."),
Option("rgw_keystone_barbican_domain", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Keystone barbican user domain."),
Option("rgw_keystone_api_version", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(2)
- .set_description(""),
+ .set_description("Version of Keystone API to use (2 or 3)."),
Option("rgw_keystone_accepted_roles", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("Member, admin")
- .set_description(""),
+ .set_description("Only users with one of these roles will be served when doing Keystone authentication."),
Option("rgw_keystone_accepted_admin_roles", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("List of roles allowing user to gain admin privileges (Keystone)."),
Option("rgw_keystone_token_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(10000)
- .set_description(""),
+ .set_description("Keystone token cache size")
+ .set_long_description(
+ "Max number of Keystone tokens that will be cached. Token that is not cached "
+ "requires RGW to access the Keystone server when authenticating."),
Option("rgw_keystone_revocation_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(15 * 60)
- .set_description(""),
+ .set_default(15_min)
+ .set_description("Keystone cache revocation interval")
+ .set_long_description(
+ "Time (in seconds) that RGW waits between requests to Keystone for getting a list "
+ "of revoked tokens. A revoked token might still be considered valid by RGW for "
+ "this amount of time."),
Option("rgw_keystone_verify_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Should RGW verify the Keystone server SSL certificate."),
Option("rgw_keystone_implicit_tenants", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("RGW Keystone implicit tenants creation")
+ .set_long_description(
+ "Implicitly create new users in their own tenant with the same name when "
+ "authenticating via Keystone."),
Option("rgw_cross_domain_policy", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("<allow-access-from domain=\"*\" secure=\"false\" />")
- .set_description(""),
+ .set_description("RGW handle cross domain policy")
+ .set_long_description("Returned cross domain policy when accessing the crossdomain.xml "
+ "resource (Swift compatiility)."),
- Option("rgw_healthcheck_disabling_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_healthcheck_disabling_path", Option::TYPE_STR, Option::LEVEL_DEV)
.set_default("")
- .set_description(""),
+ .set_description("Swift health check api can be disabled if a file can be accessed in this path."),
Option("rgw_s3_auth_use_rados", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Should S3 authentication use credentials stored in RADOS backend."),
Option("rgw_s3_auth_use_keystone", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
-
- Option("rgw_s3_auth_aws4_force_boto2_compat", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
- .set_default(true)
- .set_description(""),
+ .set_description("Should S3 authentication use Keystone."),
Option("rgw_barbican_url", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("URL to barbican server."),
Option("rgw_ldap_uri", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("ldaps://<ldap.your.domain>")
- .set_description(""),
+ .set_description("Space-separated list of LDAP servers in URI format."),
Option("rgw_ldap_binddn", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("uid=admin,cn=users,dc=example,dc=com")
- .set_description(""),
+ .set_description("LDAP entry RGW will bind with (user match)."),
Option("rgw_ldap_searchdn", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("cn=users,cn=accounts,dc=example,dc=com")
- .set_description(""),
+ .set_description("LDAP search base (basedn)."),
Option("rgw_ldap_dnattr", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("uid")
- .set_description(""),
+ .set_description("LDAP attribute containing RGW user names (to form binddns)."),
Option("rgw_ldap_secret", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("/etc/openldap/secret")
- .set_description(""),
+ .set_description("Path to file containing credentials for rgw_ldap_binddn."),
Option("rgw_s3_auth_use_ldap", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Should S3 authentication use LDAP."),
Option("rgw_ldap_searchfilter", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("LDAP search filter."),
Option("rgw_admin_entry", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("admin")
- .set_description(""),
+ .set_description("Path prefix to be used for accessing RGW RESTful admin API."),
Option("rgw_enforce_swift_acls", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("RGW enforce swift acls")
+ .set_long_description(
+ "Should RGW enforce special Swift-only ACLs. Swift has a special ACL that gives "
+ "permission to access all objects in a container."),
Option("rgw_swift_token_expiration", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(24 * 3600)
- .set_description(""),
+ .set_default(1_day)
+ .set_description("Expiration time (in seconds) for token generated through RGW Swift auth."),
Option("rgw_print_continue", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("RGW support of 100-continue")
+ .set_long_description(
+ "Should RGW explicitly send 100 (continue) responses. This is mainly relevant when "
+ "using FastCGI, as some FastCGI modules do not fully support this feature."),
Option("rgw_print_prohibited_content_length", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("RGW RFC-7230 compatibility")
+ .set_long_description(
+ "Specifies whether RGW violates RFC 7230 and sends Content-Length with 204 or 304 "
+ "statuses."),
Option("rgw_remote_addr_param", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("REMOTE_ADDR")
- .set_description(""),
+ .set_description("HTTP header that holds the remote address in incoming requests.")
+ .set_long_description(
+ "RGW will use this header to extract requests origin. When RGW runs behind "
+ "a reverse proxy, the remote address header will point at the proxy's address "
+ "and not at the originator's address. Therefore it is sometimes possible to "
+ "have the proxy add the originator's address in a separate HTTP header, which "
+ "will allow RGW to log it correctly."
+ )
+ .add_see_also("rgw_enable_ops_log"),
- Option("rgw_op_thread_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_op_thread_timeout", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(10*60)
- .set_description(""),
+ .set_description("Timeout for async rados coroutine operations."),
- Option("rgw_op_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_op_thread_suicide_timeout", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(0)
.set_description(""),
- Option("rgw_thread_pool_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_thread_pool_size", Option::TYPE_INT, Option::LEVEL_BASIC)
.set_default(100)
- .set_description(""),
+ .set_description("RGW requests handling thread pool size.")
+ .set_long_description(
+ "This parameter determines the number of concurrent requests RGW can process "
+ "when using either the civetweb, or the fastcgi frontends. The higher this "
+ "number is, RGW will be able to deal with more concurrent requests at the "
+ "cost of more resource utilization."),
Option("rgw_num_control_oids", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(8)
- .set_description(""),
+ .set_description("Number of control objects used for cross-RGW communication.")
+ .set_long_description(
+ "RGW uses certain control objects to send messages between different RGW "
+ "processes running on the same zone. These messages include metadata cache "
+ "invalidation info that is being sent when metadata is modified (such as "
+ "user or bucket information). A higher number of control objects allows "
+ "better concurrency of these messages, at the cost of more resource "
+ "utilization."),
Option("rgw_num_rados_handles", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_default(1)
- .set_description(""),
+ .set_description("Number of librados handles that RGW uses.")
+ .set_long_description(
+ "This param affects the number of separate librados handles it uses to "
+ "connect to the RADOS backend, which directly affects the number of connections "
+ "RGW will have to each OSD. A higher number affects resource utilization."),
Option("rgw_verify_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Should RGW verify SSL when connecing to a remote HTTP server")
+ .set_long_description(
+ "RGW can send requests to other RGW servers (e.g., in multi-site sync work). "
+ "This configurable selects whether RGW should verify the certificate for "
+ "the remote peer and host.")
+ .add_see_also("rgw_keystone_verify_ssl"),
Option("rgw_nfs_lru_lanes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(5)
Option("rgw_zone", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Zone name")
+ .add_see_also({"rgw_zonegroup", "rgw_realm"}),
Option("rgw_zone_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default(".rgw.root")
- .set_description(""),
+ .set_description("Zone root pool name")
+ .set_long_description(
+ "The zone root pool, is the pool where the RGW zone configuration located."
+ )
+ .add_see_also({"rgw_zonegroup_root_pool", "rgw_realm_root_pool", "rgw_period_root_pool"}),
Option("rgw_default_zone_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("default.zone")
- .set_description(""),
+ .set_description("Default zone info object id")
+ .set_long_description(
+ "Name of the RADOS object that holds the default zone information."
+ ),
Option("rgw_region", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Region name")
+ .set_long_description(
+ "Obsolete config option. The rgw_zonegroup option should be used instead.")
+ .add_see_also("rgw_zonegroup"),
Option("rgw_region_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default(".rgw.root")
- .set_description(""),
+ .set_description("Region root pool")
+ .set_long_description(
+ "Obsolete config option. The rgw_zonegroup_root_pool should be used instead.")
+ .add_see_also("rgw_zonegroup_root_pool"),
Option("rgw_default_region_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("default.region")
- .set_description(""),
+ .set_description("Default region info object id")
+ .set_long_description(
+ "Obsolete config option. The rgw_default_zonegroup_info_oid should be used instead.")
+ .add_see_also("rgw_default_zonegroup_info_oid"),
Option("rgw_zonegroup", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Zonegroup name")
+ .add_see_also({"rgw_zone", "rgw_realm"}),
Option("rgw_zonegroup_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default(".rgw.root")
- .set_description(""),
+ .set_description("Zonegroup root pool")
+ .set_long_description(
+ "The zonegroup root pool, is the pool where the RGW zonegroup configuration located."
+ )
+ .add_see_also({"rgw_zone_root_pool", "rgw_realm_root_pool", "rgw_period_root_pool"}),
Option("rgw_default_zonegroup_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("default.zonegroup")
Option("rgw_realm_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default(".rgw.root")
- .set_description(""),
+ .set_description("Realm root pool")
+ .set_long_description(
+ "The realm root pool, is the pool where the RGW realm configuration located."
+ )
+ .add_see_also({"rgw_zonegroup_root_pool", "rgw_zone_root_pool", "rgw_period_root_pool"}),
Option("rgw_default_realm_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("default.realm")
Option("rgw_period_root_pool", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default(".rgw.root")
- .set_description(""),
+ .set_description("Period root pool")
+ .set_long_description(
+ "The realm root pool, is the pool where the RGW realm configuration located."
+ )
+ .add_see_also({"rgw_zonegroup_root_pool", "rgw_zone_root_pool", "rgw_realm_root_pool"}),
- Option("rgw_period_latest_epoch_info_oid", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_period_latest_epoch_info_oid", Option::TYPE_STR, Option::LEVEL_DEV)
.set_default(".latest_epoch")
.set_description(""),
Option("rgw_log_nonexistent_bucket", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Should RGW log operations on bucket that does not exist")
+ .set_long_description(
+ "This config option applies to the ops log. When this option is set, the ops log "
+ "will log operations that are sent to non existing buckets. These operations "
+ "inherently fail, and do not correspond to a specific user.")
+ .add_see_also("rgw_enable_ops_log"),
Option("rgw_log_object_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("%Y-%m-%d-%H-%i-%n")
- .set_description(""),
+ .set_description("Ops log object name format")
+ .set_long_description(
+ "Defines the format of the RADOS objects names that ops log uses to store ops "
+ "log data")
+ .add_see_also("rgw_enable_ops_log"),
Option("rgw_log_object_name_utc", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Should ops log object name based on UTC")
+ .set_long_description(
+ "If set, the names of the RADOS objects that hold the ops log data will be based "
+ "on UTC time zone. If not set, it will use the local time zone.")
+ .add_see_also({"rgw_enable_ops_log", "rgw_log_object_name"}),
Option("rgw_usage_max_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(32)
- .set_description(""),
+ .set_description("Number of shards for usage log.")
+ .set_long_description(
+ "The number of RADOS objects that RGW will use in order to store the usage log "
+ "data.")
+ .add_see_also("rgw_enable_usage_log"),
Option("rgw_usage_max_user_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(1)
.set_min(1)
- .set_description(""),
+ .set_description("Number of shards for single user in usage log")
+ .set_long_description(
+ "The number of shards that a single user will span over in the usage log.")
+ .add_see_also("rgw_enable_usage_log"),
Option("rgw_enable_ops_log", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Enable ops log")
+ .add_see_also({"rgw_log_nonexistent_bucket", "rgw_log_object_name", "rgw_ops_log_rados",
+ "rgw_ops_log_socket_path"}),
Option("rgw_enable_usage_log", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Enable usage log")
+ .add_see_also("rgw_usage_max_shards"),
Option("rgw_ops_log_rados", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Use RADOS for ops log")
+ .set_long_description(
+ "If set, RGW will store ops log information in RADOS.")
+ .add_see_also({"rgw_enable_ops_log"}),
Option("rgw_ops_log_socket_path", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Unix domain socket path for ops log.")
+ .set_long_description(
+ "Path to unix domain socket that RGW will listen for connection on. When connected, "
+ "RGW will send ops log data through it.")
+ .add_see_also({"rgw_enable_ops_log", "rgw_ops_log_data_backlog"}),
Option("rgw_ops_log_data_backlog", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(5 << 20)
- .set_description(""),
+ .set_description("Ops log socket backlog")
+ .set_long_description(
+ "Maximum amount of data backlog that RGW can keep when ops log is configured to "
+ "send info through unix domain socket. When data backlog is higher than this, "
+ "ops log entries will be lost. In order to avoid ops log information loss, the "
+ "listener needs to clear data (by reading it) quickly enough.")
+ .add_see_also({"rgw_enable_ops_log", "rgw_ops_log_socket_path"}),
Option("rgw_fcgi_socket_backlog", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(1024)
- .set_description(""),
+ .set_description("FastCGI socket connection backlog")
+ .set_long_description(
+ "Size of FastCGI connection backlog. This reflects the maximum number of new "
+ "connection requests that RGW can handle concurrently without dropping any. ")
+ .add_see_also({"rgw_host", "rgw_socket_path"}),
Option("rgw_usage_log_flush_threshold", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(1024)
- .set_description(""),
+ .set_description("Number of entries in usage log before flushing")
+ .set_long_description(
+ "This is the max number of entries that will be held in the usage log, before it "
+ "will be flushed to the backend. Note that the usage log is periodically flushed, "
+ "even if number of entries does not reach this threshold. A usage log entry "
+ "corresponds to one or more operations on a single bucket.i")
+ .add_see_also({"rgw_enable_usage_log", "rgw_usage_log_tick_interval"}),
Option("rgw_usage_log_tick_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(30)
- .set_description(""),
-
- Option("rgw_intent_log_object_name", Option::TYPE_STR, Option::LEVEL_ADVANCED)
- .set_default("%Y-%m-%d-%i-%n")
- .set_description(""),
-
- Option("rgw_intent_log_object_name_utc", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
- .set_default(false)
- .set_description(""),
+ .set_description("Number of seconds between usage log flush cycles")
+ .set_long_description(
+ "The number of seconds between consecutive usage log flushes. The usage log will "
+ "also flush itself to the backend if the number of pending entries reaches a "
+ "certain threshold.")
+ .add_see_also({"rgw_enable_usage_log", "rgw_usage_log_flush_threshold"}),
- Option("rgw_init_timeout", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_init_timeout", Option::TYPE_INT, Option::LEVEL_BASIC)
.set_default(300)
- .set_description(""),
+ .set_description("Initialization timeout")
+ .set_long_description(
+ "The time length (in seconds) that RGW will allow for its initialization. RGW "
+ "process will give up and quit if initialization is not complete after this amount "
+ "of time."),
- Option("rgw_mime_types_file", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_mime_types_file", Option::TYPE_STR, Option::LEVEL_BASIC)
.set_default("/etc/mime.types")
- .set_description(""),
+ .set_description("Path to local mime types file")
+ .set_long_description(
+ "The mime types file is needed in Swift when uploading an object. If object's "
+ "content type is not specified, RGW will use data from this file to assign "
+ "a content type to the object."),
Option("rgw_gc_max_objs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(32)
- .set_description(""),
+ .set_description("Number of shards for garbage collector data")
+ .set_long_description(
+ "The number of garbage collector data shards, is the number of RADOS objects that "
+ "RGW will use to store the garbage collection information on.")
+ .add_see_also({"rgw_gc_obj_min_wait", "rgw_gc_processor_max_time", "rgw_gc_processor_period"}),
Option("rgw_gc_obj_min_wait", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(2 * 3600)
- .set_description(""),
+ .set_default(2_hr)
+ .set_description("Garabge collection object expiration time")
+ .set_long_description(
+ "The length of time (in seconds) that the RGW collector will wait before purging "
+ "a deleted object's data. RGW will not remove object immediately, as object could "
+ "still have readers. A mechanism exists to increase the object's expiration time "
+ "when it's being read.")
+ .add_see_also({"rgw_gc_max_objs", "rgw_gc_processor_max_time", "rgw_gc_processor_period"}),
Option("rgw_gc_processor_max_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(3600)
- .set_description(""),
+ .set_default(1_hr)
+ .set_description("Length of time GC processor can lease shard")
+ .set_long_description(
+ "Garbage collection thread in RGW process holds a lease on its data shards. These "
+ "objects contain the information about the objects that need to be removed. RGW "
+ "takes a lease in order to prevent multiple RGW processes from handling the same "
+ "objects concurrently. This time signifies that maximum amount of time that RGW "
+ "is allowed to hold that lease. In the case where RGW goes down uncleanly, this "
+ "is the amount of time where processing of that data shard will be blocked.")
+ .add_see_also({"rgw_gc_max_objs", "rgw_gc_obj_min_wait", "rgw_gc_processor_period"}),
Option("rgw_gc_processor_period", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(3600)
- .set_description(""),
+ .set_default(1_hr)
+ .set_description("Garbage collector cycle run time")
+ .set_long_description(
+ "The amount of time between the start of consecutive runs of the garbage collector "
+ "threads. If garbage collector runs takes more than this period, it will not wait "
+ "before running again.")
+ .add_see_also({"rgw_gc_max_objs", "rgw_gc_obj_min_wait", "rgw_gc_processor_max_time"}),
Option("rgw_s3_success_create_obj_status", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(0)
- .set_description(""),
+ .set_description("HTTP return code override for object creation")
+ .set_long_description(
+ "If not zero, this is the HTTP return code that will be returned on a succesful S3 "
+ "object creation."),
Option("rgw_resolve_cname", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Support vanity domain names via CNAME")
+ .set_long_description(
+ "If true, RGW will query DNS when detecting that it's serving a request that was "
+ "sent to a host in another domain. If a CNAME record is configured for that domain "
+ "it will use it instead. This gives user to have the ability of creating a unique "
+ "domain of their own to point at data in their bucket."),
Option("rgw_obj_stripe_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(4 << 20)
- .set_description(""),
+ .set_default(4_M)
+ .set_description("RGW object stripe size")
+ .set_long_description(
+ "The size of an object stripe for RGW objects. This is the maximum size a backing "
+ "RADOS object will have. RGW objects that are larger than this will span over "
+ "multiple objects."),
Option("rgw_extended_http_attrs", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("RGW support extended HTTP attrs")
+ .set_long_description(
+ "Add new set of attributes that could be set on an object. These extra attributes "
+ "can be set through HTTP header fields when putting the objects. If set, these "
+ "attributes will return as HTTP fields when doing GET/HEAD on the object."),
Option("rgw_exit_timeout_secs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(120)
- .set_description(""),
+ .set_description("RGW shutdown timeout")
+ .set_long_description("Number of seconds to wait for a process before exiting unconditionally."),
Option("rgw_get_obj_window_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(16 << 20)
- .set_description(""),
+ .set_default(16_M)
+ .set_description("RGW object read window size")
+ .set_long_description("The window size in bytes for a single object read request"),
Option("rgw_get_obj_max_req_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(4 << 20)
- .set_description(""),
+ .set_default(4_M)
+ .set_description("RGW object read chunk size")
+ .set_long_description(
+ "The maximum request size of a single object read operation sent to RADOS"),
Option("rgw_relaxed_s3_bucket_names", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("RGW enable relaxed S3 bucket names")
+ .set_long_description("RGW enable relaxed S3 bucket name rules for US region buckets."),
Option("rgw_defer_to_bucket_acls", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Bucket ACLs override object ACLs")
+ .set_long_description(
+ "If not empty, a string that selects that mode of operation. 'recurse' will use "
+ "bucket's ACL for the authorizaton. 'full-control' will allow users that users "
+ "that have full control permission on the bucket have access to the object."),
Option("rgw_list_buckets_max_chunk", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(1000)
- .set_description(""),
+ .set_description("Max number of buckets to retrieve in a single listing operation")
+ .set_long_description(
+ "When RGW fetches lists of user's buckets from the backend, this is the max number "
+ "of entries it will try to retrieve in a single operation. Note that the backend "
+ "may choose to return a smaller number of entries."),
Option("rgw_md_log_max_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(64)
- .set_description(""),
+ .set_description("RGW number of metadata log shards")
+ .set_long_description(
+ "The number of shards the RGW metadata log entries will reside in. This affects "
+ "the metadata sync parallelism as a shard can only be processed by a single "
+ "RGW at a time"),
- Option("rgw_num_zone_opstate_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_num_zone_opstate_shards", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(128)
.set_description(""),
- Option("rgw_opstate_ratelimit_sec", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_opstate_ratelimit_sec", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(30)
.set_description(""),
- Option("rgw_curl_wait_timeout_ms", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_curl_wait_timeout_ms", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(1000)
.set_description(""),
Option("rgw_copy_obj_progress", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Send progress report through copy operation")
+ .set_long_description(
+ "If true, RGW will send progress information when copy operation is executed. "),
Option("rgw_copy_obj_progress_every_bytes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(1024 * 1024)
- .set_description(""),
+ .set_default(1_M)
+ .set_description("Send copy-object progress info after these many bytes"),
Option("rgw_obj_tombstone_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(1000)
- .set_description(""),
+ .set_description("Max number of entries to keep in tombstone cache")
+ .set_long_description(
+ "The tombstone cache is used when doing a multi-zone data sync. RGW keeps "
+ "there information about removed objects which is needed in order to prevent "
+ "re-syncing of objects that were already removed."),
Option("rgw_data_log_window", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(30)
- .set_description(""),
+ .set_description("Data log time window")
+ .set_long_description(
+ "The data log keeps information about buckets that have objectst that were "
+ "modified within a specific timeframe. The sync process then knows which buckets "
+ "are needed to be scanned for data sync."),
- Option("rgw_data_log_changes_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_data_log_changes_size", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(1000)
- .set_description(""),
+ .set_description("Max size of pending changes in data log")
+ .set_long_description(
+ "RGW will trigger update to the data log if the number of pending entries reached "
+ "this number."),
Option("rgw_data_log_num_shards", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(128)
- .set_description(""),
+ .set_description("Number of data log shards")
+ .set_long_description(
+ "The number of shards the RGW data log entries will reside in. This affects the "
+ "data sync parallelism as a shard can only be processed by a single RGW at a time."),
- Option("rgw_data_log_obj_prefix", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_data_log_obj_prefix", Option::TYPE_STR, Option::LEVEL_DEV)
.set_default("data_log")
.set_description(""),
- Option("rgw_replica_log_obj_prefix", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_replica_log_obj_prefix", Option::TYPE_STR, Option::LEVEL_DEV)
.set_default("replica_log")
.set_description(""),
Option("rgw_bucket_quota_ttl", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(600)
- .set_description(""),
+ .set_description("Bucket quota stats cache TTL")
+ .set_long_description(
+ "Length of time for bucket stats to be cached within RGW instance."),
- Option("rgw_bucket_quota_soft_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
+ Option("rgw_bucket_quota_soft_threshold", Option::TYPE_FLOAT, Option::LEVEL_BASIC)
.set_default(0.95)
- .set_description(""),
+ .set_description("RGW quota soft threshold")
+ .set_long_description(
+ "Threshold from which RGW doesn't rely on cached info for quota "
+ "decisions. This is done for higher accuracy of the quota mechanism at "
+ "cost of performance, when getting close to the quota limit. The value "
+ "configured here is the ratio between the data usage to the max usage "
+ "as specified by the quota."),
Option("rgw_bucket_quota_cache_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(10000)
- .set_description(""),
+ .set_description("RGW quota stats cache size")
+ .set_long_description(
+ "Maximum number of entries in the quota stats cache."),
- Option("rgw_bucket_default_quota_max_objects", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_bucket_default_quota_max_objects", Option::TYPE_INT, Option::LEVEL_BASIC)
.set_default(-1)
- .set_description(""),
+ .set_description("Default quota for max objects in a bucket")
+ .set_long_description(
+ "The default quota configuration for max number of objects in a bucket. A "
+ "negative number means 'unlimited'."),
Option("rgw_bucket_default_quota_max_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(-1)
- .set_description(""),
+ .set_description("Default quota for total size in a bucket")
+ .set_long_description(
+ "The default quota configuration for total size of objects in a bucket. A "
+ "negative number means 'unlimited'."),
Option("rgw_expose_bucket", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Send Bucket HTTP header with the response")
+ .set_long_description(
+ "If true, RGW will send a Bucket HTTP header with the responses. The header will "
+ "contain the name of the bucket the operation happened on."),
- Option("rgw_frontends", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_frontends", Option::TYPE_STR, Option::LEVEL_BASIC)
.set_default("civetweb port=7480")
- .set_description(""),
+ .set_description("RGW frontends configuration")
+ .set_long_description(
+ "A comma delimited list of frontends configuration. Each configuration contains "
+ "the type of the frontend followed by an optional space delimited set of "
+ "key=value config parameters."),
Option("rgw_user_quota_bucket_sync_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(180)
- .set_description(""),
+ .set_description("User quota bucket sync interval")
+ .set_long_description(
+ "Time period for accumulating modified buckets before syncing these stats."),
Option("rgw_user_quota_sync_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(3600 * 24)
- .set_description(""),
+ .set_default(1_day)
+ .set_description("User quota sync interval")
+ .set_long_description(
+ "Time period for accumulating modified buckets before syncing entire user stats."),
Option("rgw_user_quota_sync_idle_users", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Should sync idle users quota")
+ .set_long_description(
+ "Whether stats for idle users be fully synced."),
Option("rgw_user_quota_sync_wait_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(3600 * 24)
- .set_description(""),
+ .set_default(1_day)
+ .set_description("User quota full-sync wait time")
+ .set_long_description(
+ "Minimum time between two full stats sync for non-idle users."),
- Option("rgw_user_default_quota_max_objects", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_user_default_quota_max_objects", Option::TYPE_INT, Option::LEVEL_BASIC)
.set_default(-1)
- .set_description(""),
+ .set_description("User quota max objects")
+ .set_long_description(
+ "The default quota configuration for total number of objects for a single user. A "
+ "negative number means 'unlimited'."),
- Option("rgw_user_default_quota_max_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_user_default_quota_max_size", Option::TYPE_INT, Option::LEVEL_BASIC)
.set_default(-1)
- .set_description(""),
+ .set_description("User quota max size")
+ .set_long_description(
+ "The default quota configuration for total size of objects for a single user. A "
+ "negative number means 'unlimited'."),
Option("rgw_multipart_min_part_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(5 * 1024 * 1024)
- .set_description(""),
+ .set_default(5_M)
+ .set_description("Minimum S3 multipart-upload part size")
+ .set_long_description(
+ "When doing a multipart upload, each part (other than the last part) should be "
+ "at least this size."),
Option("rgw_multipart_part_upload_limit", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(10000)
- .set_description(""),
+ .set_description("Max number of parts in multipart upload"),
Option("rgw_max_slo_entries", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(1000)
- .set_description(""),
+ .set_description("Max number of entries in Swift Static Large Object manifest"),
- Option("rgw_olh_pending_timeout_sec", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(3600)
- .set_description(""),
+ Option("rgw_olh_pending_timeout_sec", Option::TYPE_INT, Option::LEVEL_DEV)
+ .set_default(1_hr)
+ .set_description("Max time for pending OLH change to complete")
+ .set_long_description(
+ "OLH is a versioned object's logical head. Operations on it are journaled and "
+ "as pending before completion. If an operation doesn't complete with this amount "
+ "of seconds, we remove the operation from the journal."),
- Option("rgw_user_max_buckets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_user_max_buckets", Option::TYPE_INT, Option::LEVEL_BASIC)
.set_default(1000)
- .set_description(""),
+ .set_description("Max number of buckets per user")
+ .set_long_description(
+ "A user can create this many buckets. Zero means unlimmited, negative number means "
+ "user cannot create any buckets (although user will retain buckets already created."),
Option("rgw_objexp_gc_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(60 * 10)
- .set_description(""),
-
- Option("rgw_objexp_time_step", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(4096)
- .set_description(""),
+ .set_default(10_min)
+ .set_description("Swift objects expirer garbage collector interval"),
Option("rgw_objexp_hints_num_shards", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_default(127)
- .set_description(""),
+ .set_description("Number of object expirer data shards")
+ .set_long_description(
+ "The number of shards the (Swift) object expirer will store its data on."),
- Option("rgw_objexp_chunk_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
+ Option("rgw_objexp_chunk_size", Option::TYPE_UINT, Option::LEVEL_DEV)
.set_default(100)
.set_description(""),
- Option("rgw_enable_static_website", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
+ Option("rgw_enable_static_website", Option::TYPE_BOOL, Option::LEVEL_BASIC)
.set_default(false)
- .set_description(""),
+ .set_description("Enable static website APIs")
+ .set_long_description(
+ "This configurable controls whether RGW handles the website control APIs. RGW can "
+ "server static websites if s3website hostnames are configured, and unrelated to "
+ "this configurable."),
- Option("rgw_log_http_headers", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_log_http_headers", Option::TYPE_STR, Option::LEVEL_BASIC)
.set_default("")
- .set_description(""),
+ .set_description("List of HTTP headers to log")
+ .set_long_description(
+ "A comma delimited list of HTTP headers to log when seen, ignores case (e.g., "
+ "http_x_forwarded_for)."),
Option("rgw_num_async_rados_threads", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(32)
- .set_description(""),
+ .set_description("Number of concurrent RADOS operations in multisite sync")
+ .set_long_description(
+ "The number of concurrent RADOS IO operations that will be triggered for handling "
+ "multisite sync operations. This includes control related work, and not the actual "
+ "sync operations."),
Option("rgw_md_notify_interval_msec", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(200)
- .set_description(""),
+ .set_description("Length of time to aggregate metadata changes")
+ .set_long_description(
+ "Length of time (in milliseconds) in which the master zone aggregates all the "
+ "metadata changes that occured, before sending notifications to all the other "
+ "zones."),
Option("rgw_run_sync_thread", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Should run sync thread"),
- Option("rgw_sync_lease_period", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_sync_lease_period", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(120)
.set_description(""),
Option("rgw_sync_log_trim_interval", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(1200)
- .set_description(""),
+ .set_description("Sync log trim interval")
+ .set_long_description(
+ "Time in seconds between attempts to trim sync logs."),
+
+ Option("rgw_sync_log_trim_max_buckets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ .set_default(16)
+ .set_description("Maximum number of buckets to trim per interval")
+ .set_long_description("The maximum number of buckets to consider for bucket index log trimming each trim interval, regardless of the number of bucket index shards. Priority is given to buckets with the most sync activity over the last trim interval.")
+ .add_see_also("rgw_sync_log_trim_interval")
+ .add_see_also("rgw_sync_log_trim_min_cold_buckets")
+ .add_see_also("rgw_sync_log_trim_concurrent_buckets"),
+
+ Option("rgw_sync_log_trim_min_cold_buckets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ .set_default(4)
+ .set_description("Minimum number of cold buckets to trim per interval")
+ .set_long_description("Of the `rgw_sync_log_trim_max_buckets` selected for bucket index log trimming each trim interval, at least this many of them must be 'cold' buckets. These buckets are selected in order from the list of all bucket instances, to guarantee that all buckets will be visited eventually.")
+ .add_see_also("rgw_sync_log_trim_interval")
+ .add_see_also("rgw_sync_log_trim_max_buckets")
+ .add_see_also("rgw_sync_log_trim_concurrent_buckets"),
+
+ Option("rgw_sync_log_trim_concurrent_buckets", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ .set_default(4)
+ .set_description("Maximum number of buckets to trim in parallel")
+ .add_see_also("rgw_sync_log_trim_interval")
+ .add_see_also("rgw_sync_log_trim_max_buckets")
+ .add_see_also("rgw_sync_log_trim_min_cold_buckets"),
Option("rgw_sync_data_inject_err_probability", Option::TYPE_FLOAT, Option::LEVEL_DEV)
.set_default(0)
Option("rgw_period_push_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(2)
- .set_description(""),
+ .set_description("Period push interval")
+ .set_long_description(
+ "Number of seconds to wait before retrying 'period push' operation."),
Option("rgw_period_push_interval_max", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(30)
- .set_description(""),
+ .set_description("Period push maximum interval")
+ .set_long_description(
+ "The max number of seconds to wait before retrying 'period push' after exponential "
+ "backoff."),
Option("rgw_safe_max_objects_per_shard", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(100*1024)
- .set_description(""),
+ .set_description("Safe number of objects per shard")
+ .set_long_description(
+ "This is the max number of objects per bucket index shard that RGW considers "
+ "safe. RGW will warn if it identifies a bucket where its per-shard count is "
+ "higher than a percentage of this number.")
+ .add_see_also("rgw_shard_warning_threshold"),
Option("rgw_shard_warning_threshold", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(90)
- .set_description(""),
+ .set_description("Warn about max objects per shard")
+ .set_long_description(
+ "Warn if number of objects per shard in a specific bucket passed this percentage "
+ "of the safe number.")
+ .add_see_also("rgw_safe_max_objects_per_shard"),
Option("rgw_swift_versioning_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Enable Swift versioning"),
Option("rgw_swift_custom_header", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Enable swift custom header")
+ .set_long_description(
+ "If not empty, specifies a name of HTTP header that can include custom data. When "
+ "uploading an object, if this header is passed RGW will store this header info "
+ "and it will be available when listing the bucket."),
Option("rgw_swift_need_stats", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Enable stats on bucket listing in Swift"),
- Option("rgw_reshard_num_logs", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_reshard_num_logs", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(16)
.set_description(""),
- Option("rgw_reshard_bucket_lock_duration", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_reshard_bucket_lock_duration", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(120)
.set_description(""),
Option("rgw_crypt_require_ssl", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Requests including encryption key headers must be sent over ssl"),
- Option("rgw_crypt_default_encryption_key", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_crypt_default_encryption_key", Option::TYPE_STR, Option::LEVEL_DEV)
.set_default("")
.set_description(""),
- Option("rgw_crypt_s3_kms_encryption_keys", Option::TYPE_STR, Option::LEVEL_ADVANCED)
+ Option("rgw_crypt_s3_kms_encryption_keys", Option::TYPE_STR, Option::LEVEL_DEV)
.set_default("")
.set_description(""),
Option("rgw_crypt_suppress_logs", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
- .set_description(""),
+ .set_description("Suppress logs that might print client key"),
Option("rgw_list_bucket_min_readahead", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(1000)
- .set_description(""),
+ .set_description("Minimum number of entries to request from rados for bucket listing"),
Option("rgw_rest_getusage_op_compat", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("REST GetUsage request backward compatibility"),
Option("rgw_torrent_flag", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(false)
- .set_description(""),
+ .set_description("Produce torrent function flag"),
Option("rgw_torrent_tracker", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Torrent field annouce and annouce list"),
Option("rgw_torrent_createby", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("torrent field created by"),
Option("rgw_torrent_comment", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Torrent field comment"),
Option("rgw_torrent_encoding", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("torrent field encoding"),
Option("rgw_data_notify_interval_msec", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(200)
Option("rgw_torrent_origin", Option::TYPE_STR, Option::LEVEL_ADVANCED)
.set_default("")
- .set_description(""),
+ .set_description("Torrent origin"),
Option("rgw_torrent_sha_unit", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(512*1024)
.set_description(""),
- Option("rgw_dynamic_resharding", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
+ Option("rgw_dynamic_resharding", Option::TYPE_BOOL, Option::LEVEL_BASIC)
.set_default(true)
- .set_description(""),
+ .set_description("Enable dynamic resharding")
+ .set_long_description(
+ "If true, RGW will dynamicall increase the number of shards in buckets that have "
+ "a high number of objects per shard.")
+ .add_see_also("rgw_max_objs_per_shard"),
- Option("rgw_max_objs_per_shard", Option::TYPE_INT, Option::LEVEL_ADVANCED)
+ Option("rgw_max_objs_per_shard", Option::TYPE_INT, Option::LEVEL_BASIC)
.set_default(100000)
- .set_description(""),
+ .set_description("Max objects per shard for dynamic resharding")
+ .set_long_description(
+ "This is the max number of objects per bucket index shard that RGW will "
+ "allow with dynamic resharding. RGW will trigger an automatic reshard operation "
+ "on the bucket if it exceeds this number.")
+ .add_see_also("rgw_dynamic_resharding"),
Option("rgw_reshard_thread_interval", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(60 * 10)
+ .set_default(10_min)
.set_description(""),
+
+ Option("rgw_cache_expiry_interval", Option::TYPE_UINT,
+ Option::LEVEL_ADVANCED)
+ .set_default(900)
+ .set_description("Number of seconds before entries in the bucket info "
+ "cache are assumed stale and re-fetched. Zero is never.")
+ .add_tag("performance")
+ .add_service("rgw")
+ .set_long_description("The Rados Gateway stores metadata about buckets in "
+ "an internal cache. This should be kept consistent "
+ "by the OSD's relaying notify events between "
+ "multiple watching RGW processes. In the event "
+ "that this notification protocol fails, bounding "
+ "the length of time that any data in the cache will "
+ "be assumed valid will ensure that any RGW instance "
+ "that falls out of sync will eventually recover. "
+ "This seems to be an issue mostly for large numbers "
+ "of RGW instances under heavy use. If you would like "
+ "to turn off cache expiry, set this value to zero."),
+
});
}
.set_default(false)
.set_description("localize parent requests to closest OSD"),
+ Option("rbd_sparse_read_threshold_bytes", Option::TYPE_UINT,
+ Option::LEVEL_ADVANCED)
+ .set_default(64_K)
+ .set_description("threshold for issuing a sparse-read")
+ .set_long_description("minimum number of sequential bytes to read against "
+ "an object before issuing a sparse-read request to "
+ "the cluster. 0 implies it must be a full object read"
+ "to issue a sparse-read, 1 implies always use "
+ "sparse-read, and any value larger than the maximum "
+ "object size will disable sparse-read for all "
+ "requests"),
+
Option("rbd_readahead_trigger_requests", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(10)
.set_description("number of sequential requests necessary to trigger readahead"),
Option("rbd_readahead_max_bytes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(512 * 1024)
+ .set_default(512_K)
.set_description("set to 0 to disable readahead"),
Option("rbd_readahead_disable_after_bytes", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(50 * 1024 * 1024)
+ .set_default(50_M)
.set_description("how many bytes are read in total before readahead is disabled"),
Option("rbd_clone_copy_on_read", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
.set_description(""),
- Option("mds_blacklist_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
- .set_default(24.0*60.0)
- .set_description(""),
-
Option("mds_session_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(60)
.set_description(""),
.set_default(1024)
.set_description(""),
- Option("mds_revoke_cap_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
- .set_default(60)
- .set_description(""),
-
Option("mds_recall_state_timeout", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_default(60)
.set_description(""),
.set_default(30)
.set_description(""),
- Option("mds_log_max_expiring", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(20)
- .set_description(""),
-
Option("mds_bal_export_pin", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
.set_description(""),
.set_default(0)
.set_description(""),
+ Option("mds_max_export_size", Option::TYPE_UINT, Option::LEVEL_DEV)
+ .set_default(1_G)
+ .set_description(""),
+
Option("mds_kill_export_at", Option::TYPE_INT, Option::LEVEL_DEV)
.set_default(0)
.set_description(""),
.set_description(""),
Option("client_oc_size", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(1024*1024* 200)
+ .set_default(200_M)
.set_description(""),
Option("client_oc_max_dirty", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(1024*1024* 100)
+ .set_default(100_M)
.set_description(""),
Option("client_oc_target_dirty", Option::TYPE_INT, Option::LEVEL_ADVANCED)
- .set_default(1024*1024* 8)
+ .set_default(8_M)
.set_description(""),
Option("client_oc_max_dirty_age", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
.set_description(""),
Option("client_max_inline_size", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
- .set_default(4096)
+ .set_default(4_K)
.set_description(""),
Option("client_inject_release_failure", Option::TYPE_BOOL, Option::LEVEL_DEV)
.set_default(false)
.set_description(""),
- Option("client_die_on_failed_remount", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
- .set_default(true)
+ Option("client_die_on_failed_remount", Option::TYPE_BOOL, Option::LEVEL_DEV)
+ .set_default(false)
.set_description(""),
+ Option("client_die_on_failed_dentry_invalidate", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
+ .set_default(true)
+ .set_description("kill the client when no dentry invalidation options are available")
+ .set_long_description("The CephFS client requires a mechanism to invalidate dentries in the caller (e.g. the kernel for ceph-fuse) when capabilities must be recalled. If the client cannot do this then the MDS cache cannot shrink which can cause the MDS to fail."),
+
Option("client_check_pool_perm", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
.set_default(true)
.set_description(""),
projects / ceph.git / blobdiff