[DOCS] Edit ILM operation summaries

lcawl · lcawl · commit e2469aa4f7cb · 2024-12-10T15:29:33.000-08:00
diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv
@@ -197,6 +197,7 @@ ilm-delete-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{br
 ilm-explain-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-explain-lifecycle.html
 ilm-get-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-get-lifecycle.html
 ilm-get-status,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-get-status.html
+ilm-index-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-index-lifecycle.html
 ilm-migrate-to-data-tiers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-migrate-to-data-tiers.html
 ilm-move-to-step,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-move-to-step.html
 ilm-put-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-put-lifecycle.html
@@ -271,6 +272,7 @@ mapping-source-field,https://www.elastic.co/guide/en/elasticsearch/reference/{br
 mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping.html
 mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping.html
 mean-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_mean_reciprocal_rank
+migrate-index-allocation-filters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migrate-index-allocation-filters.html
 migration-api-deprecation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migration-api-deprecation.html
 migration-api-feature-upgrade,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migration-api-feature-upgrade.html
 ml-apis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-apis.html
diff --git a/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts b/specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts
@@ -22,8 +22,8 @@ import { Name } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
- * Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.
- *
+ * Deletes a lifecycle policy.
+ * You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.
  * @rest_spec_name ilm.delete_lifecycle
  * @availability stack since=6.6.0 stability=stable
  * @cluster_privileges manage_ilm
diff --git a/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts b/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts
@@ -22,7 +22,11 @@ import { IndexName } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
- * Retrieves information about the index’s current lifecycle state, such as the currently executing phase, action, and step. Shows when the index entered each one, the definition of the running phase, and information about any failures.
+ * Explain the lifecycle state.
+ * Get the current lifecycle status for one or more indices.
+ * For data streams, the API retrieves the current lifecycle status for the stream's backing indices.
+ *
+ * The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.
  * @rest_spec_name ilm.explain_lifecycle
  * @availability stack since=6.6.0 stability=stable
  * @index_privileges view_index_metadata,manage_ilm
diff --git a/specification/ilm/get_lifecycle/GetLifecycleRequest.ts b/specification/ilm/get_lifecycle/GetLifecycleRequest.ts
@@ -22,7 +22,7 @@ import { Name } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
- * Retrieves a lifecycle policy.
+ * Get lifecycle policies.
  * @rest_spec_name ilm.get_lifecycle
  * @availability stack since=6.6.0 stability=stable
  * @cluster_privileges manage_ilm, read_ilm
diff --git a/specification/ilm/get_status/GetIlmStatusRequest.ts b/specification/ilm/get_status/GetIlmStatusRequest.ts
@@ -20,7 +20,10 @@
 import { RequestBase } from '@_types/Base'
 
 /**
+ * Get the index lifecycle management status.
+ * Get the current ILM status.
  * @rest_spec_name ilm.get_status
  * @availability stack since=6.6.0 stability=stable
+ * @cluster_privileges read_ilm
  */
 export interface Request extends RequestBase {}
diff --git a/specification/ilm/migrate_to_data_tiers/Request.ts b/specification/ilm/migrate_to_data_tiers/Request.ts
@@ -20,12 +20,23 @@
 import { RequestBase } from '@_types/Base'
 
 /**
- * Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and
- * attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+
+ * Migrate to data tiers routing.
+ * Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.
+ * Optionally, delete one legacy index template.
  * Using node roles enables ILM to automatically move the indices between data tiers.
  *
+ * Migrating away from custom node attributes routing can be manually performed.
+ * This API provides an automated way of performing three out of the four manual steps listed in the migration guide:
+ *
+ * 1. Stop setting the custom hot attribute on new indices.
+ * 1. Remove custom allocation settings from existing ILM policies.
+ * 1. Replace custom allocation settings from existing indices with the corresponding tier preference.
+ *
+ * ILM must be stopped before performing the migration.
+ * Use the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`.
  * @rest_spec_name ilm.migrate_to_data_tiers
  * @availability stack since=7.14.0 stability=stable
+ * @ext_doc_id migrate-index-allocation-filters
  */
 export interface Request extends RequestBase {
   query_parameters: {
diff --git a/specification/ilm/move_to_step/MoveToStepRequest.ts b/specification/ilm/move_to_step/MoveToStepRequest.ts
@@ -22,8 +22,23 @@ import { IndexName } from '@_types/common'
 import { StepKey } from './types'
 
 /**
+ * Move to a lifecycle step.
+ * Manually move an index into a specific step in the lifecycle policy and run that step.
+ *
+ * WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.
+ *
+ * You must specify both the current step and the step to be executed in the body of the request.
+ * The request will fail if the current step does not match the step currently running for the index
+ * This is to prevent the index from being moved from an unexpected step into the next step.
+ *
+ * When specifying the target (`next_step`) to which the index will be moved, either the name or both the action and name fields are optional.
+ * If only the phase is specified, the index will move to the first step of the first action in the target phase.
+ * If the phase and action are specified, the index will move to the first step of the specified action in the specified phase.
+ * Only actions specified in the ILM policy are considered valid.
+ * An index cannot move to a step that is not part of its policy.
  * @rest_spec_name ilm.move_to_step
  * @availability stack since=6.6.0 stability=stable
+ * @index_privileges manage_ilm
  */
 export interface Request extends RequestBase {
   path_parts: {
diff --git a/specification/ilm/put_lifecycle/PutLifecycleRequest.ts b/specification/ilm/put_lifecycle/PutLifecycleRequest.ts
@@ -23,11 +23,15 @@ import { Name } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
- * Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented.
+ * Create or update a lifecycle policy.
+ * If the specified policy exists, it is replaced and the policy version is incremented.
+ *
+ * NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.
  * @rest_spec_name ilm.put_lifecycle
  * @availability stack since=6.6.0 stability=stable
  * @cluster_privileges manage_ilm
  * @index_privileges manage
+ * @ext_doc_id ilm-index-lifecycle
  */
 export interface Request extends RequestBase {
   path_parts: {
diff --git a/specification/ilm/remove_policy/RemovePolicyRequest.ts b/specification/ilm/remove_policy/RemovePolicyRequest.ts
@@ -21,8 +21,12 @@ import { RequestBase } from '@_types/Base'
 import { IndexName } from '@_types/common'
 
 /**
+ * Remove policies from an index.
+ * Remove the assigned lifecycle policies from an index or a data stream's backing indices.
+ * It also stops managing the indices.
  * @rest_spec_name ilm.remove_policy
  * @availability stack since=6.6.0 stability=stable
+ * @index_privileges manage_ilm
  */
 export interface Request extends RequestBase {
   path_parts: {
diff --git a/specification/ilm/retry/RetryIlmRequest.ts b/specification/ilm/retry/RetryIlmRequest.ts
@@ -21,8 +21,13 @@ import { RequestBase } from '@_types/Base'
 import { IndexName } from '@_types/common'
 
 /**
+ * Retry a policy.
+ * Retry running the lifecycle policy for an index that is in the ERROR step.
+ * The API sets the policy back to the step where the error occurred and runs the step.
+ * Use the explain lifecycle state API to determine whether an index is in the ERROR step.
  * @rest_spec_name ilm.retry
  * @availability stack since=6.6.0 stability=stable
+ * @index_privileges manage_ilm
  */
 export interface Request extends RequestBase {
   path_parts: {
diff --git a/specification/ilm/start/StartIlmRequest.ts b/specification/ilm/start/StartIlmRequest.ts
@@ -21,8 +21,13 @@ import { RequestBase } from '@_types/Base'
 import { Duration } from '@_types/Time'
 
 /**
+ * Start the index lifecycle management plugin.
+ * Start the ILM plugin if it is currently stopped.
+ * ILM is started automatically when the cluster is formed.
+ * Restarting ILM is necessary only when it has been stopped using the stop ILM API.
  * @rest_spec_name ilm.start
  * @availability stack since=6.6.0 stability=stable
+ * @cluster_privileges manage_ilm
  */
 export interface Request extends RequestBase {
   query_parameters: {
diff --git a/specification/ilm/stop/StopIlmRequest.ts b/specification/ilm/stop/StopIlmRequest.ts
@@ -21,8 +21,15 @@ import { RequestBase } from '@_types/Base'
 import { Duration } from '@_types/Time'
 
 /**
+ * Stop the index lifecycle management plugin.
+ * Halt all lifecycle management operations and stop the ILM plugin.
+ * This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.
+ *
+ * The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped.
+ * Use the get ILM status API to check whether ILM is running.
  * @rest_spec_name ilm.stop
  * @availability stack since=6.6.0 stability=stable
+ * @cluster_privileges manage_ilm
  */
 export interface Request extends RequestBase {
   query_parameters: {
diff --git a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts
@@ -23,7 +23,7 @@ import { Duration } from '@_types/Time'
 
 /**
  * Get the status for a data stream lifecycle.
- * Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.
+ * Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.
  * @rest_spec_name indices.explain_data_lifecycle
  * @availability stack since=8.11.0 stability=stable
  * @availability serverless stability=stable visibility=public
