Browse Source

Installation and removal instructions for Ingest Plugins (#18769)

* Add install and remove instructions to ingest-geoip and ingest-attachment docs
Christoph Wurm 9 years ago
parent
commit
cd0473159a
2 changed files with 61 additions and 1 deletions
  1. 30 0
      docs/plugins/ingest-attachment.asciidoc
  2. 31 1
      docs/plugins/ingest-geoip.asciidoc

+ 30 - 0
docs/plugins/ingest-attachment.asciidoc

@@ -11,6 +11,36 @@ 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.
+
+[[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 the Attachment Processor in a Pipeline
+
 [[ingest-attachment-options]]
 .Attachment options
 [options="header"]

+ 31 - 1
docs/plugins/ingest-geoip.asciidoc

@@ -11,7 +11,37 @@ 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.
 
-[[geoip-options]]
+[[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.
+
+[[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 the Geoip Processor in a Pipeline
+
+[[ingest-geoip-options]]
 .Geoip options
 [options="header"]
 |======