Skip to content

Commit

Permalink
cleanup: make the pool setting GET decription point to SET description
Browse files Browse the repository at this point in the history
Signed-off-by: Guang Yang yguang@yahoo-inc.com
  • Loading branch information
Guang Yang committed Sep 30, 2015
1 parent c41869b commit d31ba28
Showing 1 changed file with 47 additions and 46 deletions.
93 changes: 47 additions & 46 deletions doc/rados/operations/pools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,8 @@ To set a value to a pool, execute the following::

You may set values for the following keys:

.. _size:

``size``

:Description: Sets the number of replicas for objects in the pool.
Expand All @@ -244,6 +246,8 @@ You may set values for the following keys:

:Type: Integer

.. _min_size:

``min_size``

:Description: Sets the minimum number of replicas required for I/O.
Expand All @@ -253,13 +257,16 @@ You may set values for the following keys:
:Type: Integer
:Version: ``0.54`` and above

.. _crash_replay_interval:

``crash_replay_interval``

:Description: The number of seconds to allow clients to replay acknowledged,
but uncommitted requests.

:Type: Integer

.. _pgp_num:

``pgp_num``

Expand All @@ -269,12 +276,14 @@ You may set values for the following keys:
:Type: Integer
:Valid Range: Equal to or less than ``pg_num``.

.. _crush_ruleset:

``crush_ruleset``

:Description: The ruleset to use for mapping object placement in the cluster.
:Type: Integer

.. _hashpspool:

``hashpspool``

Expand All @@ -283,6 +292,7 @@ You may set values for the following keys:
:Valid Range: 1 sets flag, 0 unsets flag
:Version: Version ``0.48`` Argonaut and above.

.. _nodelete:

``nodelete``

Expand All @@ -291,6 +301,7 @@ You may set values for the following keys:
:Valid Range: 1 sets flag, 0 unsets flag
:Version: Version ``FIXME``

.. _nopgchange:

``nopgchange``

Expand All @@ -299,6 +310,7 @@ You may set values for the following keys:
:Valid Range: 1 sets flag, 0 unsets flag
:Version: Version ``FIXME``

.. _nosizechange:

``nosizechange``

Expand All @@ -307,27 +319,31 @@ You may set values for the following keys:
:Valid Range: 1 sets flag, 0 unsets flag
:Version: Version ``FIXME``

.. _write_fadvise_dontneed:

``write_fadvise_dontneed``

:Description: Set/Unset WRITE_FADVISE_DONTNEED flag on a given pool.
:Type: Integer
:Valid Range: 1 sets flag, 0 unsets flag

.. _noscrub:

``noscrub``

:Description: Set/Unset NOSCRUB flag on a given pool.
:Type: Integer
:Valid Range: 1 sets flag, 0 unsets flag

.. _nodeep-scrub:

``nodeep-scrub``

:Description: Set/Unset NODEEP_SCRUB flag on a given pool.
:Type: Integer
:Valid Range: 1 sets flag, 0 unsets flag

.. _hit_set_type:

``hit_set_type``

Expand All @@ -338,6 +354,8 @@ You may set values for the following keys:
:Valid Settings: ``bloom``, ``explicit_hash``, ``explicit_object``
:Default: ``bloom``. Other values are for testing.

.. _hit_set_count:

``hit_set_count``

:Description: The number of hit sets to store for cache pools. The higher
Expand All @@ -346,6 +364,7 @@ You may set values for the following keys:
:Type: Integer
:Valid Range: ``1``. Agent doesn't handle > 1 yet.

.. _hit_set_period:

``hit_set_period``

Expand All @@ -356,6 +375,7 @@ You may set values for the following keys:
:Type: Integer
:Example: ``3600`` 1hr

.. _hit_set_fpp:

``hit_set_fpp``

Expand All @@ -366,6 +386,7 @@ You may set values for the following keys:
:Valid Range: 0.0 - 1.0
:Default: ``0.05``

