From 61196bed6408a6d526d1849462255052a3182134 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 30 Jul 2024 15:27:09 +0000 Subject: [PATCH] Update index-codecs.md (#7837) * Update index-codecs.md qat_deflate does not work on 2.14, it does on 2.15. 2.14: { "error": { "root_cause": [ { "type": "illegal_argument_exception", "reason": "unknown value for [index.codec] must be one of [default, lz4, best_compression, zlib] but was: qat_deflate" } ], "type": "illegal_argument_exception", "reason": "unknown value for [index.codec] must be one of [default, lz4, best_compression, zlib] but was: qat_deflate" }, "status": 400 } 2.15: { "acknowledged": true, "shards_acknowledged": true, "index": "x" } Signed-off-by: Sander van de Geijn * Update to 2.15 for all. Signed-off-by: Sander van de Geijn --------- Signed-off-by: Sander van de Geijn (cherry picked from commit f58bf565d47720ae6eedf850595bdd4d23c94d92) Signed-off-by: github-actions[bot] --- _im-plugin/index-codecs.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_im-plugin/index-codecs.md b/_im-plugin/index-codecs.md index ed28aca8e8..81af8b899f 100644 --- a/_im-plugin/index-codecs.md +++ b/_im-plugin/index-codecs.md @@ -32,11 +32,11 @@ For the `zstd` and `zstd_no_dict` codecs, you can optionally specify a compressi When an index segment is created, it uses the current index codec for compression. If you update the index codec, any segment created after the update will use the new compression algorithm. For specific operation considerations, see [Index codec considerations for index operations](#index-codec-considerations-for-index-operations). {: .note} -As of OpenSearch 2.14, hardware-accelerated compression codecs for the `DEFLATE` and `LZ4` compression algorithms are available. These hardware-accelerated codecs are available on the latest 4th and 5th Gen Intel®️ Xeon®️ processors running Linux kernel 3.10 and later. For all other systems and platforms, the codecs use that platform's corresponding software implementations. +As of OpenSearch 2.15, hardware-accelerated compression codecs for the `DEFLATE` and `LZ4` compression algorithms are available. These hardware-accelerated codecs are available on the latest 4th and 5th Gen Intel®️ Xeon®️ processors running Linux kernel 3.10 and later. For all other systems and platforms, the codecs use that platform's corresponding software implementations. The new hardware-accelerated codecs can be used by setting one of the following `index.codec` values: -* `qat_lz4` (OpenSearch 2.14 and later): Hardware-accelerated `LZ4` -* `qat_deflate` (OpenSearch 2.14 and later): Hardware-accelerated `DEFLATE` +* `qat_lz4` (OpenSearch 2.15 and later): Hardware-accelerated `LZ4` +* `qat_deflate` (OpenSearch 2.15 and later): Hardware-accelerated `DEFLATE` `qat_deflate` offers a much better compression ratio than `qat_lz4`, with a modest drop in compression and decompression speed. {: .note} @@ -78,7 +78,7 @@ When creating a [snapshot]({{site.url}}{{site.baseurl}}/tuning-your-cluster/avai When you restore the indexes from a snapshot of a cluster to another cluster, it is important to verify that the target cluster supports the codecs of the segments in the source snapshot. For example, if the source snapshot contains segments of the `zstd` or `zstd_no_dict` codecs (introduced in OpenSearch 2.9), you won't be able to restore the snapshot to a cluster that runs on an older OpenSearch version because it doesn't support these codecs. -For hardware-accelerated compression codecs, available in OpenSearch 2.14 and later, the value of `index.codec.qatmode` affects how snapshots and restores are performed. If the value is `auto` (the default), then snapshots and restores work without issue. However, if the value is `hardware`, then it must be reset to `auto` in order for the restore process to succeed on systems lacking the hardware accelerator. +For hardware-accelerated compression codecs, available in OpenSearch 2.15 and later, the value of `index.codec.qatmode` affects how snapshots and restores are performed. If the value is `auto` (the default), then snapshots and restores work without issue. However, if the value is `hardware`, then it must be reset to `auto` in order for the restore process to succeed on systems lacking the hardware accelerator. You can modify the value of `index.codec.qatmode` during the restore process by setting its value as follows: `"index_settings": {"index.codec.qatmode": "auto"}`. {: .note}