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 ./...
```
|
||
|---|---|---|
| .. | ||
| paths | ||
| python | ||
| apply_presets.go | ||
| apply_presets_test.go | ||
| apply_source_linked_deployment_preset.go | ||
| apply_source_linked_deployment_preset_test.go | ||
| compute_id_compat.go | ||
| compute_id_compate_test.go | ||
| configure_dashboard_defaults.go | ||
| configure_dashboard_defaults_test.go | ||
| configure_volume_defaults.go | ||
| configure_volume_defaults_test.go | ||
| configure_wsfs.go | ||
| configure_wsfs_test.go | ||
| default_queueing.go | ||
| default_queueing_test.go | ||
| default_target.go | ||
| default_target_test.go | ||
| default_workspace_paths.go | ||
| default_workspace_paths_test.go | ||
| default_workspace_root.go | ||
| default_workspace_root_test.go | ||
| environments_compat.go | ||
| environments_compat_test.go | ||
| expand_pipeline_glob_paths.go | ||
| expand_pipeline_glob_paths_test.go | ||
| expand_workspace_root.go | ||
| expand_workspace_root_test.go | ||
| initialize_urls.go | ||
| initialize_urls_test.go | ||
| initialize_variables.go | ||
| initialize_variables_test.go | ||
| initialize_workspace_client.go | ||
| load_git_details.go | ||
| merge_apps.go | ||
| merge_apps_test.go | ||
| merge_job_clusters.go | ||
| merge_job_clusters_test.go | ||
| merge_job_parameters.go | ||
| merge_job_parameters_test.go | ||
| merge_job_tasks.go | ||
| merge_job_tasks_test.go | ||
| merge_pipeline_clusters.go | ||
| merge_pipeline_clusters_test.go | ||
| mutator.go | ||
| noop.go | ||
| override_compute.go | ||
| override_compute_test.go | ||
| populate_current_user.go | ||
| populate_current_user_test.go | ||
| prepend_workspace_prefix.go | ||
| prepend_workspace_prefix_test.go | ||
| process_target_mode.go | ||
| process_target_mode_test.go | ||
| resolve_resource_references.go | ||
| resolve_resource_references_test.go | ||
| resolve_variable_references.go | ||
| resolve_variable_references_test.go | ||
| rewrite_sync_paths.go | ||
| rewrite_sync_paths_test.go | ||
| rewrite_workspace_prefix.go | ||
| rewrite_workspace_prefix_test.go | ||
| run_as.go | ||
| run_as_test.go | ||
| select_default_target.go | ||
| select_default_target_test.go | ||
| select_target.go | ||
| select_target_test.go | ||
| set_variables.go | ||
| set_variables_test.go | ||
| sync_default_path.go | ||
| sync_default_path_test.go | ||
| sync_infer_root.go | ||
| sync_infer_root_internal_test.go | ||
| sync_infer_root_test.go | ||
| translate_paths.go | ||
| translate_paths_apps.go | ||
| translate_paths_apps_test.go | ||
| translate_paths_artifacts.go | ||
| translate_paths_dashboards.go | ||
| translate_paths_dashboards_test.go | ||
| translate_paths_jobs.go | ||
| translate_paths_pipelines.go | ||
| translate_paths_test.go | ||
| validate_git_details.go | ||
| validate_git_details_test.go | ||
| verify_cli_version.go | ||
| verify_cli_version_test.go | ||