github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-28 17:34:17 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Documentation update for creating plugins (#93413)

Browse source 
* [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>
This commit is contained in:
Abdon Pijpelink 2023-02-13 14:15:12 +01:00 • committed by GitHub
parent c46d7e7b01
commit f93a94009f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
29 changed files with 585 additions and 169 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/plugins/plugin-script.asciidoc
View file

@ -1,5 +1,14 @@
[[plugin-management]]
== Plugin Management
== Plugin management
[discrete]
=== Managing plugins on {ess}
Refer to the {cloud}/ec-adding-plugins.html[{ess} documentation] for information
about managing plugins on {ecloud}.
[discrete]
=== Managing plugins for self-managed deployments
Use the `elasticsearch-plugin` command line tool to install, list, and remove plugins. It is
located in the `$ES_HOME/bin` directory by default but it may be in a
@ -34,7 +43,7 @@ If you run {es} using Docker, you can manage plugins using a
<<manage-plugins-using-configuration-file,configuration file>>.
[[installation]]
=== Installing Plugins
=== Installing plugins
The documentation for each plugin usually includes specific installation
instructions for that plugin, but below we document the various available
@ -139,7 +148,7 @@ that all the plugins will be installed, or none of the plugins will be installed
if any installation fails.
[[mandatory-plugins]]
=== Mandatory Plugins
=== Mandatory plugins
If you rely on some plugins, you can define mandatory plugins by adding
`plugin.mandatory` setting to the `config/elasticsearch.yml` file, for
@ -153,7 +162,7 @@ plugin.mandatory: analysis-icu,lang-js
For safety reasons, a node will not start if it is missing a mandatory plugin.
[[listing-removing-updating]]
=== Listing, Removing and Updating Installed Plugins
=== Listing, removing and updating installed plugins
[discrete]
=== Listing plugins
@ -202,8 +211,9 @@ sudo bin/elasticsearch-plugin remove [pluginname] [pluginname] ... [pluginname]
[discrete]
=== Updating plugins
Plugins are built for a specific version of Elasticsearch, and therefore must be reinstalled
each time Elasticsearch is updated.
Except for text analysis plugins that are created using the
<<creating-stable-plugins,stable plugin API>>, plugins are built for a specific
version of {es}, and must be reinstalled each time {es} is updated.
[source,shell]
-----------------------------------
@ -216,7 +226,7 @@ sudo bin/elasticsearch-plugin install [pluginname]
The `plugin` scripts supports a number of other command line parameters:
[discrete]
=== Silent/Verbose mode
=== Silent/verbose mode
The `--verbose` parameter outputs more debug information, while the `--silent`
parameter turns off all output including the progress bar. The script may