Remove deprecated or readonly fields from the bundle schema #1809
Conversation
This file contains 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
pietern
reviewed
Oct 7, 2024
pietern
approved these changes
Oct 7, 2024
|
@shreyas-goenka The AI config schema change is also part of the SDK bump (#1810). Let's queue this one after that one such that the Git history makes sense. |
andrewnester
added a commit
that referenced
this pull request
Oct 9, 2024
Important changes:
Workspace paths are automatically prefixed with `/Workspace`. In addition, all usage of path strings such as `/Workspace/${workspace.root_path}/...` in bundle configuration is automatically replaced with `${workspace.root_path}/...` and generates a warning as part of bundle validate.
If you have specified a custom `workspace.root_path`, `workspace.artifact_path`, or `workspace.file_path`, Databricks Asset Bundles automatically prefixes it with `/Workspace`, but if you use any of these as variables (for example, `my_config_path: /Workspace/${workspace.file_path}/config`), you need to update those entries to remove the /Workspace prefix to avoid the warning.
If you pass one of these as variables and prefix them in your code, you need to update your code to not do this.
This change is required because originally when the workspace file system was rooted at `/` and home directories were under `/Users`, to access workspace paths through the Databricks REST API you would use these paths directly. To access workspace paths from your code, you could use the `/Workspace` file path and home directories were also available under `/Workspace/Users`. To avoid this duality of workspace paths, as well as the ambiguity between workspace paths and Unity Catalog `/Volumes` paths, all workspace paths are prefixed with `/Workspace`.
Bundles:
* Add an error if state files grow bigger than the export limit ([#1795](#1795)).
* Always prepend bundle remote paths with /Workspace ([#1724](#1724)).
* Add resource path field to bundle workspace configuration ([#1800](#1800)).
* Add validation for files with a `.(resource-name).yml` extension ([#1780](#1780)).
Internal:
* Remove deprecated or readonly fields from the bundle schema ([#1809](#1809)).
API Changes:
* Changed `databricks git-credentials create` command . New request type is .
* Changed `databricks git-credentials delete` command . New request type is .
* Changed `databricks git-credentials delete` command to return .
* Changed `databricks git-credentials get` command . New request type is .
* Changed `databricks git-credentials get` command to return .
* Changed `databricks git-credentials list` command to return .
* Changed `databricks git-credentials update` command . New request type is .
* Changed `databricks git-credentials update` command to return .
* Changed `databricks repos create` command . New request type is .
* Changed `databricks repos create` command to return .
* Changed `databricks repos delete` command to return .
* Changed `databricks repos get` command to return .
* Changed `databricks repos update` command . New request type is .
* Changed `databricks repos update` command to return .
OpenAPI commit 0c86ea6dbd9a730c24ff0d4e509603e476955ac5 (2024-10-02)
Dependency updates:
* Upgrade TF provider to 1.53.0 ([#1815](#1815)).
* Bump golang.org/x/term from 0.24.0 to 0.25.0 ([#1811](#1811)).
* Bump golang.org/x/text from 0.18.0 to 0.19.0 ([#1812](#1812)).
* Bump github.com/databricks/databricks-sdk-go from 0.47.0 to 0.48.0 ([#1810](#1810)).
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 9, 2024
Notable changes for Databricks Asset Bundles:
Workspace paths are automatically prefixed with `/Workspace`. In
addition, all usage of path strings such as
`/Workspace/${workspace.root_path}/...` in bundle configuration is
automatically replaced with `${workspace.root_path}/...` and generates a
warning as part of bundle validate.
More details can be find here:
https://docs.databricks.com/en/release-notes/dev-tools/bundles.html#workspace-paths-will-be-automatically-prefixed
Bundles:
* Add an error if state files grow bigger than the export limit
([#1795](#1795)).
* Always prepend bundle remote paths with /Workspace
([#1724](#1724)).
* Add resource path field to bundle workspace configuration
([#1800](#1800)).
* Add validation for files with a `.(resource-name).yml` extension
([#1780](#1780)).
Internal:
* Remove deprecated or readonly fields from the bundle schema
([#1809](#1809)).
API Changes:
* Changed `databricks git-credentials create`, `databricks
git-credentials delete`, `databricks git-credentials get`, `databricks
git-credentials list`, `databricks git-credentials update` commands .
* Changed `databricks repos create`, `databricks repos delete`,
`databricks repos get`, `databricks repos update` command .
OpenAPI commit 0c86ea6dbd9a730c24ff0d4e509603e476955ac5 (2024-10-02)
Dependency updates:
* Upgrade TF provider to 1.53.0
([#1815](#1815)).
* Bump golang.org/x/term from 0.24.0 to 0.25.0
([#1811](#1811)).
* Bump golang.org/x/text from 0.18.0 to 0.19.0
([#1812](#1812)).
* Bump github.com/databricks/databricks-sdk-go from 0.47.0 to 0.48.0
([#1810](#1810)).
---------
Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
We do not need the user to specify these fields in their bundle configuration, so we remove them from the JSON schema.
Tests
Manually and end to end tests. The JSON schema has also been regenerated after these changes.