Skip to content

Commit a68a66c

Browse files
kilfoyleeedugonleemthompo
authored
Combine 'Index mgmt' with 'Index mgmt in Kibana' (#2010)
As part of the ILM review it was pointed out that the very important [Index management in Kibana](https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/index-management-in-kibana) page is kind of hard to find, since it's nested a few levels down in the "Index Lifecycle Management" section. It's also confusing that we have a few pages about managing indices. This PR combines the contents of "Index management in Kibana" into [Index Management](https://www.elastic.co/docs/manage-data/data-store/index-basics#index-management) (a section of the main, very prominent "Index basics" page at the top of the ToC). **Notes:** - For the removed [Index management in Kibana](https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/index-management-in-kibana) page, I've changed the page to "hidden" in the ToC, replaced the content with a `This page has moved` note, and created a redirect in the `redirect.yml` file. - The original pages differed in that one seemed mainly for Stack, one for both Serverless and Stack. In combining them I've used tabs to separate out the steps that differ. - The "Index management in Kibana" page had a nice tutorial about setting up index templates. I've tested to make sure that it works on Serverless. - We also have a [Manage existing indices](https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/manage-existing-indices) page. In a separate PR I've moved that to be nested under "Migrate to ILM" so it's clear that the page is not really about managing indices in general. - I've updated outdated screencaps and also changed them to show the "Include hidden indices" option enabled, since this came up a few times in the ILM review. See: * Updated [Index management](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2010/manage-data/data-store/index-basics#index-management) * Removed [Index management in Kibana](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2010/manage-data/lifecycle/index-lifecycle-management/index-management-in-kibana) Closes: #1569 --------- Co-authored-by: Edu González de la Herrán <[email protected]> Co-authored-by: Liam Thompson <[email protected]>
1 parent a4cb8a0 commit a68a66c

File tree

18 files changed

+210
-224
lines changed

18 files changed

+210
-224
lines changed

deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ $$$ec-restrictions-apis-kibana$$$
7272
* {{es}} plugins, are not enabled by default for security purposes. Reach out to support if you would like to enable {{es}} plugins support on your account.
7373
* Some {{es}} plugins do not apply to {{ecloud}}. For example, you won’t ever need to change discovery, as {{ecloud}} handles how nodes discover one another.
7474
% * In {{es}} 5.0 and later, site plugins are no longer supported. This change does not affect the site plugins {{ecloud}} might provide out of the box, such as Kopf or Head, since these site plugins are serviced by our proxies and not {{es}} itself.
75-
% * In {{es}} 5.0 and later, site plugins such as Kopf and Paramedic are no longer provided. We recommend that you use our [cluster performance metrics](../../monitor/stack-monitoring.md), [X-Pack monitoring features](../../monitor/stack-monitoring.md) and Kibana’s (6.3+) [Index Management UI](/manage-data/lifecycle/index-lifecycle-management/index-management-in-kibana.md) if you want more detailed information or perform index management actions.
75+
% * In {{es}} 5.0 and later, site plugins such as Kopf and Paramedic are no longer provided. We recommend that you use our [cluster performance metrics](../../monitor/stack-monitoring.md), [X-Pack monitoring features](../../monitor/stack-monitoring.md) and Kibana’s (6.3+) [Index Management UI](/manage-data/data-store/index-basics.md#manage-indices) if you want more detailed information or perform index management actions.
7676

7777

7878
## Watcher [ec-restrictions-watcher]

explore-analyze/alerts-cases/watcher/watcher-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To use Watcher in {{kib}}, you must have the built-in `kibana_admin` role and ei
3030
To manage roles, go to the **Roles** management page, or use the [role APIs](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-roles). Watches are shared between all users with the same role.
3131

3232
::::{note}
33-
If you are creating a threshold watch, you must also have the `view_index_metadata` index privilege. See [Index management](../../../manage-data/lifecycle/index-lifecycle-management/index-management-in-kibana.md) for detailed information.
33+
If you are creating a threshold watch, you must also have the `view_index_metadata` index privilege. See [Index management](/manage-data/data-store/index-basics.md#index-management) for detailed information.
3434
::::
3535

3636
## Create a threshold alert [watcher-create-threshold-alert]

manage-data/data-store/data-streams/logs-data-stream.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PUT _index_template/my-index-template
4848

4949
After the index template is created, new indices that use the template will be configured as a logs data stream. You can start indexing data and [using the data stream](use-data-stream.md).
5050

51-
You can also set the index mode and adjust other template settings in [the Elastic UI](../../lifecycle/index-lifecycle-management/index-management-in-kibana.md).
51+
You can also set the index mode and adjust other template settings in [the Elastic UI](/manage-data/data-store/index-basics.md#index-management-manage-index-templates).
5252

5353

5454
## Synthetic source [logsdb-synthetic-source]

manage-data/data-store/index-basics.md

Lines changed: 192 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,23 +68,75 @@ Each index has a [mapping](/manage-data/data-store/mapping.md) or schema for how
6868

6969
## Index management
7070

71-
Elastic's index management features are an easy, convenient way to manage your cluster's indices, data streams, index templates, and enrich policies. Practicing good index management ensures your data is stored correctly and in the most cost-effective way possible.
71+
Elastic's **Index Management** features are an easy, convenient way to manage your clusters indices, [data streams](/manage-data/lifecycle/data-stream.md), [templates](/manage-data/data-store/templates.md), and [enrich policies](/manage-data/ingest/transform-enrich/data-enrichment.md). Practicing good index management ensures your data is stored correctly and in the most cost-effective way possible.
7272

73-
Go to **{{project-settings}} → {{manage-app}} → {{index-manage-app}}**.
73+
To use these features:
74+
* On {{serverless-full}}, go to **Project settings** > **Management** > **Index Management**.
75+
* On {{stack}}, go to **Stack Management** > **Index Management**.
76+
77+
### Required permissions [index-mgm-req-permissions]
78+
```{applies_to}
79+
stack: ga
80+
```
81+
82+
If you use {{es}} {{security-features}}, the following [security privileges](/deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md) are required:
83+
84+
* The `monitor` cluster privilege to access {{kib}}'s **Index Management** features.
85+
* The `view_index_metadata` and `manage` index privileges to view a data stream or index’s data.
86+
* The `manage_index_templates` cluster privilege to manage index templates.
87+
88+
To add these privileges, go to **Stack Management > Security > Roles** or use the [Create or update roles API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role).
7489

7590
### Manage indices
7691

7792
Investigate your indices and perform operations from the **Indices** view.
7893

94+
:::::{tab-set}
95+
:group: stack-serverless
96+
97+
::::{tab-item} {{serverless-short}}
98+
:sync: serverless
99+
79100
:::{image} /manage-data/images/serverless-index-management-indices.png
80101
:alt: Index Management indices
81102
:screenshot:
82103
:::
83104

105+
* Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md).
106+
84107
* To show details and perform operations, click the index name. To perform operations on multiple indices, select their checkboxes and then open the **Manage** menu. For more information on managing indices, refer to [Index APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-indices).
108+
109+
* To filter the list of indices, use the search bar or click a badge. Badges indicate if an index is a [follower index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow), a [rollup index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps), or [frozen](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-unfreeze).
110+
111+
* To drill down into the index overivew, [mappings](/manage-data/data-store/mapping.md), and [settings](elasticsearch://reference/elasticsearch/index-settings/index.md), click an index name. From this view, you can navigate to **Discover** to further explore the documents in the index.
112+
113+
::::
114+
115+
::::{tab-item} {{stack}}
116+
:sync: stack
117+
118+
:::{image} /manage-data/images/elasticsearch-reference-management_index_labels.png
119+
:alt: Index Management UI
120+
:screenshot:
121+
:::
122+
123+
* Enable **Include hidden indices** to view the full set of indices, including backing indices for [data streams](/manage-data/data-store/data-streams.md).
124+
125+
* To show details and perform operations such as close, forcemerge, and flush, click the index name. To perform operations on multiple indices, select their checkboxes and then open the **Manage** menu. For more information on managing indices, refer to [Index APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-indices).
126+
85127
* To filter the list of indices, use the search bar or click a badge. Badges indicate if an index is a [follower index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow), a [rollup index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps), or [frozen](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-unfreeze).
86-
* To drill down into the index [mappings](/manage-data/data-store/mapping.md), [settings](elasticsearch://reference/elasticsearch/index-settings/index.md), and statistics, click an index name. From this view, you can navigate to **Discover** to further explore the documents in the index.
87-
* To create new indices, use the **Create index** wizard.
128+
129+
You can also use the drop-down menus to filter the list by the [index lifecycle](/manage-data/lifecycle/index-lifecycle-management/index-lifecycle.md) status or phase.
130+
131+
* To drill down into the index [mappings](/manage-data/data-store/mapping.md), [settings](elasticsearch://reference/elasticsearch/index-settings/index.md), statistics, and lifecycle details, click an index name. From this view, you can navigate to **Discover** to further explore the documents in the index.
132+
133+
:::{image} /manage-data/images/elasticsearch-reference-management_index_details.png
134+
:alt: Index Management UI
135+
:screenshot:
136+
:::
137+
138+
::::
139+
:::::
88140

89141
### Manage data streams
90142

@@ -101,8 +153,8 @@ In {{es-serverless}}, indices matching the `logs-*-*` pattern use the logsDB ind
101153

102154
* To view information about the stream's backing indices, click the number in the **Indices** column.
103155
* A value in the **Data retention** column indicates that the data stream is managed by a data stream lifecycle policy. This value is the time period for which your data is guaranteed to be stored. Data older than this period can be deleted by {{es}} at a later time.
104-
* To modify the data retention value, select an index, open the **Manage** menu, and click **Edit data retention**.
105-
* To view more information about a data stream, such as its generation or its current index lifecycle policy, click the stream's name. From this view, you can navigate to **Discover** to further explore data within the data stream.
156+
* To modify the data retention value, select an index, open the **Manage** menu, and click **Edit data retention**. On {{stack}}, this action is only available if your data stream is not managed by an ILM policy.
157+
* To view more information about a data stream including it's lifecycle settings, click the stream's name.
106158

107159
### Manage index templates [index-management-manage-index-templates]
108160

@@ -120,6 +172,123 @@ Create, edit, clone, and delete your index templates in the **Index Templates**
120172
* Values in the **Content** column indicate whether a template contains index mappings, settings, and aliases.
121173
* To create new index templates, use the **Create template** wizard.
122174

175+
#### Try it: Create an index template [_try_it_create_an_index_template]
176+
177+
In this tutorial, you’ll create an index template and use it to configure two new indices.
178+
179+
##### Step 1. Add a name and index pattern
180+
181+
1. In the **Index Templates** view, open the **Create template** wizard.
182+
183+
:::{image} /manage-data/images/elasticsearch-reference-management_index_create_wizard.png
184+
:alt: Create wizard
185+
:screenshot:
186+
:::
187+
188+
2. In the **Name** field, enter `my-index-template`.
189+
3. Set **Index pattern** to `my-index-*` so the template matches any index with that index pattern.
190+
4. Leave **Data Stream**, **Priority**, **Version**, and **_meta field** blank or as-is.
191+
192+
##### Step 2. Add settings, mappings, and aliases
193+
194+
When creating an index template, you can define settings, mappings, and aliases directly in the template or include them through one or more component templates.
195+
196+
A [component template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template) is a type of [template](/manage-data/data-store/templates.md) used as a building block for constructing index templates. {{kib}} displays badges indicating whether a component template contains mappings (**M**), index settings (**S**), aliases (**A**), or a combination of the three.
197+
198+
1. Add component templates to your index template.
199+
200+
Component templates are optional. For this tutorial, do not add any component templates.
201+
202+
:::{image} /manage-data/images/elasticsearch-reference-management_index_component_template.png
203+
:alt: Component templates page
204+
:screenshot:
205+
:::
206+
207+
2. Define index settings directly in the index template. When used in conjunction with component templates, settings defined directly in the index template override any conflicting settings from the associated component templates.
208+
209+
This step is optional. For this tutorial, leave this section blank.
210+
3. Define mappings directly in the index template. When used in conjunction with component templates, these mappings override any conflicting definitions from the associated component templates.
211+
212+
Define a mapping that contains an [object](elasticsearch://reference/elasticsearch/mapping-reference/object.md) field named `geo` with a child [`geo_point`](elasticsearch://reference/elasticsearch/mapping-reference/geo-point.md) field named `coordinates`:
213+
214+
:::{image} /manage-data/images/elasticsearch-reference-management-index-templates-mappings.png
215+
:alt: Mapped fields page
216+
:screenshot:
217+
:::
218+
219+
Alternatively, you can click the **Load JSON** link and define the mapping as JSON:
220+
221+
```js
222+
{
223+
"properties": {
224+
"geo": {
225+
"properties": {
226+
"coordinates": {
227+
"type": "geo_point"
228+
}
229+
}
230+
}
231+
}
232+
}
233+
```
234+
235+
You can create additional mapping configurations in the **Dynamic templates** and **Advanced options** tabs. For this tutorial, do not create any additional mappings.
236+
237+
4. Define an alias named `my-index`:
238+
239+
```js
240+
{
241+
"my-index": {}
242+
}
243+
```
244+
245+
5. On the review page, check the summary. If everything looks right, click **Create template**.
246+
247+
##### Step 3. Create new indices
248+
249+
You’re now ready to create new indices using your index template.
250+
251+
1. Index the following documents to create two indices: `my-index-000001` and `my-index-000002`.
252+
253+
```console
254+
POST /my-index-000001/_doc
255+
{
256+
"@timestamp": "2019-05-18T15:57:27.541Z",
257+
"ip": "225.44.217.191",
258+
"extension": "jpg",
259+
"response": "200",
260+
"geo": {
261+
"coordinates": {
262+
"lat": 38.53146222,
263+
"lon": -121.7864906
264+
}
265+
},
266+
"url": "https://media-for-the-masses.theacademyofperformingartsandscience.org/uploads/charles-fullerton.jpg"
267+
}
268+
269+
POST /my-index-000002/_doc
270+
{
271+
"@timestamp": "2019-05-20T03:44:20.844Z",
272+
"ip": "198.247.165.49",
273+
"extension": "php",
274+
"response": "200",
275+
"geo": {
276+
"coordinates": {
277+
"lat": 37.13189556,
278+
"lon": -76.4929875
279+
}
280+
},
281+
"memory": 241720,
282+
"url": "https://theacademyofperformingartsandscience.org/people/type:astronauts/name:laurel-b-clark/profile"
283+
}
284+
```
285+
286+
2. Use the [get index API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get) to view the configurations for the new indices. The indices were configured using the index template you created earlier.
287+
288+
```console
289+
GET /my-index-000001,my-index-000002
290+
```
291+
123292
### Manage component templates
124293

125294
[Component templates](/manage-data/data-store/templates.md) are reusable building blocks that configure mappings, settings, and aliases.
@@ -136,9 +305,15 @@ Create, edit, clone, and delete your component templates in the **Component Temp
136305

137306
### Manage enrich policies
138307

139-
An [enrich policy](/manage-data/ingest/transform-enrich/data-enrichment.md#enrich-policy) is a set of configuration options used to add the right enrich data to the right incoming documents.
308+
An [enrich policy](/manage-data/ingest/transform-enrich/data-enrichment.md#enrich-policy) is a set of configuration options used to add data from your existing indices to incoming documents during ingest. An enrich policy contains:
140309

141-
Add data from your existing indices to incoming documents using the **Enrich Policies** view.
310+
* The policy type that determines how the policy matches the enrich data to incoming documents
311+
* The source indices that store enrich data as documents
312+
* The fields from the source indices used to match incoming documents
313+
* The enrich fields containing enrich data from the source indices that you want to add to incoming documents
314+
* An optional [query](elasticsearch://reference/query-languages/query-dsl/query-dsl-match-all-query.md).
315+
316+
Use the **Enrich Policies** view to add data from your existing indices to incoming documents during ingest.
142317

143318
:::{image} /manage-data/images/serverless-management-enrich-policies.png
144319
:alt: Enrich policies
@@ -149,6 +324,14 @@ Add data from your existing indices to incoming documents using the **Enrich Pol
149324
* To perform operations, click the policy name or use the buttons in the **Actions** column.
150325
* To create new policies, use the **Create enrich policy** wizard.
151326

152-
You must execute a new enrich policy before you can use it with an enrich processor. When executed, an enrich policy uses enrich data from the policy's source indices to create a streamlined system index called the enrich index. The policy uses this index to match and enrich incoming documents.
327+
You must execute a new enrich policy before you can use it with an enrich processor or {{esql}} query. When executed, an enrich policy uses enrich data from the policy's source indices to create a streamlined system index called the enrich index. The policy uses this index to match and enrich incoming documents.
328+
329+
When creating an enrich policy, the UI walks you through the configuration setup and selecting the fields. Before you can use the policy with an enrich processor or {{esql}} query, you must execute the policy.
330+
331+
When executed, an enrich policy uses enrich data from the policy’s source indices to create a streamlined system index called the enrich index. The policy uses this index to match and enrich incoming documents.
153332
333+
Check out these examples:
154334
335+
* [Example: Enrich your data based on geolocation](/manage-data/ingest/transform-enrich/example-enrich-data-based-on-geolocation.md)
336+
* [Example: Enrich your data based on exact values](/manage-data/ingest/transform-enrich/example-enrich-data-based-on-exact-values.md)
337+
* [Example: Enrich your data by matching a value to a range](/manage-data/ingest/transform-enrich/example-enrich-data-by-matching-value-to-range.md)

manage-data/data-store/templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ If you use {{fleet}} or {{agent}}, assign your index templates a priority lower
5555

5656
## Create index template [create-index-templates]
5757

58-
Use the [index template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template) and [put component template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template) APIs to create and update index templates. You can also [manage index templates](../lifecycle/index-lifecycle-management/index-management-in-kibana.md) from Stack Management in {{kib}}.
58+
Use the [put index template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template) and [put component template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template) APIs to create and update index templates. You can also [manage index templates](/manage-data/data-store/index-basics.md#index-management) from Stack Management in {{kib}}.
5959

6060
The following requests create two component templates.
6161

10.1 KB
Loading
471 KB
Loading
201 KB
Loading

manage-data/ingest/transform-enrich/ingest-pipelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ $$$pipeline-custom-logs-index-template$$$
270270

271271
2. Create an [index template](../../data-store/templates.md) that includes your pipeline in the [`index.default_pipeline`](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-default-pipeline) or [`index.final_pipeline`](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-final-pipeline) index setting. Ensure the template is [data stream enabled](../../data-store/data-streams/set-up-data-stream.md#create-index-template). The template’s index pattern should match `logs-<dataset-name>-*`.
272272

273-
You can create this template using {{kib}}'s [**Index Management**](../../lifecycle/index-lifecycle-management/index-management-in-kibana.md#manage-index-templates) feature or the [create index template API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template).
273+
You can create this template using {{kib}}'s [**Index Management**](/manage-data/data-store/index-basics.md#index-management-manage-index-templates) feature or the [create index template API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template).
274274

275275
For example, the following request creates a template matching `logs-my_app-*`. The template uses a component template that contains the `index.default_pipeline` index setting.
276276

0 commit comments

Comments
 (0)