From aa319153f249a4fa1975002c9d17ccc5faeb1b68 Mon Sep 17 00:00:00 2001 From: Mulugeta Mammo Date: Mon, 1 May 2023 16:29:48 -0700 Subject: [PATCH 1/4] Add documentation for the custom-codecs plugin. - Add documentation for the custom-codecs plugin (https://github.com/opensearch-project/OpenSearch/pull/3577). Signed-off-by: Mulugeta Mammo --- _api-reference/index-apis/create-index.md | 2 +- _install-and-configure/plugins.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/_api-reference/index-apis/create-index.md b/_api-reference/index-apis/create-index.md index 5328869b9f8..df98b1e0e77 100644 --- a/_api-reference/index-apis/create-index.md +++ b/_api-reference/index-apis/create-index.md @@ -80,7 +80,7 @@ Setting | Description index.number_of_shards | The number of primary shards in the index. Default is 1. index.number_of_routing_shards | The number of routing shards used to split an index. index.shard.check_on_startup | Whether the index's shards should be checked for corruption. Available options are `false` (do not check for corruption), `checksum` (check for physical corruption), and `true` (check for both physical and logical corruption). Default is `false`. -index.codec | The compression type to use to compress stored data. Available values are `default` (optimizes for retrieval speed) and `best_compression` (optimizes for better compression at the expense of speed, leading to smaller data sizes on disk). +index.codec | The compression type to use to compress stored data. Available values are `default` (optimizes for retrieval speed) and `best_compression` (optimizes for better compression at the expense of speed, leading to smaller data sizes on disk). For snapshot distributions built with sandbox feature enabled, `-Dsandbox.enabled=true`, OpenSearch offers a custom-codecs plugin that supports the value `zstd` for Zstandard compression. index.routing_partition_size | 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 just a single shard. To enable, set this value to greater than 1 but less than `index.number_of_shards`. Default is 1. index.soft_deletes.retention_lease.period | The maximum amount of time to retain a shard's history of operations. Default is `12h`. index.load_fixed_bitset_filters_eagerly | Whether OpenSearch should pre-load cached filters. Available options are `true` and `false`. Default is `true`. diff --git a/_install-and-configure/plugins.md b/_install-and-configure/plugins.md index dabac1a0d62..50407aa3ac0 100644 --- a/_install-and-configure/plugins.md +++ b/_install-and-configure/plugins.md @@ -289,6 +289,20 @@ Members of the OpenSearch community have built countless plugins for the service | store-smb | 1.0.0 | | transport-nio | 1.0.0 | +### Experimental plugins + +OpenSearch offers experimental plugins that may be used in a snapshot distribution that has the [sandbox feature enabled](https://github.com/opensearch-project/OpenSearch/blob/main/sandbox/build.gradle). + +| Plugin Name | Description | Earliest Available Version | +| :--- | :--- | +| custom-codecs | Provides additional compression codecs. | 1.0.0 | + +#### Example usage: +```bash +./gradlew assemble -Dsandbox.enabled=true +bin/opensearch-plugin install file:///path/to/plugin--SNAPSHOT.zip +``` + ## Related links - [About Observability]({{site.url}}{{site.baseurl}}/observability-plugin/index/) From 1668d14b19e00a5882f532c4a28cd39642ecce0c Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 5 Jun 2023 13:12:15 -0500 Subject: [PATCH 2/4] Update _api-reference/index-apis/create-index.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _api-reference/index-apis/create-index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_api-reference/index-apis/create-index.md b/_api-reference/index-apis/create-index.md index df98b1e0e77..e915d1b7edd 100644 --- a/_api-reference/index-apis/create-index.md +++ b/_api-reference/index-apis/create-index.md @@ -80,7 +80,7 @@ Setting | Description index.number_of_shards | The number of primary shards in the index. Default is 1. index.number_of_routing_shards | The number of routing shards used to split an index. index.shard.check_on_startup | Whether the index's shards should be checked for corruption. Available options are `false` (do not check for corruption), `checksum` (check for physical corruption), and `true` (check for both physical and logical corruption). Default is `false`. -index.codec | The compression type to use to compress stored data. Available values are `default` (optimizes for retrieval speed) and `best_compression` (optimizes for better compression at the expense of speed, leading to smaller data sizes on disk). For snapshot distributions built with sandbox feature enabled, `-Dsandbox.enabled=true`, OpenSearch offers a custom-codecs plugin that supports the value `zstd` for Zstandard compression. +index.codec | The compression type to use to compress stored data. Available values are `default` (optimizes for retrieval speed) and `best_compression` (optimizes for better compression at the expense of speed, leading to smaller data sizes on disk). For snapshot distributions built with the sandbox feature enabled, `-Dsandbox.enabled=true`, OpenSearch offers a custom-codecs plugin that supports the value `zstd` for Zstandard compression. index.routing_partition_size | 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 just a single shard. To enable, set this value to greater than 1 but less than `index.number_of_shards`. Default is 1. index.soft_deletes.retention_lease.period | The maximum amount of time to retain a shard's history of operations. Default is `12h`. index.load_fixed_bitset_filters_eagerly | Whether OpenSearch should pre-load cached filters. Available options are `true` and `false`. Default is `true`. From d20f3ffe2ea6b2bc0080fdd9e7b41ce43d5cce40 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 5 Jun 2023 13:14:16 -0500 Subject: [PATCH 3/4] Update _install-and-configure/plugins.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _install-and-configure/plugins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_install-and-configure/plugins.md b/_install-and-configure/plugins.md index 50407aa3ac0..631cd7acfc8 100644 --- a/_install-and-configure/plugins.md +++ b/_install-and-configure/plugins.md @@ -297,7 +297,7 @@ OpenSearch offers experimental plugins that may be used in a snapshot distributi | :--- | :--- | | custom-codecs | Provides additional compression codecs. | 1.0.0 | -#### Example usage: +Use the following example command to enable the sandbox feature: ```bash ./gradlew assemble -Dsandbox.enabled=true bin/opensearch-plugin install file:///path/to/plugin--SNAPSHOT.zip From cd3353b3b265e8cc86213fedd5511d283b59e83e Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Mon, 5 Jun 2023 13:14:21 -0500 Subject: [PATCH 4/4] Update _install-and-configure/plugins.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _install-and-configure/plugins.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_install-and-configure/plugins.md b/_install-and-configure/plugins.md index 631cd7acfc8..a6ef73a1a66 100644 --- a/_install-and-configure/plugins.md +++ b/_install-and-configure/plugins.md @@ -298,6 +298,7 @@ OpenSearch offers experimental plugins that may be used in a snapshot distributi | custom-codecs | Provides additional compression codecs. | 1.0.0 | Use the following example command to enable the sandbox feature: + ```bash ./gradlew assemble -Dsandbox.enabled=true bin/opensearch-plugin install file:///path/to/plugin--SNAPSHOT.zip