kukymbr/goose-docker

goose-docker

Docker配置，用于https://github.com/pressly/goose%E6%95%B0%E6%8D%AE%E5%BA%93%E8%BF%81%E7%A7%BB%E5%B7%A5%E5%85%B7%E3%80%82%E5%9F%BA%E4%BA%8E%60gomicro/docker-goose%60%E4%BB%93%E5%BA%93%E7%9A%84%E6%80%9D%E8%B7%AF%E5%BC%80%E5%8F%91%E3%80%82

核心功能与特性

• 无需创建自定义Dockerfile；
• 使用goose环境变量进行配置；
• 支持docker compose使用；
• 支持所有goose命令，不仅限于up；
• 提供amd64/arm64多架构支持（ARM64自v3.23.0起支持）。

Docker Hub注意事项

该镜像的基础仓库位于GitHub。Docker Hub上的版本可能已过时。

请访问https://ghcr.io/kukymbr/goose-docker%E8%8E%B7%E5%8F%96%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC%E3%80%82

使用方法

镜像环境变量

以下环境变量为镜像正常工作所必需：

• GOOSE_DRIVER：指定数据库驱动（例如：postgres）。
• GOOSE_DBSTRING：指定数据库连接参数（例如：host=localhost port=5432 user=postgres password=postgres dbname=postgres）。

以下环境变量可选：

• GOOSE_COMMAND：要执行的goose命令，默认值为up。
• GOOSE_COMMAND_ARG：goose命令的参数，例如up-to/down-to命令所需的VERSION参数。
• GOOSE_VERBOSE：若设置为true，goose将以-v标志执行。
• GOOSE_EXTRA_ARGS：额外的goose参数，例如GOOSE_EXTRA_ARGS="-table=_db_version -allow-missing"（仅在latest标签中可用，直至下一个goose版本发布）。

有关可用驱动、连接字符串格式和命令的详细信息，请参阅https://github.com/pressly/goose#usage%E3%80%82

goose的.env文件

若要通过.env文件向goose传递环境变量（goose自v3.24.0起支持，详情参见https://github.com/pressly/goose#environment-variables%EF%BC%89%EF%BC%8C%E9%9C%80%E5%B0%86%60.env%60%E6%96%87%E4%BB%B6%E6%8C%82%E8%BD%BD%E5%88%B0%60/goose-docker%60%E7%9B%AE%E5%BD%95%EF%BC%8C%E4%BE%8B%E5%A6%82%EF%BC%9A

shell
docker run --rm -v ./migrations:/migrations -v my_goose.env:/goose-docker/.env --network host \
  -e GOOSE_DRIVER="postgres" \
  -e GOOSE_DBSTRING="host=localhost port=5432 user=postgres password=postgres dbname=postgres" \
  ghcr.io/kukymbr/goose-docker:3.24.2

迁移文件目录

镜像期望将/migrations目录挂载到容器中，该目录应包含迁移文件。

使用示例

基础docker命令调用

shell
docker run --rm -v ./migrations:/migrations --network host \
  -e GOOSE_DRIVER="postgres" \
  -e GOOSE_DBSTRING="host=localhost port=5432 user=postgres password=postgres dbname=postgres" \
  ghcr.io/kukymbr/goose-docker:3.24.2

up-to命令示例

shell
docker run --rm -v ./migrations:/migrations --network host \
  -e GOOSE_COMMAND="up-to" \
  -e GOOSE_COMMAND_ARG="20230607203836" \
  -e GOOSE_DRIVER="postgres" \
  -e GOOSE_DBSTRING="host=localhost port=5432 user=postgres password=postgres dbname=postgres" \
  ghcr.io/kukymbr/goose-docker:3.24.2

create命令示例（自v3.20.0起支持）

shell
docker run --rm -v ./migrations:/migrations \
  -e GOOSE_COMMAND="create" \
  -e GOOSE_COMMAND_ARG="my_new_migration_name sql" \
  ghcr.io/kukymbr/goose-docker:latest

docker compose配置

docker compose示例：

yaml
services:
  # ... 添加数据库服务
  
  migrations:
    image: ghcr.io/kukymbr/goose-docker:3.24.2
    environment:
      - GOOSE_DRIVER=postgres
      - GOOSE_DBSTRING=host=postgres port=5432 user=postgres password=postgres dbname=postgres
    volumes:
      - ./migrations:/migrations

完整示例参见https://github.com/kukymbr/goose-docker/blob/main/compose.yml%E6%96%87%E4%BB%B6%E3%80%82

覆盖环境变量

若需动态覆盖docker compose或.env文件中提供的环境变量值，可在environment部分添加带有占位符值的变量，例如：

yaml
migrations:
  # ...
  environment:
    - GOOSE_COMMAND=${GOOSE_COMMAND}
    - GOOSE_COMMAND_ARG=${GOOSE_COMMAND_ARG}

执行时覆盖值：

shell
GOOSE_COMMAND="create" GOOSE_COMMAND_ARG="test_migration sql" docker compose run --rm migrations

嵌入迁移文件

若不想或无法通过卷挂载迁移文件，可创建扩展goose-docker镜像的Dockerfile，并将文件添加到其中：

Dockerfile
FROM ghcr.io/kukymbr/goose-docker:3.24.2

ADD /path/to/migrations /migrations

构建后，即可像使用goose-docker镜像一样使用该自定义镜像。

latest标签注意事项

该镜像的latest标签指向main分支的最新提交，不建议用于生产环境。生产环境应始终指定语义化版本标签。

贡献

贡献相关信息请参阅https://github.com/kukymbr/goose-docker/blob/main/CONTRIBUTING.md%E3%80%82

许可证

https://github.com/kukymbr/goose-docker/blob/main/LICENSE%E3%80%82