Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
fix(gitops): pin the action image and pass rollout metadata to GitLab prod (#21688)
boojack824a232d8cca
diff --git a/frontend/src/routes/project/ProjectGitOpsPage.tsx b/frontend/src/routes/project/ProjectGitOpsPage.tsxindex 054bf9d7bc..dee343015e 100644--- a/frontend/src/routes/project/ProjectGitOpsPage.tsx+++ b/frontend/src/routes/project/ProjectGitOpsPage.tsx@@ -30,11 +30,16 @@ import { DatabaseGroupView } from "@/types/proto-es/v1/database_group_service_pbimport type { WorkloadIdentity } from "@/types/proto-es/v1/workload_identity_service_pb";import { WorkloadIdentityConfig_ProviderType } from "@/types/proto-es/v1/workload_identity_service_pb";import {- GENERATED_WORKFLOW_AUDIENCE,getWorkloadIdentityProviderText,hasProjectPermissionV2,parseWorkloadIdentitySubjectPattern,} from "@/utils";+import {+ bytebaseActionImage,+ generateGithubReleaseYaml,+ generateGithubSqlReviewYaml,+ generateGitlabCiYaml,+} from "./gitopsWorkflowYaml";import { WorkloadIdentitySelect } from "./WorkloadIdentitySelect";export function ProjectGitOpsPage({ projectId }: { projectId: string }) {@@ -137,6 +142,8 @@ export function ProjectGitOpsPage({ projectId }: { projectId: string }) {[serverInfo]);+ const actionImage = bytebaseActionImage(serverInfo?.version ?? "");+const workloadIdentityEmail = selectedIdentityName? extractWorkloadIdentityId(selectedIdentityName): "{WORKLOAD_IDENTITY_EMAIL}";@@ -183,6 +190,7 @@ export function ProjectGitOpsPage({ projectId }: { projectId: string }) {branch,runsOn,bytebaseUrl,+ actionImage,workloadIdentityEmail,projectId,targetsPlaceholder,@@ -191,6 +199,7 @@ export function ProjectGitOpsPage({ projectId }: { projectId: string }) {branch,runsOn,bytebaseUrl,+ actionImage,workloadIdentityEmail,projectId,targetsPlaceholder,@@ -203,6 +212,7 @@ export function ProjectGitOpsPage({ projectId }: { projectId: string }) {branch,runsOn,bytebaseUrl,+ actionImage,workloadIdentityEmail,projectId,targetsPlaceholder,@@ -211,6 +221,7 @@ export function ProjectGitOpsPage({ projectId }: { projectId: string }) {branch,runsOn,bytebaseUrl,+ actionImage,workloadIdentityEmail,projectId,targetsPlaceholder,@@ -222,11 +233,19 @@ export function ProjectGitOpsPage({ projectId }: { projectId: string }) {generateGitlabCiYaml({branch,bytebaseUrl,+ actionImage,workloadIdentityEmail,projectId,targetsPlaceholder,}),- [branch, bytebaseUrl, workloadIdentityEmail, projectId, targetsPlaceholder]+ [+ branch,+ bytebaseUrl,+ actionImage,+ workloadIdentityEmail,+ projectId,+ targetsPlaceholder,+ ]);const providerMismatchGithub =@@ -673,229 +692,9 @@ function StepItem({);}-// --- YAML generators ----const SAMPLE_FILE_PATH = "migrations/20240101000000_create_sample_table.sql";const SAMPLE_SQL = `CREATE TABLE sample (id SERIAL PRIMARY KEY,name VARCHAR(255) NOT NULL,created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);`;--interface YamlParams {- branch: string;- runsOn?: string;- bytebaseUrl: string;- workloadIdentityEmail: string;- projectId: string;- targetsPlaceholder: string;-}--const exchangeTokenStep = (indent: string) =>- `${indent}- name: Exchange token-${indent} id: bytebase-auth-${indent} run: |-${indent} OIDC_TOKEN=$(curl -s -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \\-${indent} "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=${GENERATED_WORKFLOW_AUDIENCE}" | jq -r '.value')-${indent} ACCESS_TOKEN=$(curl -s -X POST "$BYTEBASE_URL/v1/auth:exchangeToken" \\-${indent} -H "Content-Type: application/json" \\-${indent} -d "{\\"token\\":\\"$OIDC_TOKEN\\",\\"email\\":\\"$BYTEBASE_WORKLOAD_IDENTITY\\"}" \\-${indent} | jq -r '.accessToken')-${indent} echo "access-token=$ACCESS_TOKEN" >> $GITHUB_OUTPUT`;--const accessTokenFlag =- "--access-token=${{ steps.bytebase-auth.outputs.access-token }}";--function generateGithubSqlReviewYaml(p: YamlParams): string {- return `name: SQL Review-on:- pull_request:- branches: ["${p.branch}"]- paths: ["migrations/*.sql"]-jobs:- sql-review:- permissions:- id-token: write- pull-requests: write- runs-on: ${p.runsOn}- container:- image: bytebase/bytebase-action- env:- BYTEBASE_URL: ${p.bytebaseUrl}- BYTEBASE_WORKLOAD_IDENTITY: ${p.workloadIdentityEmail}- steps:- - uses: actions/checkout@v4-${exchangeTokenStep(" ")}- - name: SQL Review- env:- GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}- run: |- bytebase-action check \\- --url=$BYTEBASE_URL \\- ${accessTokenFlag} \\- --project=projects/${p.projectId} \\- --targets=${p.targetsPlaceholder} \\- --file-pattern=migrations/*.sql`;-}--function generateGithubReleaseYaml(p: YamlParams): string {- return `name: Rollout-on:- push:- branches: ["${p.branch}"]- paths: ["migrations/*.sql"]-env:- BYTEBASE_URL: ${p.bytebaseUrl}- BYTEBASE_WORKLOAD_IDENTITY: ${p.workloadIdentityEmail}- BYTEBASE_PROJECT: projects/${p.projectId}-jobs:- build:- runs-on: ${p.runsOn}- steps:- - uses: actions/checkout@v4- - name: Build- run: echo "Building..."- create-rollout:- needs: build- permissions:- id-token: write- runs-on: ${p.runsOn}- container:- image: bytebase/bytebase-action- outputs:- bytebase-plan: \${{ steps.set-output.outputs.plan }}- steps:- - uses: actions/checkout@v4-${exchangeTokenStep(" ")}- - name: Create rollout- run: |- bytebase-action rollout \\- --url=$BYTEBASE_URL \\- ${accessTokenFlag} \\- --project=$BYTEBASE_PROJECT \\- --targets=${p.targetsPlaceholder} \\- --file-pattern=migrations/*.sql \\- --output=\${{ runner.temp }}/bytebase-metadata.json- - name: Set output- id: set-output- run: |- PLAN=$(jq -r .plan \${{ runner.temp }}/bytebase-metadata.json)- echo "plan=$PLAN" >> $GITHUB_OUTPUT- deploy-to-test:- needs: create-rollout- permissions:- id-token: write- runs-on: ${p.runsOn}- environment: test- container:- image: bytebase/bytebase-action- steps:- - uses: actions/checkout@v4-${exchangeTokenStep(" ")}- - name: Deploy to test- run: |- bytebase-action rollout \\- --url=$BYTEBASE_URL \\- ${accessTokenFlag} \\- --project=$BYTEBASE_PROJECT \\- --target-stage=environments/test \\- --plan=\${{ needs.create-rollout.outputs.bytebase-plan }}- deploy-to-prod:- needs: [deploy-to-test, create-rollout]- permissions:- id-token: write- runs-on: ${p.runsOn}- environment: prod- container:- image: bytebase/bytebase-action- steps:- - uses: actions/checkout@v4-${exchangeTokenStep(" ")}- - name: Deploy to prod- run: |- bytebase-action rollout \\- --url=$BYTEBASE_URL \\- ${accessTokenFlag} \\- --project=$BYTEBASE_PROJECT \\- --target-stage=environments/prod \\- --plan=\${{ needs.create-rollout.outputs.bytebase-plan }}`;-}--const gitlabExchangeScript = ` - |- ACCESS_TOKEN=$(curl -s -X POST "$BYTEBASE_URL/v1/auth:exchangeToken" \\- -H "Content-Type: application/json" \\- -d "{\\"token\\":\\"$GITLAB_OIDC_TOKEN\\",\\"email\\":\\"$BYTEBASE_WORKLOAD_IDENTITY\\"}" \\- | jq -r '.accessToken')- export BYTEBASE_ACCESS_TOKEN=$ACCESS_TOKEN`;--function generateGitlabCiYaml(p: YamlParams): string {- return `stages:- - sql-review- - create-rollout- - deploy-to-test- - deploy-to-prod--variables:- BYTEBASE_URL: ${p.bytebaseUrl}- BYTEBASE_WORKLOAD_IDENTITY: ${p.workloadIdentityEmail}- BYTEBASE_PROJECT: projects/${p.projectId}- BYTEBASE_TARGETS: ${p.targetsPlaceholder}- FILE_PATTERN: "migrations/*.sql"--sql-review:- stage: sql-review- image: bytebase/bytebase-action- id_tokens:- GITLAB_OIDC_TOKEN:- aud: ${GENERATED_WORKFLOW_AUDIENCE}- rules:- - if: $CI_PIPELINE_SOURCE == "merge_request_event"- script:-${gitlabExchangeScript}- - bytebase-action check --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --targets=$BYTEBASE_TARGETS --file-pattern=$FILE_PATTERN--create-rollout:- stage: create-rollout- image: bytebase/bytebase-action- id_tokens:- GITLAB_OIDC_TOKEN:- aud: ${GENERATED_WORKFLOW_AUDIENCE}- rules:- - if: $CI_COMMIT_BRANCH == "${p.branch}"- script:-${gitlabExchangeScript}- - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --targets=$BYTEBASE_TARGETS --file-pattern=$FILE_PATTERN --output=bytebase-metadata.json- artifacts:- paths: [bytebase-metadata.json]--deploy-to-test:- stage: deploy-to-test- image: bytebase/bytebase-action- needs: [create-rollout]- id_tokens:- GITLAB_OIDC_TOKEN:- aud: ${GENERATED_WORKFLOW_AUDIENCE}- rules:- - if: $CI_COMMIT_BRANCH == "${p.branch}"- environment: test- script:-${gitlabExchangeScript}- - PLAN=$(jq -r .plan bytebase-metadata.json)- - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --target-stage=environments/test --plan=$PLAN--deploy-to-prod:- stage: deploy-to-prod- image: bytebase/bytebase-action- needs: [deploy-to-test]- id_tokens:- GITLAB_OIDC_TOKEN:- aud: ${GENERATED_WORKFLOW_AUDIENCE}- rules:- - if: $CI_COMMIT_BRANCH == "${p.branch}"- environment: prod- when: manual- script:-${gitlabExchangeScript}- - PLAN=$(jq -r .plan bytebase-metadata.json)- - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --target-stage=environments/prod --plan=$PLAN`;-}diff --git a/frontend/src/routes/project/gitopsWorkflowYaml.test.ts b/frontend/src/routes/project/gitopsWorkflowYaml.test.tsnew file mode 100644index 0000000000..5acfbe6edc--- /dev/null+++ b/frontend/src/routes/project/gitopsWorkflowYaml.test.ts@@ -0,0 +1,71 @@+import { describe, expect, test } from "vitest";+import {+ bytebaseActionImage,+ generateGithubReleaseYaml,+ generateGithubSqlReviewYaml,+ generateGitlabCiYaml,+ type YamlParams,+} from "./gitopsWorkflowYaml";++const params: YamlParams = {+ branch: "main",+ runsOn: "ubuntu-latest",+ bytebaseUrl: "https://bytebase.example.com",+ actionImage: "bytebase/bytebase-action:cloud",+ workloadIdentityEmail: "[email protected]",+ projectId: "example",+ targetsPlaceholder: "instances/example/databases/example",+};++// Top-level GitLab job names map to their indented bodies.+const gitlabJobs = (yaml: string): Record<string, string> => {+ const jobs: Record<string, string> = {};+ for (const block of yaml.split(/\n(?=\S)/)) {+ const [header, ...body] = block.split("\n");+ jobs[header.replace(/:$/, "")] = body.join("\n");+ }+ return jobs;+};++describe("bytebaseActionImage", () => {+ test("uses the cloud image for a Cloud server", () => {+ expect(bytebaseActionImage("cloud-20261023")).toBe(+ "bytebase/bytebase-action:cloud"+ );+ });++ test("pins the self-hosted server version", () => {+ expect(bytebaseActionImage("3.24.0")).toBe(+ "bytebase/bytebase-action:3.24.0"+ );+ });++ test("falls back to the untagged image for an unparsable version", () => {+ expect(bytebaseActionImage("development")).toBe("bytebase/bytebase-action");+ expect(bytebaseActionImage("")).toBe("bytebase/bytebase-action");+ });+});++describe("generated workflows", () => {+ test.each([+ ["GitHub SQL review", generateGithubSqlReviewYaml, 1],+ ["GitHub release", generateGithubReleaseYaml, 3],+ ["GitLab CI", generateGitlabCiYaml, 4],+ ])("%s uses the action image for every job", (_, generate, jobCount) => {+ const images = generate(params).match(/image: .+/g);+ expect(images).toEqual(+ Array(jobCount).fill("image: bytebase/bytebase-action:cloud")+ );+ });++ test("GitLab deploy jobs receive the rollout metadata artifact", () => {+ const jobs = gitlabJobs(generateGitlabCiYaml(params));+ expect(jobs["create-rollout"]).toContain(+ "artifacts:\n paths: [bytebase-metadata.json]"+ );+ expect(jobs["deploy-to-test"]).toContain("needs: [create-rollout]");+ expect(jobs["deploy-to-prod"]).toContain(+ "needs: [create-rollout, deploy-to-test]"+ );+ });+});diff --git a/frontend/src/routes/project/gitopsWorkflowYaml.ts b/frontend/src/routes/project/gitopsWorkflowYaml.tsnew file mode 100644index 0000000000..3ec492d7b7--- /dev/null+++ b/frontend/src/routes/project/gitopsWorkflowYaml.ts@@ -0,0 +1,234 @@+import semver from "semver";+import { GENERATED_WORKFLOW_AUDIENCE } from "@/utils/workloadIdentity";++// bytebase-action exits when its version is incompatible with the server's: a+// Cloud server needs the :cloud image, and a self-hosted server rejects a newer+// minor release, which the untagged `latest` image can be.+export function bytebaseActionImage(serverVersion: string): string {+ if (serverVersion.startsWith("cloud")) {+ return "bytebase/bytebase-action:cloud";+ }+ const version = semver.valid(serverVersion);+ return version+ ? `bytebase/bytebase-action:${version}`+ : "bytebase/bytebase-action";+}++export interface YamlParams {+ branch: string;+ runsOn?: string;+ bytebaseUrl: string;+ actionImage: string;+ workloadIdentityEmail: string;+ projectId: string;+ targetsPlaceholder: string;+}++const exchangeTokenStep = (indent: string) =>+ `${indent}- name: Exchange token+${indent} id: bytebase-auth+${indent} run: |+${indent} OIDC_TOKEN=$(curl -s -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \\+${indent} "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=${GENERATED_WORKFLOW_AUDIENCE}" | jq -r '.value')+${indent} ACCESS_TOKEN=$(curl -s -X POST "$BYTEBASE_URL/v1/auth:exchangeToken" \\+${indent} -H "Content-Type: application/json" \\+${indent} -d "{\\"token\\":\\"$OIDC_TOKEN\\",\\"email\\":\\"$BYTEBASE_WORKLOAD_IDENTITY\\"}" \\+${indent} | jq -r '.accessToken')+${indent} echo "access-token=$ACCESS_TOKEN" >> $GITHUB_OUTPUT`;++const accessTokenFlag =+ "--access-token=${{ steps.bytebase-auth.outputs.access-token }}";++export function generateGithubSqlReviewYaml(p: YamlParams): string {+ return `name: SQL Review+on:+ pull_request:+ branches: ["${p.branch}"]+ paths: ["migrations/*.sql"]+jobs:+ sql-review:+ permissions:+ id-token: write+ pull-requests: write+ runs-on: ${p.runsOn}+ container:+ image: ${p.actionImage}+ env:+ BYTEBASE_URL: ${p.bytebaseUrl}+ BYTEBASE_WORKLOAD_IDENTITY: ${p.workloadIdentityEmail}+ steps:+ - uses: actions/checkout@v4+${exchangeTokenStep(" ")}+ - name: SQL Review+ env:+ GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}+ run: |+ bytebase-action check \\+ --url=$BYTEBASE_URL \\+ ${accessTokenFlag} \\+ --project=projects/${p.projectId} \\+ --targets=${p.targetsPlaceholder} \\+ --file-pattern=migrations/*.sql`;+}++export function generateGithubReleaseYaml(p: YamlParams): string {+ return `name: Rollout+on:+ push:+ branches: ["${p.branch}"]+ paths: ["migrations/*.sql"]+env:+ BYTEBASE_URL: ${p.bytebaseUrl}+ BYTEBASE_WORKLOAD_IDENTITY: ${p.workloadIdentityEmail}+ BYTEBASE_PROJECT: projects/${p.projectId}+jobs:+ build:+ runs-on: ${p.runsOn}+ steps:+ - uses: actions/checkout@v4+ - name: Build+ run: echo "Building..."+ create-rollout:+ needs: build+ permissions:+ id-token: write+ runs-on: ${p.runsOn}+ container:+ image: ${p.actionImage}+ outputs:+ bytebase-plan: \${{ steps.set-output.outputs.plan }}+ steps:+ - uses: actions/checkout@v4+${exchangeTokenStep(" ")}+ - name: Create rollout+ run: |+ bytebase-action rollout \\+ --url=$BYTEBASE_URL \\+ ${accessTokenFlag} \\+ --project=$BYTEBASE_PROJECT \\+ --targets=${p.targetsPlaceholder} \\+ --file-pattern=migrations/*.sql \\+ --output=\${{ runner.temp }}/bytebase-metadata.json+ - name: Set output+ id: set-output+ run: |+ PLAN=$(jq -r .plan \${{ runner.temp }}/bytebase-metadata.json)+ echo "plan=$PLAN" >> $GITHUB_OUTPUT+ deploy-to-test:+ needs: create-rollout+ permissions:+ id-token: write+ runs-on: ${p.runsOn}+ environment: test+ container:+ image: ${p.actionImage}+ steps:+ - uses: actions/checkout@v4+${exchangeTokenStep(" ")}+ - name: Deploy to test+ run: |+ bytebase-action rollout \\+ --url=$BYTEBASE_URL \\+ ${accessTokenFlag} \\+ --project=$BYTEBASE_PROJECT \\+ --target-stage=environments/test \\+ --plan=\${{ needs.create-rollout.outputs.bytebase-plan }}+ deploy-to-prod:+ needs: [deploy-to-test, create-rollout]+ permissions:+ id-token: write+ runs-on: ${p.runsOn}+ environment: prod+ container:+ image: ${p.actionImage}+ steps:+ - uses: actions/checkout@v4+${exchangeTokenStep(" ")}+ - name: Deploy to prod+ run: |+ bytebase-action rollout \\+ --url=$BYTEBASE_URL \\+ ${accessTokenFlag} \\+ --project=$BYTEBASE_PROJECT \\+ --target-stage=environments/prod \\+ --plan=\${{ needs.create-rollout.outputs.bytebase-plan }}`;+}++const gitlabExchangeScript = ` - |+ ACCESS_TOKEN=$(curl -s -X POST "$BYTEBASE_URL/v1/auth:exchangeToken" \\+ -H "Content-Type: application/json" \\+ -d "{\\"token\\":\\"$GITLAB_OIDC_TOKEN\\",\\"email\\":\\"$BYTEBASE_WORKLOAD_IDENTITY\\"}" \\+ | jq -r '.accessToken')+ export BYTEBASE_ACCESS_TOKEN=$ACCESS_TOKEN`;++export function generateGitlabCiYaml(p: YamlParams): string {+ return `stages:+ - sql-review+ - create-rollout+ - deploy-to-test+ - deploy-to-prod++variables:+ BYTEBASE_URL: ${p.bytebaseUrl}+ BYTEBASE_WORKLOAD_IDENTITY: ${p.workloadIdentityEmail}+ BYTEBASE_PROJECT: projects/${p.projectId}+ BYTEBASE_TARGETS: ${p.targetsPlaceholder}+ FILE_PATTERN: "migrations/*.sql"++sql-review:+ stage: sql-review+ image: ${p.actionImage}+ id_tokens:+ GITLAB_OIDC_TOKEN:+ aud: ${GENERATED_WORKFLOW_AUDIENCE}+ rules:+ - if: $CI_PIPELINE_SOURCE == "merge_request_event"+ script:+${gitlabExchangeScript}+ - bytebase-action check --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --targets=$BYTEBASE_TARGETS --file-pattern=$FILE_PATTERN++create-rollout:+ stage: create-rollout+ image: ${p.actionImage}+ id_tokens:+ GITLAB_OIDC_TOKEN:+ aud: ${GENERATED_WORKFLOW_AUDIENCE}+ rules:+ - if: $CI_COMMIT_BRANCH == "${p.branch}"+ script:+${gitlabExchangeScript}+ - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --targets=$BYTEBASE_TARGETS --file-pattern=$FILE_PATTERN --output=bytebase-metadata.json+ artifacts:+ paths: [bytebase-metadata.json]++deploy-to-test:+ stage: deploy-to-test+ image: ${p.actionImage}+ needs: [create-rollout]+ id_tokens:+ GITLAB_OIDC_TOKEN:+ aud: ${GENERATED_WORKFLOW_AUDIENCE}+ rules:+ - if: $CI_COMMIT_BRANCH == "${p.branch}"+ environment: test+ script:+${gitlabExchangeScript}+ - PLAN=$(jq -r .plan bytebase-metadata.json)+ - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --target-stage=environments/test --plan=$PLAN++deploy-to-prod:+ stage: deploy-to-prod+ image: ${p.actionImage}+ needs: [create-rollout, deploy-to-test]+ id_tokens:+ GITLAB_OIDC_TOKEN:+ aud: ${GENERATED_WORKFLOW_AUDIENCE}+ rules:+ - if: $CI_COMMIT_BRANCH == "${p.branch}"+ environment: prod+ when: manual+ script:+${gitlabExchangeScript}+ - PLAN=$(jq -r .plan bytebase-metadata.json)+ - bytebase-action rollout --url=$BYTEBASE_URL --access-token=$BYTEBASE_ACCESS_TOKEN --project=$BYTEBASE_PROJECT --target-stage=environments/prod --plan=$PLAN`;+}