[DOCS] Edit ILM GS tutorial #51513

debadair · 2020-01-28T03:42:21Z

No description provided.

elasticmachine · 2020-01-28T03:42:23Z

Pinging @elastic/es-core-features (:Core/Features/ILM+SLM)

elasticmachine · 2020-01-28T03:42:25Z

Pinging @elastic/es-docs (>docs)

andreidan

Thanks for working on this @debadair

I think this will be a great improvement and it'll help make the "join the ilm train" experience smoother.

I've left a few suggestions below.

docs/reference/ilm/getting-started-ilm.asciidoc

andreidan · 2020-01-28T10:20:00Z

docs/reference/ilm/getting-started-ilm.asciidoc

+. <<ilm-gs-check-progress, Verify that indexes are moving through the lifecycle phases>> as expected with the 
+you use the {ilm-init} explain API. 


"with the explain API"

docs/reference/ilm/getting-started-ilm.asciidoc

andreidan · 2020-01-28T10:26:39Z

docs/reference/ilm/getting-started-ilm.asciidoc

+<1> The `min_age` field defaults to `0ms` in the hot phase, so new indices immediately enter the hot phase. 
+<2> The `rollover` action is triggered when any of the conditions are met.
+<3> An index is moved into the delete phase after 90 days.
+<4> No additional conditions are specified, so the `delete` action is triggered when the index enters the delete phase. 


the delete action doesn't support any conditionals/parameters so I think we shouldn't mention conditionals here but rather "The delete action is triggered ..."

docs/reference/ilm/getting-started-ilm.asciidoc

debadair · 2020-01-30T23:30:17Z

@elasticmachine update branch

elasticmachine · 2020-01-30T23:30:19Z

merge conflict between base and head

andreidan

Thanks for iterating on this @debadair. This is great! There's one typo in the index name , but other than that LGTM

andreidan · 2020-01-31T10:57:03Z

docs/reference/ilm/getting-started-ilm.asciidoc


+For example, the following request creates an index called `datastream_000001` 


datastream_000001 -> datastream-000001

docs/reference/ilm/getting-started-ilm.asciidoc

jrodewig · 2020-02-03T14:18:24Z

docs/reference/ilm/getting-started-ilm.asciidoc

+
+When you continuously index timestamped documents into {es} using 
+Filebeat, Logstash, or some other mechanism, 
+you typically use an index alias so you can periodically roll over to a new index.


Link for index alias?

docs/reference/ilm/getting-started-ilm.asciidoc

jrodewig · 2020-02-03T14:35:42Z

docs/reference/ilm/getting-started-ilm.asciidoc


-To begin, we will want to bootstrap our first index to write to.
+To get things started, you need to bootstrap an initial index and 


Suggested change

To get things started, you need to bootstrap an initial index and

To get things started, you need to create an initial index and

jrodewig · 2020-02-03T14:36:15Z

docs/reference/ilm/getting-started-ilm.asciidoc

+
+* Creates a new index called `datastream-000002`. 
+This matches the `datastream-*` pattern, so the settings from `datastream_template` are applied to the new index.
+* Designates the new index as the write index and makes the bootstrap index read-only.


Suggested change

* Designates the new index as the write index and makes the bootstrap index read-only.

* Designates the new index as the write index and makes `datastream-000001` read-only.

docs/reference/ilm/getting-started-ilm.asciidoc

jrodewig · 2020-02-03T14:37:12Z

docs/reference/ilm/getting-started-ilm.asciidoc


 [source,console]
 --------------------------------------------------
 GET datastream-*/_ilm/explain
 --------------------------------------------------
 // TEST[continued]

-The above request will retrieve {ilm-init} execution information for all our
-managed indices.
+The response below shows that the bootstrap index is waiting in the `hot` phase's `rollover` action.


Suggested change

The response below shows that the bootstrap index is waiting in the `hot` phase's `rollover` action.

The response below shows that the `datastream-000001` index is waiting in the `hot` phase's `rollover` action.

jrodewig · 2020-02-03T14:37:46Z

docs/reference/ilm/getting-started-ilm.asciidoc

-after 90 days.
+. <<ilm-gs-create-policy, Create a lifecycle policy>> with the {ilm-init} Put policy API.  
+. <<ilm-gs-apply-policy, Create an index template>> to apply the policy to each new index.
+. <<ilm-gs-bootstrap, Bootstrap an index>> as the initial write index.


