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

Standardize file locations for supporting files #1673

Closed
Tracked by #127
sean-zheng-amazon opened this issue Mar 10, 2022 · 2 comments · Fixed by #1749
Closed
Tracked by #127

Standardize file locations for supporting files #1673

sean-zheng-amazon opened this issue Mar 10, 2022 · 2 comments · Fixed by #1749
Assignees
Labels
enhancement New feature or request v2.0.0

Comments

@sean-zheng-amazon
Copy link

Coming from opensearch-project/opensearch-plugins#127.

We should standardize the file location across plugins by implementing following conventions:

  • All supporting files for plugins should stay within the plugin's own folder: /plugins/my-plugin
  • Within plugin's folder, we recommend following directory structure:
    • ./config: config files
    • ./bin: executables
    • ./lib: for plugins that use native libraries (e.g. libKNNIndexV2_0_11.so)
    • ./install: scripts called to bootstrap the plugin before first use.
    • ./docs: document files
    • ./certs: certificates for the security plugin
    • ./data: test/demo data
  • All scripts should come in *nix and .bat flavors, should use OpenSearch's defaults for environment variables like $JAVA_HOME, so users can override these but don't need to specify them by default. Scripts should have 0755 permissions by default.
@peternied
Copy link
Member

We've had some concerns about making this change, voiced them in the main issue. I'll deep dive into this tomorrow to see what's feasible for the libs/config/bin alignment

@.sean-zheng-amazon we have been looking into this from the security plugin, it is going to break a large amount of our documentation / related to change the tooling paths that we have used for the audit/hash/securityadmin scripts.

This does not seem high value for the breaking change. Rather than centralize these scripts, what about creating an OpenSearch Admin tool that abstracts these paths entirely? FYI @.setiah that has been looking into this concept.

@peternied
Copy link
Member

For 2.0.0 we will complete this task for all folder except for bin, PR is in process now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v2.0.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants