索引生命周期操作

允许的阶段：温暖，寒冷。

更新索引设置以更改允许托管索引分片的节点，并更改副本数量。

在热阶段不允许进行分配操作。 索引的初始分配必须手动完成或通过 索引模板完成。

您可以配置此操作来修改分配规则和副本数量，仅修改分配规则，或仅修改副本数量。 有关Elasticsearch如何使用副本进行扩展的更多信息，请参阅 准备生产环境。有关控制Elasticsearch在何处分配特定索引的分片的更多信息，请参阅 索引级分片分配过滤。

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "warm": {
        "actions": {
          "allocate" : {
            "number_of_replicas" : 2,
            "total_shards_per_node" : 200
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "warm": {
        "actions": {
          "allocate" : {
            "include" : {
              "box_type": "hot,warm"
            }
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "cold": {
        "actions": {
          "allocate" : {
            "require" : {
              "box_type": "cold",
              "storage": "high"
            }
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "warm": {
        "actions": {
          "allocate" : {
            "number_of_replicas": 1,
            "require" : {
              "box_type": "cold"
            }
        }
        }
      }
    }
  }
}

允许的阶段：删除。

永久删除索引。

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "delete": {
        "actions": {
          "delete" : { }
        }
      }
    }
  }
}

允许的阶段：热，暖。

强制合并索引到指定的最大段数。

要在hot阶段使用forcemerge操作，rollover操作必须存在。 如果没有配置rollover操作，ILM将拒绝该策略。

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "warm": {
        "actions": {
          "forcemerge" : {
            "max_num_segments": 1
          }
        }
      }
    }
  }
}

允许的阶段：温暖，寒冷。

通过更新 index.routing.allocation.include._tier_preference 索引设置，将索引移动到与当前阶段对应的 数据层。 ILM 会自动在 warm 和 cold 阶段注入 migrate 操作。要防止自动迁移，您可以显式包含 migrate 操作并将 enabled 选项设置为 false。

如果冷阶段定义了一个可搜索快照操作，迁移操作将不会自动注入到冷阶段，因为托管索引将直接挂载在目标层级上，使用与迁移操作配置相同的_tier_preference基础设施。

在暖阶段，migrate 操作将 index.routing.allocation.include._tier_preference 设置为 data_warm,data_hot。这将索引移动到 暖层中的节点。如果没有暖层的节点，则会回退到 热层。

在冷阶段，migrate 操作将 index.routing.allocation.include._tier_preference 设置为 data_cold,data_warm,data_hot。这将索引移动到 冷层中的节点。如果没有冷层中的节点，它将回退到 暖层，或者如果没有暖层节点可用，则回退到 热层。

在冻结阶段不允许进行迁移操作。冻结阶段直接使用index.routing.allocation.include._tier_preference为data_frozen的可搜索快照进行挂载。这会将索引移动到冻结层中的节点。

在热阶段不允许进行迁移操作。 初始索引分配是自动执行的， 并且可以通过索引模板手动配置。

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "warm": {
        "actions": {
          "migrate" : {
          },
          "allocate": {
            "number_of_replicas": 1
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "warm": {
        "actions": {
          "migrate" : {
           "enabled": false
          },
          "allocate": {
            "include" : {
              "rack_id": "one,two"
            }
          }
        }
      }
    }
  }
}

允许的阶段：热、温、冷。

使索引数据变为只读； 禁止对索引进行数据写操作。

要在hot阶段使用readonly操作，rollover操作必须存在。 如果没有配置rollover操作，ILM将拒绝该策略。

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "warm": {
        "actions": {
          "readonly" : { }
        }
      }
    }
  }
}

允许的阶段：热。

当现有索引满足指定的滚动更新条件时，将目标滚动更新到新索引。

翻转目标可以是一个数据流或一个索引别名。当目标是一个数据流时，新索引成为数据流的写入索引，并且其代数递增。

要滚动索引别名，别名及其写入索引必须满足以下条件：

例如，如果 my-index-000001 有别名 my_data， 则必须配置以下设置。

PUT my-index-000001
{
  "settings": {
    "index.lifecycle.name": "my_policy",
    "index.lifecycle.rollover_alias": "my_data"
  },
  "aliases": {
    "my_data": {
      "is_write_index": true
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover" : {
            "max_primary_shard_size": "50gb"
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover" : {
            "max_size": "100gb"
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover" : {
            "max_docs": 100000000
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover" : {
            "max_primary_shard_docs": 10000000
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover" : {
            "max_age": "7d"
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover" : {
            "max_age": "7d",
            "max_size": "100gb",
            "min_docs": 1000
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover" : {
            "max_primary_shard_size": "50gb",
            "max_age": "30d",
            "min_primary_shard_size": "1gb"
          }
        }
      }
    }
  }
}

PUT /_ilm/policy/rollover_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover": {
            "max_size": "50gb"
          }
        }
      },
      "delete": {
        "min_age": "1d",
        "actions": {
          "delete": {}
        }
      }
    }
  }
}

允许的阶段：热、温、冷。

