diff --git a/docs/plugins/analysis-icu.asciidoc b/docs/plugins/analysis-icu.asciidoc index 7fd8ae7c728..fd322c112e6 100644 --- a/docs/plugins/analysis-icu.asciidoc +++ b/docs/plugins/analysis-icu.asciidoc @@ -23,36 +23,8 @@ characters. ================================================ - -[[analysis-icu-install]] -[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 <> 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. +:plugin_name: analysis-icu +include::install_remove.asciidoc[] [[analysis-icu-normalization-charfilter]] ==== ICU Normalization Character Filter diff --git a/docs/plugins/analysis-kuromoji.asciidoc b/docs/plugins/analysis-kuromoji.asciidoc index 69907b9812d..7a702295dd9 100644 --- a/docs/plugins/analysis-kuromoji.asciidoc +++ b/docs/plugins/analysis-kuromoji.asciidoc @@ -4,35 +4,8 @@ The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch. -[[analysis-kuromoji-install]] -[float] -==== 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 <> 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. +:plugin_name: analysis-kuromoji +include::install_remove.asciidoc[] [[analysis-kuromoji-analyzer]] ==== `kuromoji` analyzer diff --git a/docs/plugins/analysis-phonetic.asciidoc b/docs/plugins/analysis-phonetic.asciidoc index fb0f6832d4b..34f4a933f9f 100644 --- a/docs/plugins/analysis-phonetic.asciidoc +++ b/docs/plugins/analysis-phonetic.asciidoc @@ -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 algorithms. -[[analysis-phonetic-install]] -[float] -==== Installation +:plugin_name: analysis-phonetic +include::install_remove.asciidoc[] -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 <> 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]] ==== `phonetic` token filter diff --git a/docs/plugins/analysis-smartcn.asciidoc b/docs/plugins/analysis-smartcn.asciidoc index 22953c590a4..4c019ebf273 100644 --- a/docs/plugins/analysis-smartcn.asciidoc +++ b/docs/plugins/analysis-smartcn.asciidoc @@ -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 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 <> 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]] [float] diff --git a/docs/plugins/analysis-stempel.asciidoc b/docs/plugins/analysis-stempel.asciidoc index ae72c80c92e..a5526129a97 100644 --- a/docs/plugins/analysis-stempel.asciidoc +++ b/docs/plugins/analysis-stempel.asciidoc @@ -7,35 +7,8 @@ module for Polish into elasticsearch. It provides high quality stemming for Polish, based on the http://www.egothor.org/[Egothor project]. -[[analysis-stempel-install]] -[float] -==== 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 <> 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. +:plugin_name: analysis-stempel +include::install_remove.asciidoc[] [[analysis-stempel-tokenizer]] [float] diff --git a/docs/plugins/analysis-ukrainian.asciidoc b/docs/plugins/analysis-ukrainian.asciidoc index 78f8232f1c1..a86c1d18eea 100644 --- a/docs/plugins/analysis-ukrainian.asciidoc +++ b/docs/plugins/analysis-ukrainian.asciidoc @@ -3,37 +3,10 @@ The Ukrainian Analysis plugin integrates Lucene's UkrainianMorfologikAnalyzer into elasticsearch. -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]] -[float] -==== 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 <> 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. +:plugin_name: analysis-ukrainian +include::install_remove.asciidoc[] [[analysis-ukrainian-analyzer]] [float] diff --git a/docs/plugins/discovery-azure-classic.asciidoc b/docs/plugins/discovery-azure-classic.asciidoc index 0362f2a6fe3..784bbd69ee9 100644 --- a/docs/plugins/discovery-azure-classic.asciidoc +++ b/docs/plugins/discovery-azure-classic.asciidoc @@ -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 deprecated[5.0.0, Use coming Azure ARM Discovery plugin instead] -[[discovery-azure-classic-install]] -[float] -==== Installation +:plugin_name: discovery-azure-classic +include::install_remove.asciidoc[] -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 <> 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]] ==== Azure Virtual Machine Discovery diff --git a/docs/plugins/discovery-ec2.asciidoc b/docs/plugins/discovery-ec2.asciidoc index 12b59a5bd89..c60d90b42ce 100644 --- a/docs/plugins/discovery-ec2.asciidoc +++ b/docs/plugins/discovery-ec2.asciidoc @@ -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.* -[[discovery-ec2-install]] -[float] -==== 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 <> 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. +:plugin_name: discovery-ec2 +include::install_remove.asciidoc[] [[discovery-ec2-usage]] ==== Getting started with AWS diff --git a/docs/plugins/discovery-file.asciidoc b/docs/plugins/discovery-file.asciidoc index ec501a08a8a..ad06cfc0cc5 100644 --- a/docs/plugins/discovery-file.asciidoc +++ b/docs/plugins/discovery-file.asciidoc @@ -4,38 +4,8 @@ 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. -[[discovery-file-install]] -[float] -==== 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 <> 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. +:plugin_name: discovery-file +include::install_remove.asciidoc[] [[discovery-file-usage]] [float] diff --git a/docs/plugins/discovery-gce.asciidoc b/docs/plugins/discovery-gce.asciidoc index 1f19a379dc3..16c84f9033d 100644 --- a/docs/plugins/discovery-gce.asciidoc +++ b/docs/plugins/discovery-gce.asciidoc @@ -3,35 +3,8 @@ The Google Compute Engine Discovery plugin uses the GCE API for unicast discovery. -[[discovery-gce-install]] -[float] -==== 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 <> 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. +:plugin_name: discovery-gce +include::install_remove.asciidoc[] [[discovery-gce-usage]] ==== GCE Virtual Machine Discovery diff --git a/docs/plugins/ingest-attachment.asciidoc b/docs/plugins/ingest-attachment.asciidoc index cb3296132d9..443d1fb578a 100644 --- a/docs/plugins/ingest-attachment.asciidoc +++ b/docs/plugins/ingest-attachment.asciidoc @@ -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 representation. The processor will skip the base64 decoding then. -[[ingest-attachment-install]] -[float] -==== 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 <> 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. +:plugin_name: ingest-attachment +include::install_remove.asciidoc[] [[using-ingest-attachment]] ==== Using the Attachment Processor in a Pipeline @@ -125,7 +98,7 @@ PUT _ingest/pipeline/attachment NOTE: Extracting contents from binary data is a resource intensive operation and consumes a lot of resources. It is highly recommended to run pipelines using this processor in a dedicated ingest node. - + [[ingest-attachment-with-arrays]] ==== Using the Attachment Processor with arrays diff --git a/docs/plugins/ingest-geoip.asciidoc b/docs/plugins/ingest-geoip.asciidoc index 3665026c01a..51274b109ad 100644 --- a/docs/plugins/ingest-geoip.asciidoc +++ b/docs/plugins/ingest-geoip.asciidoc @@ -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 with gzip. The geoip config directory is located at `$ES_HOME/config/ingest/geoip` and holds the shipped databases too. -[[ingest-geoip-install]] -[float] -==== 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 <> 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. +:plugin_name: ingest-geoip +include::install_remove.asciidoc[] [[using-ingest-geoip]] ==== Using the Geoip Processor in a Pipeline diff --git a/docs/plugins/ingest-user-agent.asciidoc b/docs/plugins/ingest-user-agent.asciidoc index a99e0b3a83a..fadb0ad1138 100644 --- a/docs/plugins/ingest-user-agent.asciidoc +++ b/docs/plugins/ingest-user-agent.asciidoc @@ -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. -[[ingest-user-agent-install]] -[float] -==== 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 <> 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. +:plugin_name: ingest-user-agent +include::install_remove.asciidoc[] [[using-ingest-user-agent]] ==== Using the user_agent Processor in a Pipeline diff --git a/docs/plugins/install_remove.asciidoc b/docs/plugins/install_remove.asciidoc new file mode 100644 index 00000000000..f41bea39bbc --- /dev/null +++ b/docs/plugins/install_remove.asciidoc @@ -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 <> 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. + diff --git a/docs/plugins/mapper-murmur3.asciidoc b/docs/plugins/mapper-murmur3.asciidoc index 63623f109e0..a714347ced7 100644 --- a/docs/plugins/mapper-murmur3.asciidoc +++ b/docs/plugins/mapper-murmur3.asciidoc @@ -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 running cardinality aggregations on high-cardinality and large string fields. -[[mapper-murmur3-install]] -[float] -==== 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 <> 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. +:plugin_name: mapper-murmur3 +include::install_remove.asciidoc[] [[mapper-murmur3-usage]] ==== Using the `murmur3` field diff --git a/docs/plugins/mapper-size.asciidoc b/docs/plugins/mapper-size.asciidoc index 8374c09733a..27353414f06 100644 --- a/docs/plugins/mapper-size.asciidoc +++ b/docs/plugins/mapper-size.asciidoc @@ -5,35 +5,8 @@ The mapper-size plugin provides the `_size` meta field which, when enabled, indexes the size in bytes of the original {ref}/mapping-source-field.html[`_source`] field. -[[mapper-size-install]] -[float] -==== 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 <> 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. +:plugin_name: mapper-size +include::install_remove.asciidoc[] [[mapper-size-usage]] ==== Using the `_size` field diff --git a/docs/plugins/repository-azure.asciidoc b/docs/plugins/repository-azure.asciidoc index ab2f9dd05e9..7418d539a7c 100644 --- a/docs/plugins/repository-azure.asciidoc +++ b/docs/plugins/repository-azure.asciidoc @@ -4,35 +4,8 @@ The Azure Repository plugin adds support for using Azure as a repository for {ref}/modules-snapshots.html[Snapshot/Restore]. -[[repository-azure-install]] -[float] -==== 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 <> 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. +:plugin_name: repository-azure +include::install_remove.asciidoc[] [[repository-azure-usage]] ==== Azure Repository diff --git a/docs/plugins/repository-gcs.asciidoc b/docs/plugins/repository-gcs.asciidoc index 7b222c9a3f7..29661621486 100644 --- a/docs/plugins/repository-gcs.asciidoc +++ b/docs/plugins/repository-gcs.asciidoc @@ -4,37 +4,8 @@ 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]. -[[repository-gcs-install]] -[float] -==== 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 <> 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. +:plugin_name: repository-gcs +include::install_remove.asciidoc[] [[repository-gcs-usage]] ==== Getting started diff --git a/docs/plugins/repository-hdfs.asciidoc b/docs/plugins/repository-hdfs.asciidoc index bf773bef091..64b87801acb 100644 --- a/docs/plugins/repository-hdfs.asciidoc +++ b/docs/plugins/repository-hdfs.asciidoc @@ -4,35 +4,8 @@ The HDFS repository plugin adds support for using HDFS File System as a repository for {ref}/modules-snapshots.html[Snapshot/Restore]. -[[repository-hdfs-install]] -[float] -==== 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 <> 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. +:plugin_name: repository-hdfs +include::install_remove.asciidoc[] [[repository-hdfs-usage]] ==== Getting started with HDFS diff --git a/docs/plugins/repository-s3.asciidoc b/docs/plugins/repository-s3.asciidoc index d770853e777..58ca5dab2d7 100644 --- a/docs/plugins/repository-s3.asciidoc +++ b/docs/plugins/repository-s3.asciidoc @@ -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.* -[[repository-s3-install]] -[float] -==== 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 <> 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. +:plugin_name: repository-s3 +include::install_remove.asciidoc[] [[repository-s3-usage]] ==== Getting started with AWS diff --git a/docs/plugins/store-smb.asciidoc b/docs/plugins/store-smb.asciidoc index 80d4547584d..4f713568655 100644 --- a/docs/plugins/store-smb.asciidoc +++ b/docs/plugins/store-smb.asciidoc @@ -3,35 +3,8 @@ The Store SMB plugin works around for a bug in Windows SMB and Java on windows. -[[store-smb-install]] -[float] -==== 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 <> 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. +:plugin_name: store-smb +include::install_remove.asciidoc[] [[store-smb-usage]] ==== Working around a bug in Windows SMB and Java on windows