The Database CI/CD Best Practice with GitLab

Wanna GitHub instead? 👉 The Database CI/CD Best Practice with GitHub

Database change is a tricky part of the application development process: it usually involves multiple databases from different environments and cross-team collaboration, to add on top of it, databases are touch and go. It got us thinking: can we treat database the same way we treat application code?

DORA (DevOps Research & Assessment) pointed out that integrating database work into the software delivery process positively contributes to continuous delivery. It’s about time to make databases a part of the CI/CD cycle.

But how does it work, really?

A Complete Database CI/CD Workflow

Here, we present a complete Database CI/CD workflow with GitLab. It's similar with GitHub, Bitbucket or Azure DevOps.

1. The developer creates a Merge Request containing the SQL migration script;
2. SQL Review CI is automatically triggered to review SQL and offers suggestions to assist the code review;
3. After several possible iterations, the team leader or another peer on the dev teams approves the change and merges the SQL script into a branch;
4. The merge event automatically triggers the release pipeline in Bytebase and creates a release ticket capturing the intended change;
5. (Optional) an approval flow will be auto matched based on the change risk and be followed via Bytebase’s built-in UI;
6. Approved scripts are executed gradually according to the configured rollout stages;
7. The latest database schema is automatically written back to the code repository after applying changes. With this, the Dev team always has a copy of the latest schema. Furthermore, they can configure downstream pipelines based on the change of that latest schema;
8. Confirm the migration and proceed to the corresponding application rollout.

Set Up Database CI/CD with GitLab in Bytebase (Free Plan)

Here's a step-by-step tutorial on how to set up this Database CI/CD with GitLab in Bytebase.

Step 1 - Run Bytebase in Docker with the External URL generated by ngrok

ngrok is a reverse proxy tunnel, and in our case, we need it for a public network address in order to receive webhooks from gitlab.com. ngrok we used here is for demonstration purposes. For production use, we recommend using Caddy.

1. Login to ngrok Dashboard and follow its Getting Started steps to install and configure.

2. Run Bytebase in Docker with the following command.

   docker run --init \
   --name bytebase \
   --restart always \
   --publish 5678:8080 \
   --health-cmd "curl --fail http://localhost:5678/healthz || exit 1" \
   --health-interval 5m \
   --health-timeout 60s \
   --volume ~/.bytebase/data:/var/opt/bytebase \
   bytebase/bytebase:2.8.0 \
   --data /var/opt/bytebase \
   --port 8080

3. Bytebase is running successfully in Docker, and you can visit it via localhost:5678. Register an admin account and it will be granted the workspace owner role automatically.

4. Run ngrok http 5678 in the terminal and obtain the public URL: https://b67d-154-212-161-108.ngrok-free.app.

5. Log in to Bytebase, and click the gear icon (Settings) on the top right. Click General under Workspace. Paste https://b67d-154-212-161-108.ngrok-free.app as External URL under Network section and click Update.

Step 2 - Add GitLab.com as a Git provider in Bytebase

1. Visit Bytebase via https://b67d-154-212-161-108.ngrok-free.app. Click gear icon (Settings) > Integration > GitOps, choose GitLab.com, and click Next. You will see STEP 2. Copy the Redirect URI.

2. Go to https://gitlab.com/, click your avatar and choose Preferences on the dropdown menu. Click Applications on the left bar. Click Add new application. Fill in the following fields:

   • Name: Bytebase
   • Redirect URI: Copied from Bytebase GitOps config STEP 2
   • Confidential: Yes
   • Scope: api

   Click Save application.

   

3. Copy the Application ID and Secret from the GitLab application page and paste them into the Bytebase GitOps config page. Click Next. Click Authorize on popup. You will be redirected to the confirmation page. Click Confirm and add, and the Git provider is successfully added.

   

Step 3 - Configure a GitOps Workflow in Bytebase

1. Go to https://gitlab.com/ and create a new project bytebase-gitlabcom-demo. Set the Visibility Level to Public. Click Create project.

2. Go to Bytebase, go to the Sample Project. Click GitOps tab and choose GitOps workflow. Click Configure GitOps.

3. Choose GitLab.com (the git provider you just configured) and the repository you just created. You'll be redirected to STEP 3. Keep everything as default, scroll down to the bottom and check Enable SQL Review CI via GitLab CI. Click Finish.

   

