Skip to content

Commit

Permalink
Add documentation for the custom-codecs plugin.
Browse files Browse the repository at this point in the history
  - Add documentation for the custom-codecs plugin (opensearch-project/OpenSearch#3577).

Signed-off-by: Mulugeta Mammo <[email protected]>
  • Loading branch information
mulugetam committed May 1, 2023
1 parent d077955 commit 598db86
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
2 changes: 1 addition & 1 deletion _api-reference/index-apis/create-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
14 changes: 14 additions & 0 deletions _install-and-configure/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 featured 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-<version>-SNAPSHOT.zip
```

## Related links

- [About Observability]({{site.url}}{{site.baseurl}}/observability-plugin/index/)
Expand Down

0 comments on commit 598db86

Please sign in to comment.