Skip to content

docs: improve GCP service account authentication documentation #839

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.

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
merged 1 commit into from
Aug 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
199 changes: 88 additions & 111 deletions mintlify/get-started/instance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -301,150 +301,127 @@ Go to instance setting, specify `bytebase` as the Secret name and `DB_PASSWORD`

## GCP Configuration

### Cloud SQL with IAM Authentication
### Prerequisites: Service Account Setup

This guide demonstrates the most secure method for IAM authentication using GCE VM service accounts, which eliminates the need to manage service account keys.

For alternative authentication methods, refer to the official Google Cloud documentation:
- [Cloud SQL IAM database authentication overview](https://cloud.google.com/sql/docs/mysql/iam-authentication)
- [Using automatic IAM database authentication](https://cloud.google.com/sql/docs/mysql/iam-authentication#automatic)
- [Configuring instances for IAM database authentication](https://cloud.google.com/sql/docs/mysql/create-edit-iam-instances)
- [Managing users with IAM database authentication](https://cloud.google.com/sql/docs/mysql/iam-users)

#### Step 1: Create and Configure GCE VM with Service Account

1. **Create a Service Account**
- Go to [IAM & Admin → Service Accounts](https://console.cloud.google.com/iam-admin/serviceaccounts)
- Click **Create Service Account**
- Name: `bytebase-cloudsql`
- Description: "Service account for Bytebase to connect to Cloud SQL"
- Click **Create and Continue**

2. **Grant Required Permissions**
- Add these roles to the service account:
- `Cloud SQL Client` (for database connections)
- `Cloud SQL Instance User` (for IAM authentication)
- Click **Continue** and then **Done**
- Note the service account email: `bytebase-cloudsql@PROJECT_ID.iam.gserviceaccount.com`

3. **Create GCE VM with Service Account**
- Go to [Compute Engine → VM instances](https://console.cloud.google.com/compute/instances)
- Click **Create Instance**
- Under **Identity and API access**:
- Service account: Select `bytebase-cloudsql@PROJECT_ID.iam.gserviceaccount.com`
- Access scopes: Select "Allow full access to all Cloud APIs" or manually select Cloud SQL scopes
- Configure other VM settings as needed
- Click **Create**

> **Security Best Practice:** The VM automatically receives credentials through the metadata service. No service account keys are needed, reducing security risks. Learn more: [Service account impersonation](https://cloud.google.com/iam/docs/service-account-impersonation)

#### Step 2: Configure Cloud SQL Instance

1. **Enable IAM Authentication**
- Go to [Cloud SQL Instances](https://console.cloud.google.com/sql/instances)
- Select your instance or create a new one
- Click **Edit**
- Under **Customize your instance** → **Flags**:
- Add flag: `cloudsql_iam_authentication` = `on`
- Click **Save**

Reference: [Configuring instances for IAM authentication](https://cloud.google.com/sql/docs/mysql/create-edit-iam-instances)
Use attached service accounts for secure, key-free authentication on:
- **GCE** - VMs with attached service accounts
- **GKE** - Pods with Workload Identity

2. **Verify SSL/TLS Configuration**
- SSL is required for IAM authentication
- Cloud SQL enables SSL by default - no additional configuration needed
- Reference: [Configuring SSL/TLS](https://cloud.google.com/sql/docs/mysql/configure-ssl-instance)
References: [Service accounts](https://cloud.google.com/iam/docs/service-account-overview) | [Best practices](https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys) | [ADC](https://cloud.google.com/docs/authentication/application-default-credentials)

#### Step 3: Create Database Users
#### Create Service Account

Connect to your Cloud SQL instance using the root user or an admin account:
1. Go to [IAM & Admin → Service Accounts](https://console.cloud.google.com/iam-admin/serviceaccounts)
2. Create service account named `bytebase`
3. Grant roles as needed:
- `Cloud SQL Client` and `Cloud SQL Instance User` - for Cloud SQL
- `Secret Manager Secret Accessor` - for Secret Manager
4. Note the email: `bytebase@PROJECT_ID.iam.gserviceaccount.com`

**Cloud SQL for MySQL:**
```sql
CREATE USER 'bytebase-cloudsql'@'%' IDENTIFIED WITH 'cloudsql_iam_user';
```
#### Attach Service Account

**Cloud SQL for PostgreSQL:**
```sql
CREATE USER "bytebase-cloudsql@PROJECT_ID.iam" WITH LOGIN;
GRANT cloudsqliamuser TO "bytebase-cloudsql@PROJECT_ID.iam";
```
**Option A: GCE VM**
1. Create VM in [Compute Engine](https://console.cloud.google.com/compute/instances)
2. Set service account: `bytebase@PROJECT_ID.iam.gserviceaccount.com`
3. Set access scopes: "Allow full access to all Cloud APIs"

Reference: [MySQL IAM users](https://cloud.google.com/sql/docs/mysql/iam-users) | [PostgreSQL IAM users](https://cloud.google.com/sql/docs/postgres/iam-users)

#### Step 4: Deploy Bytebase on GCE VM
**Option B: GKE with Workload Identity**
```bash
# Create Kubernetes service account
kubectl create serviceaccount bytebase-ksa

Deploy Bytebase on your GCE VM instance. The VM's attached service account credentials are automatically available to Bytebase through the metadata service - no GOOGLE_APPLICATION_CREDENTIALS configuration needed.
# Bind to Google service account
kubectl annotate serviceaccount bytebase-ksa \
iam.gke.io/gcp-service-account=bytebase@PROJECT_ID.iam.gserviceaccount.com

#### Step 5: Connect from Bytebase
# Allow impersonation
gcloud iam service-accounts add-iam-policy-binding bytebase@PROJECT_ID.iam.gserviceaccount.com \
--role roles/iam.workloadIdentityUser \
--member "serviceAccount:PROJECT_ID.svc.id.goog[NAMESPACE/bytebase-ksa]"
```

1. Access Bytebase at `http://VM_EXTERNAL_IP:5678`
2. Click **New Instance**
3. Configure the connection:
- **Host:** Your Cloud SQL connection name (format: `PROJECT_ID:REGION:INSTANCE_ID`)
- Find this in Cloud SQL console → Instance details → Connection name
- **Port:** 3306 (MySQL) or 5432 (PostgreSQL)
- **Username:**
- MySQL: `bytebase-cloudsql`
- PostgreSQL: `bytebase-cloudsql@PROJECT_ID.iam`
- **Authentication:** Select `Google Cloud SQL IAM`
4. Test and save the connection
Reference: [Workload Identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity)

<Tip>
The GCE VM approach eliminates service account key management - credentials are automatically handled through the metadata service. Learn more: [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials) | [Troubleshooting IAM authentication](https://cloud.google.com/sql/docs/mysql/iam-authentication#troubleshooting)
</Tip>
Deploy Bytebase on your resource - credentials are provided automatically.

### GCP Secret Manager
#### Alternative: Service Account Keys

#### Create a service account to access the Secret Manager
<Warning>
Use only when running Bytebase outside GCP. See [why to avoid service account keys](https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys#avoid).
</Warning>

<Tip>
It's recommended to create a dedicated service account for Bytebase to retrieve the secrets. You only need to do this once.
</Tip>
1. Create a service account with required roles
2. Download the JSON key file
3. Set environment variable:
```bash
-e GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json
```

Visit [Service accounts](https://console.cloud.google.com/iam-admin/serviceaccounts) to create a new service account.
Reference: [Service account keys authentication](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key)

![](/content/docs/get-started/instance/gcp-secret-manager/create-service-account-name.webp)
### Cloud SQL with IAM Authentication

Grant `Secret Manager Secret Accessor` permission to the service account.
<Note>
Prerequisites: [Service account](#prerequisites-service-account-setup) with Cloud SQL roles.
</Note>

![](/content/docs/get-started/instance/gcp-secret-manager/create-service-account-permission.webp)
References: [IAM authentication](https://cloud.google.com/sql/docs/mysql/iam-authentication) | [Configure instances](https://cloud.google.com/sql/docs/mysql/create-edit-iam-instances)

After the service account is created, visit its `KEYS` page and add a new key.
#### Step 1: Configure Cloud SQL Instance

![](/content/docs/get-started/instance/gcp-secret-manager/create-key-file.webp)
1. In [Cloud SQL](https://console.cloud.google.com/sql/instances), edit your instance
2. Add flag: `cloudsql_iam_authentication` = `on`
3. Save (SSL is enabled by default)

Choose `JSON` as the key type and create. Keep the downloaded private key file. This will be passed as environment variables when starting Bytebase.
#### Step 2: Add Service Account User

![](/content/docs/get-started/instance/gcp-secret-manager/create-key-file2.webp)
**Using gcloud:**
```bash
gcloud sql users create bytebase@PROJECT_ID.iam.gserviceaccount.com \
--instance=INSTANCE_NAME \
--type=cloud_iam_service_account
```

#### Create secret
**Using Console:**
Instance → Users → Add User Account → Cloud IAM → Enter service account email

Visit [GCP Secret Manager](https://console.cloud.google.com/security/secret-manager/create) to create a new secret.
References: [MySQL](https://cloud.google.com/sql/docs/mysql/add-manage-iam-users) | [PostgreSQL](https://cloud.google.com/sql/docs/postgres/add-manage-iam-users)

![](/content/docs/get-started/instance/gcp-secret-manager/create-secret.webp)
#### Step 3: Connect from Bytebase

After creation, note the fully qualified secret name.
1. Click **New Instance** in Bytebase
2. Configure connection details:
- **Host:** Your Cloud SQL connection name (`PROJECT_ID:REGION:INSTANCE_ID`)
- Find this in Cloud SQL console → Instance details
- **Port:** 3306 (MySQL) or 5432 (PostgreSQL)
- **Username:**
- MySQL: `bytebase` (service account name only)
- PostgreSQL: `bytebase@PROJECT_ID.iam` (with project ID)
- **Authentication:** Select `Google Cloud SQL IAM`
3. Click **Test Connection** then **Create**

![](/content/docs/get-started/instance/gcp-secret-manager/secret-full-name.webp)
### GCP Secret Manager

#### Use secret in Bytebase
Store database passwords securely in Google Cloud Secret Manager instead of Bytebase.

Restart Bytebase by specifying `GOOGLE_APPLICATION_CREDENTIALS`=`private key file` as an environment variable. The private key file is the JSON file downloaded before for the service account.
<Note>
Prerequisites: [Service account](#prerequisites-service-account-setup) with `Secret Manager Secret Accessor` role.
</Note>

<Tip>
If you run Bytebase in docker, you need to put the JSON file under the mounted directory. Otherwise, Bytebase won't be able to access the key file.
</Tip>
#### Step 1: Create Secret

```bash
docker run --init \
-e GOOGLE_APPLICATION_CREDENTIALS=/var/opt/bytebase/key.json \
...
```
1. Go to [Secret Manager Console](https://console.cloud.google.com/security/secret-manager)
2. Click **Create Secret**
3. Enter secret name (e.g., `db-password`) and your database password as value
4. Click **Create** and note the resource name: `projects/PROJECT_ID/secrets/SECRET_NAME`

Go to instance setting, specify the fully qualified name such as `projects/228712144016/secrets/DB_PASSWORD` as the Secret full name.
#### Step 2: Configure in Bytebase

![](/content/docs/get-started/instance/gcp-secret-manager/auth.webp)
1. In your database instance settings, find the password field
2. Click the key icon to use external secret
3. Select **GCP Secret Manager**
4. Enter the secret resource name from Step 1
5. Test connection and save

## Azure Configuration

Expand Down