From 80c7492a808609e0f4933e5d2e5ee24af0b4e2d8 Mon Sep 17 00:00:00 2001 From: Shraddha Agrawal Date: Thu, 29 May 2025 13:35:40 +0530 Subject: [PATCH] doc: add docs and update release notes for the new config option Fixes: https://tracker.ceph.com/issues/71494 Signed-off-by: Shraddha Agrawal --- PendingReleaseNotes | 3 ++- doc/rados/configuration/mon-config-ref.rst | 1 + doc/rados/operations/monitoring.rst | 12 +++++++++++- 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/PendingReleaseNotes b/PendingReleaseNotes index 8380f6c06e0..8b572f71cb2 100644 --- a/PendingReleaseNotes +++ b/PendingReleaseNotes @@ -151,7 +151,8 @@ users to view the availability score for each pool in a cluster. A pool is considered unavailable if any PG in the pool is not in active state or if there are unfound objects. Otherwise the pool is considered available. The score is updated every - 5 seconds. This feature is in tech preview. + 5 seconds. The feature is on by default. A new config option `enable_availability_tracking` + can be used to turn off the feature if required. This feature is in tech preview. Related trackers: - https://tracker.ceph.com/issues/67777 diff --git a/doc/rados/configuration/mon-config-ref.rst b/doc/rados/configuration/mon-config-ref.rst index 767a2db909c..880fb608090 100644 --- a/doc/rados/configuration/mon-config-ref.rst +++ b/doc/rados/configuration/mon-config-ref.rst @@ -627,6 +627,7 @@ Miscellaneous .. confval:: mon_osd_cache_size_min .. confval:: mon_memory_target .. confval:: mon_memory_autotune +.. confval:: enable_availability_tracking .. _Paxos: https://en.wikipedia.org/wiki/Paxos_(computer_science) .. _Monitor Keyrings: ../../../dev/mon-bootstrap#secret-keys diff --git a/doc/rados/operations/monitoring.rst b/doc/rados/operations/monitoring.rst index 64901eedba6..5670b659612 100644 --- a/doc/rados/operations/monitoring.rst +++ b/doc/rados/operations/monitoring.rst @@ -784,4 +784,14 @@ the ratio of MTBF to the total time. The score is updated every five seconds. This interval is currently not configurable. Any intermittent changes to the pools that occur between this duration but are reset before we recheck the pool -status will not be captured by this feature. \ No newline at end of file +status will not be captured by this feature. + +This feature is on by default. To turn the feature off, e.g. - for an expected +downtime, the ``enable_availability_tracking`` config option can be set to ``false``. + +.. prompt:: bash $ + + ceph config set mon enable_availability_tracking false + +While the feature is turned off, the last calculated score will be preserved. The +score will again start updating once the feature is turned on again. \ No newline at end of file -- 2.39.5