bundle: route config sync write-back to the block that defines each change #6138
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| bundle: | ||
| name: test-bundle-$UNIQUE_NAME | ||
|
|
||
| # cluster_id makes OverrideCompute replace each task's compute with | ||
| # existing_cluster_id. It builds that value in Go, so the leaf is present in the | ||
| # merged config but carries no source location -- unlike a field absent from the | ||
| # config, which has no value either. Routing by location therefore finds nothing, and | ||
| # on a task defined in both blocks there is no winning definition to fall back on. The | ||
| # field is not declared anywhere, so writing it is an addition. | ||
|
|
||
| resources: | ||
| jobs: | ||
| cli_default_job: | ||
| tasks: | ||
| - task_key: shared | ||
| max_retries: 1 | ||
| new_cluster: | ||
| spark_version: 13.3.x-scala2.12 | ||
| num_workers: 1 | ||
| notebook_task: | ||
| notebook_path: /Users/{{workspace_user_name}}/nb | ||
|
|
||
| targets: | ||
| dev: | ||
| mode: development | ||
| cluster_id: 0101-000000-abcd1234 | ||
| resources: | ||
| jobs: | ||
| cli_default_job: | ||
| tasks: | ||
| - task_key: shared | ||
| timeout_seconds: 45 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle-[UNIQUE_NAME]/dev/files... | ||
| Deploying resources... | ||
| Updating deployment state... | ||
| Deployment complete! | ||
|
|
||
| === existing_cluster_id is injected by OverrideCompute; the YAML has none | ||
| >>> grep -c existing_cluster_id databricks.yml | ||
| 1 | ||
|
|
||
| === Edit that locationless field remotely on a two-block task | ||
| === Sync | ||
| Detected changes in 1 resource(s): | ||
|
|
||
| Resource: resources.jobs.cli_default_job | ||
| tasks[task_key='shared'].existing_cluster_id: add | ||
|
|
||
|
|
||
|
|
||
| === The field is added to the block declaring the resource | ||
|
|
||
| >>> diff.py databricks.yml.backup databricks.yml | ||
| --- databricks.yml.backup | ||
| +++ databricks.yml | ||
| @@ -20,4 +20,5 @@ | ||
| notebook_task: | ||
| notebook_path: /Users/{{workspace_user_name}}/nb | ||
| + existing_cluster_id: 0101-000000-remote1 | ||
|
|
||
| targets: | ||
|
|
||
| >>> grep -c existing_cluster_id: 0101-000000-remote1 databricks.yml | ||
| 1 | ||
|
|
||
| >>> [CLI] bundle destroy --auto-approve -t dev | ||
| The following resources will be deleted: | ||
| delete resources.jobs.cli_default_job | ||
|
|
||
| All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/test-bundle-[UNIQUE_NAME]/dev | ||
|
|
||
| Deleting files... | ||
| Destroy complete! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| #!/bin/bash | ||
| envsubst < databricks.yml.tmpl > databricks.yml | ||
| cleanup() { trace $CLI bundle destroy --auto-approve -t dev; } | ||
| trap cleanup EXIT | ||
| $CLI bundle deploy -t dev | ||
| job_id="$(read_id.py cli_default_job)" | ||
|
|
||
| title "existing_cluster_id is injected by OverrideCompute; the YAML has none" | ||
| errcode trace grep -c "existing_cluster_id" databricks.yml | ||
|
|
||
| title "Edit that locationless field remotely on a two-block task" | ||
| edit_resource.py jobs $job_id <<PYEDIT | ||
| for task in r["tasks"]: | ||
| if task["task_key"] == "shared": | ||
| task["existing_cluster_id"] = "0101-000000-remote1" | ||
| PYEDIT | ||
|
|
||
| title "Sync" | ||
| echo | ||
| cp databricks.yml databricks.yml.backup | ||
| errcode $CLI bundle config-remote-sync -t dev --save | ||
| title "The field is added to the block declaring the resource" | ||
| echo | ||
| trace diff.py databricks.yml.backup databricks.yml | ||
| errcode trace grep -c "existing_cluster_id: 0101-000000-remote1" databricks.yml | ||
| rm databricks.yml.backup |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| bundle: | ||
| name: test-bundle-$UNIQUE_NAME | ||
|
|
||
| # A target name may contain a dot. The write path to an override block is | ||
| # targets.<target>.<field>, which is parsed back into segments, so a dotted name has to | ||
| # be quoted or "dev.eu" becomes two keys and addresses a node that does not exist. | ||
| resources: | ||
| jobs: | ||
| dotted_job: | ||
| tasks: | ||
| - task_key: main | ||
| max_retries: 1 | ||
| notebook_task: | ||
| notebook_path: /Users/{{workspace_user_name}}/nb | ||
|
|
||
| targets: | ||
| dev.eu: | ||
| mode: development | ||
| resources: | ||
| jobs: | ||
| dotted_job: | ||
| tasks: | ||
| - task_key: main | ||
| timeout_seconds: 45 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle-[UNIQUE_NAME]/dev.eu/files... | ||
| Deploying resources... | ||
| Updating deployment state... | ||
| Deployment complete! | ||
|
|
||
| === Edit a field in the override block of a target whose name contains a dot | ||
| === Sync | ||
| Detected changes in 1 resource(s): | ||
|
|
||
| Resource: resources.jobs.dotted_job | ||
| tasks[task_key='main'].timeout_seconds: replace | ||
|
|
||
|
|
||
|
|
||
| === The override block is updated | ||
|
|
||
| >>> diff.py databricks.yml.backup databricks.yml | ||
| --- databricks.yml.backup | ||
| +++ databricks.yml | ||
| @@ -22,3 +22,3 @@ | ||
| tasks: | ||
| - task_key: main | ||
| - timeout_seconds: 45 | ||
| + timeout_seconds: 900 | ||
|
|
||
| >>> [CLI] bundle destroy --auto-approve -t dev.eu | ||
| The following resources will be deleted: | ||
| delete resources.jobs.dotted_job | ||
|
|
||
| All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/test-bundle-[UNIQUE_NAME]/dev.eu | ||
|
|
||
| Deleting files... | ||
| Destroy complete! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| #!/bin/bash | ||
| envsubst < databricks.yml.tmpl > databricks.yml | ||
| cleanup() { trace $CLI bundle destroy --auto-approve -t dev.eu; } | ||
| trap cleanup EXIT | ||
| $CLI bundle deploy -t dev.eu | ||
| job_id="$(read_id.py -t dev.eu dotted_job)" | ||
|
|
||
| title "Edit a field in the override block of a target whose name contains a dot" | ||
| edit_resource.py jobs $job_id <<PYEDIT | ||
| for task in r["tasks"]: | ||
| if task["task_key"] == "main": | ||
| task["timeout_seconds"] = 900 | ||
| PYEDIT | ||
|
|
||
| title "Sync" | ||
| echo | ||
| cp databricks.yml databricks.yml.backup | ||
| errcode $CLI bundle config-remote-sync -t dev.eu --save | ||
| title "The override block is updated" | ||
| echo | ||
| trace diff.py databricks.yml.backup databricks.yml | ||
| rm databricks.yml.backup |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| bundle: | ||
| name: test-bundle-$UNIQUE_NAME | ||
|
|
||
| # job_a's task list is split across both blocks and one task, "shared", is defined | ||
| # in both. job_b is an ordinary single-block job. | ||
| # | ||
| # The point of the fixture: an unrelated resource's change must still be applied | ||
| # in the same run as a structural change to a split element. The sync is | ||
| # unattended, so one harder change must never stop the rest. | ||
| resources: | ||
| jobs: | ||
| job_a: | ||
| tasks: | ||
| - task_key: shared | ||
| max_retries: 1 | ||
| notebook_task: | ||
| notebook_path: /Users/{{workspace_user_name}}/shared | ||
|
|
||
| job_b: | ||
| max_concurrent_runs: 1 | ||
| tasks: | ||
| - task_key: simple | ||
| notebook_task: | ||
| notebook_path: /Users/{{workspace_user_name}}/simple | ||
|
|
||
| targets: | ||
| dev: | ||
| mode: development | ||
| resources: | ||
| jobs: | ||
| job_a: | ||
| tasks: | ||
| - task_key: shared | ||
| timeout_seconds: 45 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle-[UNIQUE_NAME]/dev/files... | ||
| Deploying resources... | ||
| Updating deployment state... | ||
| Deployment complete! | ||
|
|
||
| === Rename the two-block task on job_a, and edit job_b in the same run | ||
| === Sync | ||
| Detected changes in 2 resource(s): | ||
|
|
||
| Resource: resources.jobs.job_a | ||
| tasks[task_key='shared']: remove | ||
| tasks[task_key='shared_renamed']: add | ||
|
|
||
| Resource: resources.jobs.job_b | ||
| max_concurrent_runs: replace | ||
|
|
||
|
|
||
|
|
||
| === job_b is updated, and job_a's rename is written in both blocks | ||
|
|
||
| >>> diff.py databricks.yml.backup databricks.yml | ||
| --- databricks.yml.backup | ||
| +++ databricks.yml | ||
| @@ -12,5 +12,5 @@ | ||
| job_a: | ||
| tasks: | ||
| - - task_key: shared | ||
| + - task_key: shared_renamed | ||
| max_retries: 1 | ||
| notebook_task: | ||
| @@ -18,5 +18,5 @@ | ||
|
|
||
| job_b: | ||
| - max_concurrent_runs: 1 | ||
| + max_concurrent_runs: 6 | ||
| tasks: | ||
| - task_key: simple | ||
| @@ -31,4 +31,4 @@ | ||
| job_a: | ||
| tasks: | ||
| - - task_key: shared | ||
| + - task_key: shared_renamed | ||
| timeout_seconds: 45 | ||
|
|
||
| >>> grep -c max_concurrent_runs: 6 databricks.yml | ||
| 1 | ||
|
|
||
| >>> grep -c task_key: shared_renamed databricks.yml | ||
| 2 | ||
|
|
||
| >>> [CLI] bundle destroy --auto-approve -t dev | ||
| The following resources will be deleted: | ||
| delete resources.jobs.job_a | ||
| delete resources.jobs.job_b | ||
|
|
||
| All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/test-bundle-[UNIQUE_NAME]/dev | ||
|
|
||
| Deleting files... | ||
| Destroy complete! |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an expected change, the only changed field is still "spark_version" but new diff is less noisy,