Skip to content

Commit 11bc9fc

Browse files
d-bytebaseclaude
andauthored
docs: clean up instance connection documentation (#835)
- Remove unnecessary image references and files from instance.mdx - Consolidate Advanced Options and Security Features sections - Improve clarity of SSH Tunnel and Secret Manager descriptions - Simplify Read-Only Connections setup instructions - Remove 6 outdated webp images that were cluttering the docs 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude <[email protected]>
1 parent 6584fa9 commit 11bc9fc

File tree

7 files changed

+21
-40
lines changed

7 files changed

+21
-40
lines changed
Binary file not shown.
Binary file not shown.
Binary file not shown.
-30.5 KB
Binary file not shown.
-29.3 KB
Binary file not shown.
Binary file not shown.

mintlify/get-started/instance.mdx

Lines changed: 21 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -47,46 +47,35 @@ Before configuring connection parameters, ensure network connectivity:
4747

4848
Additional parameters vary by database type - see [Database-Specific Guides](#database-specific-guides) for your database's requirements.
4949

50-
### Advanced Options
50+
### Read-Only Connections
5151

52-
#### Read-Only Connections
53-
54-
Configure separate read-only connections for enhanced security and performance:
55-
56-
<Note>
57-
Read-only connections are used for:
52+
Configure separate read-only connections for enhanced security and performance. Read-only connections are used for:
5853
- SQL Editor queries with [data source restrictions](/sql-editor/settings/data-source-restriction)
5954
- [Export Center operations](/security/database-permission/export#request-from-export-center)
60-
</Note>
6155

62-
**Setup Steps:**
56+
**Setup:**
6357
1. Create a read-only database user or configure a read-replica
64-
2. Click **Create** or **+** on **Connection info**
58+
2. In Bytebase, click **+** next to **Connection Info**
6559
3. Enter the read-only connection details
66-
4. Click **Update** to save
67-
68-
![Read-only connection configuration](/content/docs/get-started/instance/bb-instance-read-only-connection.webp)
60+
4. Save the configuration
6961

70-
#### SSH Tunnel
62+
### SSH Tunnel
7163

7264
<PricingPlanBlock feature_name="SSH_TUNNEL" />
7365

74-
Connect to databases behind firewalls using SSH tunneling:
75-
76-
![SSH tunnel architecture](/content/docs/get-started/instance/ssh-explain.webp)
66+
Use SSH tunneling to connect through a bastion host or jump server when your database is behind a firewall, in a private network, or requires specific security policies for access. This is common for databases in different VPCs or restricted network segments.
7767

78-
**Configuration:**
79-
1. Fill in standard database connection details
80-
2. Select **SSH Connection** > **Tunnel + Private Key**
81-
3. Provide SSH connection information:
82-
- SSH Host & Port
83-
- SSH Username
84-
- Private Key or Password
85-
4. Test connection and click **Create**
68+
**Setup:**
69+
1. Enter your database connection details as usual
70+
2. Enable **SSH Connection** and select **Tunnel + Private Key**
71+
3. Configure SSH tunnel settings:
72+
- **SSH Host**: Bastion host or jump server address
73+
- **SSH Port**: SSH port (typically 22)
74+
- **SSH User**: Username for SSH authentication
75+
- **Private Key** or **Password**: SSH authentication credentials
76+
4. Test the connection and save
8677

87-
![SSH tunnel setup](/content/docs/get-started/instance/bb-instance-ssh-connection.webp)
88-
89-
#### Connection Parameters
78+
### Connection Parameters
9079

9180
Customize connection behavior with database-specific parameters:
9281

@@ -105,23 +94,19 @@ Customize connection behavior with database-specific parameters:
10594
- [SQL Server Parameters](https://pkg.go.dev/github.com/microsoft/go-mssqldb#section-readme)
10695
- [Oracle Parameters](https://github.com/sijms/go-ora)
10796

108-
### Security Features
109-
110-
#### Secret Manager
97+
### Secret Manager
11198

11299
<PricingPlanBlock feature_name="EXTERNAL_SECRET_MANAGER" />
113100

114-
Store database credentials securely in secret managers instead of Bytebase's internal storage.
115-
116-
![External secret manager flow](/content/docs/get-started/instance/external-secret-manager-flow.webp)
101+
Integrate with external secret managers for centralized credential management. Use this for corporate compliance, automatic password rotation, or when you prefer not to store credentials directly in Bytebase.
117102

118103
**Supported Providers:**
119104
- **HashiCorp Vault** - Configure below
120105
- **[AWS Secrets Manager](#aws-secrets-manager)** - See AWS configuration section
121106
- **[GCP Secret Manager](#gcp-secret-manager)** - See GCP configuration section
122107
- **Custom API Endpoint** - Configure below
123108

124-
##### HashiCorp Vault
109+
#### HashiCorp Vault
125110

126111
<Note>
127112
Requires Vault KV v2 engine
@@ -134,18 +119,14 @@ Requires Vault KV v2 engine
134119
- Key: `DB_PASSWORD`
135120
- Value: Your password
136121

137-
![Vault secret creation](/content/docs/get-started/instance/vault/create-secret.webp)
138-
139122
**Bytebase Configuration:**
140123
1. Enter Vault URL
141124
2. Choose authentication method:
142125
- **[Token](https://developer.hashicorp.com/vault/docs/auth/token)**: Provide access token
143126
- **[AppRole](https://developer.hashicorp.com/vault/docs/auth/approle)**: Provide role ID and secret ID
144127
3. Specify secret location (engine/path/key)
145128

146-
![Vault authentication](/content/docs/get-started/instance/vault/auth.webp)
147-
148-
##### Custom API Endpoint
129+
#### Custom API Endpoint
149130

150131
Integrate with custom secret managers using your API:
151132

0 commit comments

Comments
 (0)