]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rados: remove HitSet-related key information 54217/head
authorZac Dover <zac.dover@proton.me>
Wed, 25 Oct 2023 23:48:57 +0000 (09:48 +1000)
committerZac Dover <zac.dover@proton.me>
Fri, 27 Oct 2023 03:06:11 +0000 (13:06 +1000)
Remove HitSet-related key information from
doc/rados/operations/pools.rst. HitSet-related keys are relevant only to
releases of Ceph that support cache tiering. Only Quincy and earlier
(inclusive) releases of Ceph support cache tiering. Backport this commit
from main to Reef, but not to Quincy or to release branches earlier than
Quincy.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 78878511a3e782d5cde63bfb71409c46244402f7)

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

index ed9dba1b60203cce04df6ace4a3c10f9726388cd..e0a12d0938ac350a333977213e1211f0681ad399 100644 (file)
@@ -287,7 +287,6 @@ by setting it in the ``[mon]`` section of the configuration file.
 .. confval:: mon_data_size_warn
 .. confval:: mon_data_avail_warn
 .. confval:: mon_data_avail_crit
-.. confval:: mon_warn_on_cache_pools_without_hit_sets
 .. confval:: mon_warn_on_crush_straw_calc_version_zero
 .. confval:: mon_warn_on_legacy_crush_tunables
 .. confval:: mon_crush_min_required_version
index 900780587428ceab34b946225f578d2b43554331..3e1ff510a6dd074a6fcbc7896194613c0705e2b3 100644 (file)
@@ -499,47 +499,6 @@ You may set values for the following keys:
    :Type: Integer
    :Valid Range: ``1`` sets flag, ``0`` unsets flag
 
-.. _hit_set_type:
-
-.. describe:: hit_set_type
-
-   :Description: Enables HitSet tracking for cache pools.
-                 For additional information, see `Bloom Filter`_.
-   :Type: String
-   :Valid Settings: ``bloom``, ``explicit_hash``, ``explicit_object``
-   :Default: ``bloom``. Other values are for testing.
-
-.. _hit_set_count:
-
-.. describe:: hit_set_count
-
-   :Description: Determines the number of HitSets to store for cache pools. The
-                 higher the value, the more RAM is consumed by the ``ceph-osd``
-                 daemon.
-   :Type: Integer
-   :Valid Range: ``1``. Agent doesn't handle > ``1`` yet.
-
-.. _hit_set_period:
-
-.. describe:: hit_set_period
-
-   :Description: Determines the duration of a HitSet period (in seconds) for
-                 cache pools. The higher the value, the more RAM is consumed
-                 by the ``ceph-osd`` daemon.
-   :Type: Integer
-   :Example: ``3600`` (3600 seconds: one hour)
-
-.. _hit_set_fpp:
-
-.. describe:: hit_set_fpp
-
-   :Description: Determines the probability of false positives for the
-                 ``bloom`` HitSet type. For additional information, see `Bloom
-                 Filter`_.
-   :Type: Double
-   :Valid Range: ``0.0`` - ``1.0``
-   :Default: ``0.05``
-
 .. _cache_target_dirty_ratio:
 
 .. describe:: cache_target_dirty_ratio
@@ -593,23 +552,6 @@ You may set values for the following keys:
    :Type: Integer
    :Example: ``1000000`` #1M objects
 
-
-.. describe:: hit_set_grade_decay_rate
-   
-   :Description: Sets the temperature decay rate between two successive 
-                 HitSets.
-   :Type: Integer
-   :Valid Range: 0 - 100
-   :Default: ``20``
-
-.. describe:: hit_set_search_last_n
-   
-   :Description: Count at most N appearances in HitSets. Used for temperature 
-                 calculation.
-   :Type: Integer
-   :Valid Range: 0 - hit_set_count
-   :Default: ``1``
-
 .. _cache_min_flush_age:
 
 .. describe:: cache_min_flush_age
@@ -739,35 +681,6 @@ You may get values from the following keys:
 :Description: See crush_rule_.
 
 
-``hit_set_type``
-
-:Description: See hit_set_type_.
-
-:Type: String
-:Valid Settings: ``bloom``, ``explicit_hash``, ``explicit_object``
-
-
-``hit_set_count``
-
-:Description: See hit_set_count_.
-
-:Type: Integer
-
-
-``hit_set_period``
-
-:Description: See hit_set_period_.
-
-:Type: Integer
-
-
-``hit_set_fpp``
-
-:Description: See hit_set_fpp_.
-
-:Type: Double
-
-
 ``cache_target_dirty_ratio``
 
 :Description: See cache_target_dirty_ratio_.