Add support for configuring app health_check via bundle config

.nextchanges/bundles/7081.md

@@ -0,0 +1 @@
+* Add support for configuring an app deploy-time `health_check` via inline `config` in bundle config. ([#7081](https://github.com/databricks/cli/pull/7081))

acceptance/bundle/refschema/out.fields.txt

@@ -115,6 +115,9 @@ resources.apps.*.config.env[*]	resources.AppEnvVar	ALL
 resources.apps.*.config.env[*].name	string	ALL
 resources.apps.*.config.env[*].value	string	ALL
 resources.apps.*.config.env[*].value_from	string	ALL
+resources.apps.*.config.health_check	*resources.AppHealthCheck	ALL
+resources.apps.*.config.health_check.path	string	ALL
+resources.apps.*.config.health_check.timeout_seconds	int	ALL
 resources.apps.*.create_time	string	ALL
 resources.apps.*.creator	string	ALL
 resources.apps.*.default_git_source	*apps.GitSource	ALL

acceptance/bundle/resources/apps/inline_config/app/app.py

@@ -8,3 +8,8 @@
 @app.route("/")
 def home():
     return "Hello from inline config app!"
+
+
+@app.route("/health")
+def health():
+    return "OK"

acceptance/bundle/resources/apps/inline_config/databricks.yml.tmpl

@@ -14,3 +14,6 @@ resources:
             value: test_value
           - name: ANOTHER_VAR
             value: another_value
+        health_check:
+          path: /health
+          timeout_seconds: 120

acceptance/bundle/resources/apps/inline_config/output.txt

@@ -20,7 +20,11 @@ Resources: 1 created, 0 changed, 0 deleted, 0 unchanged
     {
       "name": "ANOTHER_VAR"
     }
-  ]
+  ],
+  "health_check": {
+    "path": "/health",
+    "timeout": "120s"
+  }
 }
 
 >>> [CLI] bundle destroy --auto-approve

acceptance/bundle/resources/apps/inline_config/script

@@ -13,4 +13,4 @@ $CLI bundle run myapp > /dev/null 2>&1
 DEPLOYMENT_ID=$($CLI apps get "$APP_NAME" | jq -r '.active_deployment.deployment_id')
 add_repl "$DEPLOYMENT_ID" DEPLOYMENT_ID
 
-trace $CLI apps get-deployment "$APP_NAME" "$DEPLOYMENT_ID" | jq '{command, env_vars}'
+trace $CLI apps get-deployment "$APP_NAME" "$DEPLOYMENT_ID" | jq '{command, env_vars, health_check}'

bundle/appdeploy/app.go

@@ -8,6 +8,7 @@ import (
 	"github.com/databricks/cli/bundle/config/resources"
 	"github.com/databricks/cli/libs/cmdio"
 	"github.com/databricks/databricks-sdk-go"
+	"github.com/databricks/databricks-sdk-go/common/types/duration"
 	sdkapps "github.com/databricks/databricks-sdk-go/service/apps"
 )
 
@@ -45,6 +46,15 @@ func BuildDeployment(sourcePath string, config *resources.AppConfig, gitSource *
 				}
 			}
 		}
+
+		if config.HealthCheck != nil {
+			deployment.HealthCheck = &sdkapps.AppHealthCheck{
+				Path: config.HealthCheck.Path,
+			}
+			if config.HealthCheck.TimeoutSeconds > 0 {
+				deployment.HealthCheck.Timeout = duration.New(time.Duration(config.HealthCheck.TimeoutSeconds) * time.Second)
+			}
+		}
 	}
 
 	return deployment

bundle/config/resources/apps.go

@@ -19,6 +19,18 @@ type AppConfig struct {
 
 	// Env contains environment variables to set for the app
 	Env []AppEnvVar `json:"env,omitempty" yaml:"env,omitempty"`
+
+	// HealthCheck configures the HTTP check that must pass before a deployment is considered successful
+	HealthCheck *AppHealthCheck `json:"health_check,omitempty" yaml:"health_check,omitempty"`
+}
+
+// AppHealthCheck represents a deploy-time health check configuration for an app
+type AppHealthCheck struct {
+	// Path is the HTTP path to probe (e.g., "/health")
+	Path string `json:"path" yaml:"path"`
+
+	// TimeoutSeconds is how long to wait for the health check to pass before failing the deployment
+	TimeoutSeconds int `json:"timeout_seconds,omitempty" yaml:"timeout_seconds,omitempty"`
 }
 
 // AppEnvVar represents an environment variable configuration for an app

