diff --git a/mintlify/content/docs/get-started/instance/bb-instance-read-only-connection.webp b/mintlify/content/docs/get-started/instance/bb-instance-read-only-connection.webp deleted file mode 100644 index 9ea43039d..000000000 Binary files a/mintlify/content/docs/get-started/instance/bb-instance-read-only-connection.webp and /dev/null differ diff --git a/mintlify/content/docs/get-started/instance/bb-instance-ssh-connection.webp b/mintlify/content/docs/get-started/instance/bb-instance-ssh-connection.webp deleted file mode 100644 index d0ff11c65..000000000 Binary files a/mintlify/content/docs/get-started/instance/bb-instance-ssh-connection.webp and /dev/null differ diff --git a/mintlify/content/docs/get-started/instance/external-secret-manager-flow.webp b/mintlify/content/docs/get-started/instance/external-secret-manager-flow.webp deleted file mode 100644 index c1f2c806e..000000000 Binary files a/mintlify/content/docs/get-started/instance/external-secret-manager-flow.webp and /dev/null differ diff --git a/mintlify/content/docs/get-started/instance/ssh-explain.webp b/mintlify/content/docs/get-started/instance/ssh-explain.webp deleted file mode 100644 index a751a2fc2..000000000 Binary files a/mintlify/content/docs/get-started/instance/ssh-explain.webp and /dev/null differ diff --git a/mintlify/content/docs/get-started/instance/vault/auth.webp b/mintlify/content/docs/get-started/instance/vault/auth.webp deleted file mode 100644 index 60c0c4bc6..000000000 Binary files a/mintlify/content/docs/get-started/instance/vault/auth.webp and /dev/null differ diff --git a/mintlify/content/docs/get-started/instance/vault/create-secret.webp b/mintlify/content/docs/get-started/instance/vault/create-secret.webp deleted file mode 100644 index ac17d51ec..000000000 Binary files a/mintlify/content/docs/get-started/instance/vault/create-secret.webp and /dev/null differ diff --git a/mintlify/get-started/instance.mdx b/mintlify/get-started/instance.mdx index 0ddaa9ff1..bb8709536 100644 --- a/mintlify/get-started/instance.mdx +++ b/mintlify/get-started/instance.mdx @@ -47,46 +47,35 @@ Before configuring connection parameters, ensure network connectivity: Additional parameters vary by database type - see [Database-Specific Guides](#database-specific-guides) for your database's requirements. -### Advanced Options +### Read-Only Connections -#### Read-Only Connections - -Configure separate read-only connections for enhanced security and performance: - - -Read-only connections are used for: +Configure separate read-only connections for enhanced security and performance. Read-only connections are used for: - SQL Editor queries with [data source restrictions](/sql-editor/settings/data-source-restriction) - [Export Center operations](/security/database-permission/export#request-from-export-center) - -**Setup Steps:** +**Setup:** 1. Create a read-only database user or configure a read-replica -2. Click **Create** or **+** on **Connection info** +2. In Bytebase, click **+** next to **Connection Info** 3. Enter the read-only connection details -4. Click **Update** to save - -![Read-only connection configuration](/content/docs/get-started/instance/bb-instance-read-only-connection.webp) +4. Save the configuration -#### SSH Tunnel +### SSH Tunnel -Connect to databases behind firewalls using SSH tunneling: - -![SSH tunnel architecture](/content/docs/get-started/instance/ssh-explain.webp) +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. -**Configuration:** -1. Fill in standard database connection details -2. Select **SSH Connection** > **Tunnel + Private Key** -3. Provide SSH connection information: - - SSH Host & Port - - SSH Username - - Private Key or Password -4. Test connection and click **Create** +**Setup:** +1. Enter your database connection details as usual +2. Enable **SSH Connection** and select **Tunnel + Private Key** +3. Configure SSH tunnel settings: + - **SSH Host**: Bastion host or jump server address + - **SSH Port**: SSH port (typically 22) + - **SSH User**: Username for SSH authentication + - **Private Key** or **Password**: SSH authentication credentials +4. Test the connection and save -![SSH tunnel setup](/content/docs/get-started/instance/bb-instance-ssh-connection.webp) - -#### Connection Parameters +### Connection Parameters Customize connection behavior with database-specific parameters: @@ -105,15 +94,11 @@ Customize connection behavior with database-specific parameters: - [SQL Server Parameters](https://pkg.go.dev/github.com/microsoft/go-mssqldb#section-readme) - [Oracle Parameters](https://github.com/sijms/go-ora) -### Security Features - -#### Secret Manager +### Secret Manager -Store database credentials securely in secret managers instead of Bytebase's internal storage. - -![External secret manager flow](/content/docs/get-started/instance/external-secret-manager-flow.webp) +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. **Supported Providers:** - **HashiCorp Vault** - Configure below @@ -121,7 +106,7 @@ Store database credentials securely in secret managers instead of Bytebase's int - **[GCP Secret Manager](#gcp-secret-manager)** - See GCP configuration section - **Custom API Endpoint** - Configure below -##### HashiCorp Vault +#### HashiCorp Vault Requires Vault KV v2 engine @@ -134,8 +119,6 @@ Requires Vault KV v2 engine - Key: `DB_PASSWORD` - Value: Your password -![Vault secret creation](/content/docs/get-started/instance/vault/create-secret.webp) - **Bytebase Configuration:** 1. Enter Vault URL 2. Choose authentication method: @@ -143,9 +126,7 @@ Requires Vault KV v2 engine - **[AppRole](https://developer.hashicorp.com/vault/docs/auth/approle)**: Provide role ID and secret ID 3. Specify secret location (engine/path/key) -![Vault authentication](/content/docs/get-started/instance/vault/auth.webp) - -##### Custom API Endpoint +#### Custom API Endpoint Integrate with custom secret managers using your API: