opensearchstaging/opensearch-dashboards

OpenSearch Dashboards Docker 暂存镜像文档

1. 镜像概述和主要用途

1.1 概述

本镜像为 OpenSearch Dashboards 的 Docker 暂存（Staging）版本，用于存储和分发开发、测试阶段的镜像版本。暂存镜像包含最新开发特性，支持在正式发布前进行功能验证、兼容性测试及集成验证。

1.2 主要用途

• 为开发团队提供最新测试版本的 OpenSearch Dashboards 镜像，加速功能迭代验证；
• 支持多版本并行测试，验证不同开发分支的兼容性；
• 作为正式发布镜像的前置验证环境，确保发布质量。

2. 核心功能和特性

3. 使用场景和适用范围

3.1 典型使用场景

• 功能开发测试：开发人员拉取暂存镜像，验证新功能（如可视化插件、查询优化）在容器环境中的表现；
• 版本迭代验证：测试团队基于暂存镜像验证版本升级路径，检查数据迁移、配置兼容性；
• 多环境一致性测试：在开发、测试、预发布环境中使用相同暂存镜像，确保环境一致性。

3.2 适用范围

• OpenSearch Dashboards 开发团队、测试团队；
• 需要提前验证新功能的企业用户；
• 基于 OpenSearch 构建自定义监控平台的集成测试场景。

4. 使用方法和配置说明

4.1 前提条件

• 已安装 Docker Engine（20.10+）或 Docker Desktop；
• 已部署对应版本的 OpenSearch 服务端（暂存版或正式版，需确保版本兼容）。

4.2 镜像拉取

暂存镜像托管于 OpenSearch 暂存仓库，拉取命令格式如下：

bash
docker pull <暂存仓库地址>/opensearch-dashboards:<版本标签>

示例（假设暂存仓库地址为 staging.opensearchproject.org）：

bash
docker pull staging.opensearchproject.org/opensearch-dashboards:2.11.0-staging

4.3 基本运行方法（Docker Run）

4.3.1 单机快速启动

bash
docker run -d \
  --name opensearch-dashboards-staging \
  -p 5601:5601 \
  -e "OPENSEARCH_HOSTS=http://<opensearch-staging-host>:9200" \
  -e "DISABLE_SECURITY_DASHBOARDS_PLUGIN=true" \  # 测试环境可禁用安全插件
  staging.opensearchproject.org/opensearch-dashboards:2.11.0-staging

说明：

• -p 5601:5601：映射容器内 Dashboards 端口到主机；
• OPENSEARCH_HOSTS：指定连接的 OpenSearch 服务端地址（需替换为实际暂存/测试集群地址）；
• DISABLE_SECURITY_DASHBOARDS_PLUGIN：测试环境可禁用安全插件（正式环境需启用）。

4.3.2 访问验证

启动后，通过 http://<主机IP>:5601 访问 OpenSearch Dashboards 界面。

4.4 Docker Compose 配置示例

适用于本地开发/测试环境，与 OpenSearch 暂存版联动部署：

yaml
version: '3.8'
services:
  opensearch:
    image: staging.opensearchproject.org/opensearch:2.11.0-staging  # 对应版本的 OpenSearch 暂存镜像
    container_name: opensearch-staging
    environment:
      - discovery.type=single-node
      - DISABLE_SECURITY_PLUGIN=true  # 测试环境禁用安全插件
    ports:
      - "9200:9200"
    networks:
      - opensearch-net

  opensearch-dashboards:
    image: staging.opensearchproject.org/opensearch-dashboards:2.11.0-staging
    container_name: opensearch-dashboards-staging
    environment:
      - OPENSEARCH_HOSTS=http://opensearch-staging:9200  # 连接同一网络内的 OpenSearch 服务
      - DISABLE_SECURITY_DASHBOARDS_PLUGIN=true
    ports:
      - "5601:5601"
    depends_on:
      - opensearch
    networks:
      - opensearch-net

networks:
  opensearch-net:

启动命令：

bash
docker-compose up -d

4.5 配置说明

4.5.1 核心环境变量

4.5.2 自定义配置文件

通过挂载本地配置文件覆盖默认配置（需确保配置文件格式与暂存版本兼容）：

bash
docker run -d \
  --name opensearch-dashboards-staging \
  -p 5601:5601 \
  -v /path/to/local/opensearch_dashboards.yml:/usr/share/opensearch-dashboards/config/opensearch_dashboards.yml \
  staging.opensearchproject.org/opensearch-dashboards:2.11.0-staging

5. 注意事项

• 暂存镜像包含未稳定功能，不建议用于生产环境；
• 版本标签格式可能变更，建议通过暂存仓库官方渠道获取最新标签信息；
• 需确保与 OpenSearch 服务端版本匹配（暂存版对应暂存版，版本号需一致），避免兼容性问题。