From 4a4dc9f5a1d5f788e9a49dfdecc9b3aee7d310a4 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Wed, 21 Apr 2021 12:13:14 +0800 Subject: [PATCH] doc/rados/configuration/osd-config-ref: use confval directive for defining options Signed-off-by: Kefu Chai --- doc/rados/configuration/osd-config-ref.rst | 122 ++------------------- src/common/options/global.yaml.in | 19 +++- 2 files changed, 28 insertions(+), 113 deletions(-) diff --git a/doc/rados/configuration/osd-config-ref.rst b/doc/rados/configuration/osd-config-ref.rst index 6cdf5ed3003..de39c1e69b1 100644 --- a/doc/rados/configuration/osd-config-ref.rst +++ b/doc/rados/configuration/osd-config-ref.rst @@ -405,20 +405,8 @@ perform well in a degraded state. Tiering ======= -``osd_agent_max_ops`` - -:Description: The maximum number of simultaneous flushing ops per tiering agent - in the high speed mode. -:Type: 32-bit Integer -:Default: ``4`` - - -``osd_agent_max_low_ops`` - -:Description: The maximum number of simultaneous flushing ops per tiering agent - in the low speed mode. -:Type: 32-bit Integer -:Default: ``2`` +.. confval:: osd_agent_max_ops +.. confval:: osd_agent_max_low_ops See `cache target dirty high ratio`_ for when the tiering agent flushes dirty objects within the high speed mode. @@ -426,103 +414,15 @@ objects within the high speed mode. Miscellaneous ============= - -``osd_snap_trim_thread_timeout`` - -:Description: The maximum time in seconds before timing out a snap trim thread. -:Type: 32-bit Integer -:Default: ``1*60*60`` - - -``osd_backlog_thread_timeout`` - -:Description: The maximum time in seconds before timing out a backlog thread. -:Type: 32-bit Integer -:Default: ``1*60*60`` - - -``osd_default_notify_timeout`` - -:Description: The OSD default notification timeout (in seconds). -:Type: 32-bit Unsigned Integer -:Default: ``30`` - - -``osd_check_for_log_corruption`` - -:Description: Check log files for corruption. Can be computationally expensive. -:Type: Boolean -:Default: ``false`` - - -``osd_remove_thread_timeout`` - -:Description: The maximum time in seconds before timing out a remove OSD thread. -:Type: 32-bit Integer -:Default: ``60*60`` - - -``osd_command_thread_timeout`` - -:Description: The maximum time in seconds before timing out a command thread. -:Type: 32-bit Integer -:Default: ``10*60`` - - -``osd_delete_sleep`` - -:Description: Time in seconds to sleep before the next removal transaction. This - throttles the PG deletion process. - -:Type: Float -:Default: ``0`` - - -``osd_delete_sleep_hdd`` - -:Description: Time in seconds to sleep before the next removal transaction - for HDDs. - -:Type: Float -:Default: ``5`` - - -``osd_delete_sleep_ssd`` - -:Description: Time in seconds to sleep before the next removal transaction - for SSDs. - -:Type: Float -:Default: ``0`` - - -``osd_delete_sleep_hybrid`` - -:Description: Time in seconds to sleep before the next removal transaction - when OSD data is on HDD and OSD journal or WAL+DB is on SSD. - -:Type: Float -:Default: ``1`` - - -``osd_command_max_records`` - -:Description: Limits the number of lost objects to return. -:Type: 32-bit Integer -:Default: ``256`` - - -``osd_fast_fail_on_connection_refused`` - -:Description: If this option is enabled, crashed OSDs are marked down - immediately by connected peers and MONs (assuming that the - crashed OSD host survives). Disable it to restore old - behavior, at the expense of possible long I/O stalls when - OSDs crash in the middle of I/O operations. -:Type: Boolean -:Default: ``true`` - - +.. confval:: osd_default_notify_timeout +.. confval:: osd_check_for_log_corruption +.. confval:: osd_command_thread_timeout +.. confval:: osd_delete_sleep +.. confval:: osd_delete_sleep_hdd +.. confval:: osd_delete_sleep_ssd +.. confval:: osd_delete_sleep_hybrid +.. confval:: osd_command_max_records +.. confval:: osd_fast_fail_on_connection_refused .. _pool: ../../operations/pools .. _Configuring Monitor/OSD Interaction: ../mon-osd-interaction diff --git a/src/common/options/global.yaml.in b/src/common/options/global.yaml.in index 0da17545848..e38b5626663 100644 --- a/src/common/options/global.yaml.in +++ b/src/common/options/global.yaml.in @@ -3680,12 +3680,16 @@ options: type: int level: advanced desc: maximum concurrent tiering operations for tiering agent + fmt_desc: The maximum number of simultaneous flushing ops per tiering agent + in the high speed mode. default: 4 with_legacy: true - name: osd_agent_max_low_ops type: int level: advanced desc: maximum concurrent low-priority tiering operations for tiering agent + fmt_desc: The maximum number of simultaneous flushing ops per tiering agent + in the low speed mode. default: 2 with_legacy: true - name: osd_agent_min_evict_effort @@ -4771,6 +4775,7 @@ options: type: int level: advanced default: 10_min + fmt_desc: The maximum time in seconds before timing out a command thread. with_legacy: true - name: osd_command_thread_suicide_timeout type: int @@ -5315,6 +5320,7 @@ options: type: bool level: advanced default: false + fmt_desc: Check log files for corruption. Can be computationally expensive. with_legacy: true - name: osd_use_stale_snap type: bool @@ -5330,6 +5336,7 @@ options: level: advanced desc: default number of seconds after which notify propagation times out. used if a client has not specified other value + fmt_desc: The OSD default notification timeout (in seconds). default: 30 with_legacy: true - name: osd_kill_backfill_at @@ -5473,6 +5480,7 @@ options: type: int level: advanced default: 256 + fmt_desc: Limits the number of lost objects to return. with_legacy: true # max peer osds to report that are blocking our progress - name: osd_max_pg_blocked_by @@ -5662,6 +5670,8 @@ options: level: advanced desc: Time in seconds to sleep before next removal transaction (overrides values below) + fmt_desc: Time in seconds to sleep before the next removal transaction. This + throttles the PG deletion process. default: 0 - name: osd_delete_sleep_hdd type: float @@ -5676,8 +5686,8 @@ options: - name: osd_delete_sleep_hybrid type: float level: advanced - desc: Time in seconds to sleep before next removal transaction when data is on HDD - and journal is on SSD + desc: Time in seconds to sleep before next removal transaction when OSD data is on HDD + and OSD journal or WAL+DB is on SSD default: 1 # what % full makes an OSD "full" (failsafe) - name: osd_failsafe_full_ratio @@ -5710,6 +5720,11 @@ options: type: bool level: advanced default: true + fmt_desc: If this option is enabled, crashed OSDs are marked down + immediately by connected peers and MONs (assuming that the + crashed OSD host survives). Disable it to restore old + behavior, at the expense of possible long I/O stalls when + OSDs crash in the middle of I/O operations. with_legacy: true - name: osd_pg_object_context_cache_count type: int