Document RGW quota cache options

Quota cache options were undocumented.

Fixes: http://tracker.ceph.com/issues/18747
Signed-off-by: Daniel Gryniewicz <dang@redhat.com>

diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst
index f1916481bd936f1afce50235f764f22939eb69ea..c1f1904f7b74aeb7d52bce27b438ba0a28e129ee 100644 (file)
--- 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 989aaeaf2bad0e456e99b9895c4755eca6e05056..0a4008359f83708757a6c5ade76b9adc694c485b 100644 (file)
--- 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,