honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Remove the fact that ingest was a plugin from the docs.

This commit is contained in:
Martijn van Groningen 2016-01-26 14:52:40 +01:00
parent df0be87b18
commit b784b81665
2 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/plugins/ingest-geoip.asciidoc
View File

@ -4,7 +4,7 @@
The GeoIP processor adds information about the geographical location of IP addresses, based on data from the Maxmind databases. 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. This processor adds this information by default under the `geoip` field.
The ingest plugin ships by default with the GeoLite2 City and GeoLite2 Country geoip2 databases from Maxmind made available 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/ under the CCA-ShareAlike 3.0 license. For more details see, http://dev.maxmind.com/geoip/geoip2/geolite2/
The GeoIP processor can run with other geoip2 databases from Maxmind. The files must be copied into the geoip config directory The GeoIP processor can run with other geoip2 databases from Maxmind. The files must be copied into the geoip config directory
@ -18,7 +18,7 @@ is located at `$ES_HOME/config/ingest/geoip` and holds the shipped databases too
| Name | Required | Default | Description | Name | Required | Default | Description
| `source_field` | yes | - | The field to get the ip address or hostname from for the geographical lookup. | `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. | `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 plugin ships with the GeoLite2-City.mmdb and GeoLite2-Country.mmdb files. | `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`] <1> | Controls what properties are added to the `target_field` based on the geoip lookup.
|====== |======

23
docs/reference/ingest/ingest.asciidoc
View File

@ -1,23 +1,22 @@
[[ingest]] [[ingest]]
== Ingest Plugin == Ingest Node
The ingest plugin can be used to pre-process documents before the actual indexing takes place. Ingest node can be used to pre-process documents before the actual indexing takes place.
This pre-processing happens by the ingest plugin that intercepts bulk and index requests, applies the This pre-processing happens by an ingest node that intercepts bulk and index requests, applies the
transformations and then passes the documents back to the index or bulk APIs. transformations and then passes the documents back to the index or bulk APIs.
The ingest plugin is disabled by default. In order to enable the ingest plugin the following Ingest node is enabled by default. In order to disable ingest the following
setting should be configured in the elasticsearch.yml file: setting should be configured in the elasticsearch.yml file:
[source,yaml] [source,yaml]
-------------------------------------------------- --------------------------------------------------
node.ingest: true node.ingest: false
-------------------------------------------------- --------------------------------------------------
The ingest plugin can be installed and enabled on any node. It is possible to run ingest It is possible to enable ingest on any node or have dedicated ingest nodes.
on an master and or data node or have dedicated client nodes that run with ingest.
In order to pre-process document before indexing the `pipeline` parameter should be used In order to pre-process document before indexing the `pipeline` parameter should be used
on an index or bulk request to tell the ingest plugin what pipeline is going to be used. on an index or bulk request to tell Ingest what pipeline is going to be used.
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -606,9 +605,9 @@ The following example sets the id of a document to `1`:
The following metadata fields are accessible by a processor: `_index`, `_type`, `_id`, `_routing`, `_parent`, The following metadata fields are accessible by a processor: `_index`, `_type`, `_id`, `_routing`, `_parent`,
`_timestamp` and `_ttl`. `_timestamp` and `_ttl`.
Beyond metadata fields and source fields, the ingest plugin also adds ingest metadata to documents being processed. Beyond metadata fields and source fields, ingest also adds ingest metadata to documents being processed.
These metadata properties are accessible under the `_ingest` key. Currently the ingest plugin adds the ingest timestamp These metadata properties are accessible under the `_ingest` key. Currently ingest adds the ingest timestamp
under `_ingest.timestamp` key to the ingest metadata, which is the time the ingest plugin received the index or bulk under `_ingest.timestamp` key to the ingest metadata, which is the time ES received the index or bulk
request to pre-process. But any processor is free to add more ingest related metadata to it. Ingest metadata is transient request to pre-process. But any processor is free to add more ingest related metadata to it. Ingest metadata is transient
and is lost after a document has been processed by the pipeline and thus ingest metadata won't be indexed. and is lost after a document has been processed by the pipeline and thus ingest metadata won't be indexed.
@ -626,7 +625,7 @@ The following example adds a field with the name `received` and the value is the
As opposed to Elasticsearch metadata fields, the ingest metadata field name _ingest can be used as a valid field name As opposed to Elasticsearch metadata fields, the ingest metadata field name _ingest can be used as a valid field name
in the source of a document. Use _source._ingest to refer to it, otherwise _ingest will be interpreted as ingest in the source of a document. Use _source._ingest to refer to it, otherwise _ingest will be interpreted as ingest
metadata fields by the ingest plugin. metadata fields.
A number of processor settings also support templating. Settings that support templating can have zero or more A number of processor settings also support templating. Settings that support templating can have zero or more
template snippets. A template snippet begins with `{{` and ends with `}}`. template snippets. A template snippet begins with `{{` and ends with `}}`.