CockroachDB Remote Client 镜像文档

镜像概述和主要用途

CockroachDB Remote Client是一个用于对CockroachDB集群执行简单任务后自动退出的Docker镜像。该镜像主要用于执行一次性操作，如创建数据库、创建用户、设置集群配置参数或初始化集群等。其设计初衷是在Kubernetes或Docker Compose等编排环境中，作为临时服务完成初始化配置任务，任务执行完毕后容器自动退出。

核心功能和特性

• 支持连接CockroachDB集群并执行基础管理操作
• 可创建指定名称的数据库
• 可创建数据库用户（自动赋予admin权限）
• 支持配置集群组织信息和企业许可证
• 支持初始化CockroachDB集群（执行cockroach init命令）
• 支持安全和非安全两种连接方式
• 任务完成后自动终止容器，不常驻运行

使用场景和适用范围

• CockroachDB集群部署后的初始化配置（如创建业务数据库和用户）
• 在Docker Compose环境中作为依赖服务，确保集群启动后自动执行初始化操作
• 在Kubernetes环境中作为Job资源，执行一次性集群配置任务
• 需要临时连接CockroachDB集群执行简单SQL操作或配置修改的场景

使用方法和配置说明

环境变量配置

该镜像通过环境变量进行配置，支持以下参数（详细连接说明可参考CockroachDB***文档）：

Docker Compose配置示例

以下是在Docker Compose中使用该镜像的典型配置示例，其中crdb-init服务即为使用该镜像的临时初始化服务：

services:
  # CockroachDB节点服务（示例）
  crdb-0:
    ...
  
  crdb-1:
    ...
  
  crdb-2:
    ...

  # 负载均衡服务（示例）
  lb:
    container_name: lb
    hostname: lb
    image: timveil/dynamic-haproxy:latest
    ports:
      - "26257:26257"  # CockroachDB SQL端口
      - "8080:8080"    # 集群UI端口
      - "8081:8081"
    environment:
      - NODES=crdb-0 crdb-1 crdb-2  # 集群节点列表
    depends_on:
      - crdb-0
      - crdb-1
      - crdb-2

  # CockroachDB初始化服务（使用当前镜像）
  crdb-init:
    container_name: crdb-init
    hostname: crdb-init
    image: timveil/cockroachdb-remote-client:latest
    environment:
      - COCKROACH_HOST=crdb-0:26257  # 连接地址（必填）
      - COCKROACH_INSECURE=true       # 使用非安全连接
      - DATABASE_NAME=test            # 要创建的数据库名称
    depends_on:
      - lb  # 依赖负载均衡服务或集群节点服务

镜像构建与发布

构建镜像

如需自行构建镜像，可使用以下命令：

docker build --no-cache -t timveil/cockroachdb-remote-client:latest .

发布镜像

构建完成后，可通过以下命令将镜像推送到镜像仓库：

docker push timveil/cockroachdb-remote-client:latest

运行镜像

基础运行

直接运行镜像（需通过环境变量指定必要参数）：

docker run -it timveil/cockroachdb-remote-client:latest

指定环境变量运行

通过环境变量配置连接信息和任务参数：

docker run \
    --env COCKROACH_HOST=localhost:26257 \  # 连接本地CockroachDB节点
    --env COCKROACH_INSECURE=true \         # 非安全连接模式
    --env DATABASE_NAME=test \              # 创建名为test的数据库
    --env COCKROACH_INIT=true \             # 初始化集群
    -it timveil/cockroachdb-remote-client:latest