mirror of https://github.com/databricks/cli.git
Populate missing bundle config reference doc descriptions and fix resource reference doc template (#2314)
## Changes - Added some missing descriptions to annotations.yml - Fixed links in the resource reference doc template ## Tests <!-- How is this tested? -->
This commit is contained in:
Julia Crawford (Databricks)
GitHub
parent
4881fd873b
commit
864f0abc4b
|
|
@ -1,11 +1,13 @@
|
|||
---
|
||||
description: Configuration reference for databricks.yml
|
||||
description: 'Configuration reference for databricks.yml'
|
||||
last_update:
|
||||
date: 2025-02-14
|
||||
---
|
||||
|
||||
<!-- DO NOT EDIT. This file is autogenerated with https://github.com/databricks/cli -->
|
||||
<!--DO NOT EDIT. This file is autogenerated with https://github.com/databricks/cli-->
|
||||
|
||||
# Configuration reference
|
||||
|
||||
This article provides reference for keys supported by <DABS> configuration (YAML). See [_](/dev-tools/bundles/index.md).
|
||||
This article provides reference for keys supported by :re[DABS] configuration (YAML). See [\_](/dev-tools/bundles/index.md).
|
||||
|
||||
For complete bundle examples, see [_](/dev-tools/bundles/resource-examples.md) and the [bundle-examples GitHub repository](https://github.com/databricks/bundle-examples).
|
||||
For complete bundle examples, see [\_](/dev-tools/bundles/resource-examples.md) and the [bundle-examples GitHub repository](https://github.com/databricks/bundle-examples).
|
||||
|
|
|
|||
|
|
@ -1,71 +1,124 @@
|
|||
---
|
||||
description: Learn about resources supported by Databricks Asset Bundles and how to configure them.
|
||||
description: 'Learn about resources supported by Databricks Asset Bundles and how to configure them.'
|
||||
last_update:
|
||||
date: 2025-02-14
|
||||
---
|
||||
|
||||
<!-- DO NOT EDIT. This file is autogenerated with https://github.com/databricks/cli -->
|
||||
|
||||
# <DABS> resources
|
||||
# :re[DABS] resources
|
||||
|
||||
<DABS> allows you to specify information about the <Databricks> resources used by the bundle in the `resources` mapping in the bundle configuration. See [resources mapping](/dev-tools/bundles/settings.md#resources) and [resources key reference](/dev-tools/bundles/reference.md#resources).
|
||||
:re[DABS] allows you to specify information about the :re[Databricks] resources used by the bundle in the `resources` mapping in the bundle configuration. See [resources mapping](/dev-tools/bundles/settings.md#resources) and [resources key reference](/dev-tools/bundles/reference.md#resources).
|
||||
|
||||
This article outlines supported resource types for bundles and provides details and an example for each supported type. For additional examples, see [_](/dev-tools/bundles/resource-examples.md).
|
||||
This article outlines supported resource types for bundles and provides details and an example for each supported type. For additional examples, see [\_](/dev-tools/bundles/resource-examples.md).
|
||||
|
||||
## <a id="resource-types"></a> Supported resources
|
||||
:::tip
|
||||
|
||||
To generate YAML for any existing resource, use the `databricks bundle generate` command. See [\_](/dev-tools/cli/bundle-commands.md#generate).
|
||||
|
||||
:::
|
||||
|
||||
## <a id="resource-types"></a>Supported resources
|
||||
|
||||
The following table lists supported resource types for bundles. Some resources can be created by defining them in a bundle and deploying the bundle, and some resources only support referencing an existing resource to include in the bundle.
|
||||
|
||||
Resources are defined using the corresponding [Databricks REST API](/api/workspace/introduction) object's create operation request payload, where the object's supported fields, expressed as YAML, are the resource's supported properties. Links to documentation for each resource's corresponding payloads are listed in the table.
|
||||
Resources are defined using the corresponding [Databricks REST API](https://docs.databricks.com/api/workspace/introduction) object’s create operation request payload, where the object’s supported fields, expressed as YAML, are the resource’s supported properties. Links to documentation for each resource’s corresponding payloads are listed in the table.
|
||||
|
||||
.. tip:: The `databricks bundle validate` command returns warnings if unknown resource properties are found in bundle configuration files.
|
||||
:::tip
|
||||
|
||||
The `databricks bundle validate` command returns warnings if unknown resource properties are found in bundle configuration files.
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
:::
|
||||
|
||||
* - Resource
|
||||
- Create support
|
||||
- Corresponding REST API object
|
||||
::::aws-azure
|
||||
|
||||
* - [cluster](#cluster)
|
||||
- ✓
|
||||
- [Cluster object](/api/workspace/clusters/create)
|
||||
:::list-table
|
||||
|
||||
* - [dashboard](#dashboard)
|
||||
-
|
||||
- [Dashboard object](/api/workspace/lakeview/create)
|
||||
- - Resource
|
||||
- Create support
|
||||
- Corresponding REST API object
|
||||
- - [app](#apps)
|
||||
- ✓
|
||||
- [App object](https://docs.databricks.com/api/workspace/apps/create)
|
||||
- - [cluster](#clusters)
|
||||
- ✓
|
||||
- [Cluster object](https://docs.databricks.com/api/workspace/clusters/create)
|
||||
- - [dashboard](#dashboards)
|
||||
-
|
||||
- [Dashboard object](https://docs.databricks.com/api/workspace/lakeview/create)
|
||||
- - [experiment](#experiments)
|
||||
- ✓
|
||||
- [Experiment object](https://docs.databricks.com/api/workspace/experiments/createexperiment)
|
||||
- - [job](#job)
|
||||
- ✓
|
||||
- [Job object](https://docs.databricks.com/api/workspace/jobs/create)
|
||||
- - [model (legacy)](#models)
|
||||
- ✓
|
||||
- [Model (legacy) object](https://docs.databricks.com/api/workspace/modelregistry/createmodel)
|
||||
- - [model_serving_endpoint](#model_serving_endpoints)
|
||||
- ✓
|
||||
- [Model serving endpoint object](https://docs.databricks.com/api/workspace/servingendpoints/create)
|
||||
- - [pipeline](#pipeline)
|
||||
- ✓
|
||||
- [Pipeline object](https://docs.databricks.com/api/workspace/pipelines/create)
|
||||
- - [quality_monitor](#quality_monitors)
|
||||
- ✓
|
||||
- [Quality monitor object](https://docs.databricks.com/api/workspace/qualitymonitors/create)
|
||||
- - [registered_model](#registered_models) (:re[UC])
|
||||
- ✓
|
||||
- [Registered model object](https://docs.databricks.com/api/workspace/registeredmodels/create)
|
||||
- - [schema](#schemas) (:re[UC])
|
||||
- ✓
|
||||
- [Schema object](https://docs.databricks.com/api/workspace/schemas/create)
|
||||
- - [volume](#volumes) (:re[UC])
|
||||
- ✓
|
||||
- [Volume object](https://docs.databricks.com/api/workspace/volumes/create)
|
||||
|
||||
* - [experiment](#experiment)
|
||||
- ✓
|
||||
- [Experiment object](/api/workspace/experiments/createexperiment)
|
||||
:::
|
||||
|
||||
* - [job](#job)
|
||||
- ✓
|
||||
- [Job object](/api/workspace/jobs/create)
|
||||
::::
|
||||
|
||||
* - [model (legacy)](#model-legacy)
|
||||
- ✓
|
||||
- [Model (legacy) object](/api/workspace/modelregistry/createmodel)
|
||||
::::gcp
|
||||
|
||||
* - [model_serving_endpoint](#model-serving-endpoint)
|
||||
- ✓
|
||||
- [Model serving endpoint object](/api/workspace/servingendpoints/create)
|
||||
:::list-table
|
||||
|
||||
* - [pipeline](#pipeline)
|
||||
- ✓
|
||||
- [Pipeline object](/api/workspace/pipelines/create)
|
||||
- - Resource
|
||||
- Create support
|
||||
- Corresponding REST API object
|
||||
- - [cluster](#clusters)
|
||||
- ✓
|
||||
- [Cluster object](https://docs.databricks.com/api/workspace/clusters/create)
|
||||
- - [dashboard](#dashboards)
|
||||
-
|
||||
- [Dashboard object](https://docs.databricks.com/api/workspace/lakeview/create)
|
||||
- - [experiment](#experiments)
|
||||
- ✓
|
||||
- [Experiment object](https://docs.databricks.com/api/workspace/experiments/createexperiment)
|
||||
- - [job](#jobs)
|
||||
- ✓
|
||||
- [Job object](https://docs.databricks.com/api/workspace/jobs/create)
|
||||
- - [model (legacy)](#models)
|
||||
- ✓
|
||||
- [Model (legacy) object](https://docs.databricks.com/api/workspace/modelregistry/createmodel)
|
||||
- - [model_serving_endpoint](#model_serving_endpoints)
|
||||
- ✓
|
||||
- [Model serving endpoint object](https://docs.databricks.com/api/workspace/servingendpoints/create)
|
||||
- - [pipeline](#pipelines)
|
||||
- ✓
|
||||
- [Pipeline object]](https://docs.databricks.com/api/workspace/pipelines/create)
|
||||
- - [quality_monitor](#quality_monitors)
|
||||
- ✓
|
||||
- [Quality monitor object](https://docs.databricks.com/api/workspace/qualitymonitors/create)
|
||||
- - [registered_model](#registered_models) (:re[UC])
|
||||
- ✓
|
||||
- [Registered model object](https://docs.databricks.com/api/workspace/registeredmodels/create)
|
||||
- - [schema](#schemas) (:re[UC])
|
||||
- ✓
|
||||
- [Schema object](https://docs.databricks.com/api/workspace/schemas/create)
|
||||
- - [volume](#volumes) (:re[UC])
|
||||
- ✓
|
||||
- [Volume object](https://docs.databricks.com/api/workspace/volumes/create)
|
||||
|
||||
* - [quality_monitor](#quality-monitor)
|
||||
- ✓
|
||||
- [Quality monitor object](/api/workspace/qualitymonitors/create)
|
||||
:::
|
||||
|
||||
* - [registered_model](#registered-model) (<UC>)
|
||||
- ✓
|
||||
- [Registered model object](/api/workspace/registeredmodels/create)
|
||||
|
||||
* - [schema](#schema) (<UC>)
|
||||
- ✓
|
||||
- [Schema object](/api/workspace/schemas/create)
|
||||
|
||||
* - [volume](#volume) (<UC>)
|
||||
- ✓
|
||||
- [Volume object](/api/workspace/volumes/create)
|
||||
::::
|
||||
|
|
|
|||
|
|
@ -1,25 +1,25 @@
|
|||
github.com/databricks/cli/bundle/config.Artifact:
|
||||
"build":
|
||||
"description": |-
|
||||
An optional set of non-default build commands to run locally before deployment.
|
||||
An optional set of build commands to run locally before deployment.
|
||||
"executable":
|
||||
"description": |-
|
||||
The executable type. Valid values are `bash`, `sh`, and `cmd`.
|
||||
"files":
|
||||
"description": |-
|
||||
The source files for the artifact.
|
||||
The relative or absolute path to the built artifact files.
|
||||
"path":
|
||||
"description": |-
|
||||
The location where the built artifact will be saved.
|
||||
The local path of the directory for the artifact.
|
||||
"type":
|
||||
"description": |-
|
||||
Required. The type of the artifact.
|
||||
Required if the artifact is a Python wheel. The type of the artifact. Valid values are `whl` and `jar`.
|
||||
"markdown_description": |-
|
||||
Required. The type of the artifact. Valid values are `whl`.
|
||||
Required if the artifact is a Python wheel. The type of the artifact. Valid values are `whl` and `jar`.
|
||||
github.com/databricks/cli/bundle/config.ArtifactFile:
|
||||
"source":
|
||||
"description": |-
|
||||
Required. The path of the files used to build the artifact.
|
||||
Required. The artifact source file.
|
||||
github.com/databricks/cli/bundle/config.Bundle:
|
||||
"cluster_id":
|
||||
"description": |-
|
||||
|
|
@ -28,7 +28,7 @@ github.com/databricks/cli/bundle/config.Bundle:
|
|||
The ID of a cluster to use to run the bundle. See [_](/dev-tools/bundles/settings.md#cluster_id).
|
||||
"compute_id":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
Deprecated. The ID of the compute to use to run the bundle.
|
||||
"databricks_cli_version":
|
||||
"description": |-
|
||||
The Databricks CLI version to use for the bundle.
|
||||
|
|
@ -141,62 +141,64 @@ github.com/databricks/cli/bundle/config.Python:
|
|||
github.com/databricks/cli/bundle/config.Resources:
|
||||
"apps":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The app resource defines a Databricks app.
|
||||
"markdown_description": |-
|
||||
The app resource defines a [Databricks app](/api/workspace/apps/create). For information about Databricks Apps, see [_](/dev-tools/databricks-apps/index.md).
|
||||
"clusters":
|
||||
"description": |-
|
||||
The cluster definitions for the bundle, where each key is the name of a cluster.
|
||||
"markdown_description": |-
|
||||
The cluster definitions for the bundle, where each key is the name of a cluster. See [_](/dev-tools/bundles/resources.md#clusters)
|
||||
The cluster definitions for the bundle, where each key is the name of a cluster. See [_](/dev-tools/bundles/resources.md#clusters).
|
||||
"dashboards":
|
||||
"description": |-
|
||||
The dashboard definitions for the bundle, where each key is the name of the dashboard.
|
||||
"markdown_description": |-
|
||||
The dashboard definitions for the bundle, where each key is the name of the dashboard. See [_](/dev-tools/bundles/resources.md#dashboards)
|
||||
The dashboard definitions for the bundle, where each key is the name of the dashboard. See [_](/dev-tools/bundles/resources.md#dashboards).
|
||||
"experiments":
|
||||
"description": |-
|
||||
The experiment definitions for the bundle, where each key is the name of the experiment.
|
||||
"markdown_description": |-
|
||||
The experiment definitions for the bundle, where each key is the name of the experiment. See [_](/dev-tools/bundles/resources.md#experiments)
|
||||
The experiment definitions for the bundle, where each key is the name of the experiment. See [_](/dev-tools/bundles/resources.md#experiments).
|
||||
"jobs":
|
||||
"description": |-
|
||||
The job definitions for the bundle, where each key is the name of the job.
|
||||
"markdown_description": |-
|
||||
The job definitions for the bundle, where each key is the name of the job. See [_](/dev-tools/bundles/resources.md#jobs)
|
||||
The job definitions for the bundle, where each key is the name of the job. See [_](/dev-tools/bundles/resources.md#jobs).
|
||||
"model_serving_endpoints":
|
||||
"description": |-
|
||||
The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint.
|
||||
"markdown_description": |-
|
||||
The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [_](/dev-tools/bundles/resources.md#model_serving_endpoints)
|
||||
The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [_](/dev-tools/bundles/resources.md#model_serving_endpoints).
|
||||
"models":
|
||||
"description": |-
|
||||
The model definitions for the bundle, where each key is the name of the model.
|
||||
"markdown_description": |-
|
||||
The model definitions for the bundle, where each key is the name of the model. See [_](/dev-tools/bundles/resources.md#models)
|
||||
The model definitions for the bundle, where each key is the name of the model. See [_](/dev-tools/bundles/resources.md#models).
|
||||
"pipelines":
|
||||
"description": |-
|
||||
The pipeline definitions for the bundle, where each key is the name of the pipeline.
|
||||
"markdown_description": |-
|
||||
The pipeline definitions for the bundle, where each key is the name of the pipeline. See [_](/dev-tools/bundles/resources.md#pipelines)
|
||||
The pipeline definitions for the bundle, where each key is the name of the pipeline. See [_](/dev-tools/bundles/resources.md#pipelines).
|
||||
"quality_monitors":
|
||||
"description": |-
|
||||
The quality monitor definitions for the bundle, where each key is the name of the quality monitor.
|
||||
"markdown_description": |-
|
||||
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":
|
||||
"description": |-
|
||||
The registered model definitions for the bundle, where each key is the name of the <UC> registered model.
|
||||
"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 <UC> registered model. See [_](/dev-tools/bundles/resources.md#registered_models).
|
||||
"schemas":
|
||||
"description": |-
|
||||
The schema definitions for the bundle, where each key is the name of the schema.
|
||||
"markdown_description": |-
|
||||
The schema definitions for the bundle, where each key is the name of the schema. See [_](/dev-tools/bundles/resources.md#schemas)
|
||||
The schema definitions for the bundle, where each key is the name of the schema. See [_](/dev-tools/bundles/resources.md#schemas).
|
||||
"volumes":
|
||||
"description": |-
|
||||
The volume definitions for the bundle, where each key is the name of the volume.
|
||||
"markdown_description": |-
|
||||
The volume definitions for the bundle, where each key is the name of the volume. See [_](/dev-tools/bundles/resources.md#volumes)
|
||||
The volume definitions for the bundle, where each key is the name of the volume. See [_](/dev-tools/bundles/resources.md#volumes).
|
||||
github.com/databricks/cli/bundle/config.Root:
|
||||
"artifacts":
|
||||
"description": |-
|
||||
|
|
@ -225,7 +227,7 @@ github.com/databricks/cli/bundle/config.Root:
|
|||
"description": |-
|
||||
Specifies a list of path globs that contain configuration files to include within the bundle.
|
||||
"markdown_description": |-
|
||||
Specifies a list of path globs that contain configuration files to include within the bundle. See [_](/dev-tools/bundles/settings.md#include)
|
||||
Specifies a list of path globs that contain configuration files to include within the bundle. See [_](/dev-tools/bundles/settings.md#include).
|
||||
"permissions":
|
||||
"description": |-
|
||||
Defines a permission for a specific entity.
|
||||
|
|
@ -417,44 +419,44 @@ github.com/databricks/cli/bundle/config/resources.Permission:
|
|||
github.com/databricks/cli/bundle/config/variable.Lookup:
|
||||
"alert":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the alert for which to retrieve an ID.
|
||||
"cluster":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the cluster for which to retrieve an ID.
|
||||
"cluster_policy":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the cluster_policy for which to retrieve an ID.
|
||||
"dashboard":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the dashboard for which to retrieve an ID.
|
||||
"instance_pool":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the instance_pool for which to retrieve an ID.
|
||||
"job":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the job for which to retrieve an ID.
|
||||
"metastore":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the metastore for which to retrieve an ID.
|
||||
"notification_destination":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the notification_destination for which to retrieve an ID.
|
||||
"pipeline":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the pipeline for which to retrieve an ID.
|
||||
"query":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the query for which to retrieve an ID.
|
||||
"service_principal":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the service_principal for which to retrieve an ID.
|
||||
"warehouse":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The name of the warehouse for which to retrieve an ID.
|
||||
github.com/databricks/cli/bundle/config/variable.TargetVariable:
|
||||
"default":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The default value for the variable.
|
||||
"description":
|
||||
"description": |-
|
||||
The description of the variable.
|
||||
|
|
@ -475,7 +477,7 @@ github.com/databricks/cli/bundle/config/variable.Variable:
|
|||
Defines a custom variable for the bundle. See [_](/dev-tools/bundles/settings.md#variables).
|
||||
"default":
|
||||
"description": |-
|
||||
PLACEHOLDER
|
||||
The default value for the variable.
|
||||
"description":
|
||||
"description": |-
|
||||
The description of the variable
|
||||
|
|
|
|||
|
|
@ -951,39 +951,51 @@
|
|||
"type": "object",
|
||||
"properties": {
|
||||
"alert": {
|
||||
"description": "The name of the alert for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"cluster": {
|
||||
"description": "The name of the cluster for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"cluster_policy": {
|
||||
"description": "The name of the cluster_policy for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"dashboard": {
|
||||
"description": "The name of the dashboard for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"instance_pool": {
|
||||
"description": "The name of the instance_pool for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"job": {
|
||||
"description": "The name of the job for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"metastore": {
|
||||
"description": "The name of the metastore for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"notification_destination": {
|
||||
"description": "The name of the notification_destination for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"pipeline": {
|
||||
"description": "The name of the pipeline for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"query": {
|
||||
"description": "The name of the query for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"service_principal": {
|
||||
"description": "The name of the service_principal for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"warehouse": {
|
||||
"description": "The name of the warehouse for which to retrieve an ID.",
|
||||
"$ref": "#/$defs/string"
|
||||
}
|
||||
},
|
||||
|
|
@ -1001,6 +1013,7 @@
|
|||
"type": "object",
|
||||
"properties": {
|
||||
"default": {
|
||||
"description": "The default value for the variable.",
|
||||
"$ref": "#/$defs/interface"
|
||||
},
|
||||
"description": {
|
||||
|
|
@ -1026,6 +1039,7 @@
|
|||
"description": "Defines a custom variable for the bundle.",
|
||||
"properties": {
|
||||
"default": {
|
||||
"description": "The default value for the variable.",
|
||||
"$ref": "#/$defs/interface"
|
||||
},
|
||||
"description": {
|
||||
|
|
@ -1055,7 +1069,7 @@
|
|||
"type": "object",
|
||||
"properties": {
|
||||
"build": {
|
||||
"description": "An optional set of non-default build commands to run locally before deployment.",
|
||||
"description": "An optional set of build commands to run locally before deployment.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"executable": {
|
||||
|
|
@ -1063,17 +1077,17 @@
|
|||
"$ref": "#/$defs/github.com/databricks/cli/libs/exec.ExecutableType"
|
||||
},
|
||||
"files": {
|
||||
"description": "The source files for the artifact.",
|
||||
"description": "The relative or absolute path to the built artifact files.",
|
||||
"$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config.ArtifactFile"
|
||||
},
|
||||
"path": {
|
||||
"description": "The location where the built artifact will be saved.",
|
||||
"description": "The local path of the directory for the artifact.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"type": {
|
||||
"description": "Required. The type of the artifact.",
|
||||
"description": "Required if the artifact is a Python wheel. The type of the artifact. Valid values are `whl` and `jar`.",
|
||||
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.ArtifactType",
|
||||
"markdownDescription": "Required. The type of the artifact. Valid values are `whl`."
|
||||
"markdownDescription": "Required if the artifact is a Python wheel. The type of the artifact. Valid values are `whl` and `jar`."
|
||||
}
|
||||
},
|
||||
"additionalProperties": false,
|
||||
|
|
@ -1093,7 +1107,7 @@
|
|||
"type": "object",
|
||||
"properties": {
|
||||
"source": {
|
||||
"description": "Required. The path of the files used to build the artifact.",
|
||||
"description": "Required. The artifact source file.",
|
||||
"$ref": "#/$defs/string"
|
||||
}
|
||||
},
|
||||
|
|
@ -1122,6 +1136,7 @@
|
|||
"markdownDescription": "The ID of a cluster to use to run the bundle. See [cluster_id](https://docs.databricks.com/dev-tools/bundles/settings.html#cluster_id)."
|
||||
},
|
||||
"compute_id": {
|
||||
"description": "Deprecated. The ID of the compute to use to run the bundle.",
|
||||
"$ref": "#/$defs/string"
|
||||
},
|
||||
"databricks_cli_version": {
|
||||
|
|
@ -1367,62 +1382,64 @@
|
|||
"type": "object",
|
||||
"properties": {
|
||||
"apps": {
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.App"
|
||||
"description": "The app resource defines a Databricks app.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.App",
|
||||
"markdownDescription": "The app resource defines a [Databricks app](https://docs.databricks.com/api/workspace/apps/create). For information about Databricks Apps, see [link](https://docs.databricks.com/dev-tools/databricks-apps/index.html)."
|
||||
},
|
||||
"clusters": {
|
||||
"description": "The cluster definitions for the bundle, where each key is the name of a cluster.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Cluster",
|
||||
"markdownDescription": "The cluster definitions for the bundle, where each key is the name of a cluster. See [clusters](https://docs.databricks.com/dev-tools/bundles/resources.html#clusters)"
|
||||
"markdownDescription": "The cluster definitions for the bundle, where each key is the name of a cluster. See [clusters](https://docs.databricks.com/dev-tools/bundles/resources.html#clusters)."
|
||||
},
|
||||
"dashboards": {
|
||||
"description": "The dashboard definitions for the bundle, where each key is the name of the dashboard.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Dashboard",
|
||||
"markdownDescription": "The dashboard definitions for the bundle, where each key is the name of the dashboard. See [dashboards](https://docs.databricks.com/dev-tools/bundles/resources.html#dashboards)"
|
||||
"markdownDescription": "The dashboard definitions for the bundle, where each key is the name of the dashboard. See [dashboards](https://docs.databricks.com/dev-tools/bundles/resources.html#dashboards)."
|
||||
},
|
||||
"experiments": {
|
||||
"description": "The experiment definitions for the bundle, where each key is the name of the experiment.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowExperiment",
|
||||
"markdownDescription": "The experiment definitions for the bundle, where each key is the name of the experiment. See [experiments](https://docs.databricks.com/dev-tools/bundles/resources.html#experiments)"
|
||||
"markdownDescription": "The experiment definitions for the bundle, where each key is the name of the experiment. See [experiments](https://docs.databricks.com/dev-tools/bundles/resources.html#experiments)."
|
||||
},
|
||||
"jobs": {
|
||||
"description": "The job definitions for the bundle, where each key is the name of the job.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Job",
|
||||
"markdownDescription": "The job definitions for the bundle, where each key is the name of the job. See [jobs](https://docs.databricks.com/dev-tools/bundles/resources.html#jobs)"
|
||||
"markdownDescription": "The job definitions for the bundle, where each key is the name of the job. See [jobs](https://docs.databricks.com/dev-tools/bundles/resources.html#jobs)."
|
||||
},
|
||||
"model_serving_endpoints": {
|
||||
"description": "The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint",
|
||||
"markdownDescription": "The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [model_serving_endpoints](https://docs.databricks.com/dev-tools/bundles/resources.html#model_serving_endpoints)"
|
||||
"markdownDescription": "The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [model_serving_endpoints](https://docs.databricks.com/dev-tools/bundles/resources.html#model_serving_endpoints)."
|
||||
},
|
||||
"models": {
|
||||
"description": "The model definitions for the bundle, where each key is the name of the model.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowModel",
|
||||
"markdownDescription": "The model definitions for the bundle, where each key is the name of the model. See [models](https://docs.databricks.com/dev-tools/bundles/resources.html#models)"
|
||||
"markdownDescription": "The model definitions for the bundle, where each key is the name of the model. See [models](https://docs.databricks.com/dev-tools/bundles/resources.html#models)."
|
||||
},
|
||||
"pipelines": {
|
||||
"description": "The pipeline definitions for the bundle, where each key is the name of the pipeline.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Pipeline",
|
||||
"markdownDescription": "The pipeline definitions for the bundle, where each key is the name of the pipeline. See [pipelines](https://docs.databricks.com/dev-tools/bundles/resources.html#pipelines)"
|
||||
"markdownDescription": "The pipeline definitions for the bundle, where each key is the name of the pipeline. See [pipelines](https://docs.databricks.com/dev-tools/bundles/resources.html#pipelines)."
|
||||
},
|
||||
"quality_monitors": {
|
||||
"description": "The quality monitor definitions for the bundle, where each key is the name of the quality monitor.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.QualityMonitor",
|
||||
"markdownDescription": "The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [quality_monitors](https://docs.databricks.com/dev-tools/bundles/resources.html#quality_monitors)"
|
||||
"markdownDescription": "The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [quality_monitors](https://docs.databricks.com/dev-tools/bundles/resources.html#quality_monitors)."
|
||||
},
|
||||
"registered_models": {
|
||||
"description": "The registered model definitions for the bundle, where each key is the name of the \u003cUC\u003e registered model.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.RegisteredModel",
|
||||
"markdownDescription": "The registered model definitions for the bundle, where each key is the name of the \u003cUC\u003e registered model. See [registered_models](https://docs.databricks.com/dev-tools/bundles/resources.html#registered_models)"
|
||||
"markdownDescription": "The registered model definitions for the bundle, where each key is the name of the \u003cUC\u003e registered model. See [registered_models](https://docs.databricks.com/dev-tools/bundles/resources.html#registered_models)."
|
||||
},
|
||||
"schemas": {
|
||||
"description": "The schema definitions for the bundle, where each key is the name of the schema.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Schema",
|
||||
"markdownDescription": "The schema definitions for the bundle, where each key is the name of the schema. See [schemas](https://docs.databricks.com/dev-tools/bundles/resources.html#schemas)"
|
||||
"markdownDescription": "The schema definitions for the bundle, where each key is the name of the schema. See [schemas](https://docs.databricks.com/dev-tools/bundles/resources.html#schemas)."
|
||||
},
|
||||
"volumes": {
|
||||
"description": "The volume definitions for the bundle, where each key is the name of the volume.",
|
||||
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Volume",
|
||||
"markdownDescription": "The volume definitions for the bundle, where each key is the name of the volume. See [volumes](https://docs.databricks.com/dev-tools/bundles/resources.html#volumes)"
|
||||
"markdownDescription": "The volume definitions for the bundle, where each key is the name of the volume. See [volumes](https://docs.databricks.com/dev-tools/bundles/resources.html#volumes)."
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
|
|
@ -7296,7 +7313,7 @@
|
|||
"include": {
|
||||
"description": "Specifies a list of path globs that contain configuration files to include within the bundle.",
|
||||
"$ref": "#/$defs/slice/string",
|
||||
"markdownDescription": "Specifies a list of path globs that contain configuration files to include within the bundle. See [include](https://docs.databricks.com/dev-tools/bundles/settings.html#include)"
|
||||
"markdownDescription": "Specifies a list of path globs that contain configuration files to include within the bundle. See [include](https://docs.databricks.com/dev-tools/bundles/settings.html#include)."
|
||||
},
|
||||
"permissions": {
|
||||
"description": "Defines a permission for a specific entity.",
|
||||
|
|
|
|||
Loading…
Reference in New Issue