聚合一个时间序列（TSDS）索引并存储预先计算的统计摘要（最小值、最大值、总和、值计数 和 平均值），这些摘要按配置的时间间隔对每个指标字段进行分组。例如，一个包含每10秒采样一次指标的TSDS索引可以被降采样到一个每小时索引。在一个小时间隔内的所有文档被汇总并存储为一个文档，并存储在降采样索引中。

此操作对应于 downsample API。

生成的降采样索引的名称是 downsample--。如果ILM对数据流的备份索引执行 downsample操作，降采样索引将成为同一流的备份索引，并且源索引将被删除。

要在hot阶段使用downsample操作，rollover操作必须存在。如果没有配置rollover操作，ILM将拒绝该策略。

PUT _ilm/policy/datastream_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover": {
            "max_docs": 1
          },
          "downsample": {
  	          "fixed_interval": "1h"
  	      }
        }
      }
    }
  }
}

允许的阶段：热，冷，冷冻。

在配置的存储库中获取托管索引的快照，并将其挂载为可搜索快照。如果索引是数据流的一部分，则挂载的索引将替换流中的原始索引。

The searchable_snapshot action requires 数据层。该操作使用 index.routing.allocation.include._tier_preference 设置将索引直接挂载到与阶段对应的数据层。在冻结阶段，该操作将一个前缀为 partial- 的部分挂载索引挂载到冻结层。在其他阶段，该操作将一个前缀为 restored- 的完全挂载索引挂载到相应的数据层。

在冻结层中，操作将忽略原始索引中存在的 index.routing.allocation.total_shards_per_node 设置， 以考虑冻结层与其他层之间节点数量的差异。要为可搜索快照设置 index.routing.allocation.total_shards_per_node，请在 ILM 策略的冻结阶段中的 searchable_snapshot 操作内设置 total_shards_per_node 选项。

如果在热阶段使用了searchable_snapshot操作，则后续阶段不能包含shrink或forcemerge操作。

此操作无法在数据流的写入索引上执行。尝试这样做将会失败。要将索引转换为可搜索快照，首先需要手动滚动数据流。这将创建一个新的写入索引。由于该索引不再是流的写入索引，因此可以将其转换为可搜索快照。使用在热阶段中使用滚动操作的策略将避免这种情况，并且无需为未来的托管索引进行手动滚动。

默认情况下，此快照会在删除阶段的删除操作中被删除。 要保留快照，请在删除操作中将delete_searchable_snapshot设置为false。此快照保留基于索引生命周期管理（ILM）策略运行，不受快照生命周期管理（SLM）策略的影响。

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "cold": {
        "actions": {
          "searchable_snapshot" : {
            "snapshot_repository" : "backing_repo"
          }
        }
      }
    }
  }
}

允许的阶段：热、温、冷。

设置索引的优先级， 一旦策略进入热、温或冷阶段。 优先级较高的索引在节点重启后会优先于优先级较低的索引进行恢复。

通常，热阶段的索引应具有最高值，冷阶段的索引应具有最低值。 例如：热阶段为100，暖阶段为50，冷阶段为0。 未设置此值的索引具有默认优先级1。

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "warm": {
        "actions": {
          "set_priority" : {
            "priority": 50
          }
        }
      }
    }
  }
}

允许的阶段：热，暖。

源索引上的块写入并将其收缩为具有较少主分片的新索引。生成的索引名称是 shrink--。此操作对应于 收缩索引 API。

在执行了shrink操作后，任何指向源索引的别名都会指向新的收缩索引。如果ILM对数据流的备份索引执行了shrink操作，收缩后的索引将替换流中的源索引。您不能对写入索引执行shrink操作。

要在hot阶段使用shrink操作，rollover操作必须存在。如果没有配置rollover操作，ILM将拒绝该策略。

收缩操作将取消设置索引的 index.routing.allocation.total_shards_per_node 设置，这意味着将没有限制。这是为了确保索引的所有分片都可以复制到单个节点上。此设置更改将在步骤完成后继续保留在索引上。

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "warm": {
        "actions": {
          "shrink" : {
            "number_of_shards": 1
          }
        }
      }
    }
  }
}

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "warm": {
        "actions": {
          "shrink" : {
            "max_primary_shard_size": "50gb"
          }
        }
      }
    }
  }
}

允许的阶段：热、温、冷、冻结。

将一个CCR跟随者索引转换为常规索引。 这使得可以在跟随者索引上安全地执行收缩、滚动更新和可搜索快照操作。 您也可以在通过生命周期移动跟随者索引时直接使用取消跟随操作。 对非跟随者索引没有影响，阶段执行只是移动到下一个操作。

此操作会等待，直到可以安全地将跟随者索引转换为常规索引。 必须满足以下条件：

一旦满足这些条件，unfollow 将执行以下操作：

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "unfollow" : {}
        }
      }
    }
  }
}

允许的阶段：删除。

等待指定的SLM策略执行完毕后再删除索引。 这样可以确保已删除索引的快照可用。

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "delete": {
        "actions": {
          "wait_for_snapshot" : {
            "policy": "slm-policy-name"
          }
        }
      }
    }
  }
}