Added `bundle deployment bind` and `unbind` command #1131

andrewnester · 2024-01-18T15:17:20Z

Changes

Added bundle deployment bind and unbind command.

This command allows to bind bundle-defined resources to existing resources in Databricks workspace so they become DABs-managed.

Tests

Manually + added E2E test

bundle/phases/bind.go

pietern · 2024-01-23T07:54:54Z

cmd/bundle/bind.go

+
+		ctx := cmd.Context()
+		if !autoApprove {
+			answer, err := cmdio.AskYesOrNo(ctx, "Binding to existing resource means that the resource will be managed by the bundle which can lead to changes in the resource. Do you want to continue?")


We should confirm that we would not recreate the resource on the TF side. Especially for pipelines this can be very dangerous where underlying tables get dropped if we do.

@pietern I've added a step which shows terraform plan after import and asks user to confirm it, otherwise reverts the import

cmd/bundle/bind.go

bundle/config/resources/job.go

bundle/deploy/terraform/import.go

bundle/phases/bind.go

cmd/bundle/deployment/bind.go

bundle/deploy/terraform/import.go

cmd/bundle/deployment/bind.go

bundle/config/resources.go

bundle/deploy/terraform/import.go

bundle/phases/bind.go

internal/bundle/bind_resource_test.go

bundle/deploy/terraform/import.go

codecov-commenter · 2024-02-07T14:31:04Z

Codecov Report

Attention: 145 lines in your changes are missing coverage. Please review.

Comparison is base (f8b0f78) 51.85% compared to head (7f8e3b4) 51.28%.
Report is 16 commits behind head on main.

Files	Patch %	Lines
bundle/deploy/terraform/import.go	0.00%	67 Missing ⚠️
bundle/config/resources.go	0.00%	20 Missing ⚠️
bundle/deploy/terraform/unbind.go	0.00%	18 Missing ⚠️
bundle/config/resources/job.go	0.00%	15 Missing ⚠️
bundle/config/resources/pipeline.go	0.00%	11 Missing ⚠️
internal/helpers.go	0.00%	6 Missing ⚠️
cmd/bundle/bundle.go	0.00%	1 Missing ⚠️
cmd/bundle/deploy.go	0.00%	1 Missing ⚠️
cmd/bundle/destroy.go	0.00%	1 Missing ⚠️
cmd/bundle/generate.go	0.00%	1 Missing ⚠️
... and 4 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1131      +/-   ##
==========================================
- Coverage   51.85%   51.28%   -0.57%     
==========================================
  Files         299      301       +2     
  Lines       16537    16737     +200     
==========================================
+ Hits         8575     8584       +9     
- Misses       7340     7519     +179     
- Partials      622      634      +12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

bundle/config/resources.go

bundle/config/resources/job.go

bundle/config/resources/pipeline.go

pietern · 2024-02-08T09:17:44Z

bundle/deploy/terraform/import.go

+	// This is necessary because the import operation requires the resource to be defined in the Terraform configuration.
+	_, err = os.Stat(filepath.Join(dir, "bundle.tf.json"))
+	if err != nil {
+		err = bundle.Apply(ctx, b, Write())


Can't we always write it? Note that the Terraform interpolation mutator also needs to run.

@pietern doing this will include all local changes to bundle config as well which I believe we should not include especially considering we push the state remotely

bundle/deploy/terraform/import.go

bundle/phases/destroy.go

pietern · 2024-02-08T09:24:23Z

cmd/bundle/deployment/bind.go

+				ResourceKey:  args[0],
+				ResourceId:   args[1],
+			}),
+		))


If this succeeds we should display a message (if in text output mode) to confirm it did.

This can also include a call to action to hint at running a deploy next.

@juliacrawf-db Could you shine your light on how to best convey this?

Oh no! I missed this ping! That string looks great. But wouldn't we want a similar error message in unbind.go if the unbinding fails?

pietern

I propose we also add an integration test to check that aborting the import works as expected and doesn't have side effects.

Everything else LGTM.

bundle/deploy/terraform/import.go

pietern · 2024-02-14T10:33:07Z

bundle/config/resources.go

