stakater/elasticsearch-backup

elasticsearch-backup 镜像文档

镜像概述

elasticsearch-backup是一个专为Elasticsearch设计的sidecar容器镜像，用于持续备份Elasticsearch数据。它与Elasticsearch容器并行运行，按照用户配置的时间间隔，对/usr/share/elasticsearch/data目录中的数据进行备份。备份过程中会将数据压缩为yyyy.mm.dd-HH-MM-SS.tar.gz格式的文件，并自动推送至指定的AWS S3存储桶，实现数据的安全存储与灾备。

核心功能与特性

• 持续运行模式：作为sidecar容器与Elasticsearch容器协同工作，全程监控并执行备份任务
• 定时备份机制：支持用户自定义备份间隔，灵活配置备份频率
• 自动数据压缩：备份数据自动压缩为yyyy.mm.dd-HH-MM-SS.tar.gz格式，优化存储空间
• AWS S3集成：直接将压缩后的备份文件推送至AWS S3桶，实现异地数据存储

使用场景与适用范围

• Elasticsearch集群日常数据备份与归档
• 生产环境Elasticsearch数据灾备方案
• 需要定期保存Elasticsearch历史数据的业务场景
• 对数据安全性和可恢复性有要求的企业级应用

使用方法与配置说明

环境要求

• 已部署Elasticsearch容器，且数据目录为/usr/share/elasticsearch/data
• 具备AWS S3存储桶及有效的访问凭证（Access Key）
• Docker环境已正确配置

核心配置参数

Docker Run部署示例

bash
docker run -d \
  --name es-backup \
  --link elasticsearch:elasticsearch \
  -v /path/to/elasticsearch/data:/usr/share/elasticsearch/data \
  -e BACKUP_INTERVAL=3600 \
  -e S3_BUCKET=es-backup-bucket \
  -e AWS_REGION=us-west-2 \
  -e AWS_ACCESS_KEY_ID=AKIAXXXXXXXXXXXX \
  -e AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
  elasticsearch-backup:latest

Docker Compose配置示例

yaml
version: '3.8'
services:
  elasticsearch:
    image: elasticsearch:8.11.0
    volumes:
      - es_data:/usr/share/elasticsearch/data
    environment:
      - discovery.type=single-node
      - ES_JAVA_OPTS=-Xms512m -Xmx512m
    ports:
      - "9200:9200"

  es-backup:
    image: elasticsearch-backup:latest
    volumes:
      - es_data:/usr/share/elasticsearch/data
    environment:
      - BACKUP_INTERVAL=3600
      - S3_BUCKET=es-backup-bucket
      - AWS_REGION=us-west-2
      - AWS_ACCESS_KEY_ID=AKIAXXXXXXXXXXXX
      - AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    depends_on:
      - elasticsearch

volumes:
  es_data:

注意事项

• 确保Elasticsearch数据卷正确挂载至容器内的/usr/share/elasticsearch/data路径
• AWS访问凭证需具备S3桶的写入权限（推荐配置最小权限原则）
• 备份间隔应根据业务数据更新频率合理设置，避免过短影响性能或过长导致数据丢失风险
• 更多详细配置与使用说明可参考项目GitHub仓库