https://github.com/opensearch-project/opensearch-sdk-java

OpenSearch SDK to build and run extensions
https://github.com/opensearch-project/opensearch-sdk-java

java

Last synced: about 1 year ago
JSON representation

OpenSearch SDK to build and run extensions

• Host: GitHub
• URL: https://github.com/opensearch-project/opensearch-sdk-java
• Owner: opensearch-project
• License: apache-2.0
• Created: 2022-04-29T18:31:35.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-03-26T05:07:38.000Z (about 1 year ago)
• Last Synced: 2025-04-02T12:12:20.708Z (about 1 year ago)
• Topics: java
• Language: Java
• Homepage:
• Size: 1.73 MB
• Stars: 30
• Watchers: 15
• Forks: 58
• Open Issues: 120
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
[![codecov](https://codecov.io/gh/opensearch-project/opensearch-sdk-java/branch/main/graph/badge.svg)](https://codecov.io/gh/opensearch-project/opensearch-sdk-java)

[![GHA gradle check](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/build.yml/badge.svg)](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/build.yml)

[![GHA validate pull request](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/wrapper.yml/badge.svg)](https://github.com/opensearch-project/opensearch-sdk-java/actions/workflows/wrapper.yml)

# OpenSearch SDK for Java

* [OpenSearch SDK for Java](#opensearch-sdk-for-java)

  * [Introduction](#introduction)

  * [Design](#design)

  * [Creating an extension](#creating-an-extension)

  * [Developer Guide](#developer-guide)

  * [Plugin migration](#plugin-migration)

  * [Contributing](#contributing)

  * [Maintainers](#maintainers)

  * [Code of Conduct](#code-of-conduct)

To view extension documentation as a webpage, go to [https://opensearch-project.github.io/opensearch-sdk-java/](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](https://opensearch.org/blog/technical-post/2021/12/plugins-intro/) onto which plugins hook.

For more information about extensibility, see [this GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/1422).

## Design

For an overview of extension architecture and information about how extensions work, see [DESIGN](DESIGN.md).

## Creating an extension

For information about developing an extension, see [CREATE_YOUR_FIRST_EXTENSION](CREATE_YOUR_FIRST_EXTENSION.md).

## Developer Guide

For instructions on building, testing, and running an extension, see the [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md).

## Plugin migration

For tips on migrating an existing plugin to an extension, see [PLUGIN_MIGRATION](PLUGIN_MIGRATION.md).

## Contributing

For information about contributing, see [CONTRIBUTING](CONTRIBUTING.md).

## Maintainers

For points of contact, see [MAINTAINERS](MAINTAINERS.md).

## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments.