chore: migration doc (#171)

ecmadao · web-flow · commit 97c346d85e41 · 2026-02-10T15:51:15.000+08:00
* chore: migration doc

* chore: update docs
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-3.15.0
+3.15.1
diff --git a/docs/data-sources/iam_policy.md b/docs/data-sources/iam_policy.md
@@ -40,17 +40,18 @@ Optional:
 Optional:
 
 - `condition` (Block Set) Match the condition limit. (see [below for nested schema](#nestedblock--iam_policy--binding--condition))
-- `members` (Set of String) A set of memebers. The value can be "allUsers", "user:{email}" or "group:{email}".
+- `members` (Set of String) A set of memebers. The value can be "allUsers", "user:{email}", "group:{email}", "serviceAccount:{email}" or "workloadIdentity:{email}".
 - `role` (String) The role full name in roles/{id} format.
 
 <a id="nestedblock--iam_policy--binding--condition"></a>
 ### Nested Schema for `iam_policy.binding.condition`
 
 Optional:
 
-- `database` (String) The accessible database full name in instances/{instance resource id}/databases/{database name} format
+- `database` (String) The accessible database full name in instances/{instance resource id}/databases/{database name} format. Only works for the role with bb.sql.x permissions.
+- `environment_ids` (Set of String) The environment ID list to allow the DDL/DML operation in the SQL Editor. Only works for the role with bb.sql.ddl or bb.sql.dml permissions.
 - `expire_timestamp` (String) The expiration timestamp in YYYY-MM-DDThh:mm:ssZ format
-- `schema` (String) The accessible schema in the database
-- `tables` (Set of String) The accessible table list
+- `schema` (String) The accessible schema in the database. Must configure with the database.
+- `tables` (Set of String) The accessible table list. Must configure with the database.
 
 
diff --git a/docs/resources/iam_policy.md b/docs/resources/iam_policy.md
@@ -40,17 +40,18 @@ Optional:
 Optional:
 
 - `condition` (Block Set) Match the condition limit. (see [below for nested schema](#nestedblock--iam_policy--binding--condition))
-- `members` (Set of String) A set of memebers. The value can be "allUsers", "user:{email}" or "group:{email}".
+- `members` (Set of String) A set of memebers. The value can be "allUsers", "user:{email}", "group:{email}", "serviceAccount:{email}" or "workloadIdentity:{email}".
 - `role` (String) The role full name in roles/{id} format.
 
 <a id="nestedblock--iam_policy--binding--condition"></a>
 ### Nested Schema for `iam_policy.binding.condition`
 
 Optional:
 
-- `database` (String) The accessible database full name in instances/{instance resource id}/databases/{database name} format
+- `database` (String) The accessible database full name in instances/{instance resource id}/databases/{database name} format. Only works for the role with bb.sql.x permissions.
+- `environment_ids` (Set of String) The environment ID list to allow the DDL/DML operation in the SQL Editor. Only works for the role with bb.sql.ddl or bb.sql.dml permissions.
 - `expire_timestamp` (String) The expiration timestamp in YYYY-MM-DDThh:mm:ssZ format
-- `schema` (String) The accessible schema in the database
-- `tables` (Set of String) The accessible table list
+- `schema` (String) The accessible schema in the database. Must configure with the database.
+- `tables` (Set of String) The accessible table list. Must configure with the database.
 
 
diff --git a/examples/approval/main.tf b/examples/approval/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "terraform.local/bytebase/bytebase"
     }
diff --git a/examples/database/main.tf b/examples/database/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/database_group/main.tf b/examples/database_group/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/environments/main.tf b/examples/environments/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/groups/main.tf b/examples/groups/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/iamPolicy/main.tf b/examples/iamPolicy/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/instances/main.tf b/examples/instances/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/policies/main.tf b/examples/policies/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/projects/main.tf b/examples/projects/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/roles/main.tf b/examples/roles/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/settings/main.tf b/examples/settings/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/setup/iam.tf b/examples/setup/iam.tf
@@ -92,6 +92,7 @@ resource "bytebase_iam_policy" "project_iam" {
         database         = "instances/test-sample-instance/databases/employee"
         tables           = ["dept_emp", "dept_manager"]
         expire_timestamp = "2027-03-09T16:17:49Z"
+        environment_ids  = ["test"] # allow DDL/DML in test environment.
       }
     }
   }
diff --git a/examples/setup/main.tf b/examples/setup/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/setup/users.tf b/examples/setup/users.tf
@@ -1,4 +1,9 @@
 # Create or update the user.
+resource "bytebase_user" "workspace_owner" {
+  title = "Owner"
+  email = "owner@bytebase.com"
+}
+
 resource "bytebase_user" "workspace_dba" {
   title = "DBA"
   email = "dba@bytebase.com"
@@ -83,4 +88,4 @@ resource "bytebase_group" "project_owners" {
     member = format("users/%s", bytebase_user.workspace_dba.email)
     role   = "MEMBER"
   }
-}
+}
diff --git a/examples/sql_review/main.tf b/examples/sql_review/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/users/main.tf b/examples/users/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "3.15.0"
+      version = "3.15.1"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/migration/3.15.1.md b/migration/3.15.1.md
diff --git a/provider/data_source_iam_policy.go b/provider/data_source_iam_policy.go
diff --git a/provider/data_source_policy.go b/provider/data_source_policy.go
diff --git a/provider/internal/cel.go b/provider/internal/cel.go
diff --git a/provider/resource_iam_policy.go b/provider/resource_iam_policy.go
diff --git a/provider/resource_policy.go b/provider/resource_policy.go
diff --git a/tutorials/0-provider.tf b/tutorials/0-provider.tf

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`terraform {`
`2`	`2`	`required_providers {`
`3`	`3`	`bytebase = {`
`4`		`- version = "3.15.0"`
	`4`	`+ version = "3.15.1"`
`5`	`5`	`# For local development, please use "terraform.local/bytebase/bytebase" instead`
`6`	`6`	`source = "terraform.local/bytebase/bytebase"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`terraform {`
`3`	`3`	`required_providers {`
`4`	`4`	`bytebase = {`
`5`		`- version = "3.15.0"`
	`5`	`+ version = "3.15.1"`
`6`	`6`	`# For local development, please use "terraform.local/bytebase/bytebase" instead`
`7`	`7`	`source = "registry.terraform.io/bytebase/bytebase"`
`8`	`8`	`}`