itzg/elasticsearch-curator

镜像概述

该镜像用于定期运行https://www.elastic.co/guide/en/elasticsearch/client/curator/5.0/about.html%E5%B7%A5%E5%85%B7%EF%BC%8C%E6%8F%90%E4%BE%9B%E5%9F%BA%E4%BA%8E%E6%97%B6%E9%97%B4%E5%92%8C%E5%89%8D%E7%BC%80%E7%9A%84Elasticsearch%E7%B4%A2%E5%BC%95%E7%AE%A1%E7%90%86%E8%83%BD%E5%8A%9B%EF%BC%8C%E5%B8%AE%E5%8A%A9%E8%87%AA%E5%8A%A8%E6%B8%85%E7%90%86%E8%BF%87%E6%9C%9F%E7%B4%A2%E5%BC%95%EF%BC%8C%E4%BC%98%E5%8C%96%E5%AD%98%E5%82%A8%E8%B5%84%E6%BA%90%E3%80%82

核心功能与特性

• 定期执行：按配置周期自动运行curator任务，默认每日执行一次
• 环境变量配置：通过环境变量灵活设置运行参数，无需修改配置文件
• 默认索引过滤：预设清理规则，自动删除前缀为"logstash-"或"metricbeat-"且超过指定年龄的索引
• 可自定义配置：支持通过挂载文件或扩展镜像替换默认配置文件，满足个性化需求

使用场景

适用于需要自动管理Elasticsearch索引生命周期的环境，特别是：

• 日志收集系统（如ELK Stack）中定期清理历史日志索引
• 指标监控系统（如Metricbeat）中自动删除过期指标数据
• 任何需要按时间和前缀策略维护Elasticsearch索引的场景

使用方法与配置说明

环境变量配置

默认配置规则

镜像包含基础配置文件，实现以下默认行为：

• 删除前缀为"logstash-"或"metricbeat-"的索引
• 仅删除创建时间超过$DELETE_AGE天的索引

默认配置文件路径：

• /etc/curator/config.yml：curator基础配置
• /etc/curator/actions.yml：索引管理动作配置

Docker部署示例

基本运行命令

bash
docker run -d \
  -e PERIOD=43200 \          # 每12小时运行一次
  -e ES_HOST=elasticsearch \ # Elasticsearch主机地址
  -e DELETE_AGE=30 \         # 删除30天前的索引
  --name elasticsearch-curator \
  your-image-name

自定义配置文件

若需修改索引过滤规则或动作，可通过挂载自定义配置文件：

bash
docker run -d \
  -e PERIOD=86400 \
  -e ES_HOST=elasticsearch \
  -v /path/to/your/config.yml:/etc/curator/config.yml \
  -v /path/to/your/actions.yml:/etc/curator/actions.yml \
  --name elasticsearch-curator \
  docker.xuanyuan.run/your-image-name

扩展镜像（可选）

也可通过Dockerfile扩展镜像以自定义配置：

dockerfile
FROM your-image-name
COPY custom-config.yml /etc/curator/config.yml
COPY custom-actions.yml /etc/curator/actions.yml