Skip to content

[7.x] [DOCS] Simplify index template snippets for data streams (#59533) #59553

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

Merged
jrodewig merged 3 commits into from
Jul 14, 2020
Merged

[7.x] [DOCS] Simplify index template snippets for data streams (#59533) #59553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d17559b
[DOCS] Simplify index template snippets for data streams (#59533)
jrodewig Jul 14, 2020
ab252ec
Merge remote-tracking branch 'upstream/7.x' into backport__59533-7x
jrodewig Jul 14, 2020
051709b
Merge remote-tracking branch 'upstream/7.x' into backport__59533-7x
jrodewig Jul 14, 2020
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
52 changes: 7 additions & 45 deletions docs/reference/data-streams/change-mappings-and-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,31 +52,13 @@ PUT /_ilm/policy/logs_policy
PUT /_index_template/logs_data_stream
{
"index_patterns": [ "logs*" ],
"data_stream": {},
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
}
}
"data_stream": { }
}

PUT /_index_template/new_logs_data_stream
{
"index_patterns": [ "new_logs*" ],
"data_stream": {},
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
}
}
"data_stream": { }
}

PUT /_data_stream/logs
Expand Down Expand Up @@ -120,13 +102,10 @@ for a new field, `message`, to the template.
PUT /_index_template/logs_data_stream
{
"index_patterns": [ "logs*" ],
"data_stream": {},
"data_stream": { },
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
},
"message": { <1>
"type": "text"
}
Expand Down Expand Up @@ -187,13 +166,10 @@ mapping parameter to `true`.
PUT /_index_template/logs_data_stream
{
"index_patterns": [ "logs*" ],
"data_stream": {},
"data_stream": { },
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
},
"host": {
"properties": {
"ip": {
Expand Down Expand Up @@ -271,15 +247,8 @@ template's `index.refresh_interval` index setting to `30s` (30 seconds).
PUT /_index_template/logs_data_stream
{
"index_patterns": [ "logs*" ],
"data_stream": {},
"data_stream": { },
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
},
"settings": {
"index.refresh_interval": "30s" <1>
}
Expand Down Expand Up @@ -335,15 +304,8 @@ The following <<indices-templates,put index template API>> requests adds new
PUT /_index_template/logs_data_stream
{
"index_patterns": [ "logs*" ],
"data_stream": {},
"data_stream": { },
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
},
"settings": {
"sort.field": [ "@timestamp"], <1>
"sort.order": [ "desc"] <2>
Expand Down Expand Up @@ -448,7 +410,7 @@ uses the `logs_data_stream` template as its basis, with the following changes:
PUT /_index_template/new_logs_data_stream
{
"index_patterns": [ "new_logs*" ],
"data_stream": {},
"data_stream": { },
"template": {
"mappings": {
"properties": {
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/data-streams/set-up-a-data-stream.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ configures the `logs_data_stream` template.
PUT /_index_template/logs_data_stream
{
"index_patterns": [ "logs*" ],
"data_stream": {},
"data_stream": { },
"template": {
"settings": {
"index.lifecycle.name": "logs_policy"
Expand Down
11 changes: 1 addition & 10 deletions docs/reference/data-streams/use-a-data-stream.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,7 @@ the following:
PUT /_index_template/logs_data_stream
{
"index_patterns": [ "logs*" ],
"data_stream": {},
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
}
}
"data_stream": { }
}

PUT /_data_stream/logs
Expand Down
11 changes: 1 addition & 10 deletions docs/reference/ilm/ilm-tutorial.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,19 +121,12 @@ with the options you specify.
PUT _index_template/timeseries_template
{
"index_patterns": ["timeseries"], <1>
"data_stream": {},
"data_stream": { },
"template": {
"settings": {
"number_of_shards": 1,
"number_of_replicas": 1,
"index.lifecycle.name": "timeseries_policy" <2>
},
"mappings": {
"properties": {
"@timestamp": {
"type": "date" <3>
}
}
}
}
}
Expand All @@ -142,8 +135,6 @@ PUT _index_template/timeseries_template

<1> Apply the template when a document is indexed into the `timeseries` target.
<2> The name of the {ilm-init} policy used to manage the data stream.
<3> A <<date,`date`>> or <<date_nanos,`date_nanos`>> field mapping for the
"@timestamp" field the data stream will use.
====

[discrete]
Expand Down
11 changes: 1 addition & 10 deletions docs/reference/indices/create-data-stream.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,7 @@ See <<set-up-a-data-stream>>.
PUT /_index_template/template
{
"index_patterns": ["my-data-stream*"],
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
}
},
"data_stream": {}
"data_stream": { }
}
----
////
Expand Down
11 changes: 1 addition & 10 deletions docs/reference/indices/delete-data-stream.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,7 @@ indices. See <<delete-a-data-stream>>.
PUT /_index_template/template
{
"index_patterns": ["my-data-stream*"],
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
}
},
"data_stream": {}
"data_stream": { }
}

PUT /_data_stream/my-data-stream
Expand Down
7 changes: 0 additions & 7 deletions docs/reference/indices/get-data-stream.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,6 @@ PUT /_index_template/my-index-template
"index_patterns": [ "my-data-stream*" ],
"data_stream": {},
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
},
"settings": {
"index.lifecycle.name": "my-lifecycle-policy"
}
Expand Down
11 changes: 1 addition & 10 deletions docs/reference/indices/resolve.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,7 @@ PUT /my-index/_alias/f-alias
PUT /_index_template/foo_data_stream
{
"index_patterns": [ "foo" ],
"data_stream": {},
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
}
}
"data_stream": { }
}

PUT /_data_stream/foo
Expand Down
11 changes: 1 addition & 10 deletions docs/reference/indices/rollover-index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,16 +232,7 @@ The API returns the following response:
PUT _index_template/template
{
"index_patterns": ["my-data-stream*"],
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
}
},
"data_stream": {}
"data_stream": { }
}
-----------------------------------
// TEST
Expand Down
11 changes: 1 addition & 10 deletions x-pack/docs/en/security/authorization/alias-privileges.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,7 @@ backing indices, the user can retrieve a document directly from `.ds-logs-000002
PUT /_index_template/logs_data_stream
{
"index_patterns": [ "logs*" ],
"data_stream": {},
"template": {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
}
}
}
}
"data_stream": { }
}

PUT /_data_stream/logs
Expand Down