aristanetworks/curator

Elasticsearch Curator 镜像文档

镜像概述

Elasticsearch Curator 是一款专为管理 Elasticsearch 索引设计的工具，本镜像发布于 Docker Hub，提供了便捷的容器化部署方式。它允许用户通过配置文件或命令行操作，实现对 Elasticsearch 索引的生命周期管理，包括索引的创建、删除、备份、优化、快照等操作，适用于需要定期维护 Elasticsearch 集群的场景。

核心功能与特性

• 索引生命周期管理：支持按时间、大小等条件自动管理索引，如删除旧索引、归档历史数据。
• 索引操作：提供创建、删除、关闭、打开、优化（force merge）索引等基础操作。
• 快照管理：支持创建、删除、恢复 Elasticsearch 快照，实现数据备份与恢复。
• 配置灵活性：支持通过 YAML 配置文件定义操作规则，或直接通过命令行参数执行操作。
• 容器化部署：轻量级镜像，易于集成到 Docker 或 Kubernetes 环境中，支持定时任务调度。

使用场景与适用范围

• 日志管理系统：定期清理过期日志索引，释放存储空间。
• 监控平台：管理监控指标索引，按时间归档或删除历史数据。
• 数据分析平台：优化索引结构，提升查询性能，或备份重要分析数据。
• Elasticsearch 集群维护：自动化执行索引维护任务，减少人工操作成本。

使用方法与配置说明

基本使用（Docker Run）

执行单次索引操作：

bash
docker run --rm \
  -e ELASTICSEARCH_HOST=elasticsearch \
  -e ELASTICSEARCH_PORT=9200 \
  -v /path/to/curator/config:/config \
  docker-library/elasticsearch-curator \
  curator /config/action.yml --config /config/config.yml

Docker Compose 配置示例

yaml
version: '3'
services:
  curator:
    image: docker-library/elasticsearch-curator
    environment:
      - ELASTICSEARCH_HOST=elasticsearch
      - ELASTICSEARCH_PORT=9200
      - LOG_LEVEL=INFO
    volumes:
      - ./curator/config:/config
    command: curator /config/action.yml --config /config/config.yml
    depends_on:
      - elasticsearch

配置文件说明

1. 主配置文件（config.yml）

定义 Elasticsearch 连接信息及全局设置：

yaml
client:
  hosts:
    - ${ELASTICSEARCH_HOST}
  port: ${ELASTICSEARCH_PORT}
  timeout: 30
  master_only: False
logging:
  loglevel: ${LOG_LEVEL:-INFO}
  logfile: /var/log/curator/curator.log
  logformat: default

2. 操作配置文件（action.yml）

定义具体索引操作规则，例如删除 30 天前的日志索引：

yaml
actions:
  1:
    action: delete_indices
    description: "Delete indices older than 30 days"
    options:
      ignore_empty_list: True
      timeout_override:
      continue_if_exception: False
      disable_action: False
    filters:
      - filtertype: pattern
        kind: prefix
        value: log-
      - filtertype: age
        source: creation_date
        direction: older
        unit: days
        unit_count: 30

环境变量说明

定时任务调度

结合 cron 服务实现定期执行（示例：每天凌晨 2 点执行）：

bash
# 在主机上创建 cron 任务
echo "0 2 * * * docker run --rm -v /path/to/config:/config docker-library/elasticsearch-curator curator /config/action.yml --config /config/config.yml" | crontab -

注意事项

• 确保 Elasticsearch 集群与 Curator 容器网络互通，可通过 --network 参数指定网络。
• 操作前建议先通过 --dry-run 参数测试配置，避免误操作：

  bash
  docker run --rm ... curator /config/action.yml --config /config/config.yml --dry-run
  

• 对于生产环境，建议挂载日志目录（如 /var/log/curator）以便排查问题。