From b80322037bb409a052c42907e5ade2bcb06c2d3a Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Wed, 20 Dec 2023 15:00:38 +1000 Subject: [PATCH] doc/radosgw: edit compression.rst Improve the grammar and simplify the sentence structure of doc/radosgw/compression.rst. This commit is made in anticipation of a near-future commit that will list the compression algorithms available to users of Ceph. Co-authored-by: Anthony D'Atri Signed-off-by: Zac Dover (cherry picked from commit 84c5d2c828c2fbd70bdeadedd341ca42ddb1c20c) --- doc/radosgw/compression.rst | 34 +++++++++++++++++++++------------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/doc/radosgw/compression.rst b/doc/radosgw/compression.rst index 23655f1dce0ed..8e28ae96d60a4 100644 --- a/doc/radosgw/compression.rst +++ b/doc/radosgw/compression.rst @@ -4,8 +4,8 @@ Compression .. versionadded:: Kraken -The Ceph Object Gateway supports server-side compression of uploaded objects, -using any of Ceph's existing compression plugins. +The Ceph Object Gateway supports server-side compression of uploaded objects. +using any of the existing compression plugins. Configuration @@ -15,14 +15,15 @@ Compression can be enabled on a storage class in the Zone's placement target by providing the ``--compression=`` option to the command ``radosgw-admin zone placement modify``. -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, nor does it force existing objects to be recompressed. +The compression ``type`` refers to the name of the compression plugin that will +be used when writing new object data. Each compressed object remembers which +plugin was used, so any change to this setting will neither affect Ceph's +ability to decompress existing objects nor require 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``. +Compression settings apply 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:: @@ -59,11 +60,15 @@ For example:: 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``:: +Run the ``radosgw-admin bucket stats`` command to see compression statistics +for a given bucket: + +.. prompt:: bash + + radosgw-admin bucket stats --bucket= + +:: - $ radosgw-admin bucket stats --bucket= { ... "usage": { @@ -80,6 +85,9 @@ are included in its ``bucket stats``:: ... } +Other commands and APIs will report object and bucket sizes based on their +uncompressed data. + The ``size_utilized`` and ``size_kb_utilized`` fields represent the total size of compressed data, in bytes and kilobytes respectively. -- 2.39.5