4. After SQL Review CI is automatically setup, click Review the merge request. You'll be redirected to GitLab. Click Merge and you'll see the CI is automatically configured. It will be triggered later once a new merge request is created.

   

5. Go back to Bytebase, you'll see the GitOps workflow is configured successfully.

Step 4 - Create a Merge Request and Trigger SQL Review CI

1. Go to Environments, you'll see there's a SQL Review policy attached with Prod. Click Edit, you'll see three activated SQL Review rules which will be applied via CI.

   

2. To test SQL Review CI, we'll create a merge request to change the Prod database schema. However, it will voliate the SQL Review policy first. Go to bytebase-gitlabcom-demo on GitLab. Click New branch, name it add-nickname-table-employee. Click Create branch.

3. On the new branch, create a subdirectory bytebase, and create a sub-subdirectory prod. Within the prod directory, create a file employee##202309262500##ddl##add_nickname_table_employee.sql. Copy the following SQL script into the file and commit the change.

   ALTER TABLE "public"."employee"
   ADD COLUMN "nick_name" text;

4. Create a merge request including the above commits. The SQL Review CI will run automatically and show the fail message. However you can still merge it regardless of the CI result.

   

5. Update the SQL script and commit in the current branch. The SQL Review CI will run again and show the pass message. Click Merge.

   ALTER TABLE "public"."employee"
   ADD COLUMN "nick_name" text NOT NULL DEFAULT '';

   

6. Go back to project Sample Project in Bytebase, you'll see the there's an issue created by push event.

   

7. Click issue/102 and redirect to the issue. Because there is no approval flow or manual rollout configured. The issue rollouts automatically. You may click View change to see the diff.

   

Advanced Features (Enterprise Plan)

You may upgrade to Enterprise plan to explore more features.

Click Start free trial on the left bottom and upgrade to Enterprise plan, Go to Instances to Assign License for the existing two instances.

Manual Rollout

Go to Environments > 2.Prod, Find Rollout policy section, and choose Manual rollout > Require rolling out from DBA or workspace owner.

Custom Approval

1. Go to Settings > Security & Policy > Custom Approval. Set Project Owner -> DBA as Approval flow for DDL > High Risk.

   

2. Go to Settings > Security & Policy > Risk Center. Click Add rule and click Load for the first template. Click Add.

   

LATEST Schema Write-back

After schema migration completes, Bytebase will write the latest schema back to the Git repository. So that the team always has a canonical source of truth for the database schema in Git.

1. Go back to GitLab, and create a new branch add-country-table-employee. Create a file employee##202309261700##ddl##add_country_table_employee.sql under bytebase/prod directory. Copy the following SQL script into the file and commit the change.

   ALTER TABLE "public"."employee"
   ADD COLUMN "country" text NOT NULL DEFAULT '';

2. Go back to Bytebase, and go to the newly created issue. Because of the settings we made above, it matches the approval flow Project Owner -> DBA,

   

3. After following the approval flow to click Approve, the banner will show Waiting for Rollout instead. The Assignee then can click Rollout.

4. Go back to GitLab, you'll notice there's a new file .employee##LATEST.sql under bytebase/prod/ with the latest schema written back by Bytebase.

Schema Drift

Bytbease has built-in schema drift detection to detect unexpected schema changes. Let's use the SQL Editor Admin Mode to simulate this.

1. Click terminal icon (SQL Editor) on the top right. You'll be redirect to SQL Editor. Click Admin mode. Everything you do in this mode is the same as connecting directly to the server, which is not recorded by Bytebase.

2. Select (Prod) employee on the left, and paste and run the following script:

   ALTER TABLE "public"."employee"
       ADD COLUMN "city" text NOT NULL DEFAULT '';

3. Go back to Bytebase Console, and click Databases > employee under Prod. Click Sync Now. After seeing the success message, refresh the page. You'll see the schema drift. You may configure auto scan on instance detail page to avoid manual sync.

   

4. Go to Anomaly Center, and you'll see the Schema drift there too.

Summary

Now with Bytebase, you have a complete Database CI/CD workflow with GitLab. You can apply this workflow to your own project and customize it to fit your needs. If you have any questions, please feel free join and discuss in Discord.

Further Readings

• How to integrate SQL Review into Your GitLab or GitHub CI/CD
• The Database CI/CD Best Practice with GitHub
• Database as Code - the Good, the Bad and the Ugly