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] Reference ZSTD Codecs as optional plugin #4832

Closed
1 of 4 tasks
sarthakaggarwal97 opened this issue Aug 18, 2023 · 9 comments
Closed
1 of 4 tasks

[DOC] Reference ZSTD Codecs as optional plugin #4832

sarthakaggarwal97 opened this issue Aug 18, 2023 · 9 comments
Assignees
Labels
3 - Done Issue is done/complete v2.10.0

Comments

@sarthakaggarwal97
Copy link
Contributor

sarthakaggarwal97 commented Aug 18, 2023

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.
Following recent discussions with respect to this issue, it would be required to inform the users that codecs are still in optional plugin, experimental or feature flag based.

Docs to be changed:

  1. https://opensearch.org/docs/latest/im-plugin/index-codecs/
  2. https://opensearch.org/docs/latest/tuning-your-cluster/performance/

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

@hdhalter
Copy link
Contributor

Hi @kolchfa-aws , since you are familiar with this content, can you please update the doc? Thanks.

@hdhalter hdhalter added 1 - Backlog Issue: The issue is unassigned or assigned but not started and removed untriaged labels Aug 18, 2023
@sarthakaggarwal97 sarthakaggarwal97 changed the title [DOC] Reference ZSTD Codecs as experimental [DOC] Reference ZSTD Codecs as optional plugin Aug 18, 2023
@sarthakaggarwal97
Copy link
Contributor Author

Closing this issue since we are not making this feature experimental for now. Thanks @kolchfa-aws @hdhalter

@dblock
Copy link
Member

dblock commented Sep 7, 2023

  1. In 2.10 the ZSTD plugin is not installed by default like in 2.9.
  2. If we do [Onboarding] [2.10.0] Install custom-codecs plugin (zstd compression) in 2.10 distribution opensearch-build#3971 it will be installed in the full distribution but not in the min distribution.

Either way this is a breaking change and needs to be documented, reopening.

@dblock dblock reopened this Sep 7, 2023
@dblock dblock added the v2.10.0 label Sep 7, 2023
@hdhalter hdhalter removed the untriaged label Sep 7, 2023
@hdhalter
Copy link
Contributor

hdhalter commented Sep 7, 2023

@dblock - Is there someone that can create a PR?

@andrross
Copy link
Member

andrross commented Sep 7, 2023

Either way this is a breaking change and needs to be documented, reopening.

@dblock There are many examples in the documentation of installed-by-default plugin functionality being described without mention that it is a plugin that can be uninstalled. (e.g. Aysnc search) What specifically do you think needs to be documented here (assuming the plugin is installed by default)?

@dblock
Copy link
Member

dblock commented Sep 8, 2023

IMO the change to users for the min distribution - installed in 2.9, not installed in 2.10. But I am not sure whether we say anything about that anywhere?

@andrross
Copy link
Member

andrross commented Sep 8, 2023

At a minimum we should add it to the list of bundled plugins: #5000

@hdhalter Can someone take a look here?

@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 1 - Backlog Issue: The issue is unassigned or assigned but not started 3 - Done Issue is done/complete labels Sep 11, 2023
@kolchfa-aws
Copy link
Collaborator

Thanks, @andrross! Is there any more work needed for this issue or is it fixed by #5000?

@andrross
Copy link
Member

@kolchfa-aws, I don't have any other specific suggestions to change other than what is done by #5000

@kolchfa-aws kolchfa-aws added the 3 - Done Issue is done/complete label Sep 15, 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 v2.10.0
Projects
None yet
Development

No branches or pull requests

5 participants