mirror of https://github.com/databricks/cli.git
913e10a037
## Changes
Now it's possible to configure new `app` resource in bundle and point it
to the custom `source_code_path` location where Databricks App code is
defined.
On `databricks bundle deploy` DABs will create an app. All consecutive
`databricks bundle deploy` execution will update an existing app if
there are any updated
On `databricks bundle run <my_app>` DABs will execute app deployment. If
the app is not started yet, it will start the app first.
### Bundle configuration
```
bundle:
name: apps
variables:
my_job_id:
description: "ID of job to run app"
lookup:
job: "My Job"
databricks_name:
description: "Name for app user"
additional_flags:
description: "Additional flags to run command app"
default: ""
my_app_config:
type: complex
description: "Configuration for my Databricks App"
default:
command:
- flask
- --app
- hello
- run
- ${var.additional_flags}
env:
- name: DATABRICKS_NAME
value: ${var.databricks_name}
resources:
apps:
my_app:
name: "anester-app" # required and has to be unique
description: "My App"
source_code_path: ./app # required and points to location of app code
config: ${var.my_app_config}
resources:
- name: "my-job"
description: "A job for app to be able to run"
job:
id: ${var.my_job_id}
permission: "CAN_MANAGE_RUN"
permissions:
- user_name: "foo@bar.com"
level: "CAN_VIEW"
- service_principal_name: "my_sp"
level: "CAN_MANAGE"
targets:
dev:
variables:
databricks_name: "Andrew (from dev)"
additional_flags: --debug
prod:
variables:
databricks_name: "Andrew (from prod)"
```
### Execution
1. `databricks bundle deploy -t dev`
2. `databricks bundle run my_app -t dev`
**If app is started**
```
✓ Getting the status of the app my-app
✓ App is in RUNNING state
✓ Preparing source code for new app deployment.
✓ Deployment is pending
✓ Starting app with command: flask --app hello run --debug
✓ App started successfully
You can access the app at <app-url>
```
**If app is not started**
```
✓ Getting the status of the app my-app
✓ App is in UNAVAILABLE state
✓ Starting the app my-app
✓ App is starting...
....
✓ App is starting...
✓ App is started!
✓ Preparing source code for new app deployment.
✓ Downloading source code from /Workspace/Users/...
✓ Starting app with command: flask --app hello run --debug
✓ App started successfully
You can access the app at <app-url>
```
## Tests
Added unit and config tests + manual test.
```
--- PASS: TestAccDeployBundleWithApp (404.59s)
PASS
coverage: 36.8% of statements in ./...
ok github.com/databricks/cli/internal/bundle 405.035s coverage: 36.8% of statements in ./...
```
|
||
|---|---|---|
| .. | ||
| apps | ||
| autoload_git | ||
| basic | ||
| bundle_permissions | ||
| environment_key_only | ||
| environment_overrides | ||
| environments_autoload_git | ||
| environments_job_and_pipeline | ||
| environments_override_job_cluster | ||
| git_branch_validation | ||
| include_default | ||
| include_invalid | ||
| include_multiple | ||
| include_with_glob | ||
| interpolation | ||
| interpolation_target | ||
| issue_1828 | ||
| job_and_pipeline | ||
| job_cluster_key | ||
| job_with_spark_conf | ||
| model_serving_endpoint | ||
| override_job_parameters | ||
| path_translation | ||
| pipeline_glob_paths | ||
| presets | ||
| python_wheel | ||
| quality_monitor | ||
| registered_model | ||
| relative_path_translation | ||
| relative_path_with_includes | ||
| run_as | ||
| sync | ||
| target_empty | ||
| target_overrides | ||
| validate | ||
| yaml_anchors | ||
| yaml_anchors_separate_block | ||
| README.md | ||
| apps_test.go | ||
| basic_test.go | ||
| bundle_permissions_test.go | ||
| enviroment_key_test.go | ||
| environment_git_test.go | ||
| environment_overrides_test.go | ||
| environments_job_and_pipeline_test.go | ||
| environments_override_job_cluster_test.go | ||
| git_test.go | ||
| include_test.go | ||
| interpolation_test.go | ||
| issue_1828_test.go | ||
| job_and_pipeline_test.go | ||
| job_cluster_key_test.go | ||
| job_with_spark_conf_test.go | ||
| loader.go | ||
| model_serving_endpoint_test.go | ||
| override_job_parameters_test.go | ||
| path_translation_test.go | ||
| pipeline_glob_paths_test.go | ||
| presets_test.go | ||
| python_wheel_test.go | ||
| quality_monitor_test.go | ||
| registered_model_test.go | ||
| relative_path_translation_test.go | ||
| relative_path_with_includes_test.go | ||
| run_as_test.go | ||
| suggest_target_test.go | ||
| sync_include_exclude_no_matches_test.go | ||
| sync_test.go | ||
| target_empty_test.go | ||
| target_overrides_test.go | ||
| validate_test.go | ||
| yaml_anchors_test.go | ||
README.md
Bundle configuration tests
Every test here uses an example bundle configuration. Each bundle configuration is located in a dedicated subdirectory.