blob: 41d427974e0dc369f13cf84a8ae13212e24ba693 [file] [log] [blame] [view]
# Index backend for Gerrit, based on ElasticSearch
Indexing backend libModule for [Gerrit Code Review](https://gerritcodereview.com)
based on [ElasticSearch](https://www.elastic.co/elasticsearch/).
This module was originally part of Gerrit core and then extracted into a separate
component from v3.5.0-rc3 as part of [Change-Id: Ib7b5167ce](https://gerrit-review.googlesource.com/c/gerrit/+/323676).
Note that, ElasticSearch source code is no longer Apache 2.0-licensed for versions
7.11 and newer. See ElasticSearch [2021 license change](https://www.elastic.co/pricing/faq/licensing)
for more information.
## 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-elasticsearch 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.