tugboatqa/elasticsearch

Elasticsearch Tugboat 适配镜像 技术文档

1. 镜像概述和主要用途

1.1 镜像基础

本镜像基于官方 Elasticsearch 镜像扩展构建，专门优化以适配 Tugboat 环境。

1.2 版本标签说明

• 2.x 系列标签：基于 Docker Hub 官方 https://hub.docker.com/_/elasticsearch/ 扩展，适配 Tugboat 环境。
• 更新版本标签：基于 Elastic.co 官方维护的 Elasticsearch 镜像（底层系统为 CentOS）扩展，适配 Tugboat 环境。

1.3 主要用途

在 Tugboat 开发、测试或 CI/CD 环境中提供开箱即用的 Elasticsearch 服务，支持依赖 Elasticsearch 的应用在 Tugboat 工作流中快速部署和运行。

2. 核心功能和特性

2.1 Elasticsearch 核心功能

• 全文搜索：支持复杂的全文检索，提供高性能的文本分析和查询能力。
• 实时分析：支持对结构化、非结构化数据的实时聚合和分析。
• 分布式架构：原生支持水平扩展，具备自动分片、副本机制，确保高可用和容错性。
• RESTful API：通过 HTTP/JSON 接口提供便捷的交互方式，支持索引管理、数据CRUD、查询等操作。

2.2 镜像扩展特性

• Tugboat 兼容性：针对 Tugboat 环境的网络配置、资源管理等进行优化，确保服务稳定运行。
• 官方镜像可靠性：基于 Elasticsearch 官方镜像构建，继承其安全性、更新机制和社区支持。
• 版本适配：不同标签对应不同版本的 Elasticsearch 官方镜像，满足多样化版本需求。

3. 使用场景和适用范围

3.1 适用场景

• Tugboat 开发环境：团队协作开发中，为依赖 Elasticsearch 的应用提供本地一致的搜索服务环境。
• CI/CD 流程集成：在 Tugboat 自动化测试流程中，作为测试环境的搜索服务组件，验证应用与 Elasticsearch 的交互逻辑。
• 演示环境部署：快速搭建包含 Elasticsearch 的演示环境，展示应用的搜索和分析功能。

3.2 适用范围

• 需要在 Tugboat 平台运行 Elasticsearch 的开发/测试团队。
• 依赖特定版本 Elasticsearch（2.x 或更新版本）且需与 Tugboat 环境兼容的应用。

4. 使用方法和配置说明

4.1 基本使用（docker run 命令）

bash
# 示例：使用最新标签启动单节点 Elasticsearch（适配 Tugboat）
docker run -d \
  --name tugboat-elasticsearch \
  -p 9200:9200 \
  -e "discovery.type=single-node" \  # 单节点模式（适用于开发/测试）
  -e "ES_JAVA_OPTS=-Xms512m -Xmx512m" \  # 配置 JVM 内存
  your-registry/elasticsearch-tugboat:latest  # 替换为实际镜像名称和标签

注：2.x 版本标签使用方法类似，只需将标签替换为 2.x（如 your-registry/elasticsearch-tugboat:2.x）。

4.2 Docker Compose 配置示例

在 Tugboat 项目中，可通过 docker-compose.yml 集成该镜像：

yaml
version: '3.8'
services:
  elasticsearch:
    image: your-registry/elasticsearch-tugboat:latest  # 镜像名称和标签
    container_name: tugboat-es
    ports:
      - "9200:9200"  # HTTP API 端口
      - "9300:9300"  # 节点间通信端口（集群模式需开放）
    environment:
      - discovery.type=single-node  # 单节点模式（开发测试用）
      - ES_JAVA_OPTS=-Xms1g -Xmx1g  # 根据 Tugboat 资源调整 JVM 内存
      - xpack.security.enabled=false  # 禁用 X-Pack 安全（开发环境简化）
    volumes:
      - es-data:/usr/share/elasticsearch/data  # 数据持久化（可选）
    networks:
      - tugboat-network  # 接入 Tugboat 项目网络

networks:
  tugboat-network:
    external: true  # 使用 Tugboat 现有网络

volumes:
  es-data:  # 数据卷（可选，用于持久化 Elasticsearch 数据）

4.3 环境变量说明

该镜像继承官方 Elasticsearch 镜像的环境变量，常用配置如下：

4.4 注意事项

• 版本标签选择：根据应用依赖的 Elasticsearch 版本选择对应标签，2.x 标签基于 Docker Hub 官方镜像，更新标签基于 Elastic.co 官方 CentOS 镜像。
• Tugboat 资源配置：确保 Tugboat 环境分配足够的 CPU 和内存（建议至少 2GB 内存），避免因资源不足导致服务异常。
• 数据持久化：开发/测试环境可省略数据卷挂载，生产环境需配置持久化存储以防止数据丢失。
• 网络访问：在 Tugboat 中需确保容器端口（如 9200）对外暴露，以便其他服务或本地工具访问 Elasticsearch API。