databricks-cli/bundle/libraries
shreyas-goenka 2847533e1e
Add DABs support for Unity Catalog volumes (#1762)
## Changes

This PR adds support for UC volumes to DABs.

### Can I use a UC volume managed by DABs in `artifact_path`?

Yes, but we require the volume to exist before being referenced in
`artifact_path`. Otherwise you'll see an error that the volume does not
exist. For this case, this PR also adds a warning if we detect that the
UC volume is defined in the DAB itself, which informs the user to deploy
the UC volume in a separate deployment first before using it in
`artifact_path`.

We cannot create the UC volume and then upload the artifacts to it in
the same `bundle deploy` because `bundle deploy` always uploads the
artifacts to `artifact_path` before materializing any resources defined
in the bundle. Supporting this in a single deployment requires us to
migrate away from our dependency on the Databricks Terraform provider to
manage the CRUD lifecycle of DABs resources.

### Why do we not support `preset.name_prefix` for UC volumes?

UC volumes will not have a `dev_shreyas_goenka` prefix added in `mode:
development`. Configuring `presets.name_prefix` will be a no-op for UC
volumes. We have decided not to support prefixing for UC resources. This
is because:
1. UC provides its own namespace hierarchy that is independent of DABs.
2. Users can always manually use `${workspace.current_user.short_name}`
to configure the prefixes manually.

Customers often manually set up a UC hierarchy for dev and prod,
including a schema or catalog per developer. Thus, it's often
unnecessary for us to add prefixing in `mode: development` by default
for UC resources.

In retrospect, supporting prefixing for UC schemas and registered models
was a mistake and will be removed in a future release of DABs.

## Tests
Unit, integration test, and manually. 

### Manual Testing cases:
 1. UC volume does not exist:
```
➜  bundle-playground git:(master) ✗ cli bundle deploy
Error: failed to fetch metadata for the UC volume /Volumes/main/caps/my_volume that is configured in the artifact_path: Not Found
```

2. UC Volume does not exist, but is defined in the DAB
```
➜  bundle-playground git:(master) ✗ cli bundle deploy
Error: failed to fetch metadata for the UC volume /Volumes/main/caps/managed_by_dab that is configured in the artifact_path: Not Found

Warning: You might be using a UC volume in your artifact_path that is managed by this bundle but which has not been deployed yet. Please deploy the UC volume in a separate bundle deploy before using it in the artifact_path.
  at resources.volumes.bar
  in databricks.yml:24:7

```

---------

Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
2024-12-02 21:18:07 +00:00
..
testdata Refactor library to artifact matching to not use pointers (#1172) 2024-02-05 15:29:45 +00:00
expand_glob_references.go Expand library globs relative to the sync root (#1756) 2024-09-09 09:56:16 +00:00
expand_glob_references_test.go Modify SetLocation test utility to take full locations as argument (#1788) 2024-09-25 16:13:48 +00:00
filer.go Add DABs support for Unity Catalog volumes (#1762) 2024-12-02 21:18:07 +00:00
filer_test.go Add DABs support for Unity Catalog volumes (#1762) 2024-12-02 21:18:07 +00:00
filer_volume.go Add DABs support for Unity Catalog volumes (#1762) 2024-12-02 21:18:07 +00:00
filer_volume_test.go Add DABs support for Unity Catalog volumes (#1762) 2024-12-02 21:18:07 +00:00
filer_workspace.go Add DABs support for Unity Catalog volumes (#1762) 2024-12-02 21:18:07 +00:00
filer_workspace_test.go Add DABs support for Unity Catalog volumes (#1762) 2024-12-02 21:18:07 +00:00
helpers.go Do not treat empty path as a local path (#1717) 2024-08-26 10:03:56 +00:00
helpers_test.go Do not treat empty path as a local path (#1717) 2024-08-26 10:03:56 +00:00
libraries.go Do not treat empty path as a local path (#1717) 2024-08-26 10:03:56 +00:00
local_path.go Added support for pip options in environment dependencies (#1842) 2024-10-21 11:45:39 +00:00
local_path_test.go Correctly mark PyPI package name specs with multiple specifiers as remote libraries (#1725) 2024-08-28 11:39:06 +00:00
match_test.go Expand library globs relative to the sync root (#1756) 2024-09-09 09:56:16 +00:00
path.go Use SetPermissions instead of UpdatePermissions when setting folder permissions based on top-level ones (#1822) 2024-10-29 12:06:38 +00:00
path_test.go Added validator for folder permissions (#1824) 2024-10-24 12:36:17 +00:00
upload.go Add DABs support for Unity Catalog volumes (#1762) 2024-12-02 21:18:07 +00:00
upload_test.go Add DABs support for Unity Catalog volumes (#1762) 2024-12-02 21:18:07 +00:00