iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add documentation for the custom-codecs plugin. (#3913) 

* 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 <mulugeta.mammo@intel.com>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _install-and-configure/plugins.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update _install-and-configure/plugins.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Mulugeta Mammo <mulugeta.mammo@intel.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
This commit is contained in:
mulugetam 2023-06-05 11:34:29 -07:00 committed by GitHub
parent 9c557bbad4
commit 817b730908
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_api-reference/index-apis/create-index.md
View File

@ -82,7 +82,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 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`.

15
_install-and-configure/plugins.md
View File

@ -289,6 +289,21 @@ 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 |
Use the following example command to enable the sandbox feature:
```bash
./gradlew assemble -Dsandbox.enabled=true
bin/opensearch-plugin install file:///path/to/plugin-<version>-SNAPSHOT.zip
```
## Related links
- [About Observability]({{site.url}}{{site.baseurl}}/observability-plugin/index/)