.. _cache_target_dirty_ratio:

``cache_target_dirty_ratio``

Expand All @@ -376,6 +397,7 @@ You may set values for the following keys:
:Type: Double
:Default: ``.4``

.. _cache_target_dirty_high_ratio:

``cache_target_dirty_high_ratio``

Expand All @@ -386,6 +408,7 @@ You may set values for the following keys:
:Type: Double
:Default: ``.6``

.. _cache_target_full_ratio:

``cache_target_full_ratio``

Expand All @@ -396,6 +419,7 @@ You may set values for the following keys:
:Type: Double
:Default: ``.8``

.. _target_max_bytes:

``target_max_bytes``

Expand All @@ -405,6 +429,7 @@ You may set values for the following keys:
:Type: Integer
:Example: ``1000000000000`` #1-TB

.. _target_max_objects:

``target_max_objects``

Expand All @@ -414,6 +439,7 @@ You may set values for the following keys:
:Type: Integer
:Example: ``1000000`` #1M objects

.. _cache_min_flush_age:

``cache_min_flush_age``

Expand All @@ -423,6 +449,7 @@ You may set values for the following keys:
:Type: Integer
:Example: ``600`` 10min

.. _cache_min_evict_age:

``cache_min_evict_age``

Expand All @@ -432,6 +459,8 @@ You may set values for the following keys:
:Type: Integer
:Example: ``1800`` 30min

.. _fast_read:

``fast_read``

:Description: On Erasure Coding pool, if this flag is turned on, the read request
Expand All @@ -456,145 +485,117 @@ You may get values for the following keys:

``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.
:Description: see size_

: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.
:Description: see min_size_

:Type: Integer
:Version: ``0.54`` and above

``crash_replay_interval``

:Description: The number of seconds to allow clients to replay acknowledged,
but uncommitted requests.
:Description: see crash_replay_interval_

:Type: Integer


``pgp_num``

:Description: The effective number of placement groups to use when calculating
data placement.
:Description: see pgp_num_

: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
:Description: see crush_ruleset_


``hit_set_type``

:Description: Enables hit set tracking for cache pools.
See `Bloom Filter`_ for additional information.
:Description: see hit_set_type_

: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.
:Description: see hit_set_count_

: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.
:Description: see hit_set_period_

:Type: Integer


``hit_set_fpp``

:Description: The false positive probability for the ``bloom`` hit set type.
See `Bloom Filter`_ for additional information.
:Description: see hit_set_fpp_

: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.

:Description: see cache_target_dirty_ratio_

:Type: Double


``cache_target_dirty_high_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 with a higher speed.
:Description: see cache_target_dirty_high_ratio_

: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.
:Description: see cache_target_full_ratio_

:Type: Double


``target_max_bytes``

:Description: Ceph will begin flushing or evicting objects when the
``max_bytes`` threshold is triggered.
:Description: see target_max_bytes_

:Type: Integer


``target_max_objects``

:Description: Ceph will begin flushing or evicting objects when the
``max_objects`` threshold is triggered.
:Description: see target_max_objects_

: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.
:Description: see cache_min_flush_age_

:Type: Integer


``cache_min_evict_age``

:Description: The time (in seconds) before the cache tiering agent will evict
an object from the cache pool.
:Description: see cache_min_evict_age_

:Type: Integer


``fast_read``

:Description: On Erasure Coding pool, if this flag is turned on, the read request
would issue sub reads to all shards, and wait until it receives enough
shards to decode to serve the client. In the case of jerasure and isa
erasure plugins, once the first K replies return, client's request is
serverd immediately using the data decoded from these replies. This
helps to tradeoff some resources for betterperformance. Currently this
flag is only supported for Erasure Coding pool.
:Description: see fast_read_

:Type: Boolean

Expand Down

0 comments on commit d31ba28

Please sign in to comment.