Database CI/CD and Schema Migration with GitHub using Bytebase Cloud

May 11, 2024

Estimated: 30 mins

A series of articles about Database Change Management using Bytebase Cloud. We take Amazon Aurora MySQL as an example and is also applicable to Amazon Aurora Serverless.

Database Change Management using Bytebase Cloud
Database CI/CD and Schema Migration with GitHub using Bytebase Cloud (this one)

In the last article Database Change Management using Bytebase Cloud, you have tried UI workflow in Bytebase.

This tutorial will bring your schema change to the next level by introducing the GitOps workflow, where you commit the schema change script to the GitHub repository, which will in turn trigger the schema deployment pipeline in Bytebase.

You can use Bytebase's Community Plan to finish the tutorial.

Features included#

GitOps Workflow

Prerequisites#

Before you start this tutorial, make sure you have the following ready:

Followed our previous UI-based change tutorial Database Change Management using Bytebase Cloud.
An Amazon Aurora MySQL instance.
A GitHub account.
A public GitHub repository, e.g. test-bb-gitops.

Step 1 - Connect Bytebase with GitHub.com#

Go to Bytebase homepage, and click Integration > GitOps on the left sidebar. Choose GitHub.com as Git provider. What we need is a github personal access token.
Go to your GitHub account. Click your avatar and then click Settings on the menu. Click Developer settings on the left sidebar, and then click Personal access tokens > Fine-grained tokens.
Click Generate new token, fill in the fields and check the scopes according to the description on Bytebase. Click Generate token.
Copy the token and paste it back into Bytebase Integration > GitOps. Click Confirm and add.

Step 2 - Enable GitOps workflow#

Go to the project Sample Project, click Integration > GitOps. Click Add Enable GitOps connector.
Choose GitHub.com - the provider you just added. It will display all the repositories you can manipulate. Choose test-bb-gitops.
Keep the default setting, and click Finish. Pay attention to Database Group, which is the database group that the schema change will be applied to. With Community Plan, the changes will automatically affect all databases in the project. With Enterprise Plan, you'll have the option to specify the target database group.

Step 3 - Change schema by pushing SQL schema change files to GitHub#

In your GitHub repository test-bb-gitops, create a folder bytebase, then create an sql file 202404151600_create_table_t1.sql.

Paste the sql script in it.
```
CREATE TABLE t1 (
   "id" INTEGER NOT NULL
);
```
Create a new branch for this commit and start a pull request. Click Merge pull request to merge the new branch into the main branch.
There will be a comment saying there's a rollout in Bytebase. Click and go to the issue page, you’ll see
1. The issue is created via GitHub.com, there's a link to the GitHub commit.
2. The SQL is exactly the one we have committed to the GitHub repository.
3. The SQL has passed the automatic task checks and rollout automatically.
4. Since there're two databases in the project, Bytebase creates a 2-staged pipeline to roll out the change sequentially.
Click View change, you can view the schema diff.

Summary and What's Next#

Now you have tried out GitOps workflow, which will store your database schema in GitHub and trigger the change upon committing the change to the repository via Pull Request, to bring your database change workflow to the next level of Database DevOps - Database as Code.

If the built-in workflow is not suitable, you can opt to Bytebase API to fully customize the workflow to integrate with your CI pipeline. Automating Database Schema Change workflow Using GitHub Actions is an example.

Edit this page on GitHub