mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
f93a94009f
* [DOCS] Documentation for the stable plugin API * Removed references to rivers * Add link to Cloud docs for managing plugins * Add caveat about needing to update plugins * Remove reference to site plugins * Wording and clarifications * Fix test * Add link to text analysis docs * Text analysis API dependencies * Remove reference to REST endpoints and fix list * Move plugin descriptor file to its own page * Typos * Review feedback * Delete unused properties file * Changed into * Changed 'elasticsearchVersion' into 'pluginApiVersion' * Swap 'The analysis plugin API' and 'Plugin file structure' sections * Update docs/plugins/authors.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/creating-non-text-analysis-plugins.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/creating-non-text-analysis-plugins.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/creating-text-analysis-plugins.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/creating-text-analysis-plugins.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/creating-non-text-analysis-plugins.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/creating-text-analysis-plugins.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/creating-text-analysis-plugins.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/example-text-analysis-plugin.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/plugin-descriptor-file.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/plugin-script.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/creating-non-text-analysis-plugins.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Update docs/plugins/development/creating-non-text-analysis-plugins.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> * Rewording * Add modulename and extended.plugins descriptions for descriptor file * Add link to existing plugins in Github * Review feedback * Use 'stable' and 'classic' plugin naming * Fix capitalization * Review feedback --------- Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> Co-authored-by: William Brafford <william.brafford@elastic.co>
54 lines
1.9 KiB
Text
54 lines
1.9 KiB
Text
= Elasticsearch Plugins and Integrations
|
|
|
|
include::../Versions.asciidoc[]
|
|
|
|
[[intro]]
|
|
== Introduction to plugins
|
|
|
|
Plugins are a way to enhance the core Elasticsearch functionality in a custom
|
|
manner. They range from adding custom mapping types, custom analyzers, native
|
|
scripts, custom discovery and more.
|
|
|
|
Plugins contain JAR files, but may also contain scripts and config files, and
|
|
must be installed on every node in the cluster. After installation, each
|
|
node must be restarted before the plugin becomes visible.
|
|
|
|
NOTE: A full cluster restart is required for installing plugins that have
|
|
custom cluster state metadata. It is still possible to upgrade
|
|
such plugins with a rolling restart.
|
|
|
|
This documentation distinguishes two categories of plugins:
|
|
|
|
Core Plugins:: This category identifies plugins that are part of Elasticsearch
|
|
project. Delivered at the same time as Elasticsearch, their version number always
|
|
matches the version number of Elasticsearch itself. These plugins are maintained
|
|
by the Elastic team with the appreciated help of amazing community members (for
|
|
open source plugins). Issues and bug reports can be reported on the
|
|
https://github.com/elastic/elasticsearch[Github project page].
|
|
|
|
Community contributed:: This category identifies plugins that are external to
|
|
the Elasticsearch project. They are provided by individual developers or private
|
|
companies and have their own licenses as well as their own versioning system.
|
|
Issues and bug reports can usually be reported on the community plugin's web site.
|
|
|
|
For advice on writing your own plugin, refer to <<plugin-authors>>.
|
|
|
|
include::plugin-script.asciidoc[]
|
|
|
|
include::api.asciidoc[]
|
|
|
|
include::analysis.asciidoc[]
|
|
|
|
include::discovery.asciidoc[]
|
|
|
|
include::mapper.asciidoc[]
|
|
|
|
include::repository.asciidoc[]
|
|
|
|
include::store.asciidoc[]
|
|
|
|
include::integrations.asciidoc[]
|
|
|
|
include::authors.asciidoc[]
|
|
|
|
include::redirects.asciidoc[]
|