common, doc: Improve docs osd_recovery_priority, osd_recovery_op_priority and related

Add option desciptions for osd_recovery_priority and osd_recovery_op_priority

Fixes: https://tracker.ceph.com/issues/23999

Signed-off-by: David Zafman <dzafman@redhat.com>
This commit is contained in:
David Zafman 2019-02-05 17:05:18 -08:00
parent b1efd43096
commit f7bec341da
4 changed files with 66 additions and 6 deletions

View File

@ -415,8 +415,7 @@ Operations
``osd recovery op priority``
:Description: The priority set for recovery operations. It is relative to
``osd client op priority``.
:Description: The priority set for recovery operations, if not specified by the pool's ``recovery_op_priority``.
:Type: 32-bit Integer
:Default: ``3``
@ -944,6 +943,16 @@ perform well in a degraded state.
:Type: Float
:Default: ``0.025``
``osd recovery priority``
:Description: The default priority set for recovery work queue. Not
related to a pool's ``recovery_priority``.
:Type: 32-bit Integer
:Default: ``5``
Tiering
=======

View File

@ -264,6 +264,20 @@ Ceph configuration file.
:Type: Float
:Default: ``2``
``osd recovery priority``
:Description: Priority of recovery in the work queue.
:Type: Integer
:Default: ``5``
``osd recovery op priority``
:Description: Default priority used for recovery operations if pool doesn't override.
:Type: Integer
:Default: ``3``
.. _pool: ../../operations/pools
.. _Monitoring OSDs and PGs: ../../operations/monitoring-osd-pg#peering
.. _Weighting Bucket Items: ../../operations/crush-map#weightingbucketitems

View File

@ -597,6 +597,27 @@ You may set values for the following keys:
:Default: ``0``
.. _recovery_priority:
``recovery_priority``
:Description: When a value is set it will boost the computed reservation priority
by this amount. This value should be less than 30.
:Type: Integer
:Default: ``0``
.. _recovery_op_priority:
``recovery_op_priority``
:Description: Specify the recovery operation priority for this pool instead of ``osd_recovery_op_priority``.
:Type: Integer
:Default: ``0``
Get Pool Values
===============
@ -751,6 +772,20 @@ You may get values for the following keys:
:Type: Boolean
``recovery_priority``
:Description: see recovery_priority_
:Type: Integer
``recovery_op_priority``
:Description: see recovery_op_priority_
:Type: Integer
Set the Number of Object Replicas
=================================

View File

@ -2271,11 +2271,12 @@ std::vector<Option> get_global_options() {
Option("osd_max_backfills", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_default(1)
.set_description("maximum number of concurrent backfills per OSD"),
.set_description("Maximum number of concurrent local and remote backfills or recoveries per OSD ")
.set_long_description("There can be osd_max_backfills local reservations AND the same remote reservations per OSD. So a value of 1 lets this OSD participate as 1 PG primary in recovery and 1 shard of another recovering PG."),
Option("osd_min_recovery_priority", Option::TYPE_INT, Option::LEVEL_ADVANCED)
.set_default(0)
.set_description("minimum priority below which recovery is not performed")
.set_description("Minimum priority below which recovery is not performed")
.set_long_description("The purpose here is to prevent the cluster from doing *any* lower priority work (e.g., rebalancing) below this threshold and focus solely on higher priority work (e.g., replicating degraded objects)."),
Option("osd_backfill_retry_interval", Option::TYPE_FLOAT, Option::LEVEL_ADVANCED)
@ -3876,7 +3877,7 @@ std::vector<Option> get_global_options() {
Option("osd_recovery_op_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_default(3)
.set_description(""),
.set_description("Priority to use for recovery operations if not specified for the pool"),
Option("osd_peering_op_priority", Option::TYPE_UINT, Option::LEVEL_DEV)
.set_default(255)
@ -3912,7 +3913,8 @@ std::vector<Option> get_global_options() {
Option("osd_recovery_priority", Option::TYPE_UINT, Option::LEVEL_ADVANCED)
.set_default(5)
.set_description(""),
.set_description("Priority of recovery in the work queue")
.set_long_description("Not related to a pool's recovery_priority"),
Option("osd_recovery_cost", Option::TYPE_SIZE, Option::LEVEL_ADVANCED)
.set_default(20<<20)