Rename examples in ILM guide to avoid association with data streams (#54579)

This commit is contained in:
Dan Hermann 2020-04-01 09:05:20 -05:00 committed by GitHub
parent 27f88fcdac
commit 11bfbd8bbf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -35,7 +35,7 @@ and the actions to perform in each phase. A lifecycle can have up to four phases
`hot`, `warm`, `cold`, and `delete`. Policies are defined in JSON
and added through the {ilm-init} put policy API.
For example, the following request creates a `datastream_policy` with two phases:
For example, the following request creates a `timeseries_policy` with two phases:
* The `hot` phase defines a `rollover` action to specify that an index rolls over when it
reaches either a `max_size` of 50 gigabytes or a `max_age` of 30 days.
@ -44,7 +44,7 @@ Note that this value is relative to the rollover time, not the index creation ti
[source,console]
------------------------
PUT _ilm/policy/datastream_policy
PUT _ilm/policy/timeseries_policy
{
"policy": {
"phases": {
@ -80,8 +80,8 @@ See <<_actions>> for the complete list of actions available in each phase.
To automaticaly apply a lifecycle policy to the new write index on rollover,
specify the policy in the index template used to create new indices.
For example, the following request creates a `datastream_template` that is applied to new indices
whose names match the `datastream-*` index pattern.
For example, the following request creates a `timeseries_template` that is applied to new indices
whose names match the `timeseries-*` index pattern.
The template configures two {ilm-init} settings:
* `index.lifecycle.name` specifies the name of the lifecycle policy to apply to all new indices that match
@ -91,20 +91,20 @@ when the rollover action is triggered for an index.
[source,console]
-----------------------
PUT _template/datastream_template
PUT _template/timeseries_template
{
"index_patterns": ["datastream-*"], <1>
"index_patterns": ["timeseries-*"], <1>
"settings": {
"number_of_shards": 1,
"number_of_replicas": 1,
"index.lifecycle.name": "datastream_policy", <2>
"index.lifecycle.rollover_alias": "datastream" <3>
"index.lifecycle.name": "timeseries_policy", <2>
"index.lifecycle.rollover_alias": "timeseries" <3>
}
}
-----------------------
// TEST[continued]
<1> Apply the template to a new index if its name starts with `datastream-`.
<1> Apply the template to a new index if its name starts with `timeseries-`.
<2> The name of the lifecycle policy to apply to each new index.
<3> The name of the alias used to reference these indices.
Required for policies that use the rollover action.
@ -113,7 +113,7 @@ Required for policies that use the rollover action.
[source,console]
--------------------------------------------------
DELETE /_template/datastream_template
DELETE /_template/timeseries_template
--------------------------------------------------
// TEST[continued]
@ -128,15 +128,15 @@ designate it as the write index for the rollover alias specified in your index t
The name of this index must match the template's index pattern and end with a number.
On rollover, this value is incremented to generate a name for the new index.
For example, the following request creates an index called `datastream-000001`
and makes it the write index for the `datastream` alias.
For example, the following request creates an index called `timeseries-000001`
and makes it the write index for the `timeseries` alias.
[source,console]
-----------------------
PUT datastream-000001
PUT timeseries-000001
{
"aliases": {
"datastream": {
"timeseries": {
"is_write_index": true
}
}
@ -146,12 +146,12 @@ PUT datastream-000001
When the rollover conditions are met, the `rollover` action:
* Creates a new index called `datastream-000002`.
This matches the `datastream-*` pattern, so the settings from `datastream_template` are applied to the new index.
* Creates a new index called `timeseries-000002`.
This matches the `timeseries-*` pattern, so the settings from `timeseries_template` are applied to the new index.
* Designates the new index as the write index and makes the bootstrap index read-only.
This process repeats each time rollover conditions are met.
You can search across all of the indices managed by the `datastream_policy` with the `datastream` alias.
You can search across all of the indices managed by the `timeseries_policy` with the `timeseries` alias.
Write operations are routed to the current write index.
For more information about write indices and rollover, see the <<rollover-index-api-desc, rollover API>>.
@ -167,11 +167,11 @@ This lets you find out things like:
* The current action and what step is being performed.
* If any errors have occurred or progress is blocked.
For example, the following request gets information about the `datastream` indices:
For example, the following request gets information about the `timeseries` indices:
[source,console]
--------------------------------------------------
GET datastream-*/_ilm/explain
GET timeseries-*/_ilm/explain
--------------------------------------------------
// TEST[continued]
@ -183,10 +183,10 @@ until the rollover conditions are met.
--------------------------------------------------
{
"indices": {
"datastream-000001": {
"index": "datastream-000001",
"timeseries-000001": {
"index": "timeseries-000001",
"managed": true,
"policy": "datastream_policy", <1>
"policy": "timeseries_policy", <1>
"lifecycle_date_millis": 1538475653281,
"age": "30s", <2>
"phase": "hot",
@ -196,7 +196,7 @@ until the rollover conditions are met.
"step": "attempt-rollover", <3>
"step_time_millis": 1538475653317,
"phase_execution": {
"policy": "datastream_policy",
"policy": "timeseries_policy",
"phase_definition": { <4>
"min_age": "0ms",
"actions": {