timveil/cockroachdb-single-node

CockroachDB Single Node Docker镜像

镜像概述和主要用途

这是一个简单的CockroachDB Docker镜像，基于官方CockroachDB镜像扩展，旨在简化单节点数据库的部署和使用。该镜像会自动启动单节点CockroachDB实例，适用于CI/CD流水线、功能测试等场景。支持通过环境变量配置数据库创建和存储方式，镜像托管于DockerHub，可通过https://hub.docker.com/repository/docker/timveil/cockroachdb-single-node%E8%AE%BF%E9%97%AE%E3%80%82

核心功能和特性

• 自动启动单节点：基于官方CockroachDB镜像构建，启动时自动执行单节点初始化流程
• 数据库自动创建：通过DATABASE_NAME环境变量指定需自动创建的数据库名称
• 内存存储支持：通过MEMORY_SIZE环境变量配置内存存储大小（遵循CockroachDB存储规格）
• 轻量集成：简化配置，可直接作为服务容器集成到自动化流程中

使用场景和适用范围

• CI/CD流水线：作为测试环境的临时数据库服务，支持自动化测试流程
• 功能测试：为开发或测试阶段提供独立的单节点数据库实例
• GitHub Actions服务容器：特别适用于GitHub Actions中的https://docs.github.com/en/actions/using-containerized-services/about-service-containers%E9%85%8D%E7%BD%AE%EF%BC%8C%E6%8F%90%E4%BE%9B%E6%B5%8B%E8%AF%95%E4%BE%9D%E8%B5%96%E7%9A%84%E6%95%B0%E6%8D%AE%E5%BA%93%E7%8E%AF%E5%A2%83

详细使用方法和配置说明

环境变量配置

Docker运行示例

通过以下命令启动镜像，映射数据库端口并配置环境变量：

bash
docker run -d -it -p 8080:8080 -p 26257:26257 -e "DATABASE_NAME=test" -e "MEMORY_SIZE=.5" timveil/cockroachdb-single-node:latest

端口说明：26257为CockroachDB默认SQL端口，8080为Web UI端口

GitHub Actions服务容器配置示例

在GitHub Actions工作流中作为服务容器使用时，可按以下配置集成：

yaml
# 工作流配置片段
cockroachdb:
  runs-on: ubuntu-latest
  services:
    cockroach:  # 服务容器定义
      image: timveil/cockroachdb-single-node:latest
      env:
        DATABASE_NAME: benchbase  # 自动创建名为benchbase的数据库
      ports:
        - 26257:26257  # 映射数据库端口供后续步骤访问
  steps:
    - name: Checkout代码
      uses: actions/checkout@v2
    - name: 配置JDK 11
      uses: actions/setup-java@v1
      with:
        java-version: 11
    - name: Maven构建
      run: mvn -B package --file pom.xml

构建与发布（开发者参考）

构建镜像

bash
docker build --no-cache -t timveil/cockroachdb-single-node:latest .

发布镜像

bash
docker push timveil/cockroachdb-single-node:latest