From a198deea5ff8aaeec0e25da5e5e237fd82aad8e5 Mon Sep 17 00:00:00 2001 From: cholcombe973 Date: Wed, 3 Dec 2014 16:34:32 -0800 Subject: [PATCH] Modifying the docs to add the Get pool commands to match the CLI. Signed-off-by: Chris Holcombe --- doc/rados/operations/pools.rst | 117 ++++++++++++++++++++++++++++++++- 1 file changed, 114 insertions(+), 3 deletions(-) diff --git a/doc/rados/operations/pools.rst b/doc/rados/operations/pools.rst index 009e453e4434..efa75e95fadf 100644 --- a/doc/rados/operations/pools.rst +++ b/doc/rados/operations/pools.rst @@ -376,20 +376,131 @@ To get a value from a pool, execute the following:: ceph osd pool get {pool-name} {key} +You may get values for the following keys: -``pg_num`` +``size`` + +:Description: Gets the number of replicas for objects in the pool. + See `Set the Number of Object Replicas`_ for further details. + Replicated pools only. + +:Type: Integer + +``min_size`` + +:Description: Gets the minimum number of replicas required for I/O. + See `Set the Number of Object Replicas`_ for further details. + Replicated pools only. + +:Type: Integer +:Version: ``0.54`` and above -:Description: The number of placement groups for the pool. +``crash_replay_interval`` + +:Description: The number of seconds to allow clients to replay acknowledged, + but uncommitted requests. + :Type: Integer ``pgp_num`` -:Description: The effective number of placement groups to use when calculating data placement. +:Description: The effective number of placement groups to use when calculating + data placement. + :Type: Integer :Valid Range: Equal to or less than ``pg_num``. +``crush_ruleset`` + +:Description: The ruleset to use for mapping object placement in the cluster. +:Type: Integer + + +``hit_set_type`` + +:Description: Enables hit set tracking for cache pools. + See `Bloom Filter`_ for additional information. + +:Type: String +:Valid Settings: ``bloom``, ``explicit_hash``, ``explicit_object`` + +``hit_set_count`` + +:Description: The number of hit sets to store for cache pools. The higher + the number, the more RAM consumed by the ``ceph-osd`` daemon. + +:Type: Integer + + +``hit_set_period`` + +:Description: The duration of a hit set period in seconds for cache pools. + The higher the number, the more RAM consumed by the + ``ceph-osd`` daemon. + +:Type: Integer + + +``hit_set_fpp`` + +:Description: The false positive probability for the ``bloom`` hit set type. + See `Bloom Filter`_ for additional information. + +:Type: Double + + +``cache_target_dirty_ratio`` + +:Description: The percentage of the cache pool containing modified (dirty) + objects before the cache tiering agent will flush them to the + backing storage pool. + +:Type: Double + + +``cache_target_full_ratio`` + +:Description: The percentage of the cache pool containing unmodified (clean) + objects before the cache tiering agent will evict them from the + cache pool. + +:Type: Double + + +``target_max_bytes`` + +:Description: Ceph will begin flushing or evicting objects when the + ``max_bytes`` threshold is triggered. + +:Type: Integer + + +``target_max_objects`` + +:Description: Ceph will begin flushing or evicting objects when the + ``max_objects`` threshold is triggered. + +:Type: Integer + + +``cache_min_flush_age`` + +:Description: The time (in seconds) before the cache tiering agent will flush + an object from the cache pool to the storage pool. + +:Type: Integer + + +``cache_min_evict_age`` + +:Description: The time (in seconds) before the cache tiering agent will evict + an object from the cache pool. + +:Type: Integer + + Set the Number of Object Replicas ================================= -- 2.47.3