| # Index backend for Gerrit, based on OpenSearch |
| |
| Indexing backend libModule for [Gerrit Code Review](https://gerritcodereview.com) |
| based on [OpenSearch](https://github.com/opensearch-project/opensearch). |
| |
| This module is based on a copy of the [index-elasticsearch module](https://gerrit.googlesource.com/modules/index-elasticsearch/+/refs/heads/master) |
| which was adapted to the OpenSearch APIs. OpenSearch was forked from ElasticSearch |
| when ElasticSearch 7.11 switched to Server Side Public License (SSPL) and the |
| Elastic License which aren't OSI approved Open Source licenses. Meanwhile the APIs |
| of ElasticSearch and OpenSearch diverged, hence the creation of this new module. |
| |
| ## How to build |
| |
| This libModule is built like a Gerrit in-tree plugin, using Bazelisk. See the |
| [build instructions](src/main/resources/Documentation/build.md) for more details. |
| |
| ## Setup |
| |
| See the [setup instructions](src/main/resources/Documentation/setup.md) for how to install the |
| index-opensearch module. |
| |
| For further information and supported options, refer to the [config](src/main/resources/Documentation/config.md) |
| documentation. |
| |
| ## Integration test |
| |
| This libModule runs tests like a Gerrit in-tree plugin, using Bazelisk. See the |
| [test instructions](src/main/resources/Documentation/build.md#Integration-test) for more details. |
