GitOps with VCS Integration

Built-in GitOps#

Prerequisites#

• Configure External URL.
• VCS and Bytebase are network reachable from each other.
  • VCS needs to push webhook to Bytebase.
  • Bytebase needs to fetch file content from VCS.

Workflow#

The built-in Bytebase GitOps workflow is opinionated for the typical use case:

• It imposes a naming convention on the migration file.
• It only creates Bytebase rollout issue when the migration file is merged into the target branch. Under the hood, it creates a webhook in the linked repository to observe the merge event.
• If you have successfully rolled out the issue and you want to make further change based on that migration file, you need to create a new migration file instead of editing the original one inline.

The built-in GitOps setup contains 3 steps:

1. Add Git Provider
2. Add GitOps Connector in Project
3. Create Migration Files

Custom GitOps with API#

If the built-in workflow is not suitable, you can opt to Bytebase API to fully customize the GitOps workflow to integrate with your CI pipeline.