Skip to content

Commit 2c41e97

Browse files
d-bytebaseclaude
andauthored
docs: add VCS installation guide for GitOps workflow (#879)
Add comprehensive installation and setup guide for connecting various VCS providers (GitHub, GitLab, Bitbucket, Azure DevOps) with both Bytebase Cloud and Self-Host deployments. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude <[email protected]>
1 parent 0304c03 commit 2c41e97

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

mintlify/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@
128128
"group": "GitOps Workflow",
129129
"pages": [
130130
"gitops/overview",
131+
"gitops/installation",
131132
"gitops/develop",
132133
"gitops/sql-review-ci",
133134
"gitops/release"

mintlify/gitops/installation.mdx

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Installation
3+
description: Installation and setup guide for connecting Version Control Systems with Bytebase
4+
---
5+
6+
This guide covers the setup requirements for connecting Version Control Systems (VCS) with Bytebase.
7+
8+
## Bytebase Cloud
9+
10+
**No installation required** for cloud VCS providers:
11+
- GitHub.com
12+
- GitLab.com
13+
- Bitbucket Cloud
14+
- Azure DevOps Services
15+
16+
These services connect directly to Bytebase Cloud.
17+
18+
### Self-Hosted GitLab
19+
20+
- Install a [GitLab Runner](https://docs.gitlab.com/runner/) on your GitLab server
21+
- Ensure your VPC firewall rules allow connections between Self-Hosted GitLab and Bytebase Cloud
22+
23+
## Bytebase Self-Host
24+
25+
Self-hosted Bytebase requires specific setup based on your VCS provider.
26+
27+
### Cloud VCS Providers
28+
29+
When using cloud VCS with self-hosted Bytebase, you need a self-hosted runner:
30+
31+
**GitHub.com**
32+
- Install a [GitHub self-hosted runner](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners)
33+
- Ensure runner can access your Bytebase instance
34+
35+
**GitLab.com**
36+
- Install a [GitLab Runner](https://docs.gitlab.com/runner/)
37+
- Register runner with your GitLab.com project
38+
39+
**Bitbucket Cloud**
40+
- Install a [Bitbucket self-hosted runner](https://support.atlassian.com/bitbucket-cloud/docs/runners/)
41+
- Configure Bitbucket Pipelines to use the runner
42+
43+
**Azure DevOps Services**
44+
- Install a [Self-hosted Azure Pipelines Agent](https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/agents)
45+
- Register agent with your Azure DevOps organization
46+
47+
### Self-Hosted GitLab
48+
49+
No runner installation needed. Simply ensure:
50+
- VPC connectivity between GitLab and Bytebase servers
51+
- Network policies allow communication
52+
- If your GitLab runner lacks internet access, pre-load the bytebase-action Docker image
53+

0 commit comments

Comments
 (0)