stakater/elasticsearch-restore

elasticsearch-restore 镜像文档

镜像概述

elasticsearch-restore是一个初始化容器（init container），主要功能是从AWS S3存储桶恢复Elasticsearch数据。它会将S3中的数据文件下载、解压，并复制到容器间共享的卷路径/usr/share/elasticsearch/data，为Elasticsearch主容器提供初始化数据。

核心功能与特性

• S3数据恢复：支持从AWS S3存储桶下载指定的Elasticsearch数据文件
• 自动解压：对下载的压缩数据文件进行解压缩处理
• 数据复制：将解压后的数据复制到共享卷，供Elasticsearch主容器使用
• 初始化执行：作为init container，确保在Elasticsearch主容器启动前完成数据准备

使用场景

• Elasticsearch集群初次部署时的数据初始化
• Elasticsearch服务迁移或重建时的历史数据恢复
• 灾备场景下从S3备份恢复数据
• 需要在容器启动前预置数据的Elasticsearch部署场景

使用方法与配置说明

环境变量配置

使用该镜像需配置以下环境变量：

Docker Compose示例

以下是与Elasticsearch主容器配合使用的docker-compose配置示例：

yaml
version: '3.8'
services:
  elasticsearch:
    image: docker.elastic.co/elasticsearch/elasticsearch:8.11.3
    volumes:
      - es_data:/usr/share/elasticsearch/data
    depends_on:
      - es_restore
    environment:
      - discovery.type=single-node
      - ES_JAVA_OPTS=-Xms512m -Xmx512m

  es_restore:
    image: elasticsearch-restore:latest
    volumes:
      - es_data:/usr/share/elasticsearch/data
    environment:
      - AWS_ACCESS_KEY_ID=AKIAEXAMPLEKEY
      - AWS_SECRET_ACCESS_KEY=secret123example
      - S3_BUCKET=es-backup-bucket
      - S3_OBJECT_KEY=backups/es_data_20240101.tar.gz
    restart: "no"  # 初始化容器执行完成后退出

volumes:
  es_data:

工作流程说明

1. es_restore容器作为init container首先启动
2. 通过环境变量配置的AWS凭证访问S3存储桶
3. 下载指定路径的压缩数据文件
4. 解压文件并将数据复制到共享卷/usr/share/elasticsearch/data
5. 完成后容器退出
6. Elasticsearch主容器随后启动，从共享卷加载恢复的数据

注意事项

• 确保共享卷es_data有足够的存储空间
• AWS密钥需具备S3读取权限（至少s3:GetObject权限）
• S3中的数据文件需为tar.gz格式的Elasticsearch数据备份
• 初始化容器仅在首次启动或需要恢复数据时执行，建议设置restart: "no"避免重复执行