Terraform Provider

Bytebase provides the Terraform Provider to let you manage your Bytebase resources via Terraform.

Terraform Provider → Bytebase Configuration
                      ├── Instances, Projects & Environments
                      ├── Access Policies
                      └── Settings such as Approval Workflows

Bytebase UI/API → Database Operations
                   ├── Database Creation
                   ├── Schema Migrations (DDL)
                   ├── Data Changes (DML)
                   └── Query

​

Setup

1. Create service account. After creation, you can copy the service key as service_key and the email as service_account to initialize the Terraform provider in the next step.

2. Configure Bytebase Terraform Provider

   • Provider docs
   • Usage examples

​

Troubleshoot

​

status: 404

This often happens when someone deletes the resources from the Bytebase UI and then attempts to run terraform apply.

To recover, please run terraform refresh to refresh the state first.