Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Document experimental codecs #3816

Closed
1 task done
dblock opened this issue Apr 20, 2023 · 2 comments
Closed
1 task done

[DOC] Document experimental codecs #3816

dblock opened this issue Apr 20, 2023 · 2 comments
Assignees
Labels
3 - Done Issue is done/complete Sev3 Medium priority. Content that's missing, driven by dev, PM or the community.

Comments

@dblock
Copy link
Member

dblock commented Apr 20, 2023

What do you want to do?

  • Add new documentation

Tell us about your request. Provide a summary of the request and all versions that are affected.

In opensearch-project/OpenSearch#3354 we've introduced some new experimental compression codecs . The documentation is sparse on what this does, in https://opensearch.org/docs/1.0/opensearch/rest-api/create-index/ we only say that index.codec is "The compression type to use to compress stored data. Available values are best_compression and default."

I propose we add documentation that 1) describes each codec, their pros, cons and tradeoffs, provide links to benchmarks, 2) explain what can and cannot be done at runtime (e.g. can one change a codec after the index is created? can one restore a snapshot that used a certain codec into an index that uses another?).

@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started Sev3 Medium priority. Content that's missing, driven by dev, PM or the community. and removed untriaged labels May 1, 2023
@hdhalter hdhalter self-assigned this Jul 17, 2023
@hdhalter
Copy link
Contributor

The 2.9 release covers the new index codecs ZSTD and ZSTD_NO_DICT, but there is more detail and use cases to add. We will address post-2.9.

@hdhalter hdhalter added this to the Q3 - 2023 milestone Jul 17, 2023
@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Jul 17, 2023
@hdhalter
Copy link
Contributor

Hi @dblock - We have enhanced the section on index codecs quite a bit. Can you please review and let me know if we are missing anything? Thanks! https://opensearch.org/docs/latest/im-plugin/index-codecs/

@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete Sev3 Medium priority. Content that's missing, driven by dev, PM or the community.
Projects
None yet
Development

No branches or pull requests

3 participants