improve plugin file some more

This commit is contained in:
Robert Muir 2015-07-23 11:37:55 -04:00
parent 4b2bda4195
commit d1783ab11e
1 changed files with 46 additions and 15 deletions

View File

@ -1,8 +1,26 @@
# Elasticsearch plugin descriptor file # Elasticsearch plugin descriptor file
# This file must be at the root of the plugin. # This file must exist as 'plugin-descriptor.properties' at
# A plugin can be 'jvm', 'site', or both # the root directory of all plugins.
#
# A plugin can be 'site', 'jvm', or both.
#
### example site plugin for "foo":
#
# foo.zip <-- zip file for the plugin, with this structure:
# _site/ <-- the contents that will be served
# plugin-descriptor.properties <-- example contents below:
#
# site=true
# description=My cool plugin
# version=1.0
#
### example jvm plugin for "foo"
#
# foo.zip <-- zip file for the plugin, with this structure:
# <arbitrary name1>.jar <-- classes, resources, dependencies
# <arbitrary nameN>.jar <-- any number of jars
# plugin-descriptor.properties <-- example contents below:
# #
# example jvm plugin:
# jvm=true # jvm=true
# classname=foo.bar.BazPlugin # classname=foo.bar.BazPlugin
# description=My cool plugin # description=My cool plugin
@ -10,30 +28,43 @@
# elasticsearch.version=2.0 # elasticsearch.version=2.0
# java.version=1.7 # java.version=1.7
# #
# example site plugin: ### mandatory elements for all plugins:
# site=true
# description=My cool plugin
# version=1.0
# #
# 'description': simple summary of the plugin # 'description': simple summary of the plugin
description=${project.description} description=${project.description}
#
# 'version': plugin's version # 'version': plugin's version
version=${project.version} version=${project.version}
# #
### mandatory elements for site plugins:
#
# 'site': set to true to indicate contents of the _site/
# directory in the root of the plugin should be served.
site=${elasticsearch.plugin.site}
#
### mandatory elements for jvm plugins :
#
# 'jvm': true if the 'classname' class should be loaded # 'jvm': true if the 'classname' class should be loaded
# from jar files in the root directory of the plugin # from jar files in the root directory of the plugin.
# Note that only jar files in the root directory are
# added to the classpath for the plugin! If you need
# other resources, package them into a resources jar.
jvm=${elasticsearch.plugin.jvm} jvm=${elasticsearch.plugin.jvm}
# 'classname': the name of the class to load. #
# 'classname': the name of the class to load, fully-qualified.
classname=${elasticsearch.plugin.classname} classname=${elasticsearch.plugin.classname}
# 'isolated': true if the plugin should have its own classloader. #
# passing false is deprecated, and only intended to support plugins
# that have hard dependencies against each other
isolated=${elasticsearch.plugin.isolated}
# 'java.version' version of java the code is built against # 'java.version' version of java the code is built against
java.version=${maven.compiler.target} java.version=${maven.compiler.target}
#
# 'elasticsearch.version' version of elasticsearch compiled against # 'elasticsearch.version' version of elasticsearch compiled against
elasticsearch.version=${elasticsearch.version} elasticsearch.version=${elasticsearch.version}
# #
# 'site': true if the contents of _site should be served ### deprecated elements for jvm plugins :
site=${elasticsearch.plugin.site} #
# 'isolated': true if the plugin should have its own classloader.
# passing false is deprecated, and only intended to support plugins
# that have hard dependencies against each other. If this is
# not specified, then the plugin is isolated by default.
isolated=${elasticsearch.plugin.isolated}
# #