OpenSearch/docs/reference/modules
David Pilato bd871f96c2 Check that a plugin is Lucene compatible with the current running node using `lucene` property in `es-plugin.properties` file.
* If plugin does not provide `lucene` property, we consider that the plugin is compatible.
* If plugin provides `lucene` property, we try to load related Enum org.apache.lucene.util.Version. If this fails, it means that the node is too "old" comparing to the Lucene version the plugin was built for.
* We compare then two first digits of current node lucene version against two first digits of plugin Lucene version. If not equal, it means that the plugin is too "old" for the current node.

Plugin developers who wants to launch plugin check only have to add a `lucene` property in `es-plugin.properties` file. If you are using maven to build your plugin, you can do it like this:

In `pom.xml`:

```xml
    <properties>
        <lucene.version>4.6.0</lucene.version>
    </properties>

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>
```

In `es-plugin.properties`, add:

```properties
lucene=${lucene.version}
```

BTW, if you don't already have it, you can add the plugin version as well:

```properties
version=${project.version}
```

You can disable that check using `plugins.check_lucene: false`.
2014-05-16 13:41:20 +02:00
..
discovery Update Documentation Feature Flags [1.1.0] 2014-03-25 17:51:30 +01:00
gateway Remove deprecated gateways 2014-03-26 18:10:51 -04:00
advanced-scripting.asciidoc Update advanced-scripting.asciidoc 2014-04-07 07:20:13 -06:00
cluster.asciidoc [DOCS] Multiple doc fixes 2014-03-07 14:24:58 +01:00
discovery.asciidoc [DOCS] add azure and gce discovery plugins 2014-02-06 09:18:42 +01:00
gateway.asciidoc Remove deprecated gateways 2014-03-26 18:10:51 -04:00
http.asciidoc Document http.cors-settings 2014-03-31 11:34:46 +02:00
indices.asciidoc #6081: set IO throttling back to 20 MB/sec now that #6018 is fixed 2014-05-12 14:42:26 -04:00
memcached.asciidoc [DOCS] Multiple doc fixes 2014-03-07 14:24:58 +01:00
network.asciidoc Add more anchor links to documentation 2013-09-30 13:13:16 -06:00
node.asciidoc Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00
plugins.asciidoc Check that a plugin is Lucene compatible with the current running node using `lucene` property in `es-plugin.properties` file. 2014-05-16 13:41:20 +02:00
scripting.asciidoc Correcting gramma 2014-05-06 18:00:19 +02:00
snapshots.asciidoc [DOCS] Changed coming[1.1.0] to added in snapshot status 2014-05-13 11:19:28 +02:00
threadpool.asciidoc Set queue sizes by default on bulk/index thread pools 2013-10-12 21:51:37 +02:00
thrift.asciidoc Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00
transport.asciidoc [DOCS] Multiple doc fixes 2014-03-07 14:24:58 +01:00
tribe.asciidoc Tribe: Index level blocks, index conflict settings 2014-03-27 09:45:20 -07:00