acidozik/elasticsearch-curator

镜像概述

本Docker镜像提供了与AWS OpenSearch 1.3.0版本兼容的Elastic Curator工具。Elastic Curator是一款用于管理Elasticsearch/OpenSearch索引生命周期的工具，可实现索引的创建、删除、优化、快照等操作，帮助用户自动化索引管理流程，提升集群性能和资源利用率。

核心功能和特性

• 兼容性适配：针对AWS OpenSearch 1.3.0版本进行兼容性优化，确保所有操作符合该版本API规范
• 索引生命周期管理：支持索引创建、删除、别名管理、分片调整等核心操作
• 自动化任务：可配置定时任务，实现索引自动清理、优化等周期性操作
• 灵活配置：通过YAML配置文件定义操作规则，支持自定义索引筛选条件和执行策略
• 安全支持：兼容AWS OpenSearch的IAM认证和基本认证方式

使用场景和适用范围

• 索引清理：定期删除过期历史索引，释放存储空间
• 索引优化：对大索引进行分片调整、force-merge等优化操作
• 快照管理：自动创建索引快照并存储到S3等存储服务
• 索引迁移：协助索引数据迁移和别名切换
• AWS OpenSearch 1.3.0集群：适用于需要自动化管理索引生命周期的AWS OpenSearch 1.3.0环境

使用方法和配置说明

基本使用方式

1. 拉取镜像

bash
docker pull [镜像仓库地址]/elastic-curator-aws-opensearch:latest

2. 运行容器

基本命令格式：

bash
docker run -v /path/to/config:/config [镜像仓库地址]/elastic-curator-aws-opensearch:latest curator [命令] /config/action.yml

配置文件说明

需准备两个核心配置文件：

1. config.yml（Curator配置文件）：

yaml
client:
  hosts:
    - https://your-opensearch-endpoint.amazonaws.com:443
  aws_sign_request: True  # 启用AWS签名请求
  region: us-east-1  # AWS区域
  ssl:
    verify_certs: True
logging:
  loglevel: INFO

2. action.yml（操作定义文件）：

yaml
actions:
  1:
    action: delete_indices
    description: "删除30天前的日志索引"
    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

挂载配置文件运行示例

bash
docker run -v /local/path/to/config:/config \
  -e AWS_ACCESS_KEY_ID=your-access-key \
  -e AWS_SECRET_ACCESS_KEY=your-secret-key \
  [镜像仓库地址]/elastic-curator-aws-opensearch:latest \
  curator /config/action.yml --config /config/config.yml

环境变量说明

定时任务配置

可结合crontab实现周期性执行：

bash
# 每天凌晨2点执行索引清理
0 2 * * * docker run -v /path/to/config:/config -e AWS_ACCESS_KEY_ID=xxx -e AWS_SECRET_ACCESS_KEY=xxx [镜像仓库地址]/elastic-curator-aws-opensearch:latest curator /config/action.yml --config /config/config.yml >> /var/log/curator.log 2>&1