bundle/direct/dresources/app.go

@@ -288,14 +288,15 @@ func remoteIsStarted(entry *PlanEntry) bool {
 }
 
 // deploymentToAppConfig extracts an AppConfig from an active deployment.
-// Returns nil if the deployment has no command or env vars.
+// Returns nil if the deployment has no command, env vars or health check.
 func deploymentToAppConfig(d *apps.AppDeployment) *resources.AppConfig {
-	if len(d.Command) == 0 && len(d.EnvVars) == 0 {
+	if len(d.Command) == 0 && len(d.EnvVars) == 0 && d.HealthCheck == nil {
 		return nil
 	}
 	config := &resources.AppConfig{
-		Command: d.Command,
-		Env:     nil,
+		Command:     d.Command,
+		Env:         nil,
+		HealthCheck: nil,
 	}
 	if len(d.EnvVars) > 0 {
 		config.Env = make([]resources.AppEnvVar, len(d.EnvVars))
@@ -307,6 +308,16 @@ func deploymentToAppConfig(d *apps.AppDeployment) *resources.AppConfig {
 			}
 		}
 	}
+	if d.HealthCheck != nil {
+		timeoutSeconds := 0
+		if d.HealthCheck.Timeout != nil {
+			timeoutSeconds = int(d.HealthCheck.Timeout.AsDuration().Seconds())
+		}
+		config.HealthCheck = &resources.AppHealthCheck{
+			Path:           d.HealthCheck.Path,
+			TimeoutSeconds: timeoutSeconds,
+		}
+	}
 	return config
 }
 

bundle/internal/schema/annotations.yml

@@ -364,6 +364,16 @@ resources:
                 "value_from":
                   "description": |-
                     PLACEHOLDER
+            "health_check":
+              "description": |-
+                PLACEHOLDER
+              "$fields":
+                "path":
+                  "description": |-
+                    PLACEHOLDER
+                "timeout_seconds":
+                  "description": |-
+                    PLACEHOLDER
         "effective_budget_policy_id":
           "description": |-
             PLACEHOLDER

bundle/run/app_test.go

@@ -292,6 +292,10 @@ func TestBuildAppDeploymentWithValueFrom(t *testing.T) {
 					ValueFrom: "secrets/override",
 				},
 			},
+			HealthCheck: &resources.AppHealthCheck{
+				Path:           "/health",
+				TimeoutSeconds: 120,
+			},
 		},
 	}
 
@@ -319,4 +323,7 @@ func TestBuildAppDeploymentWithValueFrom(t *testing.T) {
 	require.Equal(t, "COMBINED_VAR", deployment.EnvVars[2].Name)
 	require.Equal(t, "default_value", deployment.EnvVars[2].Value)
 	require.Equal(t, "secrets/override", deployment.EnvVars[2].ValueFrom)
+
+	require.Equal(t, "/health", deployment.HealthCheck.Path)
+	require.Equal(t, 120*time.Second, deployment.HealthCheck.Timeout.AsDuration())
 }

cmd/apps/import.go

@@ -607,6 +607,15 @@ func inlineAppConfigFile(appValue *dyn.Value) (string, error) {
 		configMap["env"] = envValue
 	}
 
+	// Add health_check if present
+	if healthCheck, ok := appConfig["health_check"]; ok {
+		healthCheckValue, err := convert.FromTyped(healthCheck, dyn.NilValue)
+		if err != nil {
+			return "", fmt.Errorf("failed to convert health_check: %w", err)
+		}
+		configMap["health_check"] = healthCheckValue
+	}
+
 	// Add the config section if we have any items
 	if len(configMap) > 0 {
 		newPairs = append(newPairs, dyn.Pair{

cmd/apps/import_test.go

@@ -217,6 +217,9 @@ func TestInlineAppConfigFileFieldPriority(t *testing.T) {
 env:
   - name: FOO
     value: bar
+health_check:
+  path: /health
+  timeout_seconds: 120
 resources:
   - name: ENDPOINT
     serving_endpoint:
@@ -245,6 +248,7 @@ resources:
 		assert.Equal(t, "existing description", result["description"])
 		assert.NotNil(t, result["config"])
 		assert.NotNil(t, result["resources"])
+		assert.Equal(t, map[string]any{"path": "/health", "timeout_seconds": int64(120)}, result["config"].(map[string]any)["health_check"])
 	})
 }