Skip to content

Commit 9528ecc

Browse files
update
1 parent b7590ab commit 9528ecc

File tree

5 files changed

+12
-14
lines changed

5 files changed

+12
-14
lines changed

mintlify/tutorials/github-action-data-masking-part1.mdx

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ description: 'Learn how to automate semantic type and global masking rule using
1111
---
1212

1313
import ApiPreface from '/snippets/tutorials/api-preface.mdx';
14-
import StartWithNgrok from '/snippets/install/start-with-ngrok.mdx';
1514
import CreateServiceAccount from '/snippets/tutorials/create-service-account.mdx';
1615

1716
<ApiPreface />
@@ -41,18 +40,17 @@ The complete code for this tutorial is available at: [example-database-security]
4140

4241
## Prerequisites
4342

44-
Before you begin, make sure you have:
45-
46-
- [Docker](https://www.docker.com/) installed
43+
- A Bytebase instance (Bytebase Cloud or self-hosted) with Enterprise Plan
44+
- For self-hosted version, you need [Docker](https://www.docker.com/) to run Bytebase
4745
- A [GitHub](https://github.com/) account
48-
- An [ngrok](http://ngrok.com/) account
49-
- Bytebase Enterprise Plan subscription (you can request a free trial)
5046

5147
## Setup Instructions
5248

53-
### Step 1 - Start Bytebase in Docker and set the External URL generated by ngrok
49+
### Step 1 - Set up Bytebase
50+
51+
import BytebaseSetupOptions from '/snippets/tutorials/bytebase-setup-options.mdx';
5452

55-
<StartWithNgrok />
53+
<BytebaseSetupOptions />
5654

5755
### Step 2 - Create Service Account
5856

@@ -72,7 +70,7 @@ Before you begin, make sure you have:
7270

7371
1. Click **Settings** and then click **Secrets and variables > Actions**. Add the following secrets:
7472

75-
- `BYTEBASE_URL`: ngrok external URL
73+
- `BYTEBASE_URL`: Your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your Bytebase Cloud URL)
7674
- `BYTEBASE_SERVICE_KEY`: `[email protected]`
7775
- `BYTEBASE_SERVICE_SECRET`: service key copied in the previous step
7876

mintlify/tutorials/gitops-azure-devops-workflow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ import BytebaseSetupOptions from '/snippets/tutorials/bytebase-setup-options.mdx
6161

6262
1. Go into `pipelines/sql-review.yml` and `pipelines/rollout-release.yml`. In the `env` section, replace the variable values with your own and commit the changes.
6363

64-
- **BYTEBASE_URL**: Your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your ngrok URL if testing locally)
64+
- **BYTEBASE_URL**: Your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your Bytebase Cloud URL)
6565
- **BYTEBASE_SERVICE_ACCOUNT**: `[email protected]` (the service account you created in the previous step)
6666
- **BYTEBASE_PROJECT**: `projects/project-sample` (the sample project in the Bytebase)
6767
- **BYTEBASE_TARGETS**: `instances/test-sample-instance/databases/hr_test,instances/prod-sample-instance/databases/hr_prod` (the two default databases in the sample project)

mintlify/tutorials/gitops-bitbucket-workflow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ _Note: Usually we enable SQL review for `Prod` environment as above. In this dem
6868

6969
1. Go into `bitbucket-pipelines.yml`, replace the variable in all 3 steps the values with your own and commit the changes.
7070

71-
- **BYTEBASE_URL**: Your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your ngrok URL if testing locally)
71+
- **BYTEBASE_URL**: Your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your Bytebase Cloud URL)
7272
- **BYTEBASE_SERVICE_ACCOUNT**: `[email protected]` (the service account you created in the previous step)
7373
- **BYTEBASE_SERVICE_ACCOUNT_SECRET**: the password of the service account
7474

mintlify/tutorials/gitops-github-workflow.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ import BytebaseSetupOptions from '/snippets/tutorials/bytebase-setup-options.mdx
7474

7575
1. Go into `.github/workflows/release-action.yml` and `.github/workflows/sql-review-action.yml`. In the `env` section, replace the variable values with your own and commit the changes.
7676

77-
- **BYTEBASE_URL**: Your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your ngrok URL if testing locally)
77+
- **BYTEBASE_URL**: Your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your Bytebase Cloud URL)
7878
- **BYTEBASE_SERVICE_ACCOUNT**: `[email protected]` (the service account you created in the previous step)
7979
- **BYTEBASE_PROJECT**: `projects/project-sample` (the sample project in the Bytebase)
8080
- **BYTEBASE_TARGETS**: `instances/test-sample-instance/databases/hr_test,instances/prod-sample-instance/databases/hr_prod` (the two default databases in the sample project)
@@ -183,7 +183,7 @@ Team members can trigger deployments by commenting `/migrate <environment>` on a
183183

184184
1. Go into `.github/workflows/chatops-migrate.yml`. In the `env` section, replace the variable values with your own:
185185

186-
- **BYTEBASE_URL**: your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your ngrok URL if testing locally)
186+
- **BYTEBASE_URL**: Your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your Bytebase Cloud URL)
187187
- **BYTEBASE_SERVICE_ACCOUNT**: `[email protected]`
188188
- **BYTEBASE_PROJECT**: `projects/project-sample`
189189
- **FILE_PATTERN**: `migrations-semver/*.sql`

mintlify/tutorials/gitops-gitlab-workflow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ _Note: Usually we enable SQL review for `Prod` environment as above. In this dem
7373

7474
1. Go into `bytebase-review.yml` and `bytebase-rollout.yml`. In the `env` section, replace the variable values with your own and commit the changes.
7575

76-
- **BYTEBASE_URL**: Your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your ngrok URL if testing locally)
76+
- **BYTEBASE_URL**: Your Bytebase instance URL (e.g., `https://bytebase.your-company.com` or your Bytebase Cloud URL)
7777
- **BYTEBASE_SERVICE_ACCOUNT**: `[email protected]` (the service account you created in the previous step)
7878
- **BYTEBASE_SERVICE_ACCOUNT_SECRET**: the password of the service account
7979

0 commit comments

Comments
 (0)