Skip to content

docs: add VCS installation guide for GitOps workflow #879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
d-bytebase merged 1 commit into from
Sep 2, 2025
Merged

docs: add VCS installation guide for GitOps workflow #879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions mintlify/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@
"group": "GitOps Workflow",
"pages": [
"gitops/overview",
"gitops/installation",
"gitops/develop",
"gitops/sql-review-ci",
"gitops/release"
Expand Down
53 changes: 53 additions & 0 deletions mintlify/gitops/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Installation
description: Installation and setup guide for connecting Version Control Systems with Bytebase
---

This guide covers the setup requirements for connecting Version Control Systems (VCS) with Bytebase.

## Bytebase Cloud

**No installation required** for cloud VCS providers:
- GitHub.com
- GitLab.com
- Bitbucket Cloud
- Azure DevOps Services

These services connect directly to Bytebase Cloud.

### Self-Hosted GitLab

- Install a [GitLab Runner](https://docs.gitlab.com/runner/) on your GitLab server
- Ensure your VPC firewall rules allow connections between Self-Hosted GitLab and Bytebase Cloud

## Bytebase Self-Host

Self-hosted Bytebase requires specific setup based on your VCS provider.

### Cloud VCS Providers

When using cloud VCS with self-hosted Bytebase, you need a self-hosted runner:

**GitHub.com**
- Install a [GitHub self-hosted runner](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners)
- Ensure runner can access your Bytebase instance

**GitLab.com**
- Install a [GitLab Runner](https://docs.gitlab.com/runner/)
- Register runner with your GitLab.com project

**Bitbucket Cloud**
- Install a [Bitbucket self-hosted runner](https://support.atlassian.com/bitbucket-cloud/docs/runners/)
- Configure Bitbucket Pipelines to use the runner

**Azure DevOps Services**
- Install a [Self-hosted Azure Pipelines Agent](https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/agents)
- Register agent with your Azure DevOps organization

### Self-Hosted GitLab

No runner installation needed. Simply ensure:
- VPC connectivity between GitLab and Bytebase servers
- Network policies allow communication
- If your GitLab runner lacks internet access, pre-load the bytebase-action Docker image