chore: support configure classification (#85)

ecmadao · web-flow · commit 72ca6df61751 · 2025-01-09T14:24:34.000+08:00
* chore: support set roles for user in workspace level

* fix: lint

* fix: test

* chore: support group

* fix: test

* fix: test

* chore: update examples

* chore: support database catalog

* fix: lint

* chore: support workspace profile setting

* fix: lint

* chore: support configure classification

* fix: lint
diff --git a/api/setting.go b/api/setting.go
@@ -10,6 +10,8 @@ const (
 	SettingWorkspaceProfile SettingName = "bb.workspace.profile"
 	// SettingWorkspaceExternalApproval is the setting name for workspace external approval config.
 	SettingWorkspaceExternalApproval SettingName = "bb.workspace.approval.external"
+	// SettingDataClassification is the setting name for data classification.
+	SettingDataClassification SettingName = "bb.workspace.data-classification"
 )
 
 // RiskLevel is the approval risk level.
diff --git a/docs/data-sources/setting.md b/docs/data-sources/setting.md
@@ -21,6 +21,7 @@ The setting data source.
 
 ### Optional
 
+- `classification` (Block List, Max: 1) Classification for data masking. Require ENTERPRISE subscription. (see [below for nested schema](#nestedblock--classification))
 - `workspace_profile` (Block List, Max: 1) (see [below for nested schema](#nestedblock--workspace_profile))
 
 ### Read-Only
@@ -29,6 +30,39 @@ The setting data source.
 - `external_approval_nodes` (Block List) Configure external nodes in the approval flow. Require ENTERPRISE subscription. (see [below for nested schema](#nestedblock--external_approval_nodes))
 - `id` (String) The ID of this resource.
 
+<a id="nestedblock--classification"></a>
+### Nested Schema for `classification`
+
+Optional:
+
+- `classification_from_config` (Boolean) If true, we will only store the classification in the config. Otherwise we will get the classification from table/column comment, and write back to the schema metadata.
+- `classifications` (Block List) (see [below for nested schema](#nestedblock--classification--classifications))
+- `id` (String) The classification unique uuid.
+- `levels` (Block List) (see [below for nested schema](#nestedblock--classification--levels))
+- `title` (String) The classification title. Optional.
+
+<a id="nestedblock--classification--classifications"></a>
+### Nested Schema for `classification.classifications`
+
+Optional:
+
+- `description` (String) The classification description.
+- `id` (String) The classification unique id, must in {number}-{number} format.
+- `level` (String) The classification level id.
+- `title` (String) The classification title.
+
+
+<a id="nestedblock--classification--levels"></a>
+### Nested Schema for `classification.levels`
+
+Optional:
+
+- `description` (String) The classification level description.
+- `id` (String) The classification level unique uuid.
+- `title` (String) The classification level title.
+
+
+
 <a id="nestedblock--workspace_profile"></a>
 ### Nested Schema for `workspace_profile`
 
diff --git a/docs/resources/setting.md b/docs/resources/setting.md
@@ -22,6 +22,7 @@ The setting resource.
 ### Optional
 
 - `approval_flow` (Block List) Configure risk level and approval flow for different tasks. Require ENTERPRISE subscription. (see [below for nested schema](#nestedblock--approval_flow))
+- `classification` (Block List, Max: 1) Classification for data masking. Require ENTERPRISE subscription. (see [below for nested schema](#nestedblock--classification))
 - `external_approval_nodes` (Block List) Configure external nodes in the approval flow. Require ENTERPRISE subscription. (see [below for nested schema](#nestedblock--external_approval_nodes))
 - `workspace_profile` (Block List, Max: 1) (see [below for nested schema](#nestedblock--workspace_profile))
 
@@ -84,6 +85,39 @@ Optional:
 
 
 
+<a id="nestedblock--classification"></a>
+### Nested Schema for `classification`
+
+Optional:
+
+- `classification_from_config` (Boolean) If true, we will only store the classification in the config. Otherwise we will get the classification from table/column comment, and write back to the schema metadata.
+- `classifications` (Block List) (see [below for nested schema](#nestedblock--classification--classifications))
+- `id` (String) The classification unique uuid.
+- `levels` (Block List) (see [below for nested schema](#nestedblock--classification--levels))
+- `title` (String) The classification title. Optional.
+
+<a id="nestedblock--classification--classifications"></a>
+### Nested Schema for `classification.classifications`
+
+Optional:
+
+- `description` (String) The classification description.
+- `id` (String) The classification unique id, must in {number}-{number} format.
+- `level` (String) The classification level id.
+- `title` (String) The classification title.
+
+
+<a id="nestedblock--classification--levels"></a>
+### Nested Schema for `classification.levels`
+
+Optional:
+
+- `description` (String) The classification level description.
+- `id` (String) The classification level unique uuid.
+- `title` (String) The classification level title.
+
+
+
 <a id="nestedblock--external_approval_nodes"></a>
 ### Nested Schema for `external_approval_nodes`
 
diff --git a/examples/database/main.tf b/examples/database/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.6"
+      version = "1.0.7"
       # 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
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.6"
+      version = "1.0.7"
       # 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 = "1.0.6"
+      version = "1.0.7"
       # 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 = "1.0.6"
+      version = "1.0.7"
       # 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 = "1.0.6"
+      version = "1.0.7"
       # 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 = "1.0.6"
+      version = "1.0.7"
       # 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 = "1.0.6"
+      version = "1.0.7"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
@@ -29,6 +29,10 @@ data "bytebase_setting" "workspace_profile" {
   name = "bb.workspace.profile"
 }
 
+data "bytebase_setting" "classification" {
+  name = "bb.workspace.data-classification"
+}
+
 output "approval_flow" {
   value = data.bytebase_setting.approval_flow
 }
@@ -40,3 +44,7 @@ output "external_approval" {
 output "workspace_profile" {
   value = data.bytebase_setting.workspace_profile
 }
+
+output "classification" {
+  value = data.bytebase_setting.classification
+}
diff --git a/examples/setup/data_masking.tf b/examples/setup/data_masking.tf
@@ -1,6 +1,49 @@
+resource "bytebase_setting" "classification" {
+  name = "bb.workspace.data-classification"
+
+  classification {
+    id    = "unique-id"
+    title = "Classification Example"
+
+    levels {
+      id    = "1"
+      title = "Level 1"
+    }
+    levels {
+      id    = "2"
+      title = "Level 2"
+    }
+
+    classifications {
+      id    = "1"
+      title = "Basic"
+    }
+    classifications {
+      id    = "1-1"
+      title = "User basic info"
+      level = "2"
+    }
+    classifications {
+      id    = "1-2"
+      title = "User contact info"
+      level = "2"
+    }
+    classifications {
+      id    = "2"
+      title = "Relationship"
+    }
+    classifications {
+      id    = "2-1"
+      title = "Social info"
+      level = "2"
+    }
+  }
+}
+
 resource "bytebase_database_catalog" "employee_catalog" {
   depends_on = [
-    bytebase_instance.test
+    bytebase_instance.test,
+    bytebase_setting.classification
   ]
 
   database = "instances/test-sample-instance/databases/employee"
@@ -9,13 +52,13 @@ resource "bytebase_database_catalog" "employee_catalog" {
     tables {
       name = "salary"
       columns {
-        name           = "amount"
-        semantic_type  = "default"
-        classification = "1-1-1"
+        name          = "amount"
+        semantic_type = "default"
       }
       columns {
-        name          = "emp_no"
-        semantic_type = "default-partial"
+        name           = "emp_no"
+        semantic_type  = "default-partial"
+        classification = "1-1"
         labels = {
           tenant = "example"
           region = "asia"
diff --git a/examples/setup/main.tf b/examples/setup/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.6"
+      version = "1.0.7"
       # 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
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.6"
+      version = "1.0.7"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/vcs/main.tf b/examples/vcs/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.6"
+      version = "1.0.7"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/provider/data_source_setting.go b/provider/data_source_setting.go
diff --git a/provider/resource_setting.go b/provider/resource_setting.go

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ const (`
`10`	`10`	`SettingWorkspaceProfile SettingName = "bb.workspace.profile"`
`11`	`11`	`// SettingWorkspaceExternalApproval is the setting name for workspace external approval config.`
`12`	`12`	`SettingWorkspaceExternalApproval SettingName = "bb.workspace.approval.external"`
	`13`	`+ // SettingDataClassification is the setting name for data classification.`
	`14`	`+ SettingDataClassification SettingName = "bb.workspace.data-classification"`
`13`	`15`	`)`
`14`	`16`
`15`	`17`	`// RiskLevel is the approval risk level.`
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 = "1.0.6"`
	`5`	`+ version = "1.0.7"`
`6`	`6`	`# For local development, please use "terraform.local/bytebase/bytebase" instead`
`7`	`7`	`source = "registry.terraform.io/bytebase/bytebase"`
`8`	`8`	`}`
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 = "1.0.6"`
	`4`	`+ version = "1.0.7"`
`5`	`5`	`# For local development, please use "terraform.local/bytebase/bytebase" instead`
`6`	`6`	`source = "registry.terraform.io/bytebase/bytebase"`
`7`	`7`	`}`