| 1 |
--- |
| 2 |
features: |
| 3 |
- | |
| 4 |
A general framework to accommodate hardware compression accelerators for |
| 5 |
compression of volumes uploaded to the Image service (Glance) as images |
| 6 |
and decompression of compressed images used to create volumes is |
| 7 |
introduced. |
| 8 |
|
| 9 |
The only accelerator supported in this release is Intel QuickAssist |
| 10 |
Technology (QAT), which produces a compressed file in gzip format. |
| 11 |
Refer to this `Cinder documentation |
| 12 |
<https://docs.openstack.org/cinder/latest/admin/blockstorage-accelerate-image-compression.html>`_ |
| 13 |
for more information about using this feature. |
| 14 |
|
| 15 |
Additionally, the framework provides software-based compression using |
| 16 |
GUNzip tool if a suitable hardware accelerator is not available. |
| 17 |
Because this software fallback could cause performance problems if the |
| 18 |
Cinder services are not deployed on sufficiently powerful nodes, the |
| 19 |
default setting is *not* to enable compression on image upload or |
| 20 |
download. |
| 21 |
|
| 22 |
The compressed image of a volume will be stored in the |
| 23 |
Image service (Glance) with the ``container_format`` image property of |
| 24 |
``compressed``. See the `Image service documentation |
| 25 |
<https://docs.openstack.org/glance/latest>`_ for more information about |
| 26 |
this image container format. |
| 27 |
issues: |
| 28 |
- | |
| 29 |
In the Image service (Glance), the ``compressed`` container format |
| 30 |
identifier does not indicate a particular compression technology; it is up |
| 31 |
to the image consumer to determine what compression has been used, and |
| 32 |
there is no requirement that OpenStack services must support arbitrary |
| 33 |
compression technologies. For the upload and download of compressed |
| 34 |
images, Cinder supports *only* the gzip format. |
| 35 |
|
| 36 |
While you may expect that Cinder will be able to consume any image in |
| 37 |
``compressed`` container format *that Cinder has created*, you should not |
| 38 |
expect Cinder to be able to successfully use an image in ``compressed`` |
| 39 |
format that it has not created itself. |
| 40 |
upgrade: |
| 41 |
- | |
| 42 |
Added string config option ``compression_format`` in [default] section of |
| 43 |
cinder.conf to specify image compression format. Currently the only legal |
| 44 |
value for this option is ``gzip``. |
| 45 |
- | |
| 46 |
Added boolean config option ``allow_compression_on_image_upload`` in |
| 47 |
[default] section of cinder.conf to enable/disable image compression on |
| 48 |
image upload. The default value of this option is ``false``, which means |
| 49 |
image compression is disabled. |