doc: add docs and update release notes for the new config option

Fixes: https://tracker.ceph.com/issues/71494
Signed-off-by: Shraddha Agrawal <shraddhaag@ibm.com>

diff --git a/PendingReleaseNotes b/PendingReleaseNotes
index 8380f6c06e0a3d5c21e339d1c7730e8f7582790e..8b572f71cb2739ae9689ecb210b9bb6b19ba903f 100644 (file)
--- 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 767a2db909cac3e0c8e0d065c18965bd4bc6c262..880fb608090f683de18dd443c73b42c95576ab8d 100644 (file)
--- 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 64901eedba61488a3507559bd74238a6324ab48d..5670b659612ad42170792d3e209ada1333156e1a 100644 (file)
--- 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