The Database CI/CD Best Practice with GitHub
Wanna other VCS providers instead? 👉
- The Database CI/CD Best Practice with GitLab
- The Database CI/CD Best Practice with Azure DevOps
- The Database CI/CD Best Practice with Bitbucket
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?
Critical Elements of Database CI/CD
To answer the "how", we first need to sort out the typical database change workflow. Before SQL statements can be safely applied to the database, there are two key steps: review & change.
This step is to make sure that the changes:
- Implement the business logic accurately;
- Follow database design best practices;
Here, the devs are generally responsible for the former task and the DBAs for the latter. The DevOps philosophy looks to solve this problem by integrating Ops and Devs. The reality is that when DBA exists in an organization, it is difficult to merge the two teams directly. One potential solution is to retain the DBA’s task while enabling dev teams to pre-review the SQL. This shift-left approach can significantly reduce the chance of release delays. Moreover, if there are no DBAs in an organization, then it is even more crucial to empower the dev team with the capability to make sure the SQL doesn’t wreak havoc on the database.
SQL Change Execution
This step is to make sure that:
- Statements are executed correctly. We don’t want wrong database connections, insufficient permissions, object name conflicts, or basic syntax errors on our hands.
- All planned statements are executed. Omissions may occur when there are many scripts to be executed or if there are multiple target databases for batch execution.
- The change executions process should not impact the business. Hardware resource exhaustion and locking the table for an extended period are not pleasant for the company.
To avoid change-related errors, reducing the manual aspects is also crucial: the more things are automated, the fewer chances for mistakes to happen. Pre-configured pipelines to automatically apply SQL to the databases? That sounds rad. In order to avoid affecting regular business operations negatively, various zero-downtime change techniques should be adopted, especially for databases with large datasets.
Thus, the critical elements for implementing Database CI/CD should enable dev teams to perform SQL reviews and streamlined SQL change rollout.
SQL Review and Change Rollout with VCS Integration
Let’s first explore how to enable the dev teams to perform SQL reviews themselves.
Very few developers are experts at reviewing SQL statements for "architecturally correctness" and even for senior DBAs, the manual checks can be highly inefficient and error-prone. Fortunately, the industry has created various automated review tools by integrating different SQL check specifications.
However, these tools have one common problem - they are all designed for the DBAs. On the one hand, these tools often require higher operational privileges to the databases and are thus not suitable to be used directly by developers. On the other hand, developers have their IDE, and a separate external arbitrator is the last thing they need. Imagine how bad it would be when you have to copy & paste code between multiple tools.
So what should a developer-friendly SQL review tool look like?
We usually perform the traditional code review process on version control systems (VCS), and the same should be applied to SQL. Therefore, SQL review tools should be integrated into the code review workflow. Bytebase has made SQL Review Action available on the GitHub Marketplace; once enabled, SQL Review Actions will be triggered as you submit PR on GitHub.
Let’s look at how to implement streamlined SQL change rollouts.
Standalone SQL deployment tools are not uncommon. These tools typically upload SQL scripts manually, proceed with the deployment via an approval flow, and then provide feedback after the rollout is complete. This model accurately depicts how the developers and the DBAs work independently, and the fragmented process is one of the most common reasons for delayed releases. After all, who can guarantee that there will never be a mistake when you are constantly moving SQL scripts between multiple systems manually?
We need a more efficient and automated release process. Let’s recall the classic CI/CD workflow for application code: commit changes > code review > merge branch > auto-build > auto-deploy. Since we’ve already implemented SQL review on GitHub Actions, why can’t we include the subsequent rollout process?
Well, yes, we can!
A SQL change rollout tool for Database CI/CD should have the ability to integrate with VCS. Once your SQL scripts have been vetted and merged into the target branch, the release process is triggered, and the scripts are automatically pushed to Bytebase. Of course, the DBA can perform another sanity check before executing the SQL against the target database.
A Complete Database CI/CD Workflow
Here, we present a complete Database CI/CD workflow:
- The developer creates a Merge Request / Pull Request containing the SQL migration script;
- SQL Review Action is automatically triggered to review SQL and offers suggestions to assist the code review;
- 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;
- The merge event automatically triggers the release pipeline in Bytebase and creates a release ticket capturing the intended change;
- (Optional) an approval flow will be auto matched based on the change risk and be followed via Bytebase’s built-in UI;
- Approved scripts are executed gradually according to the configured rollout stages;
- 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;
- Confirm the migration and proceed to the corresponding application rollout.
Set Up Database CI/CD with GitHub in Bytebase (Free Plan)
Here's a step-by-step tutorial on how to set up this Database CI/CD with GitHub in Bytebase.
Step 1 - Run Bytebase in Docker and set 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 VCS. ngrok we used here is for demonstration purposes. For production use, we recommend using Caddy.
Login to ngrok Dashboard and follow its Getting Started steps to install and configure.
and obtain the public URL
Run Bytebase in Docker with the following command:
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 adminrole automatically.
Click the gear icon (Settings) on the top right. Click General under Workspace. Paste
https://b725-103-197-71-76.ap.ngrok.ioas External URL under Network section and click Update.
Bytebase is running successfully in Docker, and you can visit it via
Step 2 - Add GitHub.com as a Git provider in Bytebase
- Visit Bytebase via your ngrok URL. Click gear icon (Settings) > Integration > GitOps, choose
GitHub.com, and click Next. You will see STEP 2. Copy the Redirect URI.
- Copy the Authorization callback URL.
- Open GitHub, and go to Settings > Developer Settings > OAuth Apps. Click New OAuth App.
- Scroll down on the new OAuth App page, paste the Authorization callback URL, then click Update Application.
- On the same page, you can also find Client ID and Client secrets.
- Switch back to the Bytebase console, fill Client ID and Client secrets in the form as Application ID and Secret.
- Click Next. 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
Create a repository named
Go to Bytebase, go to the
Sample Project. Click GitOps tab and choose
GitOps workflow. Click Configure GitOps.
GitHub.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 GitHub Action. Click Finish.
After SQL Review CI is automatically setup, click Review the pull request. You'll be redirected to GitHub. Click Merge and you'll see the CI is automatically configured. It will be triggered later once a new merge request is created.
Go back to Bytebase, you'll see the GitOps workflow is configured successfully.
Step 4 - Create a Pull Request and Trigger SQL Review CI
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.
To test SQL Review CI, we'll create a pull request to change the
Proddatabase schema. However, it will voliate the SQL Review policy first. Go to
Create a subdirectory
bytebase, and create a sub-subdirectory
prod. Within the
proddirectory, create a file
hr_prod##202309262500##ddl##add_nickname_table_employee.sql. Copy the following SQL script into the file and commit the change in a new branch.
Create a pull 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.
Update the SQL script and commit in the current branch. The SQL Review CI will run again and show the pass message. Click Merge.
Go back to project
Sample Projectin Bytebase, you'll see there's an issue created by a push event.
issue/102and redirect to the issue. Because there is no approval flow or manual rollout configured. The issue rolls out 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.
Go to Environments > 2.Prod, Find Rollout policy section, and choose Manual rollout > Require rolling out from DBA or workspace admin.
Go to Settings > Security & Policy > Custom Approval. Set
Project Owner -> DBAas Approval flow for DDL > High Risk.
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.
Go back to GitHub, and create a new branch with a file
bytebase/proddirectory. Copy the following SQL script into the file and commit the change.
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, for the Assignee field, you may leave it empty or choose one.
After following the approval flow to click Approve, the banner will show Waiting for Rollout instead. The Assignee then can click Rollout.
Go back to GitHub, you'll notice there's a new file
bytebase/prod/with the latest schema written back by Bytebase.
Click terminal icon (SQL Editor) on the top right. You'll be redirected 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.
(Prod) hr_prodon the left, and paste and run the following script:
Go back to Bytebase Console, and click Databases >
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.
Go to Anomaly Center, and you'll see the Schema drift there too.
Now with Bytebase, you have a complete Database CI/CD workflow with GitHub. 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.