steve/databricks-cli
steve
/
databricks-cli
mirror of https://github.com/databricks/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Annotation fixes

This commit is contained in:
Ilya Kuznetsov 2025-01-27 18:33:58 +01:00
parent 8a1b61d341
commit ee693532b8
No known key found for this signature in database
GPG Key ID: 91F3DDCF5D21CDDF
2 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
bundle/internal/schema/annotations.yml
View File

@ -184,9 +184,9 @@ github.com/databricks/cli/bundle/config.Resources:
The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [_](/dev-tools/bundles/resources.md#quality_monitors) The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [_](/dev-tools/bundles/resources.md#quality_monitors)
"registered_models": "registered_models":
"description": |- "description": |-
The registered model definitions for the bundle, where each key is the name of the <UC> registered model. The registered model definitions for the bundle, where each key is the name of the Unity Catalog registered model.
"markdown_description": |- "markdown_description": |-
The registered model definitions for the bundle, where each key is the name of the <UC> registered model. See [_](/dev-tools/bundles/resources.md#registered_models) The registered model definitions for the bundle, where each key is the name of the Unity Catalog registered model. See [_](/dev-tools/bundles/resources.md#registered_models)
"schemas": "schemas":
"description": |- "description": |-
The schema definitions for the bundle, where each key is the name of the schema. The schema definitions for the bundle, where each key is the name of the schema.
@ -252,7 +252,7 @@ github.com/databricks/cli/bundle/config.Root:
"description": |- "description": |-
A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource. A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource.
"markdown_description": |- "markdown_description": |-
A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource. For more information about <DABS> supported resources, and resource definition reference, see [_](/dev-tools/bundles/resources.md). A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource. For more information about Databricks Asset Bundles supported resources, and resource definition reference, see [_](/dev-tools/bundles/resources.md).
```yaml ```yaml
resources: resources:
@ -262,9 +262,9 @@ github.com/databricks/cli/bundle/config.Root:
``` ```
"run_as": "run_as":
"description": |- "description": |-
The identity to use when running <DABS> workflows. The identity to use when running Databricks Asset Bundles workflows.
"markdown_description": |- "markdown_description": |-
The identity to use when running <DABS> workflows. See [_](/dev-tools/bundles/run-as.md). The identity to use when running Databricks Asset Bundles workflows. See [_](/dev-tools/bundles/run-as.md).
"sync": "sync":
"description": |- "description": |-
The files and file paths to include or exclude in the bundle. The files and file paths to include or exclude in the bundle.

30
bundle/internal/schema/annotations_openapi_overrides.yml
View File

@ -136,7 +136,7 @@ github.com/databricks/cli/bundle/config/resources.Dashboard:
github.com/databricks/cli/bundle/config/resources.Job: github.com/databricks/cli/bundle/config/resources.Job:
"_": "_":
"markdown_description": |- "markdown_description": |-
The job resource allows you to define [jobs and their corresponding tasks](/api/workspace/jobs/create) in your bundle. For information about jobs, see [_](/jobs/index.md). For a tutorial that uses a <DABS> template to create a job, see [_](/dev-tools/bundles/jobs-tutorial.md). The job resource allows you to define [jobs and their corresponding tasks](/api/workspace/jobs/create) in your bundle. For information about jobs, see [_](/jobs/index.md). For a tutorial that uses a Databricks Asset Bundles template to create a job, see [_](/dev-tools/bundles/jobs-tutorial.md).
"markdown_examples": |- "markdown_examples": |-
The following example defines a job with the resource key `hello-job` with one notebook task: The following example defines a job with the resource key `hello-job` with one notebook task:
@ -184,7 +184,7 @@ github.com/databricks/cli/bundle/config/resources.MlflowExperiment:
github.com/databricks/cli/bundle/config/resources.MlflowModel: github.com/databricks/cli/bundle/config/resources.MlflowModel:
"_": "_":
"markdown_description": |- "markdown_description": |-
The model resource allows you to define [legacy models](/api/workspace/modelregistry/createmodel) in bundles. Databricks recommends you use <UC> [registered models](#registered-model) instead. The model resource allows you to define [legacy models](/api/workspace/modelregistry/createmodel) in bundles. Databricks recommends you use Unity Catalog [registered models](#registered-model) instead.
"permissions": "permissions":
"description": |- "description": |-
PLACEHOLDER PLACEHOLDER
@ -193,7 +193,7 @@ github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint:
"markdown_description": |- "markdown_description": |-
The model_serving_endpoint resource allows you to define [model serving endpoints](/api/workspace/servingendpoints/create). See [_](/machine-learning/model-serving/manage-serving-endpoints.md). The model_serving_endpoint resource allows you to define [model serving endpoints](/api/workspace/servingendpoints/create). See [_](/machine-learning/model-serving/manage-serving-endpoints.md).
"markdown_examples": |- "markdown_examples": |-
The following example defines a <UC> model serving endpoint: The following example defines a Unity Catalog model serving endpoint:
```yaml ```yaml
resources: resources:
@ -220,7 +220,7 @@ github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint:
github.com/databricks/cli/bundle/config/resources.Pipeline: github.com/databricks/cli/bundle/config/resources.Pipeline:
"_": "_":
"markdown_description": |- "markdown_description": |-
The pipeline resource allows you to create <DLT> [pipelines](/api/workspace/pipelines/create). For information about pipelines, see [_](/delta-live-tables/index.md). For a tutorial that uses the <DABS> template to create a pipeline, see [_](/dev-tools/bundles/pipelines-tutorial.md). The pipeline resource allows you to create <DLT> [pipelines](/api/workspace/pipelines/create). For information about pipelines, see [_](/delta-live-tables/index.md). For a tutorial that uses the Databricks Asset Bundles template to create a pipeline, see [_](/dev-tools/bundles/pipelines-tutorial.md).
"markdown_examples": |- "markdown_examples": |-
The following example defines a pipeline with the resource key `hello-pipeline`: The following example defines a pipeline with the resource key `hello-pipeline`:
@ -247,7 +247,7 @@ github.com/databricks/cli/bundle/config/resources.Pipeline:
github.com/databricks/cli/bundle/config/resources.QualityMonitor: github.com/databricks/cli/bundle/config/resources.QualityMonitor:
"_": "_":
"markdown_description": |- "markdown_description": |-
The quality_monitor resource allows you to define a <UC> [table monitor](/api/workspace/qualitymonitors/create). For information about monitors, see [_](/machine-learning/model-serving/monitor-diagnose-endpoints.md). The quality_monitor resource allows you to define a Unity Catalog [table monitor](/api/workspace/qualitymonitors/create). For information about monitors, see [_](/machine-learning/model-serving/monitor-diagnose-endpoints.md).
"markdown_examples": |- "markdown_examples": |-
The following example defines a quality monitor: The following example defines a quality monitor:
@ -275,9 +275,9 @@ github.com/databricks/cli/bundle/config/resources.QualityMonitor:
github.com/databricks/cli/bundle/config/resources.RegisteredModel: github.com/databricks/cli/bundle/config/resources.RegisteredModel:
"_": "_":
"markdown_description": |- "markdown_description": |-
The registered model resource allows you to define models in <UC>. For information about <UC> [registered models](/api/workspace/registeredmodels/create), see [_](/machine-learning/manage-model-lifecycle/index.md). The registered model resource allows you to define models in Unity Catalog. For information about Unity Catalog [registered models](/api/workspace/registeredmodels/create), see [_](/machine-learning/manage-model-lifecycle/index.md).
"markdown_examples": |- "markdown_examples": |-
The following example defines a registered model in <UC>: The following example defines a registered model in Unity Catalog:
```yaml ```yaml
resources: resources:
@ -298,12 +298,12 @@ github.com/databricks/cli/bundle/config/resources.RegisteredModel:
github.com/databricks/cli/bundle/config/resources.Schema: github.com/databricks/cli/bundle/config/resources.Schema:
"_": "_":
"markdown_description": |- "markdown_description": |-
The schema resource type allows you to define <UC> [schemas](/api/workspace/schemas/create) for tables and other assets in your workflows and pipelines created as part of a bundle. A schema, different from other resource types, has the following limitations: The schema resource type allows you to define Unity Catalog [schemas](/api/workspace/schemas/create) for tables and other assets in your workflows and pipelines created as part of a bundle. A schema, different from other resource types, has the following limitations:
- The owner of a schema resource is always the deployment user, and cannot be changed. If `run_as` is specified in the bundle, it will be ignored by operations on the schema. - The owner of a schema resource is always the deployment user, and cannot be changed. If `run_as` is specified in the bundle, it will be ignored by operations on the schema.
- Only fields supported by the corresponding [Schemas object create API](/api/workspace/schemas/create) are available for the schema resource. For example, `enable_predictive_optimization` is not supported as it is only available on the [update API](/api/workspace/schemas/update). - Only fields supported by the corresponding [Schemas object create API](/api/workspace/schemas/create) are available for the schema resource. For example, `enable_predictive_optimization` is not supported as it is only available on the [update API](/api/workspace/schemas/update).
"markdown_examples": |- "markdown_examples": |-
The following example defines a pipeline with the resource key `my_pipeline` that creates a <UC> schema with the key `my_schema` as the target: The following example defines a pipeline with the resource key `my_pipeline` that creates a Unity Catalog schema with the key `my_schema` as the target:
```yaml ```yaml
resources: resources:
@ -324,9 +324,9 @@ github.com/databricks/cli/bundle/config/resources.Schema:
comment: This schema was created by DABs. comment: This schema was created by DABs.
``` ```
A top-level grants mapping is not supported by <DABS>, so if you want to set grants for a schema, define the grants for the schema within the `schemas` mapping. For more information about grants, see [_](/data-governance/unity-catalog/manage-privileges/index.md#grant). A top-level grants mapping is not supported by Databricks Asset Bundles, so if you want to set grants for a schema, define the grants for the schema within the `schemas` mapping. For more information about grants, see [_](/data-governance/unity-catalog/manage-privileges/index.md#grant).
The following example defines a <UC> schema with grants: The following example defines a Unity Catalog schema with grants:
```yaml ```yaml
resources: resources:
@ -351,14 +351,14 @@ github.com/databricks/cli/bundle/config/resources.Schema:
github.com/databricks/cli/bundle/config/resources.Volume: github.com/databricks/cli/bundle/config/resources.Volume:
"_": "_":
"markdown_description": |- "markdown_description": |-
The volume resource type allows you to define and create <UC> [volumes](/api/workspace/volumes/create) as part of a bundle. When deploying a bundle with a volume defined, note that: The volume resource type allows you to define and create Unity Catalog [volumes](/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 <DABS> 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. - 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). - 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": |- "markdown_examples": |-
The following example creates a <UC> volume with the key `my_volume`: The following example creates a Unity Catalog volume with the key `my_volume`:
```yaml ```yaml
resources: resources:
@ -369,7 +369,7 @@ github.com/databricks/cli/bundle/config/resources.Volume:
schema_name: my_schema schema_name: my_schema
``` ```
For an example bundle that runs a job that writes to a file in <UC> volume, see the [bundle-examples GitHub repository](https://github.com/databricks/bundle-examples/tree/main/knowledge_base/write_from_job_to_volume). For an example bundle that runs a job that writes to a file in Unity Catalog volume, see the [bundle-examples GitHub repository](https://github.com/databricks/bundle-examples/tree/main/knowledge_base/write_from_job_to_volume).
"grants": "grants":
"description": |- "description": |-
PLACEHOLDER PLACEHOLDER