From 4327d1bd2dcc6d8af5f17d7c0677bc5f27d3139a Mon Sep 17 00:00:00 2001 From: Daniel Gryniewicz Date: Mon, 13 Feb 2017 10:15:57 -0500 Subject: [PATCH] Document RGW quota cache options Quota cache options were undocumented. Fixes: http://tracker.ceph.com/issues/18747 Signed-off-by: Daniel Gryniewicz --- doc/radosgw/admin.rst | 14 ++++++++++++++ doc/radosgw/config-ref.rst | 29 +++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst index f1916481bd936..c1f1904f7b74a 100644 --- a/doc/radosgw/admin.rst +++ b/doc/radosgw/admin.rst @@ -438,6 +438,20 @@ new user, and that quota is enabled. See ``rgw bucket default quota max objects ``rgw bucket default quota max size``, ``rgw user default quota max objects``, and ``rgw user default quota max size`` in `Ceph Object Gateway Config Reference`_ +Quota Cache +----------- + +Quota statistics are cached on each RGW instance. If there are multiple +instances, then the cache can keep quotas from being perfectly enforced, as +each instance will have a different view of quotas. The options that control +this are ``rgw bucket quota ttl``, ``rgw user quota bucket sync interval`` and +``rgw user quota sync interval``. The higher these values are, the more +efficient quota operations are, but the more out-of-sync multiple instances +will be. The lower these values are, the closer to perfect enforcement +multiple instances will achieve. If all three are 0, then quota caching is +effectively disabled, and multiple instances will have perfect quota +enforcement. See `Ceph Object Gateway Config Reference`_ + Reading / Writing Global Quotas ------------------------------- diff --git a/doc/radosgw/config-ref.rst b/doc/radosgw/config-ref.rst index 989aaeaf2bad0..0a4008359f837 100644 --- a/doc/radosgw/config-ref.rst +++ b/doc/radosgw/config-ref.rst @@ -359,6 +359,35 @@ instances or all radosgw-admin commands can be put into the ``[global]`` or the :Default: ``false`` +``rgw bucket quota ttl`` + +:Description: The amount of time in seconds cached quota information is + trusted. After this timeout, the quota information will be + re-fetched from the cluster. +:Type: Integer +:Default: ``600`` + + +``rgw user quota bucket sync interval`` + +:Description: The amount of time in seconds bucket quota information is + accumulated before syncing to the cluster. During this time, + other RGW instances will not see the changes in bucket quota + stats from operations on this instance. +:Type: Integer +:Default: ``180`` + + +``rgw user quota sync interval`` + +:Description: The amount of time in seconds user quota information is + accumulated before syncing to the cluster. During this time, + other RGW instances will not see the changes in user quota stats + from operations on this instance. +:Type: Integer +:Default: ``180`` + + ``rgw bucket default quota max objects`` :Description: Default max number of objects per bucket. Set on new users, -- 2.47.3