Skip to content

Commit a9834cd

Browse files
authored
[DOCS] Remove redundant ILM attributes (#36808)
1 parent ac032a0 commit a9834cd

File tree

9 files changed

+43
-46
lines changed

9 files changed

+43
-46
lines changed

docs/reference/ilm/apis/explain.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ entered this phase
170170
<3> The date the loaded policy was last modified
171171
<4> The epoch time when the loaded policy was last modified
172172

173-
If {ILM} is waiting for a step to complete, the response includes status
173+
If {ilm-init} is waiting for a step to complete, the response includes status
174174
information for the step that's being performed on the index.
175175

176176
[source,js]

docs/reference/ilm/apis/get-status.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
[role="xpack"]
22
[testenv="basic"]
33
[[ilm-get-status]]
4-
=== Get {ILM} status API
4+
=== Get {ilm} status API
55
++++
6-
<titleabbrev>Get {ILM} status</titleabbrev>
6+
<titleabbrev>Get {ilm} status</titleabbrev>
77
++++
88

99
beta[]
1010

11-
Retrieves the current {ilm} status.
11+
Retrieves the current {ilm} ({ilm-init}) status.
1212

1313
==== Request
1414

1515
`GET /_ilm/status`
1616

1717
==== Description
1818

19-
Returns the status of the {ILM} plugin. The `operation_mode` field in the
19+
Returns the status of the {ilm-init} plugin. The `operation_mode` field in the
2020
response shows one of three states: `STARTED`, `STOPPING`,
21-
or `STOPPED`. You can change the status of the {ILM} plugin with the
21+
or `STOPPED`. You can change the status of the {ilm-init} plugin with the
2222
<<ilm-start, Start ILM>> and <<ilm-stop, Stop ILM>> APIs.
2323

2424
==== Request Parameters
@@ -32,7 +32,7 @@ For more information, see {stack-ov}/security-privileges.html[Security Privilege
3232

3333
==== Examples
3434

35-
The following example gets the {ILM} plugin status.
35+
The following example gets the {ilm-init} plugin status.
3636

3737
[source,js]
3838
--------------------------------------------------

docs/reference/ilm/apis/put-lifecycle.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
3535

3636
You must have the `manage_ilm` cluster privilege to use this API. You must
3737
also have the `manage` index privilege on all indices being managed by `policy`.
38-
All operations executed by {Ilm} for a policy are executed as the user that
38+
All operations executed by {ilm} for a policy are executed as the user that
3939
put the latest version of a policy.
4040
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
4141

docs/reference/ilm/apis/start.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
[role="xpack"]
22
[testenv="basic"]
33
[[ilm-start]]
4-
=== Start {ILM} API
4+
=== Start {ilm} API
55
++++
6-
<titleabbrev>Start {ILM}</titleabbrev>
6+
<titleabbrev>Start {ilm}</titleabbrev>
77
++++
88

99
beta[]
1010

11-
Start the {ILM} plugin.
11+
Start the {ilm} ({ilm-init}) plugin.
1212

1313
==== Request
1414

1515
`POST /_ilm/start`
1616

1717
==== Description
1818

19-
Starts the {ILM} plugin if it is currently stopped. {ILM} is started
20-
automatically when the cluster is formed. Restarting {ILM} is only
21-
necessary if it has been stopped using the <<ilm-stop, Stop {ILM} API>>.
19+
Starts the {ilm-init} plugin if it is currently stopped. {ilm-init} is started
20+
automatically when the cluster is formed. Restarting {ilm-init} is only
21+
necessary if it has been stopped using the <<ilm-stop, Stop {ilm-init} API>>.
2222

2323
==== Request Parameters
2424

@@ -27,7 +27,7 @@ include::{docdir}/rest-api/timeoutparms.asciidoc[]
2727
==== Authorization
2828

2929
You must have the `manage_ilm` cluster privilege to use this API.
30-
For more information, see {stack-ov}/security-privileges.html[Security Privileges].
30+
For more information, see {stack-ov}/security-privileges.html[Security privileges].
3131

3232
==== Examples
3333

docs/reference/ilm/apis/stop.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
[role="xpack"]
22
[testenv="basic"]
33
[[ilm-stop]]
4-
=== Stop {ILM} API
4+
=== Stop {ilm} API
55
++++
6-
<titleabbrev>Stop {ILM}</titleabbrev>
6+
<titleabbrev>Stop {ilm}</titleabbrev>
77
++++
88

99
beta[]
1010

11-
Stop the {ILM} plugin.
11+
Stop the {ilm} ({ilm-init}) plugin.
1212

1313
==== Request
1414

1515
`POST /_ilm/stop`
1616

1717
==== Description
1818

19-
Halts all lifecycle management operations and stops the {ILM} plugin. This is
20-
useful when you are performing maintenance on the cluster and need to prevent
21-
{ILM} from performing any actions on your indices.
19+
Halts all lifecycle management operations and stops the {ilm-init} plugin. This
20+
is useful when you are performing maintenance on the cluster and need to prevent
21+
{ilm-init} from performing any actions on your indices.
2222

2323
The API returns as soon as the stop request has been acknowledged, but the
2424
plugin might continue to run until in-progress operations complete and the plugin
2525
can be safely stopped. Use the <<ilm-get-status, Get ILM Status>> API to see
26-
if {ILM} is running.
26+
if {ilm-init} is running.
2727

2828
==== Request Parameters
2929

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
beta[]
77

8-
Let's jump into {ILM} by working through a hands-on scenario.
9-
This section will leverage many new concepts unique to {ILM} that
8+
Let's jump into {ilm} ({ilm-init}) by working through a hands-on scenario.
9+
This section will leverage many new concepts unique to {ilm-init} that
1010
you may not be familiar with. The following sections will explore
1111
these in more details.
1212

@@ -21,7 +21,7 @@ after 90 days.
2121

2222
beta[]
2323

24-
There are many new features introduced by {ILM}, but we will only focus on
24+
There are many new features introduced by {ilm-init}, but we will only focus on
2525
a few that are needed for our example. For starters, we will use the
2626
<<ilm-put-lifecycle,Put Policy>> API to define our first policy. Lifecycle
2727
policies are defined in JSON and include specific
@@ -99,7 +99,7 @@ PUT _template/datastream_template
9999
<3> alias to use for the rollover action, required since a rollover action is
100100
defined in the policy.
101101

102-
The above index template introduces a few new settings specific to {ILM}.
102+
The above index template introduces a few new settings specific to {ilm-init}.
103103
The first being `index.lifecycle.name`. This setting will configure
104104
the "datastream_policy" to the index applying this template. This means
105105
that all newly created indices prefixed "datastream-" will be managed by
@@ -148,7 +148,7 @@ beta[]
148148
Now that we have an index managed by our policy, how do we tell what is going
149149
on? Which phase are we in? Is something broken? This section will go over a
150150
few APIs and their responses to help us inspect our indices with respect
151-
to {ILM}.
151+
to {ilm-init}.
152152

153153
With the help of the <<ilm-explain-lifecycle,Explain API>>, we can know
154154
things like which phase we're in and when we entered that phase. The API
@@ -162,7 +162,7 @@ GET datastream-*/_ilm/explain
162162
// CONSOLE
163163
// TEST[continued]
164164

165-
The above request will retrieve {ILM} execution information for all our
165+
The above request will retrieve {ilm-init} execution information for all our
166166
managed indices.
167167

168168

@@ -214,7 +214,7 @@ You can read about the full details of this response in the
214214
<<ilm-explain-lifecycle, explain API docs>>. For now, let's focus on how
215215
the response details which phase, action, and step we're in. We are in the
216216
"hot" phase, and "rollover" action. Rollover will continue to be called
217-
by {ILM} until its conditions are met and it rolls over the index.
217+
by {ilm-init} until its conditions are met and it rolls over the index.
218218
Afterwards, the original index will stay in the hot phase until 90 more
219219
days pass and it is deleted in the delete phase.
220220
As time goes on, new indices will be created and deleted.
@@ -226,7 +226,7 @@ that same alias.
226226

227227

228228

229-
That's it! We have our first use-case managed by {ILM}.
229+
That's it! We have our first use-case managed by {ilm-init}.
230230

231231
To learn more about all our APIs,
232232
check out <<index-lifecycle-management-api,ILM APIs>>.

docs/reference/ilm/index.asciidoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,14 @@
33
[[index-lifecycle-management]]
44
= Managing the index lifecycle
55

6-
:ilm: index lifecycle management
7-
:Ilm: Index lifecycle management
8-
:ILM: ILM
96
[partintro]
107
--
118
beta[]
129

13-
The <<index-lifecycle-management-api, {ilm} (ILM) APIs>> enable you to automate how you
14-
want to manage your indices over time. Rather than simply performing management
15-
actions on your indices on a set schedule, you can base actions on other factors
16-
such as shard size and performance requirements.
10+
The <<index-lifecycle-management-api,{ilm} ({ilm-init}) APIs>> enable you to
11+
automate how you want to manage your indices over time. Rather than simply
12+
performing management actions on your indices on a set schedule, you can base
13+
actions on other factors such as shard size and performance requirements.
1714

1815
You control how indices are handled as they age by attaching a
1916
lifecycle policy to the index template used to create them. You can update

docs/reference/ilm/policy-definitions.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,17 @@ index is rolled over, then `min_age` is the time elapsed from the time the index
7171
is rolled over. The intention here is to execute following phases and actions
7272
relative to when data was written last to a rolled over index.
7373

74-
The previous phase's actions must complete before {ILM} will check `min_age` and
75-
transition into the next phase.
74+
The previous phase's actions must complete before {ilm} will check `min_age`
75+
and transition into the next phase.
7676

7777
=== Phase Execution
7878

7979
beta[]
8080

8181
The current phase definition, of an index's policy being executed, is stored
8282
in the index's metadata. The phase and its actions are compiled into a series
83-
of discrete steps that are executed sequentially. Since some {ILM} actions are
84-
more complex and involve multiple operations against an index, each of these
83+
of discrete steps that are executed sequentially. Since some {ilm-init} actions
84+
are more complex and involve multiple operations against an index, each of these
8585
operations are done in isolation in a unit called a "step". The
8686
<<ilm-explain-lifecycle,Explain Lifecycle API>> exposes this information to us
8787
to see which step our index is either to execute next, or is currently

docs/reference/ilm/set-up-lifecycle-policy.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
beta[]
77

88
In order for an index to use an {ilm} policy to manage its lifecycle we must
9-
first define a lifecycle policy for it to use. The following request creates
10-
a policy called `my_policy` in Elasticsearch which we can later use to manage
11-
our indexes.
9+
first define a lifecycle policy for it to use. The following request creates a
10+
policy called `my_policy` in Elasticsearch which we can later use to manage our
11+
indexes.
1212

1313
[source,js]
1414
------------------------
@@ -39,7 +39,7 @@ PUT _ilm/policy/my_policy
3939

4040
{ilm} will manage an index using the policy defined in the
4141
`index.lifecycle.name` index setting. If this setting does not exist in the
42-
settings for a particular index {ilm} will not manage that index.
42+
settings for a particular index, {ilm} will not manage that index.
4343

4444
To set the policy for an index there are two options:
4545

@@ -90,7 +90,7 @@ PUT test-000001
9090
<1> Set this initial index to be the write index for this alias.
9191

9292
We can now write data to the `test-alias` alias. Because we have a rollover
93-
action defined in our policy when the index grows larger than 25GB {ilm} will
93+
action defined in our policy, when the index grows larger than 25GB {ilm} will
9494
create a new index and roll the alias over to use the new index automatically.
9595

9696
=== Apply a policy to a create index request

0 commit comments

Comments
 (0)