Skip to content

Commit d5f61a6

Browse files
Add qat_zstd as a valid index.codec value. (#12000)
* Add qat_zstd as a valid index.codec value. Signed-off-by: Mulugeta Mammo <mulugeta.mammo@intel.com> * Update _install-and-configure/configuring-opensearch/index-settings.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: mulugetam <mulugeta.mammo@intel.com> * Update _im-plugin/index-codecs.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: mulugetam <mulugeta.mammo@intel.com> * Update _install-and-configure/configuring-opensearch/index-settings.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: mulugetam <mulugeta.mammo@intel.com> --------- Signed-off-by: Mulugeta Mammo <mulugeta.mammo@intel.com> Signed-off-by: mulugetam <mulugeta.mammo@intel.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
1 parent 1e8686a commit d5f61a6

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

_im-plugin/index-codecs.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,12 @@ As of OpenSearch 2.15, hardware-accelerated compression codecs for the `DEFLATE`
3737
The new hardware-accelerated codecs can be used by setting one of the following `index.codec` values:
3838
* `qat_lz4` (OpenSearch 2.15 and later): Hardware-accelerated `LZ4`
3939
* `qat_deflate` (OpenSearch 2.15 and later): Hardware-accelerated `DEFLATE`
40+
* `qat_zstd` (OpenSearch 2.19.3 and later): Hardware-accelerated `ZSTD`
4041

41-
`qat_deflate` offers a much better compression ratio than `qat_lz4`, with a modest drop in compression and decompression speed.
42+
`qat_deflate` offers a much better compression ratio than `qat_lz4`, with a modest drop in compression and decompression speed. `qat_zstd` uses hardware acceleration for compression but relies on software-based decompression.
4243
{: .note}
4344

44-
The `index.codec.compression_level` setting can be used to specify the compression level for both `qat_lz4` and `qat_deflate`.
45+
The `index.codec.compression_level` setting can be used to specify the compression level for both `qat_lz4`, `qat_deflate`, and `qat_zstd`.
4546

4647
The `index.codec.qatmode` setting controls the behavior of the hardware accelerator and uses one of the following values:
4748

_install-and-configure/configuring-opensearch/index-settings.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,12 +149,13 @@ OpenSearch supports the following static index-level index settings:
149149
- `zstd_no_dict`(OpenSearch 2.9 and later)
150150
- `qat_lz4` (OpenSearch 2.14 and later, on supported systems)
151151
- `qat_deflate` (OpenSearch 2.14 and later, on supported systems)
152+
- `qat_zstd` (OpenSearch 2.19.3 and later, on supported systems)
152153

153-
For `zstd`, `zstd_no_dict`, `qat_lz4`, and `qat_deflate`, you can specify the compression level in the `index.codec.compression_level` setting. For more information, see [Index codec settings]({{site.url}}{{site.baseurl}}/im-plugin/index-codecs/). Optional. Default is `default`.
154+
For `zstd`, `zstd_no_dict`, `qat_lz4`, `qat_deflate`, and `qat_zstd`, you can specify the compression level in the `index.codec.compression_level` setting. For more information, see [Index codec settings]({{site.url}}{{site.baseurl}}/im-plugin/index-codecs/). Optional. Default is `default`.
154155

155-
- `index.codec.compression_level` (Integer): The compression level setting provides a trade-off between compression ratio and speed. A higher compression level results in a higher compression ratio (smaller storage size), but slower compression and decompression speeds lead to higher indexing and search latencies. This setting can only be specified if `index.codec` is set to `zstd` and `zstd_no_dict` in OpenSearch 2.9 and later or `qat_lz4` and `qat_deflate` in OpenSearch 2.14 and later. Valid values are integers in the [1, 6] range. For more information, see [Index codec settings]({{site.url}}{{site.baseurl}}/im-plugin/index-codecs/). Optional. Default is 3.
156+
- `index.codec.compression_level` (Integer): The compression level setting provides a trade-off between compression ratio and speed. A higher compression level results in a higher compression ratio (smaller storage size), but slower compression and decompression speeds lead to higher indexing and search latencies. This setting can only be specified if `index.codec` is set to `zstd` or `zstd_no_dict` in OpenSearch 2.9 and later; `qat_lz4` or `qat_deflate` in OpenSearch 2.14 and later; or `qat_zstd` in OpenSearch 2.19.3 and later. Valid values are integers in the `[1, 6]` range. For more information, see [Index codec settings]({{site.url}}{{site.baseurl}}/im-plugin/index-codecs/). Optional. Default is `3`.
156157

157-
- `index.codec.qatmode` (String): The hardware acceleration mode used for the `qat_lz4` and `qat_deflate` compression codecs. Valid values are `auto` and `hardware`. For more information, see [Index codec settings]({{site.url}}{{site.baseurl}}/im-plugin/index-codecs/). Optional. Default is `auto`.
158+
- `index.codec.qatmode` (String): The hardware acceleration mode used for the `qat_lz4`, `qat_deflate`, and `qat_zstd` compression codecs. Valid values are `auto` and `hardware`. For more information, see [Index codec settings]({{site.url}}{{site.baseurl}}/im-plugin/index-codecs/). Optional. Default is `auto` (the recommended setting).
158159

159160
- `index.routing_partition_size` (Integer): The number of shards a custom routing value can go to. Routing helps an imbalanced cluster by relocating values to a subset of shards rather than a single shard. To enable routing, set this value to greater than 1 but less than `index.number_of_shards`. Default is 1.
160161

0 commit comments

Comments
 (0)