Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ingest: document index.default_pipeline #34500

Merged
merged 7 commits into from
Oct 23, 2018
Merged

ingest: document index.default_pipeline #34500

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1e6e908
ingest: document index.default_pipeline
jakelandis Oct 15, 2018
66f033c
add mention of default pipeline
jakelandis Oct 18, 2018
db78d6f
update text to include pipeline=_none
jakelandis Oct 19, 2018
871c515
Merge branch 'master' into default_pipeline_doc
jakelandis Oct 19, 2018
9540e77
Merge branch 'master' into default_pipeline_doc
jakelandis Oct 22, 2018
da81500
update override text per review comment
jakelandis Oct 23, 2018
2c14a49
Merge branch 'master' into default_pipeline_doc
jakelandis Oct 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/reference/index-modules.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,12 @@ specific index module:
The length of time that a <<delete-versioning,deleted document's version number>> remains available for <<index-versioning,further versioned operations>>.
Defaults to `60s`.

`index.default_pipeline`::

The default <<ingest,ingest node>> pipeline for this index. Index requests will fail
if the default pipeline is set and the pipeline does not exist. The default may be
ignored per request by setting the request parameter `pipeline=_none`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggestion something like this in place of the last sentence:

The default may be overridden using the `pipeline` parameter. The special pipeline name `_none` indicates no ingest pipeline should be run.

The point is to show that pipeline can be specified in general to override the default, and that _none is just a special pipeline name.


[float]
=== Settings in other index modules

Expand Down
3 changes: 3 additions & 0 deletions docs/reference/ingest.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ PUT my-index/_doc/my-id?pipeline=my_pipeline_id
// CONSOLE
// TEST[catch:bad_request]

An index may also declare a <<dynamic-index-settings,default pipeline>> that will be used in the
absence of the `pipeline` parameter.

See <<ingest-apis,Ingest APIs>> for more information about creating, adding, and deleting pipelines.

--
Expand Down