README.md

• OpenSearch Plugins
  • Naming Conventions
  • Managing OpenSearch Plugins
  • Building Plugins with OpenSearch
  • Upgrading Plugins to work with OpenSearch
  • Installing Plugins
  • Developing Plugins for OpenSearch
  • Workflows
  • Plugin Release Notes
  • Headers
  • Standards
• Contributing
• License
• Copyright

OpenSearch Plugins

This repository contains all the things you ever wanted to know about OpenSearch plugins.

Naming Conventions

See CONVENTIONS.

Managing OpenSearch Plugins

We use meta to manage OpenSearch plugins as a set. See META for more information.

Building Plugins with OpenSearch

Until OpenSearch and other artifacts are published to Maven Central OpenSearch#581, plugins may require building all their dependencies and publishing them to Maven local.

See BUILDING for details.

Upgrading Plugins to work with OpenSearch

To upgrade your existing plugins to work with OpenSearch, see UPGRADING.

Installing Plugins

See INSTALLING for details.

Developing Plugins for OpenSearch

See DEVELOPING_PLUGINS for details.

Workflows

See WORKFLOWS for useful workflows that can be added.

Plugin Release Notes

Plugins generally use a standard format for release notes, see RELEASE_NOTES.

Headers

See HEADERS for details of headers including licenses.

Standards

See STANDARDS for information regarding plugin standards.

Contributing

See CONTRIBUTING for more information.

License

This project is licensed under the Apache v2.0 License.

Copyright

Copyright OpenSearch Contributors. See NOTICE for details.