anjia0532/docker-curator

Docker化的Elasticsearch Curator

这是Elasticsearch Curator的Docker化版本，一个用于管理基于时间的索引的工具。该Docker镜像基于https://hub.docker.com/r/library/python/tags/3.6-alpine/构建（镜像大小仅30MB）。

Docker Hub地址：https://hub.docker.com/r/anjia0532/docker-curator/

镜像概述和主要用途

该镜像提供了Elasticsearch Curator的容器化部署方式，方便用户管理Elasticsearch中基于时间的索引，如自动删除过期索引，以优化存储空间和性能。适用于需要定期清理历史索引的Elasticsearch环境。

核心功能和特性

• 基于轻量级python:3.6-alpine镜像，体积仅30MB
• 支持通过环境变量配置索引管理策略
• 预配置默认的索引删除规则，可自定义扩展
• 支持与Elasticsearch服务集成部署

使用场景和适用范围

• Elasticsearch日志索引管理（如Logstash、Filebeat生成的时间序列索引）
• 需要定期清理过期索引以释放存储空间的场景
• 自动化索引生命周期管理的Docker化部署环境

使用方法和配置说明

docker-compose.yml配置

yaml
version: '2'

services:

  elasticsearch:
    image: docker.elastic.co/elasticsearch/elasticsearch:x.y.z
    ports:
    - 9200:9200/tcp
    #environment:
    #    - http.host=0.0.0.0
    #    - transport.host=127.0.0.1
    # 取消注释以下部分可从卷加载elasticsearch数据
    #volumes:
    #    - /data/path/to/host/:/usr/share/elasticsearch/data

  curator:
    image: anjia0532/docker-curator
    environment:
        UNIT_COUNT: 10
        UNIT: days
        ES_HOST: elasticsearch
    depends_on:
      - elasticsearch
    volumes:
        - /config/path/to/host/:/config

action_file.yml（默认配置）

环境变量默认值

• UNIT_COUNT: 1
• UNIT: months
• ES_HOST: 127.0.0.1

yaml
actions:
  1:
    action: delete_indices
    description: >-
       删除早于${UNIT_COUNT:1} ${UNIT:months}的索引（基于索引名称），适用于logstash-
       前缀的索引。如果过滤器未生成可操作的索引列表，则忽略错误（ignore_empty_list）并正常退出。
    options:
      ignore_empty_list: True
      timeout_override:
      continue_if_exception: True
      disable_action: False
    filters:
    - filtertype: pattern
      kind: prefix
      value: logstash-
      exclude:
    - filtertype: age
      source: name
      direction: older
      timestring: '%Y.%m.%d'
      unit: ${UNIT:months}
      unit_count: ${UNIT_COUNT:1}
      exclude:
#  2:
#    action: delete_indices
#    description: >-
#       删除早于${UNIT_COUNT:1} ${UNIT:months}的索引（基于索引名称），适用于filebeat-
#       前缀的索引。如果过滤器未生成可操作的索引列表，则忽略错误（ignore_empty_list）并正常退出。
#    options:
#      ignore_empty_list: True
#      timeout_override:
#      continue_if_exception: True
#      disable_action: False
#    filters:
#    - filtertype: pattern
#      kind: prefix
#      value: filebeat-
#      exclude:
#    - filtertype: age
#      source: name
#      direction: older
#      timestring: '%Y.%m.%d'
#      unit: ${UNIT:months}
#      unit_count: ${UNIT_COUNT:1}
#      exclude:
#  3:
#    action: delete_indices
#    description: >-
#       删除早于${UNIT_COUNT:1} ${UNIT:months}的索引（基于索引名称），适用于heartbeat-
#       前缀的索引。如果过滤器未生成可操作的索引列表，则忽略错误（ignore_empty_list）并正常退出。
#    options:
#      ignore_empty_list: True
#      timeout_override:
#      continue_if_exception: True
#      disable_action: False
#    filters:
#    - filtertype: pattern
#      kind: prefix
#      value: heartbeat-
#      exclude:
#    - filtertype: age
#      source: name
#      direction: older
#      timestring: '%Y.%m.%d'
#      unit: ${UNIT:months}
#      unit_count: ${UNIT_COUNT:1}
#      exclude:
#  4:
#    action: delete_indices
#    description: >-
#       删除早于${UNIT_COUNT:1} ${UNIT:months}的索引（基于索引名称），适用于zipkin-
#       前缀的索引。如果过滤器未生成可操作的索引列表，则忽略错误（ignore_empty_list）并正常退出。
#    options:
#      ignore_empty_list: True
#      timeout_override:
#      continue_if_exception: True
#      disable_action: False
#    filters:
#    - filtertype: pattern
#      kind: prefix
#      value: zipkin-
#      exclude:
#    - filtertype: age
#      source: name
#      direction: older
#      timestring: '%Y.%m.%d'
#      unit: ${UNIT:months}
#      unit_count: ${UNIT_COUNT:1}
#      exclude:

config_file.yml

环境变量默认值

• USE_SSL: False
• HTTP_AUTH: ''
• TIMEOUT: 120
• MASTER_ONLY: True

---
# 注意，如果没有值，请将键留空。None将是字符串，而非Python的"NoneType"
client:
  hosts:
    - ${ES_HOST:127.0.0.1}
  port: 9200
  url_prefix:
  use_ssl: ${USE_SSL:False}
  certificate:
  client_cert:
  client_key:
  ssl_no_validate: False
  http_auth: ${HTTP_AUTH:''}
  timeout: ${TIMEOUT:120}
  master_only: ${MASTER_ONLY:True}
logging:
  loglevel: INFO
  logfile:
  logformat: default
  #blacklist: ['elasticsearch', 'urllib3']

定时任务配置

每天凌晨0点执行：

bash
0 0 * * * curator --config /config/config_file.yml /config/action_file.yml

Curator完整文档

完整参考文档请访问：[***]

• 配置
  • 环境变量
  • 动作文件
  • 配置文件
• 动作
  • ...
  • 删除索引
  • ...
• ...
• 示例
  • 别名
  • 分配
  • 关闭
  • 集群路由
  • 创建索引
  • 删除索引
  • 删除快照
  • 强制合并
  • 索引设置
  • 打开
  • 重建索引
  • 副本
  • 恢复
  • 滚动更新
  • 快照
• ...