diff --git a/docs/reference/images/index-mgmt/management-data-stream.png b/docs/reference/images/index-mgmt/management-data-stream.png new file mode 100644 index 0000000000000..01534fdec2a23 Binary files /dev/null and b/docs/reference/images/index-mgmt/management-data-stream.png differ diff --git a/docs/reference/images/index-mgmt/management-enrich-policies.png b/docs/reference/images/index-mgmt/management-enrich-policies.png new file mode 100644 index 0000000000000..75911842ae434 Binary files /dev/null and b/docs/reference/images/index-mgmt/management-enrich-policies.png differ diff --git a/docs/reference/indices/index-mgmt.asciidoc b/docs/reference/indices/index-mgmt.asciidoc index b89d2ec957af9..7a78f9452b85e 100644 --- a/docs/reference/indices/index-mgmt.asciidoc +++ b/docs/reference/indices/index-mgmt.asciidoc @@ -3,21 +3,15 @@ == Index management in {kib} {kib}'s *Index Management* features are an easy, convenient way to manage your -cluster's indices, <>, and <>. Practicing good index management ensures your data is stored +cluster's indices, <>, <>, and <>. Practicing good index management ensures your data is stored correctly and in the most cost-effective way possible. +To use these features, go to *Stack Management* > *Index Management*. + [discrete] [[index-mgmt-wyl]] -=== What you'll learn - -You'll learn how to: -* View and edit index settings. -* View mappings and statistics for an index. -* Perform index-level operations, such as refreshes. -* View and manage data streams. -* Create index templates to automatically configure new data streams and indices. [discrete] [[index-mgm-req-permissions]] @@ -31,82 +25,68 @@ If you use {es} {security-features}, the following or index's data. * The `manage_index_templates` cluster privilege to manage index templates. -To add these privileges in {kib}, go to *Stack Management > Security > Roles*. +To add these privileges, go to *Stack Management > Security > Roles* or use the <>. [discrete] [[view-edit-indices]] -=== View and edit indices +=== Manage indices -Open {kib}'s main menu and click *Stack Management > Index Management*. +Investigate your indices and perform operations from the *Indices* view. [role="screenshot"] image::images/index-mgmt/management_index_labels.png[Index Management UI] -The *Index Management* page contains an overview of your indices. +* 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 <>. + +* To filter the list of indices, use the search bar or click a badge. Badges indicate if an index is a <>, a <>, or <>. -Clicking a badge narrows the list to only indices of that type. -You can also filter indices using the search bar. - -By clicking the index name, you can open an index details page to investigate the index -<>, <>, and statistics. -On this page, you can also edit the index settings. - -To view and explore the documents within an index, click the *Discover index* button to open {kibana-ref}/discover.html[Discover]. - +* To drill down into the index +<>, <>, and statistics, +click an index name. From this view, you can navigate to *Discover* to +further explore the documents in the index. ++ [role="screenshot"] image::images/index-mgmt/management_index_details.png[Index Management UI] -[float] -=== Perform index-level operations - -Use the *Manage* menu to perform index-level operations. This menu -is available in the index details view, or when you select the checkbox of one or more -indices on the overview page. The menu includes the following actions: - -* <> -* <> -* <> -* <> -* <> -* <> [float] [[manage-data-streams]] === Manage data streams -The *Data Streams* view lists your data streams and lets you examine or delete -them. +Investigate your data streams and address lifecycle management needs in the *Data Streams* view. -To view more information about a data stream, such as its generation or its -current index lifecycle policy, click the stream's name. +The value in the *Indices* column indicates the number of backing indices. Click this number to drill down into details. -To view and explore the data within a data stream, click the compass icon image:compassicon.png[width=3%] next to the data stream name to open {kibana-ref}/discover.html[Discover]. +A value in the data retention column indicates that the data stream is managed by a <>. +This value is the time period for which your data is guaranteed to be stored. Data older than this period can be deleted by +Elasticsearch at a later time. [role="screenshot"] -image::images/index-mgmt/management_index_data_stream_stats.png[Data stream details] +image::images/index-mgmt/management-data-stream.png[Data stream details] -To view information about the stream's backing indices, click the number in the -*Indices* column. +* 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. -[role="screenshot"] -image::images/index-mgmt/management_index_data_stream_backing_index.png[Backing index] +* preview:[]To edit the data retention value, open the *Manage* menu, and then click *Edit data retention*. +This action is only available if your data stream is not managed by an ILM policy. [float] [[manage-index-templates]] === Manage index templates -The *Index Templates* view lists your templates and lets you examine, -edit, clone, and delete them. Changes made to an index template do not +Create, +edit, clone, and delete your index templates in the *Index Templates* view. Changes made to an index template do not affect existing indices. [role="screenshot"] image::images/index-mgmt/management-index-templates.png[Index templates] -If you don't have any templates, you can create one using the *Create template* -wizard. - [float] ==== Try it: Create an index template @@ -236,3 +216,32 @@ earlier. GET /my-index-000001,my-index-000002 -------------------------------------------------- // TEST[continued] + +[float] +[[manage-enrich-policies]] +=== Manage enrich policies + +Use the *Enrich Policies* view to add data from your existing indices to incoming documents during ingest. +An enrich policy contains: + +* The policy type that determines how the policy matches the enrich data to incoming documents +* The source indices that store enrich data as documents +* The fields from the source indices used to match incoming documents +* The enrich fields containing enrich data from the source indices that you want to add to incoming documents +* An optional <>. + +[role="screenshot"] +image::images/index-mgmt/management-enrich-policies.png[Enrich policies] + + +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. + +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. + +Check out these examples: + +* <> +* <> +* <>