Database CI/CD and Schema Migration with MariaDB and GitHub

Estimated: 30 mins
Database CI/CD and Schema Migration with MariaDB and GitHub

A series of articles about Database CI/CD and Schema Migration with MariaDB


In the last article Database CI/CD and Schema Migration with MariaDB, you have tried UI workflow in Bytebase.

This tutorial will bring you 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 free version to finish the tutorial.

Features included

  • GitOps Workflow
  • Change History

Prerequisites

Before you start this tutorial, make sure:

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.

ngrok-reverse-proxy

  1. Run Bytebase in Docker with the following command:

    docker run --rm --init \
      --name bytebase \
      --publish 8080:8080 --pull always \
      --volume ~/.bytebase/data:/var/opt/bytebase \
      bytebase/bytebase:2.15.0
  2. Bytebase is running successfully in Docker, and you can visit it via localhost:8080. Register an admin account and it will be granted the workspace admin role automatically.

  3. Login to ngrok Dashboard and complete the Getting Started steps to install and configure. If you want to use the same domain each time you launch ngrok, go to Cloud Edge > Domains, where you'll find the domain <<YOURS>>.ngrok-free.app linked to your account.

  4. Run the ngrok command ngrok http --domain=<<YOURS>>.ngrok-free.app 8080 to start ngrok with your specific domain, and you will see the output displayed below:

    terminal-ngrok

  5. Log in Bytebase and click the gear icon (Settings) on the top right. Click General under Workspace. Paste <<YOURS>>.ngrok-free.app as External URL under Network section and click Update.

    external-url

  6. Now you can access Bytebase via <<YOURS>>.ngrok-free.app.

Step 2 - Find your MariaDB instance in Bytebase

  1. Visit Bytebase Console through the browser via your ngrok URL. Log in using your account created from the previous tutorial.

  2. Click Projects on the top bar, and then click Create Project. Fill in Demo Git as Project Name, DGT as Key, Standard as Mode and click Create.

  3. Go to the Demo Git project, and click New DB.

  4. Fill the form with the following information and click Create.

    • Name: demo_db_git
    • Environment: Test
    • Instance: MariaDB test It will create an issue "CREATE DATABASE …" automatically. Because it’s for Test environment, the issue will automatically run then becomes Done. The database is created.
  5. Click New DB again, fill the form with the following information and click Create.

    • Name: demo_db_git
    • Environment: Prod
    • Instance: MariaDB prod

    It will create an issue "CREATE DATABASE …" automatically. Because it’s for Prod environment, the issue will require manual rollout. Click Rollout to run then becomes Done. The database is created.

Step 3 - Connect Bytebase with GitHub.com

  1. Click Settings on the top bar, and then click Workspace > Version Control. Choose GitHub.com and click Next. bb-settings-vc-step1

  2. Follow the instructions within STEP 2, and in this tutorial, we will use a personal account instead of an organization account. The configuration is similar. bb-settings-vc-step2

  3. Go to your GitHub account. Click Settings on the dropdown menu. gh-settings-dropdown

  4. Click Developer Settings at the bottom of the left side bar. Click OAuth Apps, and click New OAuth App. gh-oauth-apps

  5. Fill Application name and then copy the Homepage and Authorization callback URL in Bytebase and fill them. Click Register application.

  6. After the OAuth application is created successfully. Click Generate a new client secret. Copy Client ID and this newly generated client secret and paste them back in Bytebase. gh-copy-client-id bb-vc-client-id

  7. Click Next. You will be redirected to the confirmation page. Click Confirm and add, and the Git provider is successfully added. bb-settings-vc-step3

Step 4 - Enable GitOps workflow with MariaDB

  1. Go to project Demo Git, click GitOps, and choose GitOps Workflow. Click Configure GitOps. bb-demo-git-gitops-workflow

  2. Choose GitHub.com - the provider you just added. It will display all the repositories you can manipulate. Choose test-bb-mariadb-gitops.

  3. Keep the default setting, and click Finish. The GitOps workflow is successfully enabled. bb-demo-git-gitops-enabled

Step 5 - Change schema for MariaDB by pushing SQL schema change files to GitHub

  1. In your GitHub repository test-bb-mariadb-gitops, create a folder bytebase, then create a subfolder prod, and create an sql file following the pattern {{ENV_ID}}/{{DB_NAME}}##{{VERSION}}##{{TYPE}}##{{DESCRIPTION}}.sql. It is the default configuration for file path template setting under project version control.

    prod/demo_git_db##2023061614300000##ddl##create_t2.sql

    • prod corresponds to {{ENV_ID}}
    • demo_git_db corresponds to {{DB_NAME}}
    • 2023061614300000 corresponds to {{VERSION}}
    • ddl corresponds to {{TYPE}}
    • create_t2 corresponds to {{DESCRIPTION}}

    Paste the sql script in it.

    CREATE TABLE t2(
    id INT NOT NULL,
    PRIMARY KEY(id)
    )
  2. Commit and push this file.

  3. Go to Bytebase, and go into project Demo Git. You’ll find there is a new Push Event and a new issue created. bb-push-notification-only

  4. Click the issue link, and you’ll see:

    • The issue is created via GitHub.com.
    • The issue is waiting for your rollout because it’s on Prod environment where manual rollout is required by default.
    • The SQL is exactly the one we have committed to the GitHub repository.
    • The Creator is Workspace Admin, because the GitHub user you use to commit the change has the same email address found in the Bytebase member list. bb-issue-gitops-to-rollout
  5. Click Rollout, and the SQL will execute. The issue will be Done.

  6. Click View change, you could view the schema diff.

  7. You may try with your Test environment, the only difference is that you don’t need to rollout the issue manually.

If you have Enterprise Plan. Go to GitHub repository, you will see besides your committed sql, there is a .demo_git_db##LATEST.sql file. Because you have configured Schema path template before, Bytebase will write back the latest schema to that specified path after completing the schema change. Thus you have access to an update-to-date full schema at any time.

Summary and Next

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

In real world scenario, you might have separate features and main branches corresponding to your dev and production environment, you can check out GitOps with Feature Branch Workflow to learn the setup. Have a try and look forward to your feedback!

Edit this page on GitHub

Subscribe to Newsletter

By subscribing, you agree with Bytebase's Terms of Service and Privacy Policy.