emeraldsquad/cf-flyway-resource

cf-flyway-resource 镜像文档

镜像概述和主要用途

cf-flyway-resource是基于https://hub.docker.com/_/ubuntu%E6%9E%84%E5%BB%BA%E7%9A%84Concourse-CI%E8%B5%84%E6%BA%90%E9%95%9C%E5%83%8F%EF%BC%8C%E7%94%A8%E4%BA%8E%E9%80%9A%E8%BF%87Flyway%E5%9C%A8Cloud Foundry数据库服务上执行数据库迁移。它提供了与Cloud Foundry数据库服务的无缝连接，支持版本控制和自动化迁移流程，适用于CI/CD环境中的数据库 schema 管理。

核心功能和特性

• 无缝连接Cloud Foundry数据库服务
• 支持所有Flyway CLI命令
• 支持Flyway配置文件
• 兼容Flyway社区版和专业版
• 输出数据库服务元数据信息

使用场景和适用范围

适用于需要通过Concourse-CI自动化管理Cloud Foundry数据库服务迁移的场景，尤其适合：

• CI/CD流程中的数据库版本控制
• 多环境（开发、测试、生产）数据库迁移
• 需要严格审计和追踪数据库变更的场景
• 无法直接从Concourse实例访问数据库服务的环境

详细使用方法和配置说明

resource_types 配置

在Concourse pipeline中定义资源类型：

yml
- name: cf-flyway-resource
  type: docker-image
  source:
    repository: emeraldsquad/cf-flyway-resource
    tag: 5.0.0

resources 配置

定义具体资源实例：

yml
- name: cf-flyway
  type: cf-flyway-resource
  source:
    api: ((pcf-api))   
    username: ((product-name))-ciuser
    password: ((pcf-ciuser-passwd))
    organization: ((product-name))-org
    space: ((pcf-space))
    service: ((database-service-name))

source 参数说明

示例配置：

yml
- name: cf-flyway
  type: cf-flyway-resource
  source:
    api: cf-api-endpoint
    username: cf-user
    password: cf-user-password
    organization: organization-name
    space: space-name
    service: service-instance-name

check 脚本

version

check脚本始终返回当前版本号（UTC时间戳），若未收到版本则生成初始版本。

in 脚本

version

in脚本始终返回当前版本号，因此该资源不能用作输入触发器。

metadata

从Cloud Foundry API读取服务信息生成元数据，示例：

yml
cf_api : https://my.api.endpoint.com
cf_org : organization-name
cf_space : space-name
dashboard_url : https://{hostname}/service-instances/53rv1c30-1n5t-aNc3-Gu1d-000000000000/
metadata_url : /v2/service_instances/53rv1c30-1n5t-aNc3-Gu1d-000000000000
service_instance : cf-db-service-instance-name
service_label : cf-db-service-name
service_plan : cf-db-service-plan

out 脚本

migration

将数据库schema迁移到Cloud Foundry数据库服务。out脚本会：

1. 在Cloud Foundry数据库服务上创建service-key
2. 读取service-key凭据并生成包含连接信息的flyway.conf
3. 执行Flyway命令（默认：flyway info → flyway migrate → flyway info）

生成的flyway.conf默认设置flyway.cleanDisabled=true，用户提供的其他配置会被追加，但以下配置会被覆盖：

conf
flyway.url={service-key jdbc:driver//url/database}  # 由Cloud Foundry service-key凭据覆盖
flyway.user={service-key username}                  # 由Cloud Foundry service-key凭据覆盖
flyway.password={service-key password}              # 由Cloud Foundry service-key凭据覆盖
flyway.locations={params.locations}                 # 由locations参数覆盖（必填）
flyway.cleanDisabled=true                           # 由clean_disabled参数覆盖（可选，默认true）

可通过设置delete_service_key: true自动删除service-key。

支持的数据库

• Azure SQL Database (Cloud Service Broker)
• Azure SQL Database (Microsoft Azure Service Broker)
• a9s PostgreSQL
• Crunchy PostgreSQL
• MySQL for PCF

run_task（可选）

当Concourse实例无法直接访问数据库服务时，可使用run_task: true（默认）：

1. 在Cloud Foundry推送轻量级Flyway应用并绑定到数据库服务
2. 通过Cloud Foundry run-task命令执行Flyway命令
3. 可设置delete_application: true自动解绑并删除应用

推送的应用清单示例：

yml
applications:
- name: {service-instance-name}-flyway
  buildpacks: [binary_buildpack]
  health-check-type: process
  no-route: true
  instances: 0                            # 加快部署速度
  disk_quota: 256M
  memory: 256M
  command: sleep 3600                     # 确保应用1小时后自动停止

SSH访问应用容器：

bash
cf scale {service-instance-name}-flyway -i 1  # 扩展实例数
cf start {service-instance-name}-flyway       # 启动应用
cf ssh {service-instance-name}-flyway         # SSH连接

容器内已配置Flyway CLI：

bash
vcap@xxxxxxxx-xxxx-xxxx-xxxx-xxxx:~$ cd app
vcap@xxxxxxxx-xxxx-xxxx-xxxx-xxxx:~/app$ ./flyway info

使用完毕后停止应用：

bash
cf stop {service-instance-name}-flyway

params 参数说明

使用示例

1. 仅使用必填locations参数

yml
jobs:
- name: deploy
  plan:
  - get: my-app-package
  - put: cf-flyway
    params:
      locations: filesystem:my-app-package/DB/Schema

2. 添加Flyway配置文件

yml
jobs:
- name: deploy
  plan:
  - get: my-app-package
  - put: cf-flyway
    params:
      locations: filesystem:my-app-package/DB/Schema
      flyway_conf: my-app-package/DB/flyway.config

3. 内联Flyway配置

yml
jobs:
- name: deploy
  plan:
  - get: my-app-package
  - put: cf-flyway
    params:
      locations: filesystem:my-app-package/DB/Schema
      flyway_conf: |
        flyway.schemas=dbo
        flyway.connectRetries=2

4. 自定义命令序列

yml
jobs:
- name: deploy
  plan:
  - get: my-app-package
  - put: cf-flyway
    params:
      locations: filesystem:my-app-package/DB/Schema
      commands: [info, validate]

5. 使用Flyway专业版功能

yml
jobs:
- name: deploy
  plan:
  - get: my-app-package
  - put: cf-flyway
    params:
      locations: filesystem:my-app-package/DB/Schema
      commands: [info, undo, info]
      flyway_conf: |
        flyway.licenseKey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

6. 使用jdbc_builder

yml
jobs:
- name: deploy
  plan:
  - get: my-app-package
  - put: cf-flyway
    params:
      locations: filesystem:my-app-package/DB/Schema
      jdbc_builder: |
        echo jdbc:postgresql://$(echo $1 | jq -r '.uri' | grep -Poh '(?<=@).*')

7. 使用run_task并自动删除应用

yml
jobs:
- name: deploy
  plan:
  - get: my-app-package
  - put: cf-flyway
    params:
      run_task: true
      delete_application: true
      locations: filesystem:my-app-package/DB/Schema

8. 自定义内存和磁盘配额

yml
jobs:
- name: deploy
  plan:
  - get: my-app-package
  - put: cf-flyway
    params:
      run_task: true
      locations: filesystem:my-app-package/DB/Schema
      memory: 256M
      disk_quota: 256M

version

out脚本始终返回新的版本号（UTC时间戳）。

metadata

与in脚本生成的元数据格式相同，包含Cloud Foundry服务详细信息。