+	if len(found) > 1 {
+		keys := make([]string, 0, len(found))
+		for _, r := range found {
+			keys = append(keys, fmt.Sprintf("%s:%s", r.TerraformResourceName(), key))


For later; we shouldn't externalize the TF resource name as it doesn't correspond with the name in the configuration. In error messages we should refer to jobs.job_key like we do for the run args.

bundle/deploy/terraform/import.go

internal/bundle/bind_resource_test.go

CLI: * Ignore environment variables for `auth profiles` ([#1189](#1189)). * Update LICENSE ([#1013](#1013)). Bundles: * Added `bundle deployment bind` and `unbind` command ([#1131](#1131)). * Use allowlist for Git-related fields to include in metadata ([#1187](#1187)). * Added `--restart` flag for `bundle run` command ([#1191](#1191)). * Generate correct YAML if custom_tags or spark_conf is used for pipeline or job cluster configuration ([#1210](#1210)). Internal: * Move folders package into libs ([#1184](#1184)). * Log time it takes for profile to load ([#1186](#1186)). * Use mockery to generate mocks compatible with testify/mock ([#1190](#1190)). * Retain partially valid structs in `convert.Normalize` ([#1203](#1203)). * Skip `for_each_task` when generating the bundle schema ([#1204](#1204)). * Regenerate the CLI using the same OpenAPI spec as the SDK ([#1205](#1205)). * Avoid race-conditions while executing sub-commands ([#1201](#1201)). API Changes: * Changed `databricks connections delete` command with new required argument order. * Changed `databricks connections get` command with new required argument order. * Changed `databricks connections update` command with new required argument order. * Added `databricks tables exists` command. * Changed `databricks volumes delete` command with new required argument order. * Changed `databricks volumes read` command with new required argument order. * Changed `databricks volumes update` command with new required argument order. * Added `databricks lakehouse-monitors` command group. * Removed `databricks files get-status` command. * Added `databricks files create-directory` command. * Added `databricks files delete-directory` command. * Added `databricks files get-directory-metadata` command. * Added `databricks files get-metadata` command. * Added `databricks files list-directory-contents` command. * Removed `databricks pipelines reset` command. * Changed `databricks account settings delete-personal-compute-setting` command with new required argument order. * Removed `databricks account settings read-personal-compute-setting` command. * Changed `databricks account settings update-personal-compute-setting` command with new required argument order. * Added `databricks account settings get-personal-compute-setting` command. * Removed `databricks settings delete-default-workspace-namespace` command. * Removed `databricks settings read-default-workspace-namespace` command. * Removed `databricks settings update-default-workspace-namespace` command. * Added `databricks settings delete-default-namespace-setting` command. * Added `databricks settings delete-restrict-workspace-admins-setting` command. * Added `databricks settings get-default-namespace-setting` command. * Added `databricks settings get-restrict-workspace-admins-setting` command. * Added `databricks settings update-default-namespace-setting` command. * Added `databricks settings update-restrict-workspace-admins-setting` command. * Changed `databricks token-management create-obo-token` command with new required argument order. * Changed `databricks token-management get` command to return . * Changed `databricks clean-rooms delete` command with new required argument order. * Changed `databricks clean-rooms get` command with new required argument order. * Changed `databricks clean-rooms update` command with new required argument order. * Changed `databricks dashboards create` command . New request type is . * Added `databricks dashboards update` command. OpenAPI commit c40670f5a2055c92cf0a6aac92a5bccebfb80866 (2024-02-14) Dependency updates: * Bump github.com/hashicorp/hc-install from 0.6.2 to 0.6.3 ([#1200](#1200)). * Bump golang.org/x/term from 0.16.0 to 0.17.0 ([#1197](#1197)). * Bump golang.org/x/oauth2 from 0.16.0 to 0.17.0 ([#1198](#1198)). * Bump github.com/databricks/databricks-sdk-go from 0.30.1 to 0.32.0 ([#1199](#1199)).

CLI: * Ignore environment variables for `auth profiles` ([#1189](#1189)). * Update LICENSE file to match Databricks license language ([#1013](#1013)). Bundles: * Added `bundle deployment bind` and `unbind` command ([#1131](#1131)). * Use allowlist for Git-related fields to include in metadata ([#1187](#1187)). * Added `--restart` flag for `bundle run` command ([#1191](#1191)). * Generate correct YAML if `custom_tags` or `spark_conf` is used for pipeline or job cluster configuration ([#1210](#1210)). Internal: * Move folders package into libs ([#1184](#1184)). * Log time it takes for profile to load ([#1186](#1186)). * Use mockery to generate mocks compatible with testify/mock ([#1190](#1190)). * Retain partially valid structs in `convert.Normalize` ([#1203](#1203)). * Skip `for_each_task` when generating the bundle schema ([#1204](#1204)). * Regenerate the CLI using the same OpenAPI spec as the SDK ([#1205](#1205)). * Avoid race-conditions while executing sub-commands ([#1201](#1201)). API Changes: * Added `databricks tables exists` command. * Added `databricks lakehouse-monitors` command group. * Removed `databricks files get-status` command. * Added `databricks files create-directory` command. * Added `databricks files delete-directory` command. * Added `databricks files get-directory-metadata` command. * Added `databricks files get-metadata` command. * Added `databricks files list-directory-contents` command. * Removed `databricks pipelines reset` command. * Changed `databricks account settings delete-personal-compute-setting` command with new required argument order. * Removed `databricks account settings read-personal-compute-setting` command. * Changed `databricks account settings update-personal-compute-setting` command with new required argument order. * Added `databricks account settings get-personal-compute-setting` command. * Removed `databricks settings delete-default-workspace-namespace` command. * Removed `databricks settings read-default-workspace-namespace` command. * Removed `databricks settings update-default-workspace-namespace` command. * Added `databricks settings delete-default-namespace-setting` command. * Added `databricks settings delete-restrict-workspace-admins-setting` command. * Added `databricks settings get-default-namespace-setting` command. * Added `databricks settings get-restrict-workspace-admins-setting` command. * Added `databricks settings update-default-namespace-setting` command. * Added `databricks settings update-restrict-workspace-admins-setting` command. * Changed `databricks token-management create-obo-token` command with new required argument order. * Changed `databricks token-management get` command to return . * Changed `databricks dashboards create` command . New request type is . * Added `databricks dashboards update` command. OpenAPI commit c40670f5a2055c92cf0a6aac92a5bccebfb80866 (2024-02-14) Dependency updates: * Bump github.com/hashicorp/hc-install from 0.6.2 to 0.6.3 ([#1200](#1200)). * Bump golang.org/x/term from 0.16.0 to 0.17.0 ([#1197](#1197)). * Bump golang.org/x/oauth2 from 0.16.0 to 0.17.0 ([#1198](#1198)). * Bump github.com/databricks/databricks-sdk-go from 0.30.1 to 0.32.0 ([#1199](#1199)). --------- Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>

Added bundle bind command

ceb62c0

andrewnester requested review from pietern and shreyas-goenka January 18, 2024 15:17

pietern reviewed Jan 23, 2024

View reviewed changes

added confirm plan and unbind command

952d660

andrewnester requested a review from pietern January 23, 2024 12:52

pietern reviewed Jan 23, 2024

View reviewed changes

andrewnester added 2 commits January 25, 2024 12:42

use import block

8075ae1

Added e2e test

c65aa6c

andrewnester requested a review from pietern January 25, 2024 13:37

andrewnester added 2 commits January 25, 2024 13:37

Merge branch 'main' into bind-command

d8fc45e

fix build

852e7bc

andrewnester changed the title ~~Added bundle bind command~~ Added bundle deployment bind command Jan 29, 2024

andrewnester changed the title ~~Added bundle deployment bind command~~ Added bundle deployment bind and unbind command Jan 29, 2024

pietern reviewed Feb 1, 2024

View reviewed changes

juliacrawf-db reviewed Feb 5, 2024

View reviewed changes

bundle/deploy/terraform/import.go Outdated Show resolved Hide resolved

andrewnester added 3 commits February 7, 2024 15:12

push state

2cfee73

Merge branch 'main' into bind-command

b318a42

fix tests

7f795ec

andrewnester requested a review from pietern February 7, 2024 14:47

pietern reviewed Feb 8, 2024

View reviewed changes

addressed feedback

4e8d030

andrewnester requested review from juliacrawf-db and pietern February 12, 2024 12:53

added lint ignore

637ceb3

pietern reviewed Feb 13, 2024

View reviewed changes

bundle/deploy/terraform/import.go Outdated Show resolved Hide resolved

Added test for bind abort

b837d0b

pietern reviewed Feb 14, 2024

View reviewed changes

use -target flag

4822806

use os.MkdirTemp

1962a68

andrewnester requested a review from pietern February 14, 2024 13:21

andrewnester added 2 commits February 14, 2024 16:57

always write state file

04071d6

added test for generate + bind

6cbdde2

pietern reviewed Feb 14, 2024

View reviewed changes

internal/bundle/bind_resource_test.go Outdated Show resolved Hide resolved

fix comment

022ebc4

pietern approved these changes Feb 14, 2024

View reviewed changes

andrewnester requested a review from pietern February 14, 2024 16:39

fix pipeline test

7f8e3b4

andrewnester added this pull request to the merge queue Feb 14, 2024

Merged via the queue into main with commit 80670ec Feb 14, 2024
4 checks passed

andrewnester deleted the bind-command branch February 14, 2024 18:12

andrewnester mentioned this pull request Feb 15, 2024

Release v0.213.0 #1212

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added `bundle deployment bind` and `unbind` command #1131

Added `bundle deployment bind` and `unbind` command #1131

andrewnester commented Jan 18, 2024 •

edited

Loading

pietern Jan 23, 2024

andrewnester Jan 23, 2024

codecov-commenter commented Feb 7, 2024 •

edited

Loading

pietern Feb 8, 2024

andrewnester Feb 12, 2024

pietern Feb 8, 2024

pietern Feb 8, 2024

juliacrawf-db Feb 17, 2024

pietern left a comment

pietern Feb 14, 2024

Added bundle deployment bind and unbind command #1131

Added bundle deployment bind and unbind command #1131

Conversation

andrewnester commented Jan 18, 2024 • edited Loading

Changes

Tests

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Feb 7, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pietern left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Added `bundle deployment bind` and `unbind` command #1131

Added `bundle deployment bind` and `unbind` command #1131

andrewnester commented Jan 18, 2024 •

edited

Loading

codecov-commenter commented Feb 7, 2024 •

edited

Loading