Added "release-state" support to plugin docs
This commit is contained in:
parent
710cd05253
commit
ba552a0736
|
@ -23,36 +23,8 @@ characters.
|
||||||
|
|
||||||
================================================
|
================================================
|
||||||
|
|
||||||
|
:plugin_name: analysis-icu
|
||||||
[[analysis-icu-install]]
|
include::install_remove.asciidoc[]
|
||||||
[float]
|
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install analysis-icu
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/analysis-icu/analysis-icu-{version}.zip.
|
|
||||||
|
|
||||||
[[analysis-icu-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove analysis-icu
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[analysis-icu-normalization-charfilter]]
|
[[analysis-icu-normalization-charfilter]]
|
||||||
==== ICU Normalization Character Filter
|
==== ICU Normalization Character Filter
|
||||||
|
|
|
@ -4,35 +4,8 @@
|
||||||
The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis
|
The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis
|
||||||
module into elasticsearch.
|
module into elasticsearch.
|
||||||
|
|
||||||
[[analysis-kuromoji-install]]
|
:plugin_name: analysis-kuromoji
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install analysis-kuromoji
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/analysis-kuromoji/analysis-kuromoji-{version}.zip.
|
|
||||||
|
|
||||||
[[analysis-kuromoji-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove analysis-kuromoji
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[analysis-kuromoji-analyzer]]
|
[[analysis-kuromoji-analyzer]]
|
||||||
==== `kuromoji` analyzer
|
==== `kuromoji` analyzer
|
||||||
|
|
|
@ -5,35 +5,9 @@ The Phonetic Analysis plugin provides token filters which convert tokens to
|
||||||
their phonetic representation using Soundex, Metaphone, and a variety of other
|
their phonetic representation using Soundex, Metaphone, and a variety of other
|
||||||
algorithms.
|
algorithms.
|
||||||
|
|
||||||
[[analysis-phonetic-install]]
|
:plugin_name: analysis-phonetic
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install analysis-phonetic
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/analysis-phonetic/analysis-phonetic-{version}.zip.
|
|
||||||
|
|
||||||
[[analysis-phonetic-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove analysis-phonetic
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[analysis-phonetic-token-filter]]
|
[[analysis-phonetic-token-filter]]
|
||||||
==== `phonetic` token filter
|
==== `phonetic` token filter
|
||||||
|
|
|
@ -9,36 +9,9 @@ analyzer uses probabilistic knowledge to find the optimal word segmentation
|
||||||
for Simplified Chinese text. The text is first broken into sentences, then
|
for Simplified Chinese text. The text is first broken into sentences, then
|
||||||
each sentence is segmented into words.
|
each sentence is segmented into words.
|
||||||
|
|
||||||
|
:plugin_name: analysis-smartcn
|
||||||
|
include::install_remove.asciidoc[]
|
||||||
|
|
||||||
[[analysis-smartcn-install]]
|
|
||||||
[float]
|
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install analysis-smartcn
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/analysis-smartcn/analysis-smartcn-{version}.zip.
|
|
||||||
|
|
||||||
[[analysis-smartcn-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove analysis-smartcn
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[analysis-smartcn-tokenizer]]
|
[[analysis-smartcn-tokenizer]]
|
||||||
[float]
|
[float]
|
||||||
|
|
|
@ -7,35 +7,8 @@ module for Polish into elasticsearch.
|
||||||
It provides high quality stemming for Polish, based on the
|
It provides high quality stemming for Polish, based on the
|
||||||
http://www.egothor.org/[Egothor project].
|
http://www.egothor.org/[Egothor project].
|
||||||
|
|
||||||
[[analysis-stempel-install]]
|
:plugin_name: analysis-stempel
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install analysis-stempel
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/analysis-stempel/analysis-stempel-{version}.zip.
|
|
||||||
|
|
||||||
[[analysis-stempel-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove analysis-stempel
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[analysis-stempel-tokenizer]]
|
[[analysis-stempel-tokenizer]]
|
||||||
[float]
|
[float]
|
||||||
|
|
|
@ -5,35 +5,8 @@ The Ukrainian Analysis plugin integrates Lucene's UkrainianMorfologikAnalyzer in
|
||||||
|
|
||||||
It provides stemming for Ukrainian using the http://github.com/morfologik/morfologik-stemming[Morfologik project].
|
It provides stemming for Ukrainian using the http://github.com/morfologik/morfologik-stemming[Morfologik project].
|
||||||
|
|
||||||
[[analysis-ukrainian-install]]
|
:plugin_name: analysis-ukrainian
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install analysis-ukrainian
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/analysis-ukrainian/analysis-ukrainian-{version}.zip.
|
|
||||||
|
|
||||||
[[analysis-ukrainian-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove analysis-ukrainian
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[analysis-ukrainian-analyzer]]
|
[[analysis-ukrainian-analyzer]]
|
||||||
[float]
|
[float]
|
||||||
|
|
|
@ -7,35 +7,9 @@ The Azure Classic Discovery plugin uses the Azure Classic API for unicast discov
|
||||||
// See issue https://github.com/elastic/elasticsearch/issues/19146
|
// See issue https://github.com/elastic/elasticsearch/issues/19146
|
||||||
deprecated[5.0.0, Use coming Azure ARM Discovery plugin instead]
|
deprecated[5.0.0, Use coming Azure ARM Discovery plugin instead]
|
||||||
|
|
||||||
[[discovery-azure-classic-install]]
|
:plugin_name: discovery-azure-classic
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install discovery-azure-classic
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/discovery-azure-classic/discovery-azure-classic-{version}.zip.
|
|
||||||
|
|
||||||
[[discovery-azure-classic-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove discovery-azure-classic
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[discovery-azure-classic-usage]]
|
[[discovery-azure-classic-usage]]
|
||||||
==== Azure Virtual Machine Discovery
|
==== Azure Virtual Machine Discovery
|
||||||
|
|
|
@ -5,35 +5,8 @@ The EC2 discovery plugin uses the https://github.com/aws/aws-sdk-java[AWS API] f
|
||||||
|
|
||||||
*If you are looking for a hosted solution of Elasticsearch on AWS, please visit http://www.elastic.co/cloud.*
|
*If you are looking for a hosted solution of Elasticsearch on AWS, please visit http://www.elastic.co/cloud.*
|
||||||
|
|
||||||
[[discovery-ec2-install]]
|
:plugin_name: discovery-ec2
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install discovery-ec2
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/discovery-ec2/discovery-ec2-{version}.zip.
|
|
||||||
|
|
||||||
[[discovery-ec2-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove discovery-ec2
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[discovery-ec2-usage]]
|
[[discovery-ec2-usage]]
|
||||||
==== Getting started with AWS
|
==== Getting started with AWS
|
||||||
|
|
|
@ -4,38 +4,8 @@
|
||||||
The file-based discovery plugin uses a list of hosts/ports in a `unicast_hosts.txt` file
|
The file-based discovery plugin uses a list of hosts/ports in a `unicast_hosts.txt` file
|
||||||
in the `config/discovery-file` directory for unicast discovery.
|
in the `config/discovery-file` directory for unicast discovery.
|
||||||
|
|
||||||
[[discovery-file-install]]
|
:plugin_name: discovery-file
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install discovery-file
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation. Note that installing the plugin will add a
|
|
||||||
`discovery-file` directory to the `config` folder, and a default `unicast_hosts.txt`
|
|
||||||
file that must be edited with the correct unicast hosts list before starting the node.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/discovery-file/discovery-file-{version}.zip.
|
|
||||||
|
|
||||||
|
|
||||||
[[discovery-file-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove discovery-file
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[discovery-file-usage]]
|
[[discovery-file-usage]]
|
||||||
[float]
|
[float]
|
||||||
|
|
|
@ -3,35 +3,8 @@
|
||||||
|
|
||||||
The Google Compute Engine Discovery plugin uses the GCE API for unicast discovery.
|
The Google Compute Engine Discovery plugin uses the GCE API for unicast discovery.
|
||||||
|
|
||||||
[[discovery-gce-install]]
|
:plugin_name: discovery-gce
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install discovery-gce
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/discovery-gce/discovery-gce-{version}.zip.
|
|
||||||
|
|
||||||
[[discovery-gce-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove discovery-gce
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[discovery-gce-usage]]
|
[[discovery-gce-usage]]
|
||||||
==== GCE Virtual Machine Discovery
|
==== GCE Virtual Machine Discovery
|
||||||
|
|
|
@ -11,35 +11,8 @@ the overhead of converting back and forth between base64, you can use the CBOR
|
||||||
format instead of JSON and specify the field as a bytes array instead of a string
|
format instead of JSON and specify the field as a bytes array instead of a string
|
||||||
representation. The processor will skip the base64 decoding then.
|
representation. The processor will skip the base64 decoding then.
|
||||||
|
|
||||||
[[ingest-attachment-install]]
|
:plugin_name: ingest-attachment
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install ingest-attachment
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/ingest-attachment/ingest-attachment-{version}.zip.
|
|
||||||
|
|
||||||
[[ingest-attachment-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove ingest-attachment
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[using-ingest-attachment]]
|
[[using-ingest-attachment]]
|
||||||
==== Using the Attachment Processor in a Pipeline
|
==== Using the Attachment Processor in a Pipeline
|
||||||
|
|
|
@ -12,35 +12,8 @@ The GeoIP processor can run with other geoip2 databases from Maxmind. The files
|
||||||
and the `database_file` option should be used to specify the filename of the custom database. Custom database files must be compressed
|
and the `database_file` option should be used to specify the filename of the custom database. Custom database files must be compressed
|
||||||
with gzip. The geoip config directory is located at `$ES_HOME/config/ingest/geoip` and holds the shipped databases too.
|
with gzip. The geoip config directory is located at `$ES_HOME/config/ingest/geoip` and holds the shipped databases too.
|
||||||
|
|
||||||
[[ingest-geoip-install]]
|
:plugin_name: ingest-geoip
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install ingest-geoip
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/ingest-geoip/ingest-geoip-{version}.zip.
|
|
||||||
|
|
||||||
[[ingest-geoip-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove ingest-geoip
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[using-ingest-geoip]]
|
[[using-ingest-geoip]]
|
||||||
==== Using the Geoip Processor in a Pipeline
|
==== Using the Geoip Processor in a Pipeline
|
||||||
|
|
|
@ -6,35 +6,8 @@ This processor adds this information by default under the `user_agent` field.
|
||||||
|
|
||||||
The ingest-user-agent plugin ships by default with the regexes.yaml made available by uap-java with an Apache 2.0 license. For more details see https://github.com/ua-parser/uap-core.
|
The ingest-user-agent plugin ships by default with the regexes.yaml made available by uap-java with an Apache 2.0 license. For more details see https://github.com/ua-parser/uap-core.
|
||||||
|
|
||||||
[[ingest-user-agent-install]]
|
:plugin_name: ingest-user-agent
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install ingest-user-agent
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/ingest-user-agent/ingest-user-agent-{version}.zip.
|
|
||||||
|
|
||||||
[[ingest-user-agent-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove ingest-user-agent
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[using-ingest-user-agent]]
|
[[using-ingest-user-agent]]
|
||||||
==== Using the user_agent Processor in a Pipeline
|
==== Using the user_agent Processor in a Pipeline
|
||||||
|
|
|
@ -0,0 +1,40 @@
|
||||||
|
[float]
|
||||||
|
[id="{plugin_name}-install"]
|
||||||
|
==== Installation
|
||||||
|
|
||||||
|
ifeval::["{release-state}"=="unreleased"]
|
||||||
|
|
||||||
|
Version {version} of the Elastic Stack has not yet been released.
|
||||||
|
|
||||||
|
endif::[]
|
||||||
|
|
||||||
|
ifeval::["{release-state}"!="unreleased"]
|
||||||
|
|
||||||
|
This plugin can be installed using the plugin manager:
|
||||||
|
|
||||||
|
["source","sh",subs="attributes,callouts"]
|
||||||
|
----------------------------------------------------------------
|
||||||
|
sudo bin/elasticsearch-plugin install {plugin_name}
|
||||||
|
----------------------------------------------------------------
|
||||||
|
|
||||||
|
The plugin must be installed on every node in the cluster, and each node must
|
||||||
|
be restarted after installation.
|
||||||
|
|
||||||
|
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
||||||
|
{plugin_url}/{plugin_name}/{plugin_name}-{version}.zip.
|
||||||
|
|
||||||
|
endif::[]
|
||||||
|
|
||||||
|
[float]
|
||||||
|
[id="{plugin_name}-remove"]
|
||||||
|
==== Removal
|
||||||
|
|
||||||
|
The plugin can be removed with the following command:
|
||||||
|
|
||||||
|
["source","sh",subs="attributes,callouts"]
|
||||||
|
----------------------------------------------------------------
|
||||||
|
sudo bin/elasticsearch-plugin remove {plugin_name}
|
||||||
|
----------------------------------------------------------------
|
||||||
|
|
||||||
|
The node must be stopped before removing the plugin.
|
||||||
|
|
|
@ -5,35 +5,8 @@ The mapper-murmur3 plugin provides the ability to compute hash of field values
|
||||||
at index-time and store them in the index. This can sometimes be helpful when
|
at index-time and store them in the index. This can sometimes be helpful when
|
||||||
running cardinality aggregations on high-cardinality and large string fields.
|
running cardinality aggregations on high-cardinality and large string fields.
|
||||||
|
|
||||||
[[mapper-murmur3-install]]
|
:plugin_name: mapper-murmur3
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install mapper-murmur3
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/mapper-murmur3/mapper-murmur3-{version}.zip.
|
|
||||||
|
|
||||||
[[mapper-murmur3-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove mapper-murmur3
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[mapper-murmur3-usage]]
|
[[mapper-murmur3-usage]]
|
||||||
==== Using the `murmur3` field
|
==== Using the `murmur3` field
|
||||||
|
|
|
@ -5,35 +5,8 @@ The mapper-size plugin provides the `_size` meta field which, when enabled,
|
||||||
indexes the size in bytes of the original
|
indexes the size in bytes of the original
|
||||||
{ref}/mapping-source-field.html[`_source`] field.
|
{ref}/mapping-source-field.html[`_source`] field.
|
||||||
|
|
||||||
[[mapper-size-install]]
|
:plugin_name: mapper-size
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install mapper-size
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/mapper-size/mapper-size-{version}.zip.
|
|
||||||
|
|
||||||
[[mapper-size-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove mapper-size
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[mapper-size-usage]]
|
[[mapper-size-usage]]
|
||||||
==== Using the `_size` field
|
==== Using the `_size` field
|
||||||
|
|
|
@ -4,35 +4,8 @@
|
||||||
The Azure Repository plugin adds support for using Azure as a repository for
|
The Azure Repository plugin adds support for using Azure as a repository for
|
||||||
{ref}/modules-snapshots.html[Snapshot/Restore].
|
{ref}/modules-snapshots.html[Snapshot/Restore].
|
||||||
|
|
||||||
[[repository-azure-install]]
|
:plugin_name: repository-azure
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install repository-azure
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/repository-azure/repository-azure-{version}.zip.
|
|
||||||
|
|
||||||
[[repository-azure-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove repository-azure
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[repository-azure-usage]]
|
[[repository-azure-usage]]
|
||||||
==== Azure Repository
|
==== Azure Repository
|
||||||
|
|
|
@ -4,37 +4,8 @@
|
||||||
The GCS repository plugin adds support for using the https://cloud.google.com/storage/[Google Cloud Storage]
|
The GCS repository plugin adds support for using the https://cloud.google.com/storage/[Google Cloud Storage]
|
||||||
service as a repository for {ref}/modules-snapshots.html[Snapshot/Restore].
|
service as a repository for {ref}/modules-snapshots.html[Snapshot/Restore].
|
||||||
|
|
||||||
[[repository-gcs-install]]
|
:plugin_name: repository-gcs
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install repository-gcs
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
NOTE: The plugin requires new permission to be installed in order to work
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/repository-gcs/repository-gcs-{version}.zip.
|
|
||||||
|
|
||||||
[[repository-gcs-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove repository-gcs
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[repository-gcs-usage]]
|
[[repository-gcs-usage]]
|
||||||
==== Getting started
|
==== Getting started
|
||||||
|
|
|
@ -4,35 +4,8 @@
|
||||||
The HDFS repository plugin adds support for using HDFS File System as a repository for
|
The HDFS repository plugin adds support for using HDFS File System as a repository for
|
||||||
{ref}/modules-snapshots.html[Snapshot/Restore].
|
{ref}/modules-snapshots.html[Snapshot/Restore].
|
||||||
|
|
||||||
[[repository-hdfs-install]]
|
:plugin_name: repository-hdfs
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed through the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install repository-hdfs
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on _every_ node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/repository-hdfs/repository-hdfs-{version}.zip.
|
|
||||||
|
|
||||||
[[repository-hdfs-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed by specifying the _installed_ package:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove repository-hdfs
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[repository-hdfs-usage]]
|
[[repository-hdfs-usage]]
|
||||||
==== Getting started with HDFS
|
==== Getting started with HDFS
|
||||||
|
|
|
@ -6,35 +6,8 @@ The S3 repository plugin adds support for using S3 as a repository for
|
||||||
|
|
||||||
*If you are looking for a hosted solution of Elasticsearch on AWS, please visit http://www.elastic.co/cloud.*
|
*If you are looking for a hosted solution of Elasticsearch on AWS, please visit http://www.elastic.co/cloud.*
|
||||||
|
|
||||||
[[repository-s3-install]]
|
:plugin_name: repository-s3
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install repository-s3
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/repository-s3/repository-s3-{version}.zip.
|
|
||||||
|
|
||||||
[[repository-s3-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove repository-s3
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[repository-s3-usage]]
|
[[repository-s3-usage]]
|
||||||
==== Getting started with AWS
|
==== Getting started with AWS
|
||||||
|
|
|
@ -3,35 +3,8 @@
|
||||||
|
|
||||||
The Store SMB plugin works around for a bug in Windows SMB and Java on windows.
|
The Store SMB plugin works around for a bug in Windows SMB and Java on windows.
|
||||||
|
|
||||||
[[store-smb-install]]
|
:plugin_name: store-smb
|
||||||
[float]
|
include::install_remove.asciidoc[]
|
||||||
==== Installation
|
|
||||||
|
|
||||||
This plugin can be installed using the plugin manager:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin install store-smb
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The plugin must be installed on every node in the cluster, and each node must
|
|
||||||
be restarted after installation.
|
|
||||||
|
|
||||||
This plugin can be downloaded for <<plugin-management-custom-url,offline install>> from
|
|
||||||
{plugin_url}/store-smb/store-smb-{version}.zip.
|
|
||||||
|
|
||||||
[[store-smb-remove]]
|
|
||||||
[float]
|
|
||||||
==== Removal
|
|
||||||
|
|
||||||
The plugin can be removed with the following command:
|
|
||||||
|
|
||||||
[source,sh]
|
|
||||||
----------------------------------------------------------------
|
|
||||||
sudo bin/elasticsearch-plugin remove store-smb
|
|
||||||
----------------------------------------------------------------
|
|
||||||
|
|
||||||
The node must be stopped before removing the plugin.
|
|
||||||
|
|
||||||
[[store-smb-usage]]
|
[[store-smb-usage]]
|
||||||
==== Working around a bug in Windows SMB and Java on windows
|
==== Working around a bug in Windows SMB and Java on windows
|
||||||
|
|
Loading…
Reference in New Issue