Skip to content

Commit 1cbe41b

Browse files
committed
doc: add config option and usage docs
This commit adds docs for the new config option introduced as well as updates the feature docs on how to use this config option. Fixes: https://tracker.ceph.com/issues/72619 Signed-off-by: Shraddha Agrawal <[email protected]>
1 parent e9e3d90 commit 1cbe41b

File tree

3 files changed

+22
-4
lines changed

3 files changed

+22
-4
lines changed

PendingReleaseNotes

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,14 @@
175175
five seconds and the feature is enabled by default. A new config option ``enable_availability_tracking``
176176
can be used to turn off the feature if required. Another command is added to clear the
177177
availability status for a specific pool, ``ceph osd pool clear-availability-status <pool-name>``.
178+
users to view the availability score for each pool in a cluster. A pool is considered
179+
unavailable if any PG in the pool is not in active state or if there are unfound
180+
objects. Otherwise the pool is considered available. The score is updated every
181+
one second by default. This interval can be changed using the new config option
182+
``pool_availability_update_interval.``. The feature is on by default. A new config option
183+
``enable_availability_tracking`` can be used to turn off the feature if required.
184+
Another command is added to clear the availability status for a specific pool,
185+
``ceph osd pool clear-availability-status <pool-name>``.
178186
This feature is in tech preview.
179187
Related trackers:
180188
- https://tracker.ceph.com/issues/67777

doc/rados/configuration/mon-config-ref.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -628,6 +628,7 @@ Miscellaneous
628628
.. confval:: mon_memory_target
629629
.. confval:: mon_memory_autotune
630630
.. confval:: enable_availability_tracking
631+
.. confval:: pool_availability_update_interval
631632

632633
NVMe-oF Monitor Client
633634
======================

doc/rados/operations/monitoring.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -781,10 +781,19 @@ the Mean Time Between Failures (MTBF) and Mean Time To Recover (MTTR)
781781
for each pool. The availability score is then calculated by finding
782782
the ratio of MTBF to the total time.
783783

784-
The score is updated every five seconds. This interval is currently
785-
not configurable. Any intermittent changes to the pools that
786-
occur between this duration but are reset before we recheck the pool
787-
status will not be captured by this feature.
784+
The score is updated every one second. Transient changes to pools that
785+
occur and are reverted between successive updates will not be captured.
786+
It is possible to configure this interval with a command of the following
787+
form:
788+
789+
.. prompt:: bash $
790+
791+
ceph config set mon pool_availability_update_interval 2
792+
793+
This will set the update interval to two seconds. Please note that
794+
it is not possible to set this interval less than the config value set
795+
for ``paxos_propose_interval``.
796+
788797

789798
This feature is on by default. To turn the feature off, e.g. - for an expected
790799
downtime, the ``enable_availability_tracking`` config option can be set to ``false``.

0 commit comments

Comments
 (0)