From 461f329cd8d3af52d837d5aba70f5c76d5ebe031 Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Thu, 11 Feb 2016 17:40:32 -0800 Subject: [PATCH] Add ingest plugins to Elasticsearch plugin docs --- docs/plugins/index.asciidoc | 2 ++ docs/plugins/ingest-attachment.asciidoc | 2 +- docs/plugins/ingest-geoip.asciidoc | 7 ++++--- docs/plugins/ingest.asciidoc | 26 +++++++++++++++++++++++++ 4 files changed, 33 insertions(+), 4 deletions(-) create mode 100644 docs/plugins/ingest.asciidoc diff --git a/docs/plugins/index.asciidoc b/docs/plugins/index.asciidoc index bbc906572c0..598e7872dcd 100644 --- a/docs/plugins/index.asciidoc +++ b/docs/plugins/index.asciidoc @@ -47,6 +47,8 @@ include::analysis.asciidoc[] include::discovery.asciidoc[] +include::ingest.asciidoc[] + include::management.asciidoc[] include::mapper.asciidoc[] diff --git a/docs/plugins/ingest-attachment.asciidoc b/docs/plugins/ingest-attachment.asciidoc index 7401bd6caf0..97c4f3d254f 100644 --- a/docs/plugins/ingest-attachment.asciidoc +++ b/docs/plugins/ingest-attachment.asciidoc @@ -1,5 +1,5 @@ [[ingest-attachment]] -== Ingest Attachment Processor Plugin +=== Ingest Attachment Processor Plugin The ingest attachment plugin lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, PDF) using the Apache text extraction library http://lucene.apache.org/tika/[Tika]. diff --git a/docs/plugins/ingest-geoip.asciidoc b/docs/plugins/ingest-geoip.asciidoc index 2c0663b5958..0602263c215 100644 --- a/docs/plugins/ingest-geoip.asciidoc +++ b/docs/plugins/ingest-geoip.asciidoc @@ -1,5 +1,5 @@ [[ingest-geoip]] -== Ingest Geoip Processor Plugin +=== Ingest Geoip Processor Plugin The GeoIP processor adds information about the geographical location of IP addresses, based on data from the Maxmind databases. This processor adds this information by default under the `geoip` field. @@ -19,10 +19,11 @@ is located at `$ES_HOME/config/ingest/geoip` and holds the shipped databases too | `source_field` | yes | - | The field to get the ip address or hostname from for the geographical lookup. | `target_field` | no | geoip | The field that will hold the geographical information looked up from the Maxmind database. | `database_file` | no | GeoLite2-City.mmdb | The database filename in the geoip config directory. The ingest-geoip plugin ships with the GeoLite2-City.mmdb and GeoLite2-Country.mmdb files. -| `fields` | no | [`continent_name`, `country_iso_code`, `region_name`, `city_name`, `location`] <1> | Controls what properties are added to the `target_field` based on the geoip lookup. +| `fields` | no | [`continent_name`, `country_iso_code`, `region_name`, `city_name`, `location`] * | Controls what properties are added to the `target_field` based on the geoip lookup. |====== -<1> Depends on what is available in `database_field`: +*Depends on what is available in `database_field`: + * If the GeoLite2 City database is used then the following fields may be added under the `target_field`: `ip`, `country_iso_code`, `country_name`, `continent_name`, `region_name`, `city_name`, `timezone`, `latitude`, `longitude` and `location`. The fields actually added depend on what has been found and which fields were configured in `fields`. diff --git a/docs/plugins/ingest.asciidoc b/docs/plugins/ingest.asciidoc new file mode 100644 index 00000000000..ab746980f84 --- /dev/null +++ b/docs/plugins/ingest.asciidoc @@ -0,0 +1,26 @@ +[[ingest]] +== Ingest Plugins + +The ingest plugins extend Elaticsearch by providing additional ingest node capabilities. + +[float] +=== Core Ingest Plugins + +The core ingest plugins are: + +<>:: + +The ingest attachment plugin lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by +using the Apache text extraction library http://lucene.apache.org/tika/[Tika]. + +<>:: + +The GeoIP processor adds information about the geographical location of IP addresses, based on data from the Maxmind databases. +This processor adds this information by default under the `geoip` field. ++ +The ingest-geoip plugin ships by default with the GeoLite2 City and GeoLite2 Country geoip2 databases from Maxmind made available +under the CCA-ShareAlike 3.0 license. For more details see, http://dev.maxmind.com/geoip/geoip2/geolite2/. + +include::ingest-attachment.asciidoc[] + +include::ingest-geoip.asciidoc[] \ No newline at end of file