Suggested change

. <<ilm-gs-bootstrap, Bootstrap an index>> as the initial write index.

. <<ilm-gs-bootstrap, Create an initial write index>>.

jrodewig · 2020-02-03T14:38:06Z

docs/reference/ilm/getting-started-ilm.asciidoc

-The intention here is that the rollover alias is also defined on the index.
+[float]
+[[ilm-gs-bootstrap]]
+=== Bootstrap the initial time-series index


Suggested change

=== Bootstrap the initial time-series index

=== Create an initial time-series index

docs/reference/ilm/getting-started-ilm.asciidoc

jrodewig

Left some minor editorial questions/suggestions. Otherwise LGTM.

Co-Authored-By: James Rodewig <[email protected]>

debadair · 2020-02-04T23:22:12Z

Thanks for the review @andreidan & @jrodewig!

I stuck with the bootstrap terminology, at least for now. (Though since the term now is mostly associated with the framework, it is potentially problematic.)

@andreidan

* [DOCS] Edit ILM GS tutorial * [DOCS] Incorporated review feedback from @andreidan. * [DOCS] Removed test link & fixed anchor & title. * Update docs/reference/ilm/getting-started-ilm.asciidoc Co-Authored-By: James Rodewig <[email protected]>

@jrodewig

* [DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg * [DOCS] Split off ILM overview to a separate topic. (#51287) * [DOCS} Split off overview to a separate topic. * [DOCS] Incorporated feedback from @jrodewig. * [DOCS] Edit ILM GS tutorial (#51513) * [DOCS] Edit ILM GS tutorial * [DOCS] Incorporated review feedback from @andreidan. * [DOCS] Removed test link & fixed anchor & title. * Update docs/reference/ilm/getting-started-ilm.asciidoc Co-Authored-By: James Rodewig <[email protected]> * Fixed glossary merge error. Co-authored-by: James Rodewig <[email protected]>

@jrodewig

* [DOCS] Align with ILM API docs (elastic#48705) * [DOCS] Reconciled with Snapshot/Restore reorg * [DOCS] Split off ILM overview to a separate topic. (elastic#51287) * [DOCS} Split off overview to a separate topic. * [DOCS] Incorporated feedback from @jrodewig. * [DOCS] Edit ILM GS tutorial (elastic#51513) * [DOCS] Edit ILM GS tutorial * [DOCS] Incorporated review feedback from @andreidan. * [DOCS] Removed test link & fixed anchor & title. * Update docs/reference/ilm/getting-started-ilm.asciidoc Co-Authored-By: James Rodewig <[email protected]> * Fixed glossary merge error. Co-authored-by: James Rodewig <[email protected]>

@jrodewig

* [DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg * [DOCS] Split off ILM overview to a separate topic. (#51287) * [DOCS} Split off overview to a separate topic. * [DOCS] Incorporated feedback from @jrodewig. * [DOCS] Edit ILM GS tutorial (#51513) * [DOCS] Edit ILM GS tutorial * [DOCS] Incorporated review feedback from @andreidan. * [DOCS] Removed test link & fixed anchor & title. * Update docs/reference/ilm/getting-started-ilm.asciidoc Co-Authored-By: James Rodewig <[email protected]> * Fixed glossary merge error. Co-authored-by: James Rodewig <[email protected]> Co-authored-by: James Rodewig <[email protected]>

[DOCS] Edit ILM GS tutorial

f18427b

debadair added >docs General docs changes WIP :Data Management/ILM+SLM Index and Snapshot lifecycle management v8.0.0 v7.6.0 v7.5.3 labels Jan 28, 2020

andreidan requested changes Jan 28, 2020

View reviewed changes

debadair added 3 commits January 29, 2020 21:29

More edits

b812d90

[DOCS] Incorporated review feedback from @andreidan.

0245b34

[DOCS] Removed test link & fixed anchor & title.

78b73af

debadair added 3 commits January 30, 2020 15:43

Edits

0abe008

Merge branch 'master' into ilm-gs-edit

61ae641

Reverted explicit actions anchor.

99f219e

debadair removed the WIP label Jan 31, 2020

debadair requested a review from jrodewig January 31, 2020 00:46

andreidan approved these changes Jan 31, 2020

View reviewed changes

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig reviewed Feb 3, 2020

View reviewed changes

docs/reference/ilm/getting-started-ilm.asciidoc Outdated Show resolved Hide resolved

jrodewig approved these changes Feb 3, 2020

View reviewed changes

debadair and others added 9 commits February 4, 2020 13:07

Update docs/reference/ilm/getting-started-ilm.asciidoc

0cc6a8c

Co-Authored-By: James Rodewig <[email protected]>

Update docs/reference/ilm/getting-started-ilm.asciidoc

6db949a

Co-Authored-By: James Rodewig <[email protected]>

Incorporated feedback from @jrodewig

52374ce

Update docs/reference/ilm/getting-started-ilm.asciidoc

cdb2829

Co-Authored-By: James Rodewig <[email protected]>

Update docs/reference/ilm/getting-started-ilm.asciidoc

6f8e53b

Co-Authored-By: James Rodewig <[email protected]>

Update docs/reference/ilm/getting-started-ilm.asciidoc

643b606

Co-Authored-By: James Rodewig <[email protected]>

Update docs/reference/ilm/getting-started-ilm.asciidoc

d89292f

Co-Authored-By: James Rodewig <[email protected]>

Update docs/reference/ilm/getting-started-ilm.asciidoc

8996f29

Co-Authored-By: James Rodewig <[email protected]>

Update docs/reference/ilm/getting-started-ilm.asciidoc

2d2dd82

Co-Authored-By: James Rodewig <[email protected]>

debadair merged commit 8c5cdff into elastic:master Feb 4, 2020

debadair mentioned this pull request Feb 5, 2020

Backporting updates to ILM org, overview, & GS (#51898) #51902

Merged

debadair mentioned this pull request Mar 20, 2020

[DOCS] Restructure and edit the ILM and SLM documentation #53894

Closed

11 tasks

jakelandis added v8.0.0-alpha1 and removed v8.0.0 labels Jul 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS] Edit ILM GS tutorial #51513

[DOCS] Edit ILM GS tutorial #51513

debadair commented Jan 28, 2020

elasticmachine commented Jan 28, 2020

elasticmachine commented Jan 28, 2020

andreidan left a comment

andreidan Jan 28, 2020

andreidan Jan 28, 2020

debadair Jan 30, 2020

debadair commented Jan 30, 2020

elasticmachine commented Jan 30, 2020

andreidan left a comment

andreidan Jan 31, 2020

jrodewig Feb 3, 2020

jrodewig Feb 3, 2020

jrodewig Feb 3, 2020

jrodewig Feb 3, 2020

jrodewig Feb 3, 2020

jrodewig Feb 3, 2020

jrodewig left a comment

debadair commented Feb 4, 2020

		. <<ilm-gs-check-progress, Verify that indexes are moving through the lifecycle phases>> as expected with the
		you use the {ilm-init} explain API.


		For example, the following request creates an index called `datastream_000001`


		To begin, we will want to bootstrap our first index to write to.
		To get things started, you need to bootstrap an initial index and

	To get things started, you need to bootstrap an initial index and
	To get things started, you need to create an initial index and

	* Designates the new index as the write index and makes the bootstrap index read-only.
	* Designates the new index as the write index and makes `datastream-000001` read-only.

	The response below shows that the bootstrap index is waiting in the `hot` phase's `rollover` action.
	The response below shows that the `datastream-000001` index is waiting in the `hot` phase's `rollover` action.

	. <<ilm-gs-bootstrap, Bootstrap an index>> as the initial write index.
	. <<ilm-gs-bootstrap, Create an initial write index>>.

	=== Bootstrap the initial time-series index
	=== Create an initial time-series index

[DOCS] Edit ILM GS tutorial #51513

[DOCS] Edit ILM GS tutorial #51513

Conversation

debadair commented Jan 28, 2020

elasticmachine commented Jan 28, 2020

elasticmachine commented Jan 28, 2020

andreidan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

debadair commented Jan 30, 2020

elasticmachine commented Jan 30, 2020

andreidan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrodewig left a comment

Choose a reason for hiding this comment

debadair commented Feb 4, 2020