From f9278c2b4dfbf6bd2704091b9a120bd0d787dbca Mon Sep 17 00:00:00 2001 From: Ilya Kuznetsov Date: Wed, 8 Jan 2025 16:11:58 +0100 Subject: [PATCH] docs: Add override for volume spec --- .../schema/annotations_openapi_overrides.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/bundle/internal/schema/annotations_openapi_overrides.yml b/bundle/internal/schema/annotations_openapi_overrides.yml index ef602d6ef..21e8217b2 100644 --- a/bundle/internal/schema/annotations_openapi_overrides.yml +++ b/bundle/internal/schema/annotations_openapi_overrides.yml @@ -69,6 +69,25 @@ github.com/databricks/cli/bundle/config/resources.Schema: "description": |- PLACEHOLDER github.com/databricks/cli/bundle/config/resources.Volume: + "_": + "markdown_description": |- + The volume resource type allows you to define and create Unity Catalog [volumes](https://docs.databricks.com/api/workspace/volumes/create) as part of a bundle. When deploying a bundle with a volume defined, note that: + + * A volume cannot be referenced in the `artifact_path` for the bundle until it exists in the workspace. Hence, if you want to use Databricks Asset Bundles to create the volume, you must first define the volume in the bundle, deploy it to create the volume, then reference it in the `artifact_path`` in subsequent deployments. + + * Volumes in the bundle are not prepended with the `dev_${workspace.current_user.short_name}` prefix when the deployment target has `mode: development`` configured. However, you can manually configure this prefix. See [_](/dev-tools/bundles/deployment-modes.md#custom-presets) + + "markdown_examples": |- + The following example creates a Unity Catalog volume with the key `my_volume``: + + ```yaml + resources: + volumes: + my_volume: + catalog_name: main + name: my_volume + schema_name: my_schema + ``` "grants": "description": |- PLACEHOLDER