opensearch-sdk-java
opensearch-sdk-java copied to clipboard
OpenSearch SDK to build and run extensions
OpenSearch SDK for Java
-
OpenSearch SDK for Java
- Introduction
- Design
- Creating an extension
- Developer Guide
- Plugin migration
- Contributing
- Maintainers
- Code of Conduct
To view extension documentation as a webpage, go to https://opensearch-project.github.io/opensearch-sdk-java/.
Introduction
With OpenSearch plugins, you can extend and enhance various core features. However, the current plugin architecture may fatally impact clusters in the event of failure. To ensure that plugins run safely without impacting the system, our goal is to isolate plugin interactions with OpenSearch. The OpenSearch SDK for Java modularizes the extension points onto which plugins hook.
For more information about extensibility, see this GitHub issue.
Design
For an overview of extension architecture and information about how extensions work, see DESIGN.
Creating an extension
For information about developing an extension, see CREATE_YOUR_FIRST_EXTENSION.
Developer Guide
For instructions on building, testing, and running an extension, see the DEVELOPER_GUIDE.
Plugin migration
For tips on migrating an existing plugin to an extension, see PLUGIN_MIGRATION.
Contributing
For information about contributing, see CONTRIBUTING.
Maintainers
For points of contact, see MAINTAINERS.
Code of Conduct
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact [email protected] with any additional questions or comments.