ydbplatform/local-ydb

Local YDB Docker 镜像文档

镜像概述

Local YDB 是一个单节点的 YDB 测试集群 Docker 镜像，专为本地开发、调试 YQL 查询及 CI（持续集成）流程设计。它提供了简单的部署方式，可快速搭建独立的 YDB 环境，无需复杂的集群配置，适合开发人员在本地验证功能或集成到自动化测试流程中。

核心功能与特性

• 单节点部署：无需复杂集群配置，一键启动完整的 YDB 测试环境
• Web 监控界面：内置 Web UI，可直观监控集群状态与指标
• 多端口支持：包含 gRPC 端口（TLS 与非 TLS）、监控端口及 Kafka 代理端口
• 数据持久化：支持通过卷挂载持久化存储证书和数据
• 灵活标签策略：提供多种标签版本，满足稳定版、测试版等不同场景需求

使用场景

• 本地开发环境：开发人员在本地快速搭建 YDB 环境进行功能开发
• YQL 查询调试：直接在本地测试和调试 YQL 查询语句
• CI/CD 流程：集成到自动化测试流程中，作为测试环境验证代码变更
• 功能验证：验证 YDB 新特性或配置变更的效果

使用方法

运行容器

使用以下命令启动 Local YDB 容器：

bash
docker run -d --rm --name ydb-local -h localhost \
  --platform linux/amd64 \
  -p 2135:2135 -p 2136:2136 -p 8765:8765 -p 9092:9092 \
  -v $(pwd)/ydb_certs:/ydb_certs -v $(pwd)/ydb_data:/ydb_data \
  -e GRPC_TLS_PORT=2135 -e GRPC_PORT=2136 -e MON_PORT=8765 \
  -e YDB_KAFKA_PROXY_PORT=9092 \
  ydbplatform/local-ydb:latest

参数说明

Apple Silicon 处理器用户注意事项

若使用搭载 Apple Silicon 处理器的 Mac，需通过 Rosetta 模拟 x86_64 CPU 指令集：

• 使用 https://github.com/abiosoft/colima%EF%BC%9A%E6%89%A7%E8%A1%8C colima start --arch aarch64 --vm-type=vz --vz-rosetta 启动
• 使用 Docker Desktop：确保已安装并启用 Rosetta 2

Web UI 访问

YDB Web 监控界面可通过以下地址访问：
http://localhost:8765

标签命名规则

镜像内部结构

Local YDB 镜像通过 https://github.com/ydb-platform/ydb/blob/main/.github/docker/Dockerfile 构建，容器启动入口点为脚本 https://github.com/ydb-platform/ydb/blob/main/.github/docker/files/initialize_local_ydb%EF%BC%8C%E8%AF%A5%E8%84%9A%E6%9C%AC%E8%B0%83%E7%94%A8 Python 脚本 https://github.com/ydb-platform/ydb/blob/main/ydb/public/tools/local_ydb/__main__.py%E3%80%82%E6%AD%A4 Python 脚本会准备默认配置文件 https://github.com/ydb-platform/ydb/blob/main/ydb/tests/library/harness/resources/default_yaml.yml%EF%BC%8C%E5%B9%B6%E5%90%AF%E5%8A%A8 ydbd 进程。