Skip to content
geektr-cloudPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

db-init

PostgreSQL 数据库初始化工具,包含三个命令:

  • pg-init:创建数据库和按需创建账户,将连接信息写入共享目录后退出。
  • dbenv:在没有 shell 或 cat 的容器中合并 dotenv、执行应用。
  • pg-proxy:初始化数据库,并向同一 Pod 内的应用提供免密码的读写或只读代理。

镜像

  • ghcr.io/geektr-cloud/db-init/pg-init
  • ghcr.io/geektr-cloud/db-init/pg-proxy

pg-init 镜像只包含 pg-init,其中嵌入了 dbenv;启用 USE_ENV_TOOL 时会将其释放到输出目录。pg-proxy 是独立镜像。

pg-init

pg-init \
  --upstream 'postgres://postgres:secret@postgres:5432/postgres?sslmode=disable' \
  --database app \
  --expected-versions '17,18,19' \
  --expected-extensions 'vector@0.8' \
  --env-template 'DB_URL=postgresql://{{UserName}}:{{Password}}@{{Host}}:{{Port}}/{{Database}}' \
  --env-template 'RO_DB_URL=postgresql://{{RoUser}}:{{RoPassword}}@{{Host}}:{{Port}}/{{Database}}'

所有配置均可使用环境变量;显式命令行参数优先于环境变量。

环境变量 默认值 说明
UPSTREAM 无,必填 管理连接 URL,数据库部分指向可执行初始化操作的现有数据库
DATABASE 无,必填 目标数据库
USERNAME DATABASE 读写账户名
RO_USERNAME <USERNAME>-ro 只读账户名
EXPECTED_VERSIONS 空 允许的 server version 前缀,逗号分隔
EXPECTED_EXTENSIONS 空 UPSTREAM 管理库中必须已安装的扩展,支持 vector@0.8;不会自动安装到目标库
WAIT_PERIOD_SECONDS 1 临时连接错误的重试间隔
WAIT_TIMEOUT_SECONDS 30 等待 upstream 的总时限
OUTPUT_DIR /outputs 输出目录
USE_DOT_ENV true 写入 .env
USE_ENV_TOOL true 写入 dbenv,并强制启用 .env
USE_SCRIPT_ENV false 写入可 source 的 env
ENV_TEMPLATE_* 无 NAME=模板;显式 --env-template 替换全部环境模板

模板变量为 UserName、Password、RoUser、RoPassword、Host、Port、Database。仅模板引用的账户会被创建。变量使用示例中的裸函数语法,不支持 .UserName、自定义函数或模板继承。没有模板时,默认生成使用读写账户的 DB_URL。

重复执行不会删除已有数据;已创建账户会在每次执行时获得新的随机密码。只读权限覆盖 public 中当前及未来的表和序列。其他 schema 需要额外授权。

dbenv

# 将 dbenv 同目录的 .env 追加到另一个 dotenv 文件
dbenv patch-dotenv /path/to/app.env

# 或指定来源
dbenv patch-dotenv /path/to/app.env --from /outputs/.env

# 合并环境后直接替换为应用进程
dbenv exec /app/server --listen :8080

exec 中 .env 的同名变量覆盖继承环境。

pg-proxy

pg-proxy \
  --upstream 'postgres://postgres:secret@postgres:5432/postgres?sslmode=disable' \
  --database app \
  --expected-versions '17,18,19' \
  --fwd-rw=true \
  --fwd-ro=true

默认监听:

  • 读写:127.0.0.1:5432
  • 只读:127.0.0.1:6543,默认关闭
  • 就绪探针::7654

应用使用目标数据库和任意用户名连接代理,无需密码,并应设置 sslmode=disable 或 prefer。upstream TLS 不受此限制。例如:

postgres://app@127.0.0.1:5432/app?sslmode=disable
postgres://app-ro@127.0.0.1:6543/app?sslmode=disable

免鉴权端口只绑定 loopback,不要通过 Service 或端口转发暴露。探针仅在所有启用的数据端口就绪后监听,可用于 startupProbe.tcpSocket。

容器输出权限

两个镜像均以 UID/GID 65532 运行。挂载 /outputs 时,共享卷必须允许该 UID 写入,例如配置合适的 fsGroup。

scratch 镜像不预装 CA 根证书。需要校验 upstream TLS 证书时,应提供 sslrootcert 指向已挂载的 CA 文件。

开发

make test          # 单元测试与 race detector
make build         # 构建三个本地二进制
make docker-build  # 构建两个镜像

docker compose -f test/e2e/compose.yaml up -d
make test-e2e

GitHub Actions 不运行 e2e。推送 pg-init/v* 标签会构建、测试并发布两个 GHCR 镜像的 latest 和对应版本标签。

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages