From: Kefu Chai Date: Sat, 17 Apr 2021 04:46:13 +0000 (+0800) Subject: doc/rados/configuration/mclock-config-ref: use confval directive X-Git-Tag: v17.1.0~2202^2~13 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=23c7081dabc04377c577c6d652aa6ade99dca49a;p=ceph.git doc/rados/configuration/mclock-config-ref: use confval directive for defining options Signed-off-by: Kefu Chai --- diff --git a/doc/rados/configuration/mclock-config-ref.rst b/doc/rados/configuration/mclock-config-ref.rst index 085efb16cf5c7..663c032aa42e9 100644 --- a/doc/rados/configuration/mclock-config-ref.rst +++ b/doc/rados/configuration/mclock-config-ref.rst @@ -280,92 +280,15 @@ QoS requirements are being met. mClock Config Options ===================== -``osd_mclock_profile`` - -:Description: This sets the type of mclock profile to use for providing QoS - based on operations belonging to different classes (background - recovery, scrub, snaptrim, client op, osd subop). Once a built-in - profile is enabled, the lower level mclock resource control - parameters [*reservation, weight, limit*] and some Ceph - configuration parameters are set transparently. Note that the - above does not apply for the *custom* profile. - -:Type: String -:Valid Choices: high_client_ops, high_recovery_ops, balanced, custom -:Default: ``high_client_ops`` - -``osd_mclock_max_capacity_iops`` - -:Description: Max IOPS capacity (at 4KiB block size) to consider per OSD - (overrides _ssd and _hdd if non-zero) - -:Type: Float -:Default: ``0.0`` - -``osd_mclock_max_capacity_iops_hdd`` - -:Description: Max IOPS capacity (at 4KiB block size) to consider per OSD (for - rotational media) - -:Type: Float -:Default: ``315.0`` - -``osd_mclock_max_capacity_iops_ssd`` - -:Description: Max IOPS capacity (at 4KiB block size) to consider per OSD (for - solid state media) - -:Type: Float -:Default: ``21500.0`` - -``osd_mclock_cost_per_io_usec`` - -:Description: Cost per IO in microseconds to consider per OSD (overrides _ssd - and _hdd if non-zero) - -:Type: Float -:Default: ``0.0`` - -``osd_mclock_cost_per_io_usec_hdd`` - -:Description: Cost per IO in microseconds to consider per OSD (for rotational - media) - -:Type: Float -:Default: ``25000.0`` - -``osd_mclock_cost_per_io_usec_ssd`` - -:Description: Cost per IO in microseconds to consider per OSD (for solid state - media) - -:Type: Float -:Default: ``50.0`` - -``osd_mclock_cost_per_byte_usec`` - -:Description: Cost per byte in microseconds to consider per OSD (overrides _ssd - and _hdd if non-zero) - -:Type: Float -:Default: ``0.0`` - -``osd_mclock_cost_per_byte_usec_hdd`` - -:Description: Cost per byte in microseconds to consider per OSD (for rotational - media) - -:Type: Float -:Default: ``5.2`` - -``osd_mclock_cost_per_byte_usec_ssd`` - -:Description: Cost per byte in microseconds to consider per OSD (for solid state - media) - -:Type: Float -:Default: ``0.011`` - - +.. confval:: osd_mclock_profile +.. confval:: osd_mclock_max_capacity_iops +.. confval:: osd_mclock_max_capacity_iops_hdd +.. confval:: osd_mclock_max_capacity_iops_ssd +.. confval:: osd_mclock_cost_per_io_usec +.. confval:: osd_mclock_cost_per_io_usec_hdd +.. confval:: osd_mclock_cost_per_io_usec_ssd +.. confval:: osd_mclock_cost_per_byte_usec +.. confval:: osd_mclock_cost_per_byte_usec_hdd +.. confval:: osd_mclock_cost_per_byte_usec_ssd .. _OSD Config Reference: ../osd-config-ref#dmclock-qos diff --git a/doc/rados/configuration/mon-lookup-dns.rst b/doc/rados/configuration/mon-lookup-dns.rst index c9bece0040d2b..485256b997555 100644 --- a/doc/rados/configuration/mon-lookup-dns.rst +++ b/doc/rados/configuration/mon-lookup-dns.rst @@ -13,11 +13,7 @@ This allows for less configuration on clients and monitors. Using a DNS update c By default clients and daemons will look for the TCP service called *ceph-mon* which is configured by the *mon_dns_srv_name* configuration directive. -``mon dns srv name`` - -:Description: the service name used querying the DNS for the monitor hosts/addresses -:Type: String -:Default: ``ceph-mon`` +.. confval:: mon_dns_srv_name Example ------- diff --git a/src/common/options/global.yaml.in b/src/common/options/global.yaml.in index bd8f77509f30f..b243d765e732c 100644 --- a/src/common/options/global.yaml.in +++ b/src/common/options/global.yaml.in @@ -180,6 +180,7 @@ options: type: str level: advanced desc: name of DNS SRV record to check for monitor addresses + fmt_desc: the service name used querying the DNS for the monitor hosts/addresses default: ceph-mon tags: - network @@ -4337,6 +4338,8 @@ options: long_desc: This option specifies the cost factor to consider in usec per OSD. This is considered by the mclock scheduler to set an additional cost factor in QoS calculations. Only considered for osd_op_queue = mclock_scheduler + fmt_desc: Cost per IO in microseconds to consider per OSD (overrides _ssd + and _hdd if non-zero) default: 0 flags: - runtime @@ -4347,6 +4350,8 @@ options: long_desc: This option specifies the cost factor to consider in usec per OSD for rotational device type. This is considered by the mclock_scheduler to set an additional cost factor in QoS calculations. Only considered for osd_op_queue = mclock_scheduler + fmt_desc: Cost per IO in microseconds to consider per OSD (for rotational + media) default: 25000 flags: - runtime @@ -4358,6 +4363,8 @@ options: solid state device type. This is considered by the mclock_scheduler to set an additional cost factor in QoS calculations. Only considered for osd_op_queue = mclock_scheduler + fmt_desc: Cost per IO in microseconds to consider per OSD (for solid state + media) default: 50 flags: - runtime @@ -4369,6 +4376,8 @@ options: long_desc: This option specifies the cost per byte to consider in microseconds per OSD. This is considered by the mclock scheduler to set an additional cost factor in QoS calculations. Only considered for osd_op_queue = mclock_scheduler + fmt_desc: Cost per byte in microseconds to consider per OSD (overrides _ssd + and _hdd if non-zero) default: 0 flags: - runtime @@ -4380,6 +4389,8 @@ options: OSD for rotational device type. This is considered by the mclock_scheduler to set an additional cost factor in QoS calculations. Only considered for osd_op_queue = mclock_scheduler + fmt_desc: Cost per byte in microseconds to consider per OSD (for rotational + media) default: 5.2 flags: - runtime @@ -4391,6 +4402,8 @@ options: OSD for solid state device type. This is considered by the mclock_scheduler to set an additional cost factor in QoS calculations. Only considered for osd_op_queue = mclock_scheduler + fmt_desc: Cost per byte in microseconds to consider per OSD (for solid state + media) default: 0.011 flags: - runtime @@ -4402,6 +4415,8 @@ options: long_desc: This option specifies the max osd capacity in iops per OSD. Helps in QoS calculations when enabling a dmclock profile. Only considered for osd_op_queue = mclock_scheduler + fmt_desc: Max IOPS capacity (at 4KiB block size) to consider per OSD + (overrides _ssd and _hdd if non-zero) default: 0 flags: - runtime @@ -4413,6 +4428,8 @@ options: long_desc: This option specifies the max OSD capacity in iops per OSD. Helps in QoS calculations when enabling a dmclock profile. Only considered for osd_op_queue = mclock_scheduler + fmt_desc: Max IOPS capacity (at 4KiB block size) to consider per OSD (for + rotational media) default: 315 flags: - runtime @@ -4424,6 +4441,8 @@ options: long_desc: This option specifies the max OSD capacity in iops per OSD. Helps in QoS calculations when enabling a dmclock profile. Only considered for osd_op_queue = mclock_scheduler + fmt_desc: Max IOPS capacity (at 4KiB block size) to consider per OSD (for + solid state media) default: 21500 flags: - runtime @@ -4433,6 +4452,14 @@ options: desc: Which mclock profile to use long_desc: This option specifies the mclock profile to enable - one among the set of built-in profiles or a custom profile. Only considered for osd_op_queue = mclock_scheduler + fmt_desc: | + This sets the type of mclock profile to use for providing QoS + based on operations belonging to different classes (background + recovery, scrub, snaptrim, client op, osd subop). Once a built-in + profile is enabled, the lower level mclock resource control + parameters [*reservation, weight, limit*] and some Ceph + configuration parameters are set transparently. Note that the + above does not apply for the *custom* profile. default: high_client_ops see_also: - osd_op_queue