couchbase/sdk-doctor

SDK Doctor Docker镜像技术文档

镜像概述与主要用途

SDK Doctor Docker镜像是基于Couchbase SDK Doctor工具构建的容器化解决方案，用于诊断应用服务器端与Couchbase集群之间的连接问题。通过容器化部署，该镜像可简化工具的安装与运行流程，无需在本地环境直接安装依赖，适用于快速排查Couchbase集群连接故障。

核心功能与特性

• 连接诊断：诊断应用服务器端与Couchbase集群的连接性问题（如网络可达性、协议兼容性等）。
• Bucket支持：需指定目标Couchbase集群的Bucket名称，确保诊断针对具体数据存储单元。
• 安全认证兼容：支持Couchbase 5.0+集群的安全标准配置，可通过用户名密码进行身份验证。

使用场景与适用范围

• 开发调试：应用开发阶段，排查因连接配置错误（如地址、端口、Bucket名错误）导致的集群访问失败。
• 运维排查：生产环境中，诊断Couchbase集群连接故障（如认证失败、网络隔离、超时等问题）。
• 配置验证：验证Couchbase集群的网络策略、安全设置（如用户名密码权限）是否符合应用连接要求。

使用方法与配置说明

基本使用流程

通过docker run命令启动容器，执行diagnose子命令并传入Couchbase集群连接参数，即可完成诊断。

核心配置参数

部署示例

1. 基础诊断（Couchbase 5.0以下集群）

对于未启用安全认证的Couchbase集群（5.0版本以下），仅需指定集群连接字符串（含Bucket名）：

bash
docker run --rm [镜像名称] diagnose couchbase://<集群IP>/<Bucket名>

示例：诊断本地Couchbase集群的default Bucket连接

bash
docker run --rm sdk-doctor diagnose couchbase://127.0.0.1/default

2. 带认证的诊断（Couchbase 5.0+集群）

对于启用安全配置的Couchbase 5.0+集群，需通过-u和-p指定管理员用户名及密码：

bash
docker run --rm [镜像名称] diagnose couchbase://<集群IP>/<Bucket名> -u <用户名> -p <密码>

示例：诊断本地Couchbase 5.0+集群的default Bucket连接（用户Administrator，密码password）

bash
docker run --rm sdk-doctor diagnose couchbase://127.0.0.1/default -u Administrator -p password

3. Docker Compose集成示例

若需在现有Docker环境中集成诊断流程（如与Couchbase集群容器联动），可通过docker-compose.yml定义服务：

yaml
version: '3'
services:
  couchbase-cluster:  # 示例Couchbase集群服务（需提前部署）
    image: couchbase/server:latest
    ports:
      - "8091:8091"  # 管理端口
      - "11210:11210" # 数据端口

  sdk-doctor:  # SDK Doctor诊断服务
    image: sdk-doctor
    command: diagnose couchbase://couchbase-cluster/default -u Administrator -p password
    depends_on:
      - couchbase-cluster  # 确保集群启动后执行诊断

注意事项

• 网络互通：Docker容器需与Couchbase集群网络互通（如通过Docker网络、宿主机端口映射或跨主机网络）。
• 地址正确性：连接字符串中的集群地址需使用容器可访问的地址（如Docker网络内的服务名couchbase-cluster或宿主机IP）。
• 权限要求：诊断使用的用户名需具备集群访问权限（如Administrator角色），否则可能因权限不足导致诊断结果不准确。