doc: add docs for rgw compression

Signed-off-by: Casey Bodley <cbodley@redhat.com>

diff --git a/doc/radosgw/compression.rst b/doc/radosgw/compression.rst
new file mode 100644 (file)
index 0000000..41e535e
--- /dev/null
+++ b/doc/radosgw/compression.rst
@@ -0,0 +1,79 @@
+===========
+Compression
+===========
+
+.. versionadded:: Kraken
+
+The Ceph Object Gateway supports server-side compression of uploaded objects,
+using any of Ceph's existing compression plugins.
+
+
+Configuration
+=============
+
+Compression can be enabled on a Zone's placement target by providing the
+``--compression=<type>`` option to the ``radosgw-admin zone placement modify``
+command.
+
+The compression ``type`` refers to the name of the compression plugin to use
+when writing new object data. Each compressed object remembers which plugin
+was used, so changing this setting does not hinder the ability to decompress
+existing objects, not does it force existing objects to be recompressed.
+
+This compression setting applies to all new objects uploaded to buckets using
+this placement target. Compression can be disabled by setting the ``type`` to
+an empty string or ``none``.
+
+For example::
+
+  $ radosgw-admin zone placement modify --rgw-zone=default --placement-id=default-placement --compression=zlib
+  {
+  ...
+      "placement_pools": [
+          {
+              "key": "default-placement",
+              "val": {
+                  "index_pool": "default.rgw.buckets.index",
+                  "data_pool": "default.rgw.buckets.data",
+                  "data_extra_pool": "default.rgw.buckets.non-ec",
+                  "index_type": 0,
+                  "compression": "zlib"
+              }
+          }
+      ],
+  ...
+  }
+
+.. note:: A ``default`` zone is created for you if you have not done any
+   previous `Multisite Configuration`_.
+
+
+Statistics
+==========
+
+While all existing commands and APIs continue to report object and bucket
+sizes based their uncompressed data, compression statistics for a given bucket
+are included in its ``bucket stats``::
+
+  $ radosgw-admin bucket stats --bucket=<name>
+  {
+  ...
+      "usage": {
+          "rgw.main": {
+              "size": 1075028,
+              "size_actual": 1331200,
+              "size_utilized": 592035,
+              "size_kb": 1050,
+              "size_kb_actual": 1300,
+              "size_kb_utilized": 579,
+              "num_objects": 104
+          }
+      },
+  ...
+  }
+
+The ``size_utilized`` and ``size_kb_utilized`` fields represent the total
+size of compressed data, in bytes and kilobytes respectively.
+
+
+.. _`Multisite Configuration`: ../multisite

diff --git a/doc/radosgw/config-ref.rst b/doc/radosgw/config-ref.rst
index b25cf14c51ff7496d6dd06300debf525f26b96ef..390151b87e92db0c235210dcc4471f49096281fd 100644 (file)
--- a/doc/radosgw/config-ref.rst
+++ b/doc/radosgw/config-ref.rst
@@ -380,16 +380,6 @@ Ceph configuration file, the default value will be set automatically.
 :Default: ``-1``
 
 
-``rgw compression type``
-
-:Description: The compression plugin to use when writing object data. Each
-              compressed object remembers which plugin was used, so changing
-              this setting does not hinder the ability to decompress existing
-              objects, not does it force existing objects to be recompressed.
-:Type: String
-:Default: ``none``
-
-
 Regions
 =======
 

diff --git a/doc/radosgw/index.rst b/doc/radosgw/index.rst
index b2c46606b04a9b0ba0dada931fe86ae1f2cef534..af8b293f66a8763926df90f0e0b77a8cf4e67bcc 100644 (file)
--- a/doc/radosgw/index.rst
+++ b/doc/radosgw/index.rst
@@ -47,6 +47,7 @@ you may write data with one API and retrieve it with the other.
        Admin Ops API <adminops>
        OpenStack Keystone Integration <keystone>
        Multi-tenancy <multitenancy>
+       Compression <compression>
        troubleshooting
        Manpage radosgw <../../man/8/radosgw>
        Manpage radosgw-admin <../../man/8/radosgw-admin>