Skip to content

Commit c0156cb

Browse files
debadairjrodewig
andauthored
Backporting updates to ILM org, overview, & GS (#51898)
* [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]>
1 parent 0be61a3 commit c0156cb

34 files changed

+1176
-1090
lines changed

docs/reference/glossary.asciidoc

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,30 @@ In most cases, the goal of filtering is to reduce the number of documents that h
8080
Follower indices are the target indices for <<glossary-ccr,{ccr}>>. They exist
8181
in your local cluster and replicate <<glossary-leader-index,leader indices>>.
8282

83+
[[glossary-force-merge]] force merge ::
84+
// tag::force-merge-def[]
85+
// tag::force-merge-def-short[]
86+
Manually trigger a merge to reduce the number of segments in each shard of an index
87+
and free up the space used by deleted documents.
88+
// end::force-merge-def-short[]
89+
You should not force merge indices that are actively being written to.
90+
Merging is normally performed automatically, but you can use force merge after
91+
<<glossary-rollover, rollover>> to reduce the shards in the old index to a single segment.
92+
See the {ref}/indices-forcemerge.html[force merge API].
93+
// end::force-merge-def[]
94+
95+
[[glossary-freeze]] freeze ::
96+
// tag::freeze-def[]
97+
// tag::freeze-def-short[]
98+
Make an index read-only and minimize its memory footprint.
99+
// end::freeze-def-short[]
100+
Frozen indices can be searched without incurring the overhead of of re-opening a closed index,
101+
but searches are throttled and might be slower.
102+
You can freeze indices to reduce the overhead of keeping older indices searchable
103+
before you are ready to archive or delete them.
104+
See the {ref}/freeze-index-api.html[freeze API].
105+
// end::freeze-def[]
106+
83107
[[glossary-id]] id ::
84108

85109
The ID of a <<glossary-document,document>> identifies a document. The
@@ -114,6 +138,18 @@ See {ref}/indices-add-alias.html[Add index alias].
114138
See <<indices-add-alias>>.
115139
--
116140

141+
[[glossary-index-template]] index template ::
142+
+
143+
--
144+
// tag::index-template-def[]
145+
// tag::index-template-def-short[]
146+
Defines settings and mappings to apply to new indexes that match a simple naming pattern, such as _logs-*_.
147+
// end::index-template-def-short[]
148+
An index template can also attach a lifecycle policy to the new index.
149+
Index templates are used to automatically configure indices created during <<glossary-rollover, rollover>>.
150+
// end::index-template-def[]
151+
--
152+
117153
[[glossary-leader-index]] leader index ::
118154

119155
Leader indices are the source indices for <<glossary-ccr,{ccr}>>. They exist
@@ -206,6 +242,19 @@ By default, each primary shard has one replica, but the number of
206242
replicas can be changed dynamically on an existing index. A replica
207243
shard will never be started on the same node as its primary shard.
208244

245+
[[glossary-rollover]] rollover ::
246+
+
247+
--
248+
// tag::rollover-def[]
249+
// tag::rollover-def-short[]
250+
Redirect an alias to begin writing to a new index when the existing index reaches a certain age, number of docs, or size.
251+
// end::rollover-def-short[]
252+
The new index is automatically configured according to any matching <<glossary-index-template, index templates>>.
253+
For example, if you're indexing log data, you might use rollover to create daily or weekly indices.
254+
See the {ref}/indices-rollover-index.html[rollover index API].
255+
// end::rollover-def[]
256+
--
257+
209258
[[glossary-routing]] routing ::
210259

211260
When you index a document, it is stored on a single
@@ -220,7 +269,9 @@ time, or a <<mapping-routing-field,routing
220269
field>> in the <<glossary-mapping,mapping>>.
221270

222271
[[glossary-shard]] shard ::
223-
272+
+
273+
--
274+
// tag::shard-def[]
224275
A shard is a single Lucene instance. It is a low-level “worker” unit
225276
which is managed automatically by Elasticsearch. An index is a logical
226277
namespace which points to <<glossary-primary-shard,primary>> and
@@ -234,6 +285,18 @@ Elasticsearch distributes shards amongst all <<glossary-node,nodes>> in the
234285
<<glossary-cluster,cluster>>, and can move shards automatically from one
235286
node to another in the case of node failure, or the addition of new
236287
nodes.
288+
// end::shard-def[]
289+
--
290+
291+
[[glossary-shrink]] shrink ::
292+
// tag::shrink-def[]
293+
// tag::shrink-def-short[]
294+
Reduce the number of primary shards in an index.
295+
// end::shrink-def-short[]
296+
You can shrink an index to reduce its overhead when the request volume drops.
297+
For example, you might opt to shrink an index once it is no longer the write index.
298+
See the {ref}/indices-shrink-index.html[shrink index API].
299+
// end::shrink-def[]
237300

238301
[[glossary-source_field]] source field ::
239302

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<titleabbrev>Delete policy</titleabbrev>
77
++++
88

9-
Deletes a lifecycle policy.
9+
Deletes an index lifecycle policy.
1010

1111
[[ilm-delete-lifecycle-request]]
1212
==== {api-request-title}

docs/reference/ilm/apis/ilm-api.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[[index-lifecycle-management-api]]
22
== {ilm-cap} API
33

4-
You can use the following APIs to manage policies on indices. For more
5-
information, see <<index-lifecycle-management>>.
4+
You use the following APIs to set up policies to automatically manage the index lifecycle.
5+
For more information about {ilm} ({ilm-init}), see <<index-lifecycle-management>>.
66

77
[float]
88
[[ilm-api-policy-endpoint]]

0 commit comments

Comments
 (0)