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 #333

Closed
Tracked by #127
sean-zheng-amazon opened this issue Mar 10, 2022 · 1 comment
Closed
Tracked by #127

Standardize file locations for supporting files #333

sean-zheng-amazon opened this issue Mar 10, 2022 · 1 comment
Assignees
Labels

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.
@naveenpajjuri
Copy link
Contributor

Only docs folder is applicable to CCR plugin structure and is at correct place.

@sean-zheng-amazon closing this issue. Please let me know if anything else is required here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants