Disable alerts until server side issues are fixed (#3603)

shreyas-goenka · web-flow · commit ab83bd46ac59 · 2025-09-16T13:29:12.000+02:00
## Why Alerts API today has issues that make the DABs UX borderline unusable. Examples are: 1. The validation errors are not readable. 2. Server side defaults configured for many fields cause TF errors. This PR disables alerts until these issues are worked out. Support for alerts was originally added in #3033 ## Tests Existing tests.
diff --git a/NEXT_CHANGELOG.md b/NEXT_CHANGELOG.md
@@ -3,7 +3,6 @@
 ## Release v0.269.0
 
 ### Notable Changes
-* Add support for SQL Alerts in DABs ([#3033](https://github.com/databricks/cli/pull/3033))
 
 ### CLI
 
diff --git a/acceptance/bundle/deploy/alerts/basic/out.test.toml b/acceptance/bundle/deploy/alerts/basic/out.test.toml
@@ -1,5 +1,5 @@
 Local = false
-Cloud = true
+Cloud = false
 
 [EnvMatrix]
   DATABRICKS_CLI_DEPLOYMENT = ["terraform"]
diff --git a/acceptance/bundle/deploy/alerts/basic/test.toml b/acceptance/bundle/deploy/alerts/basic/test.toml
@@ -1,4 +1,4 @@
-Cloud = true
+Cloud = false
 Local = false
 
 # Permissions with alerts does not work with direct deployment yet.
diff --git a/acceptance/bundle/deployment/bind/alert/test.toml b/acceptance/bundle/deployment/bind/alert/test.toml
@@ -1,3 +1,4 @@
 Cloud = false
+Local = false # Enable when releasing support for alerts.
 
 BundleConfigTarget = "databricks.yml"
diff --git a/acceptance/bundle/summary/modified_status/output.txt b/acceptance/bundle/summary/modified_status/output.txt
@@ -1,19 +1,11 @@
 
 === Initial view of resources without id and modified_status=created
 >>> [CLI] bundle summary -o json
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:4:3
+
 {
-  "alerts": {
-    "my_alert": {
-      "custom_description": "test-alert-description",
-      "custom_summary": "test-alert-summary",
-      "display_name": "test-alert",
-      "modified_status": "created",
-      "parent_path": "/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/resources",
-      "permissions": [],
-      "query_text": "SELECT 1",
-      "warehouse_id": "test-sql-warehouse"
-    }
-  },
   "pipelines": {
     "my_pipeline": {
       "channel": "CURRENT",
@@ -58,27 +50,22 @@
 }
 
 >>> [CLI] bundle deploy
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:4:3
+
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle/default/files...
 Deploying resources...
 Updating deployment state...
 Deployment complete!
 
 === Post-deployment view of resources with id and without modified_status
 >>> [CLI] bundle summary -o json
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:4:3
+
 {
-  "alerts": {
-    "my_alert": {
-      "custom_description": "test-alert-description",
-      "custom_summary": "test-alert-summary",
-      "display_name": "test-alert",
-      "id": "[UUID]",
-      "parent_path": "/Workspace/Users/[USERNAME]/.bundle/test-bundle/default/resources",
-      "permissions": [],
-      "query_text": "SELECT 1",
-      "url": "[DATABRICKS_URL]/sql/alerts-v2/[UUID]?o=[NUMID]",
-      "warehouse_id": "test-sql-warehouse"
-    }
-  },
   "pipelines": {
     "my_pipeline": {
       "channel": "CURRENT",
@@ -128,13 +115,6 @@ Deployment complete!
 === Expecting all resources to have modified_status=deleted
 >>> [CLI] bundle summary -o json
 {
-  "alerts": {
-    "my_alert": {
-      "id": "[UUID]",
-      "modified_status": "deleted",
-      "url": "[DATABRICKS_URL]/sql/alerts-v2/[UUID]?o=[NUMID]"
-    }
-  },
   "pipelines": {
     "my_pipeline": {
       "id": "[UUID]",
@@ -160,7 +140,6 @@ Deployment complete!
 
 >>> [CLI] bundle destroy --auto-approve
 The following resources will be deleted:
-  delete alert my_alert
   delete pipeline my_pipeline
   delete schema my_schema
   delete sql_warehouse my_sql_warehouse
diff --git a/acceptance/bundle/validate/empty_resources/empty_def/output.txt b/acceptance/bundle/validate/empty_resources/empty_def/output.txt
@@ -143,12 +143,8 @@ Error: secret_scope rname is not defined
 }
 
 === resources.alerts.rname ===
-Error: alert rname is not defined
-  at resources.alerts.rname
-  in databricks.yml:6:11
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:5:3
 
-{
-  "alerts": {
-    "rname": null
-  }
-}
+{}
diff --git a/acceptance/bundle/validate/empty_resources/empty_dict/output.txt b/acceptance/bundle/validate/empty_resources/empty_dict/output.txt
@@ -199,11 +199,8 @@ Warning: required field "name" is not set
 }
 
 === resources.alerts.rname ===
-{
-  "alerts": {
-    "rname": {
-      "parent_path": "/Workspace/Users/[USERNAME]/.bundle/BUNDLE/default/resources",
-      "permissions": []
-    }
-  }
-}
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:5:3
+
+{}
diff --git a/acceptance/bundle/validate/empty_resources/null/output.txt b/acceptance/bundle/validate/empty_resources/null/output.txt
@@ -143,12 +143,8 @@ Error: secret_scope rname is not defined
 }
 
 === resources.alerts.rname ===
-Error: alert rname is not defined
-  at resources.alerts.rname
-  in databricks.yml:6:12
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:5:3
 
-{
-  "alerts": {
-    "rname": null
-  }
-}
+{}
diff --git a/acceptance/bundle/validate/empty_resources/with_grants/output.txt b/acceptance/bundle/validate/empty_resources/with_grants/output.txt
@@ -244,15 +244,8 @@ Warning: required field "name" is not set
 }
 
 === resources.alerts.rname ===
-Warning: unknown field: grants
-  at resources.alerts.rname
-  in databricks.yml:7:7
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:5:3
 
-{
-  "alerts": {
-    "rname": {
-      "parent_path": "/Workspace/Users/[USERNAME]/.bundle/BUNDLE/default/resources",
-      "permissions": []
-    }
-  }
-}
+{}
diff --git a/acceptance/bundle/validate/empty_resources/with_permissions/output.txt b/acceptance/bundle/validate/empty_resources/with_permissions/output.txt
@@ -217,11 +217,8 @@ Warning: required field "name" is not set
 }
 
 === resources.alerts.rname ===
-{
-  "alerts": {
-    "rname": {
-      "parent_path": "/Workspace/Users/[USERNAME]/.bundle/BUNDLE/default/resources",
-      "permissions": []
-    }
-  }
-}
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:5:3
+
+{}
diff --git a/acceptance/bundle/validate/presets_name_prefix/output.txt b/acceptance/bundle/validate/presets_name_prefix/output.txt
@@ -3,18 +3,15 @@
   name_prefix: "prefix-"
 
 >>> [CLI] bundle validate -o json
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:22:3
+
 Warning: required field "catalog_name" is not set
   at resources.schemas.schema1
   in databricks.yml:14:7
 
 {
-  "alerts": {
-    "alert1": {
-      "display_name": "prefix-alert1",
-      "parent_path": "/Workspace/foo/bar",
-      "permissions": []
-    }
-  },
   "jobs": {
     "job1": {
       "deployment": {
@@ -50,18 +47,15 @@ Warning: required field "catalog_name" is not set
   name_prefix: "[prefix]"
 
 >>> [CLI] bundle validate -o json
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:22:3
+
 Warning: required field "catalog_name" is not set
   at resources.schemas.schema1
   in databricks.yml:14:7
 
 {
-  "alerts": {
-    "alert1": {
-      "display_name": "[prefix]alert1",
-      "parent_path": "/Workspace/foo/bar",
-      "permissions": []
-    }
-  },
   "jobs": {
     "job1": {
       "deployment": {
@@ -97,18 +91,15 @@ Warning: required field "catalog_name" is not set
   name_prefix: ""
 
 >>> [CLI] bundle validate -o json
+Warning: unknown field: alerts
+  at resources
+  in databricks.yml:22:3
+
 Warning: required field "catalog_name" is not set
   at resources.schemas.schema1
   in databricks.yml:14:7
 
 {
-  "alerts": {
-    "alert1": {
-      "display_name": "alert1",
-      "parent_path": "/Workspace/foo/bar",
-      "permissions": []
-    }
-  },
   "jobs": {
     "job1": {
       "deployment": {
diff --git a/bundle/config/mutator/resourcemutator/apply_presets.go b/bundle/config/mutator/resourcemutator/apply_presets.go
@@ -240,12 +240,12 @@ func (m *applyPresets) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnos
 	// Apps: No presets
 
 	// Alerts: Prefix
-	for _, a := range r.Alerts {
-		if a == nil {
-			continue
-		}
-		a.DisplayName = prefix + a.DisplayName
-	}
+	// for _, a := range r.Alerts {
+	// 	if a == nil {
+	// 		continue
+	// 	}
+	// 	a.DisplayName = prefix + a.DisplayName
+	// }
 
 	// SQL Warehouses: Prefix, Tags
 	for _, w := range r.SqlWarehouses {
diff --git a/bundle/config/mutator/resourcemutator/apply_target_mode_test.go b/bundle/config/mutator/resourcemutator/apply_target_mode_test.go
@@ -190,13 +190,13 @@ func mockBundle(mode config.Mode) *bundle.Bundle {
 						},
 					},
 				},
-				Alerts: map[string]*resources.Alert{
-					"alert1": {
-						AlertV2: sql.AlertV2{
-							DisplayName: "alert1",
-						},
-					},
-				},
+				// Alerts: map[string]*resources.Alert{
+				// 	"alert1": {
+				// 		AlertV2: sql.AlertV2{
+				// 			DisplayName: "alert1",
+				// 		},
+				// 	},
+				// },
 			},
 		},
 		SyncRoot: vfs.MustNew("/Users/lennart.kats@databricks.com"),
diff --git a/bundle/config/mutator/resourcemutator/run_as.go b/bundle/config/mutator/resourcemutator/run_as.go
@@ -110,15 +110,15 @@ func validateRunAs(b *bundle.Bundle) diag.Diagnostics {
 		))
 	}
 
-	// Alerts do not support run_as in the API.
-	if len(b.Config.Resources.Alerts) > 0 {
-		diags = diags.Extend(reportRunAsNotSupported(
-			"alerts",
-			b.Config.GetLocation("resources.alerts"),
-			b.Config.Workspace.CurrentUser.UserName,
-			identity,
-		))
-	}
+	// // Alerts do not support run_as in the API.
+	// if len(b.Config.Resources.Alerts) > 0 {
+	// 	diags = diags.Extend(reportRunAsNotSupported(
+	// 		"alerts",
+	// 		b.Config.GetLocation("resources.alerts"),
+	// 		b.Config.Workspace.CurrentUser.UserName,
+	// 		identity,
+	// 	))
+	// }
 
 	// Apps do not support run_as in the API.
 	if len(b.Config.Resources.Apps) > 0 {
diff --git a/bundle/config/mutator/resourcemutator/run_as_test.go b/bundle/config/mutator/resourcemutator/run_as_test.go
@@ -32,7 +32,7 @@ func allResourceTypes(t *testing.T) []string {
 	// the dyn library gives us the correct list of all resources supported. Please
 	// also update this check when adding a new resource
 	require.Equal(t, []string{
-		"alerts",
+		// "alerts",
 		"apps",
 		"clusters",
 		"dashboards",
diff --git a/bundle/config/resources.go b/bundle/config/resources.go
@@ -25,11 +25,11 @@ type Resources struct {
 	Dashboards            map[string]*resources.Dashboard            `json:"dashboards,omitempty"`
 	Apps                  map[string]*resources.App                  `json:"apps,omitempty"`
 	SecretScopes          map[string]*resources.SecretScope          `json:"secret_scopes,omitempty"`
-	Alerts                map[string]*resources.Alert                `json:"alerts,omitempty"`
-	SqlWarehouses         map[string]*resources.SqlWarehouse         `json:"sql_warehouses,omitempty"`
-	DatabaseInstances     map[string]*resources.DatabaseInstance     `json:"database_instances,omitempty"`
-	DatabaseCatalogs      map[string]*resources.DatabaseCatalog      `json:"database_catalogs,omitempty"`
-	SyncedDatabaseTables  map[string]*resources.SyncedDatabaseTable  `json:"synced_database_tables,omitempty"`
+	// Alerts                map[string]*resources.Alert                `json:"alerts,omitempty"`
+	SqlWarehouses        map[string]*resources.SqlWarehouse        `json:"sql_warehouses,omitempty"`
+	DatabaseInstances    map[string]*resources.DatabaseInstance    `json:"database_instances,omitempty"`
+	DatabaseCatalogs     map[string]*resources.DatabaseCatalog     `json:"database_catalogs,omitempty"`
+	SyncedDatabaseTables map[string]*resources.SyncedDatabaseTable `json:"synced_database_tables,omitempty"`
 }
 
 type ConfigResource interface {
@@ -92,7 +92,7 @@ func (r *Resources) AllResources() []ResourceGroup {
 		collectResourceMap(descriptions["dashboards"], r.Dashboards),
 		collectResourceMap(descriptions["volumes"], r.Volumes),
 		collectResourceMap(descriptions["apps"], r.Apps),
-		collectResourceMap(descriptions["alerts"], r.Alerts),
+		// collectResourceMap(descriptions["alerts"], r.Alerts),
 		collectResourceMap(descriptions["secret_scopes"], r.SecretScopes),
 		collectResourceMap(descriptions["sql_warehouses"], r.SqlWarehouses),
 		collectResourceMap(descriptions["database_instances"], r.DatabaseInstances),
@@ -175,11 +175,11 @@ func (r *Resources) FindResourceByConfigKey(key string) (ConfigResource, error)
 		}
 	}
 
-	for k := range r.Alerts {
-		if k == key {
-			found = append(found, r.Alerts[k])
-		}
-	}
+	// for k := range r.Alerts {
+	// 	if k == key {
+	// 		found = append(found, r.Alerts[k])
+	// 	}
+	// }
 
 	for k := range r.SqlWarehouses {
 		if k == key {
@@ -236,10 +236,10 @@ func SupportedResources() map[string]resources.ResourceDescription {
 		"volumes":                 (&resources.Volume{}).ResourceDescription(),
 		"apps":                    (&resources.App{}).ResourceDescription(),
 		"secret_scopes":           (&resources.SecretScope{}).ResourceDescription(),
-		"alerts":                  (&resources.Alert{}).ResourceDescription(),
-		"sql_warehouses":          (&resources.SqlWarehouse{}).ResourceDescription(),
-		"database_instances":      (&resources.DatabaseInstance{}).ResourceDescription(),
-		"database_catalogs":       (&resources.DatabaseCatalog{}).ResourceDescription(),
-		"synced_database_tables":  (&resources.SyncedDatabaseTable{}).ResourceDescription(),
+		// "alerts":                  (&resources.Alert{}).ResourceDescription(),
+		"sql_warehouses":         (&resources.SqlWarehouse{}).ResourceDescription(),
+		"database_instances":     (&resources.DatabaseInstance{}).ResourceDescription(),
+		"database_catalogs":      (&resources.DatabaseCatalog{}).ResourceDescription(),
+		"synced_database_tables": (&resources.SyncedDatabaseTable{}).ResourceDescription(),
 	}
 }
diff --git a/bundle/config/resources_test.go b/bundle/config/resources_test.go
diff --git a/bundle/deploy/resource_path_mkdir.go b/bundle/deploy/resource_path_mkdir.go
diff --git a/bundle/internal/schema/annotations.yml b/bundle/internal/schema/annotations.yml
diff --git a/bundle/internal/schema/annotations_openapi.yml b/bundle/internal/schema/annotations_openapi.yml
diff --git a/bundle/internal/schema/annotations_openapi_overrides.yml b/bundle/internal/schema/annotations_openapi_overrides.yml
diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json
diff --git a/bundle/statemgmt/state_load_test.go b/bundle/statemgmt/state_load_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Cloud = true`
	`1`	`+Cloud = false`
`2`	`2`	`Local = false`
`3`	`3`
`4`	`4`	`# Permissions with alerts does not work with direct deployment yet.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`Cloud = false`
	`2`	`+Local = false # Enable when releasing support for alerts.`
`2`	`3`
`3`	`4`	`BundleConfigTarget = "databricks.yml"`