Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Remove references to elasticsearch directory in plugins #28647

Merged
merged 2 commits into from
Feb 13, 2018
Merged

Docs: Remove references to elasticsearch directory in plugins #28647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cb7136
Docs: Remove references to elasticsearch directory in plugins
rjernst Feb 13, 2018
65d9679
more elasticsearch dir refs
rjernst Feb 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions buildSrc/src/main/resources/meta-plugin-descriptor.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# Elasticsearch meta plugin descriptor file
# This file must exist as 'meta-plugin-descriptor.properties' in a folder named `elasticsearch`.
# This file must exist as 'meta-plugin-descriptor.properties' inside a plugin.
#
### example meta plugin for "meta-foo"
#
# meta-foo.zip <-- zip file for the meta plugin, with this structure:
#|____elasticsearch/
#| |____ <bundled_plugin_1> <-- The plugin files for bundled_plugin_1 (the content of the elastisearch directory)
#| |____ <bundled_plugin_2> <-- The plugin files for bundled_plugin_2
#| |____ meta-plugin-descriptor.properties <-- example contents below:
# |____ <bundled_plugin_1> <-- The plugin files for bundled_plugin_1
# |____ <bundled_plugin_2> <-- The plugin files for bundled_plugin_2
# |____ meta-plugin-descriptor.properties <-- example contents below:
#
# description=My meta plugin
# name=meta-foo
Expand Down
10 changes: 4 additions & 6 deletions buildSrc/src/main/resources/plugin-descriptor.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# Elasticsearch plugin descriptor file
# This file must exist as 'plugin-descriptor.properties' in a folder named `elasticsearch`
# inside all plugins.
# This file must exist as 'plugin-descriptor.properties' inside a plugin.
#
### example plugin for "foo"
#
# foo.zip <-- zip file for the plugin, with this structure:
#|____elasticsearch/
#| |____ <arbitrary name1>.jar <-- classes, resources, dependencies
#| |____ <arbitrary nameN>.jar <-- any number of jars
#| |____ plugin-descriptor.properties <-- example contents below:
# |____ <arbitrary name1>.jar <-- classes, resources, dependencies
# |____ <arbitrary nameN>.jar <-- any number of jars
# |____ plugin-descriptor.properties <-- example contents below:
#
# classname=foo.bar.BazPlugin
# description=My cool plugin
Expand Down
9 changes: 2 additions & 7 deletions docs/plugins/authors.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,10 @@ These examples provide the bare bones needed to get started. For more
information about how to write a plugin, we recommend looking at the plugins
listed in this documentation for inspiration.

[float]
=== Plugin Structure

All plugin files must be contained in a directory called `elasticsearch`.

[float]
=== Plugin descriptor file

All plugins must contain a file called `plugin-descriptor.properties` in the folder named `elasticsearch`.
All plugins must contain a file called `plugin-descriptor.properties`.
The format for this file is described in detail in this example:

["source","properties",subs="attributes"]
Expand Down Expand Up @@ -63,7 +58,7 @@ of nonnegative decimal integers separated by "."'s and may have leading zeros.

|=======================================================================

Note that only jar files in the 'elasticsearch' directory are added to the classpath for the plugin!
Note that only jar files at the root of the plugin are added to the classpath for the plugin!
If you need other resources, package them into a resources jar.

[IMPORTANT]
Expand Down