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

feat: New annotations

This commit is contained in:
Ilya Kuznetsov 2024-12-10 16:07:25 +01:00
parent a579b1cd03
commit e15107fbcc
No known key found for this signature in database
GPG Key ID: 91F3DDCF5D21CDDF
2 changed files with 316 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,136 +8,172 @@ github.com/databricks/cli/bundle/config.Artifact:
To specify multiple build commands, separate each command with double-ampersand (&&) characters. To specify multiple build commands, separate each command with double-ampersand (&&) characters.
"executable": "executable":
"description": |- "description": |-
PLACEHOLDER The executable type. Valid values are ......
"files": "files":
"description": |- "description": |-
PLACEHOLDER The source files for the artifact.
"markdown_description": |-
The source files for the artifact, defined as an [_](#artifact_file).
"path": "path":
"description": |- "description": |-
PLACEHOLDER The location where the built artifact will be saved.
"type": "type":
"description": |- "description": |-
PLACEHOLDER The type of the artifact. Valid values are wheel or jar.
github.com/databricks/cli/bundle/config.ArtifactFile: github.com/databricks/cli/bundle/config.ArtifactFile:
"source": "source":
"description": |- "description": |-
PLACEHOLDER The path of the files used to build the artifact.
github.com/databricks/cli/bundle/config.Bundle: github.com/databricks/cli/bundle/config.Bundle:
"cluster_id": "cluster_id":
"description": |- "description": |-
PLACEHOLDER The ID of a cluster to use to run the bundle.
"markdown_description": |-
The ID of a cluster to use to run the bundle. See [_](/dev-tools/bundles/settings.md#cluster_id).
"compute_id": "compute_id":
"description": |- "description": |-
PLACEHOLDER PLACEHOLDER
"databricks_cli_version": "databricks_cli_version":
"description": |- "description": |-
PLACEHOLDER The Databricks CLI version to use for the bundle.
"markdown_description": |-
The Databricks CLI version to use for the bundle. See [_](/dev-tools/bundles/settings.md#databricks_cli_version).
"deployment": "deployment":
"description": |- "description": |-
PLACEHOLDER The definition of the bundle deployment
"markdown_description": |-
The definition of the bundle deployment. For supported attributes, see [_](#deployment) and [_](/dev-tools/bundles/deployment-modes.md).
"git": "git":
"description": |- "description": |-
PLACEHOLDER The Git version control details that are associated with your bundle.
"markdown_description": |-
The Git version control details that are associated with your bundle. For supported attributes, see [_](#git) and [_](/dev-tools/bundles/settings.md#git).
"name": "name":
"description": |- "description": |-
PLACEHOLDER The name of the bundle.
"uuid": "uuid":
"description": |- "description": |-
PLACEHOLDER PLACEHOLDER
github.com/databricks/cli/bundle/config.Deployment: github.com/databricks/cli/bundle/config.Deployment:
"fail_on_active_runs": "fail_on_active_runs":
"description": |- "description": |-
PLACEHOLDER Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted.
"lock": "lock":
"description": |- "description": |-
PLACEHOLDER The deployment lock attributes.
"markdown_description": |-
The deployment lock attributes. See [_](#lock).
github.com/databricks/cli/bundle/config.Experimental: github.com/databricks/cli/bundle/config.Experimental:
"pydabs": "pydabs":
"description": |- "description": |-
PLACEHOLDER The PyDABs configuration.
"python_wheel_wrapper": "python_wheel_wrapper":
"description": |- "description": |-
PLACEHOLDER Whether to use a Python wheel wrapper
"scripts": "scripts":
"description": |- "description": |-
PLACEHOLDER The commands to run
"use_legacy_run_as": "use_legacy_run_as":
"description": |- "description": |-
PLACEHOLDER Whether to use the legacy run_as behavior
github.com/databricks/cli/bundle/config.Git: github.com/databricks/cli/bundle/config.Git:
"branch": "branch":
"description": |- "description": |-
PLACEHOLDER The Git branch name.
"markdown_description": |-
The Git branch name. See [_](/dev-tools/bundles/settings.md#git).
"origin_url": "origin_url":
"description": |- "description": |-
PLACEHOLDER The origin URL of the repository.
"markdown_description": |-
The origin URL of the repository. See [_](/dev-tools/bundles/settings.md#git).
github.com/databricks/cli/bundle/config.Lock: github.com/databricks/cli/bundle/config.Lock:
"enabled": "enabled":
"description": |- "description": |-
PLACEHOLDER Whether this lock is enabled.
"force": "force":
"description": |- "description": |-
PLACEHOLDER Whether to force this lock if it is enabled.
github.com/databricks/cli/bundle/config.Presets: github.com/databricks/cli/bundle/config.Presets:
"jobs_max_concurrent_runs": "jobs_max_concurrent_runs":
"description": |- "description": |-
PLACEHOLDER The maximum concurrent runs for a job.
"name_prefix": "name_prefix":
"description": |- "description": |-
PLACEHOLDER The prefix for job runs of the bundle.
"pipelines_development": "pipelines_development":
"description": |- "description": |-
PLACEHOLDER Whether pipeline deployments should be locked in development mode.
"source_linked_deployment": "source_linked_deployment":
"description": |- "description": |-
PLACEHOLDER Whether to link the deployment to the bundle source.
"tags": "tags":
"description": |- "description": |-
PLACEHOLDER The tags for the bundle deployment.
"trigger_pause_status": "trigger_pause_status":
"description": |- "description": |-
PLACEHOLDER A pause status to apply to all job triggers and schedules. Valid values are PAUSED or UNPAUSED.
github.com/databricks/cli/bundle/config.PyDABs: github.com/databricks/cli/bundle/config.PyDABs:
"enabled": "enabled":
"description": |- "description": |-
PLACEHOLDER Whether or not PyDABs (Private Preview) is enabled
"import": "import":
"description": |- "description": |-
PLACEHOLDER The PyDABs project to import to discover resources, resource generator and mutators
"venv_path": "venv_path":
"description": |- "description": |-
PLACEHOLDER The Python virtual environment path
github.com/databricks/cli/bundle/config.Resources: github.com/databricks/cli/bundle/config.Resources:
"clusters": "clusters":
"description": |- "description": |-
PLACEHOLDER The cluster definitions for the bundle.
"markdown_description": |-
The cluster definitions for the bundle. See [_](/dev-tools/bundles/resources.md#cluster)
"dashboards": "dashboards":
"description": |- "description": |-
PLACEHOLDER The dashboard definitions for the bundle.
"markdown_description": |-
The dashboard definitions for the bundle. See [_](/dev-tools/bundles/resources.md#dashboard)
"experiments": "experiments":
"description": |- "description": |-
PLACEHOLDER The experiment definitions for the bundle.
"markdown_description": |-
The experiment definitions for the bundle. See [_](/dev-tools/bundles/resources.md#experiment)
"jobs": "jobs":
"description": |- "description": |-
PLACEHOLDER The job definitions for the bundle.
"markdown_description": |-
The job definitions for the bundle. See [_](/dev-tools/bundles/resources.md#job)
"model_serving_endpoints": "model_serving_endpoints":
"description": |- "description": |-
PLACEHOLDER The model serving endpoint definitions for the bundle.
"markdown_description": |-
The model serving endpoint definitions for the bundle. See [_](/dev-tools/bundles/resources.md#model_serving_endpoint)
"models": "models":
"description": |- "description": |-
PLACEHOLDER The model definitions for the bundle.
"markdown_description": |-
The model definitions for the bundle. See [_](/dev-tools/bundles/resources.md#model)
"pipelines": "pipelines":
"description": |- "description": |-
PLACEHOLDER The pipeline definitions for the bundle.
"markdown_description": |-
The pipeline definitions for the bundle. See [_](/dev-tools/bundles/resources.md#pipeline)
"quality_monitors": "quality_monitors":
"description": |- "description": |-
PLACEHOLDER The quality monitor definitions for the bundle.
"markdown_description": |-
The quality monitor definitions for the bundle. See [_](/dev-tools/bundles/resources.md#quality_monitor)
"registered_models": "registered_models":
"description": |- "description": |-
PLACEHOLDER The registered model definitions for the bundle.
"markdown_description": |-
The registered model definitions for the bundle. See [_](/dev-tools/bundles/resources.md#registered_model)
"schemas": "schemas":
"description": |- "description": |-
PLACEHOLDER The schema definitions for the bundle.
"markdown_description": |-
The schema definitions for the bundle. See [_](/dev-tools/bundles/resources.md#schema)
"volumes": "volumes":
"description": |- "description": |-
PLACEHOLDER PLACEHOLDER
@ -147,159 +183,189 @@ github.com/databricks/cli/bundle/config.Root:
Defines the attributes to build an artifact Defines the attributes to build an artifact
"bundle": "bundle":
"description": |- "description": |-
PLACEHOLDER The attributes of the bundle.
"markdown_description": |-
The attributes of the bundle. See [_](/dev-tools/bundles/settings.md#bundle)
"experimental": "experimental":
"description": |- "description": |-
PLACEHOLDER Defines attributes for experimental features.
"include": "include":
"description": |- "description": |-
PLACEHOLDER PLACEHOLDER
"permissions": "permissions":
"description": |- "description": |-
PLACEHOLDER Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle
"markdown_description": |-
Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle. See [_](/dev-tools/bundles/settings.md#permissions) and [_](/dev-tools/bundles/permissions.md).
"presets": "presets":
"description": |- "description": |-
PLACEHOLDER Defines bundle deployment presets.
"markdown_description": |-
Defines bundle deployment presets. See [_](/dev-tools/bundles/deployment-modes.md#presets).
"resources": "resources":
"description": |- "description": |-
PLACEHOLDER PLACEHOLDER
"markdown_description": |-
See [_](/dev-tools/bundles/resources.md).
"run_as": "run_as":
"description": |- "description": |-
PLACEHOLDER PLACEHOLDER
"sync": "sync":
"description": |- "description": |-
PLACEHOLDER The files and file paths to include or exclude in the bundle.
"markdown_description": |-
The files and file paths to include or exclude in the bundle. See [_](/dev-tools/bundles/)
"targets": "targets":
"description": |- "description": |-
PLACEHOLDER Defines deployment targets for the bundle.
"variables": "variables":
"description": |- "description": |-
PLACEHOLDER A Map that defines the custom variables for the bundle, where each key is the name of the variable, and the value is a Map that defines the variable.
"workspace": "workspace":
"description": |- "description": |-
PLACEHOLDER Defines the Databricks workspace for the bundle.
github.com/databricks/cli/bundle/config.Sync: github.com/databricks/cli/bundle/config.Sync:
"exclude": "exclude":
"description": |- "description": |-
PLACEHOLDER A list of files or folders to exclude from the bundle.
"include": "include":
"description": |- "description": |-
PLACEHOLDER A list of files or folders to include in the bundle.
"paths": "paths":
"description": |- "description": |-
PLACEHOLDER The local folder paths, which can be outside the bundle root, to synchronize to the workspace when the bundle is deployed.
github.com/databricks/cli/bundle/config.Target: github.com/databricks/cli/bundle/config.Target:
"artifacts": "artifacts":
"description": |- "description": |-
PLACEHOLDER The artifacts to include in the target deployment.
"markdown_description": |-
The artifacts to include in the target deployment. See [_](#artifact)
"bundle": "bundle":
"description": |- "description": |-
PLACEHOLDER The name of the bundle when deploying to this target.
"cluster_id": "cluster_id":
"description": |- "description": |-
PLACEHOLDER The ID of the cluster to use for this target.
"compute_id": "compute_id":
"description": |- "description": |-
PLACEHOLDER Deprecated. The ID of the compute to use for this target.
"default": "default":
"description": |- "description": |-
PLACEHOLDER Whether this target is the default target.
"git": "git":
"description": |- "description": |-
PLACEHOLDER The Git version control settings for the target.
"markdown_description": |-
The Git version control settings for the target. See [_](#git).
"mode": "mode":
"description": |- "description": |-
PLACEHOLDER The deployment mode for the target. Valid values are development or production.
"markdown_description": |-
The deployment mode for the target. Valid values are development or production. See [_](/dev-tools/bundles/deployment-modes.md).
"permissions": "permissions":
"description": |- "description": |-
PLACEHOLDER The permissions for deploying and running the bundle in the target.
"markdown_description": |-
The permissions for deploying and running the bundle in the target. See [_](#permission).
"presets": "presets":
"description": |- "description": |-
PLACEHOLDER The deployment presets for the target.
"markdown_description": |-
The deployment presets for the target. See [_](#preset).
"resources": "resources":
"description": |- "description": |-
PLACEHOLDER The resource definitions for the target.
"markdown_description": |-
The resource definitions for the target. See [_](#resources).
"run_as": "run_as":
"description": |- "description": |-
PLACEHOLDER The identity to use to run the bundle.
"markdown_description": |-
The identity to use to run the bundle. See [_](#job_run_as) and [_](/dev-tools/bundles/run_as.md).
"sync": "sync":
"description": |- "description": |-
PLACEHOLDER The local paths to sync to the target workspace when a bundle is run or deployed.
"markdown_description": |-
The local paths to sync to the target workspace when a bundle is run or deployed. See [_](#sync).
"variables": "variables":
"description": |- "description": |-
PLACEHOLDER The custom variable definitions for the target.
"markdown_description": |-
The custom variable definitions for the target. See [_](/dev-tools/bundles/settings.md#variables) and [_](/dev-tools/bundles/variables.md).
"workspace": "workspace":
"description": |- "description": |-
PLACEHOLDER The Databricks workspace for the target. _.
"markdown_description": |-
The Databricks workspace for the target. [_](#workspace)
github.com/databricks/cli/bundle/config.Workspace: github.com/databricks/cli/bundle/config.Workspace:
"artifact_path": "artifact_path":
"description": |- "description": |-
PLACEHOLDER The artifact path to use within the workspace for both deployments and workflow runs
"auth_type": "auth_type":
"description": |- "description": |-
PLACEHOLDER The authentication type.
"azure_client_id": "azure_client_id":
"description": |- "description": |-
PLACEHOLDER The Azure client ID
"azure_environment": "azure_environment":
"description": |- "description": |-
PLACEHOLDER The Azure environment
"azure_login_app_id": "azure_login_app_id":
"description": |- "description": |-
PLACEHOLDER The Azure login app ID
"azure_tenant_id": "azure_tenant_id":
"description": |- "description": |-
PLACEHOLDER The Azure tenant ID
"azure_use_msi": "azure_use_msi":
"description": |- "description": |-
PLACEHOLDER Whether to use MSI for Azure
"azure_workspace_resource_id": "azure_workspace_resource_id":
"description": |- "description": |-
PLACEHOLDER The Azure workspace resource ID
"client_id": "client_id":
"description": |- "description": |-
PLACEHOLDER The client ID for the workspace
"file_path": "file_path":
"description": |- "description": |-
PLACEHOLDER The file path to use within the workspace for both deployments and workflow runs
"google_service_account": "google_service_account":
"description": |- "description": |-
PLACEHOLDER The Google service account name
"host": "host":
"description": |- "description": |-
PLACEHOLDER The Databricks workspace host URL
"profile": "profile":
"description": |- "description": |-
PLACEHOLDER The Databricks workspace profile name
"resource_path": "resource_path":
"description": |- "description": |-
PLACEHOLDER The workspace resource path
"root_path": "root_path":
"description": |- "description": |-
PLACEHOLDER The Databricks workspace root path
"state_path": "state_path":
"description": |- "description": |-
PLACEHOLDER The workspace state path
github.com/databricks/cli/bundle/config/resources.Grant: github.com/databricks/cli/bundle/config/resources.Grant:
"principal": "principal":
"description": |- "description": |-
PLACEHOLDER The name of the principal that will be granted privileges
"privileges": "privileges":
"description": |- "description": |-
PLACEHOLDER The privileges to grant to the specified entity
github.com/databricks/cli/bundle/config/resources.Permission: github.com/databricks/cli/bundle/config/resources.Permission:
"group_name": "group_name":
"description": |- "description": |-
PLACEHOLDER The name of the group that has the permission set in level.
"level": "level":
"description": |- "description": |-
PLACEHOLDER The allowed permission for user, group, service principal defined for this permission.
"service_principal_name": "service_principal_name":
"description": |- "description": |-
PLACEHOLDER The name of the service principal that has the permission set in level.
"user_name": "user_name":
"description": |- "description": |-
PLACEHOLDER The name of the user that has the permission set in level.
github.com/databricks/cli/bundle/config/variable.Lookup: github.com/databricks/cli/bundle/config/variable.Lookup:
"alert": "alert":
"description": |- "description": |-
@ -343,26 +409,26 @@ github.com/databricks/cli/bundle/config/variable.TargetVariable:
PLACEHOLDER PLACEHOLDER
"description": "description":
"description": |- "description": |-
PLACEHOLDER The description of the variable
"lookup": "lookup":
"description": |- "description": |-
PLACEHOLDER The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.
"type": "type":
"description": |- "description": |-
PLACEHOLDER The type of the variable. Valid values are complex.
github.com/databricks/cli/bundle/config/variable.Variable: github.com/databricks/cli/bundle/config/variable.Variable:
"default": "default":
"description": |- "description": |-
PLACEHOLDER PLACEHOLDER
"description": "description":
"description": |- "description": |-
PLACEHOLDER The description of the variable
"lookup": "lookup":
"description": |- "description": |-
PLACEHOLDER The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.
"type": "type":
"description": |- "description": |-
PLACEHOLDER The type of the variable. Valid values are complex.
github.com/databricks/databricks-sdk-go/service/serving.Ai21LabsConfig: github.com/databricks/databricks-sdk-go/service/serving.Ai21LabsConfig:
"ai21labs_api_key": "ai21labs_api_key":
"description": |- "description": |-

191
bundle/schema/jsonschema.json generated
View File

@ -249,9 +249,11 @@
"type": "object", "type": "object",
"properties": { "properties": {
"principal": { "principal": {
"description": "The name of the principal that will be granted privileges",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"privileges": { "privileges": {
"description": "The privileges to grant to the specified entity",
"$ref": "#/$defs/slice/string" "$ref": "#/$defs/slice/string"
} }
}, },
@ -503,15 +505,19 @@
"type": "object", "type": "object",
"properties": { "properties": {
"group_name": { "group_name": {
"description": "The name of the group that has the permission set in level.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"level": { "level": {
"description": "The allowed permission for user, group, service principal defined for this permission.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"service_principal_name": { "service_principal_name": {
"description": "The name of the service principal that has the permission set in level.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"user_name": { "user_name": {
"description": "The name of the user that has the permission set in level.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
} }
}, },
@ -895,12 +901,15 @@
"$ref": "#/$defs/interface" "$ref": "#/$defs/interface"
}, },
"description": { "description": {
"description": "The description of the variable",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"lookup": { "lookup": {
"description": "The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup" "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup"
}, },
"type": { "type": {
"description": "The type of the variable. Valid values are complex.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType" "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType"
} }
}, },
@ -916,12 +925,15 @@
"$ref": "#/$defs/interface" "$ref": "#/$defs/interface"
}, },
"description": { "description": {
"description": "The description of the variable",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"lookup": { "lookup": {
"description": "The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup" "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup"
}, },
"type": { "type": {
"description": "The type of the variable. Valid values are complex.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType" "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType"
} }
}, },
@ -941,15 +953,20 @@
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"executable": { "executable": {
"description": "The executable type. Valid values are ......",
"$ref": "#/$defs/github.com/databricks/cli/libs/exec.ExecutableType" "$ref": "#/$defs/github.com/databricks/cli/libs/exec.ExecutableType"
}, },
"files": { "files": {
"$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config.ArtifactFile" "description": "The source files for the artifact.",
"$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config.ArtifactFile",
"markdownDescription": "The source files for the artifact, defined as an [_](#artifact_file)."
}, },
"path": { "path": {
"description": "The location where the built artifact will be saved.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"type": { "type": {
"description": "The type of the artifact. Valid values are wheel or jar.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.ArtifactType" "$ref": "#/$defs/github.com/databricks/cli/bundle/config.ArtifactType"
} }
}, },
@ -970,6 +987,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"source": { "source": {
"description": "The path of the files used to build the artifact.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
} }
}, },
@ -993,21 +1011,30 @@
"type": "object", "type": "object",
"properties": { "properties": {
"cluster_id": { "cluster_id": {
"$ref": "#/$defs/string" "description": "The ID of a cluster to use to run the bundle.",
"$ref": "#/$defs/string",
"markdownDescription": "The ID of a cluster to use to run the bundle. See [_](/dev-tools/bundles/settings.md#cluster_id)."
}, },
"compute_id": { "compute_id": {
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"databricks_cli_version": { "databricks_cli_version": {
"$ref": "#/$defs/string" "description": "The Databricks CLI version to use for the bundle.",
"$ref": "#/$defs/string",
"markdownDescription": "The Databricks CLI version to use for the bundle. See [_](/dev-tools/bundles/settings.md#databricks_cli_version)."
}, },
"deployment": { "deployment": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Deployment" "description": "The definition of the bundle deployment",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Deployment",
"markdownDescription": "The definition of the bundle deployment. For supported attributes, see [_](#deployment) and [_](/dev-tools/bundles/deployment-modes.md)."
}, },
"git": { "git": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Git" "description": "The Git version control details that are associated with your bundle.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Git",
"markdownDescription": "The Git version control details that are associated with your bundle. For supported attributes, see [_](#git) and [_](/dev-tools/bundles/settings.md#git)."
}, },
"name": { "name": {
"description": "The name of the bundle.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"uuid": { "uuid": {
@ -1034,10 +1061,13 @@
"type": "object", "type": "object",
"properties": { "properties": {
"fail_on_active_runs": { "fail_on_active_runs": {
"description": "Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted.",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
}, },
"lock": { "lock": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Lock" "description": "The deployment lock attributes.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Lock",
"markdownDescription": "The deployment lock attributes. See [_](#lock)."
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -1054,15 +1084,19 @@
"type": "object", "type": "object",
"properties": { "properties": {
"pydabs": { "pydabs": {
"description": "The PyDABs configuration.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.PyDABs" "$ref": "#/$defs/github.com/databricks/cli/bundle/config.PyDABs"
}, },
"python_wheel_wrapper": { "python_wheel_wrapper": {
"description": "Whether to use a Python wheel wrapper",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
}, },
"scripts": { "scripts": {
"description": "The commands to run",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Command" "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Command"
}, },
"use_legacy_run_as": { "use_legacy_run_as": {
"description": "Whether to use the legacy run_as behavior",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
} }
}, },
@ -1080,10 +1114,14 @@
"type": "object", "type": "object",
"properties": { "properties": {
"branch": { "branch": {
"$ref": "#/$defs/string" "description": "The Git branch name.",
"$ref": "#/$defs/string",
"markdownDescription": "The Git branch name. See [_](/dev-tools/bundles/settings.md#git)."
}, },
"origin_url": { "origin_url": {
"$ref": "#/$defs/string" "description": "The origin URL of the repository.",
"$ref": "#/$defs/string",
"markdownDescription": "The origin URL of the repository. See [_](/dev-tools/bundles/settings.md#git)."
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -1100,9 +1138,11 @@
"type": "object", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"description": "Whether this lock is enabled.",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
}, },
"force": { "force": {
"description": "Whether to force this lock if it is enabled.",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
} }
}, },
@ -1123,21 +1163,27 @@
"type": "object", "type": "object",
"properties": { "properties": {
"jobs_max_concurrent_runs": { "jobs_max_concurrent_runs": {
"description": "The maximum concurrent runs for a job.",
"$ref": "#/$defs/int" "$ref": "#/$defs/int"
}, },
"name_prefix": { "name_prefix": {
"description": "The prefix for job runs of the bundle.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"pipelines_development": { "pipelines_development": {
"description": "Whether pipeline deployments should be locked in development mode.",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
}, },
"source_linked_deployment": { "source_linked_deployment": {
"description": "Whether to link the deployment to the bundle source.",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
}, },
"tags": { "tags": {
"description": "The tags for the bundle deployment.",
"$ref": "#/$defs/map/string" "$ref": "#/$defs/map/string"
}, },
"trigger_pause_status": { "trigger_pause_status": {
"description": "A pause status to apply to all job triggers and schedules. Valid values are PAUSED or UNPAUSED.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
} }
}, },
@ -1155,12 +1201,15 @@
"type": "object", "type": "object",
"properties": { "properties": {
"enabled": { "enabled": {
"description": "Whether or not PyDABs (Private Preview) is enabled",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
}, },
"import": { "import": {
"description": "The PyDABs project to import to discover resources, resource generator and mutators",
"$ref": "#/$defs/slice/string" "$ref": "#/$defs/slice/string"
}, },
"venv_path": { "venv_path": {
"description": "The Python virtual environment path",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
} }
}, },
@ -1178,34 +1227,54 @@
"type": "object", "type": "object",
"properties": { "properties": {
"clusters": { "clusters": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Cluster" "description": "The cluster definitions for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Cluster",
"markdownDescription": "The cluster definitions for the bundle. See [_](/dev-tools/bundles/resources.md#cluster)"
}, },
"dashboards": { "dashboards": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Dashboard" "description": "The dashboard definitions for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Dashboard",
"markdownDescription": "The dashboard definitions for the bundle. See [_](/dev-tools/bundles/resources.md#dashboard)"
}, },
"experiments": { "experiments": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowExperiment" "description": "The experiment definitions for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowExperiment",
"markdownDescription": "The experiment definitions for the bundle. See [_](/dev-tools/bundles/resources.md#experiment)"
}, },
"jobs": { "jobs": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Job" "description": "The job definitions for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Job",
"markdownDescription": "The job definitions for the bundle. See [_](/dev-tools/bundles/resources.md#job)"
}, },
"model_serving_endpoints": { "model_serving_endpoints": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint" "description": "The model serving endpoint definitions for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint",
"markdownDescription": "The model serving endpoint definitions for the bundle. See [_](/dev-tools/bundles/resources.md#model_serving_endpoint)"
}, },
"models": { "models": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowModel" "description": "The model definitions for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowModel",
"markdownDescription": "The model definitions for the bundle. See [_](/dev-tools/bundles/resources.md#model)"
}, },
"pipelines": { "pipelines": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Pipeline" "description": "The pipeline definitions for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Pipeline",
"markdownDescription": "The pipeline definitions for the bundle. See [_](/dev-tools/bundles/resources.md#pipeline)"
}, },
"quality_monitors": { "quality_monitors": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.QualityMonitor" "description": "The quality monitor definitions for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.QualityMonitor",
"markdownDescription": "The quality monitor definitions for the bundle. See [_](/dev-tools/bundles/resources.md#quality_monitor)"
}, },
"registered_models": { "registered_models": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.RegisteredModel" "description": "The registered model definitions for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.RegisteredModel",
"markdownDescription": "The registered model definitions for the bundle. See [_](/dev-tools/bundles/resources.md#registered_model)"
}, },
"schemas": { "schemas": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Schema" "description": "The schema definitions for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Schema",
"markdownDescription": "The schema definitions for the bundle. See [_](/dev-tools/bundles/resources.md#schema)"
}, },
"volumes": { "volumes": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Volume" "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Volume"
@ -1225,12 +1294,15 @@
"type": "object", "type": "object",
"properties": { "properties": {
"exclude": { "exclude": {
"description": "A list of files or folders to exclude from the bundle.",
"$ref": "#/$defs/slice/string" "$ref": "#/$defs/slice/string"
}, },
"include": { "include": {
"description": "A list of files or folders to include in the bundle.",
"$ref": "#/$defs/slice/string" "$ref": "#/$defs/slice/string"
}, },
"paths": { "paths": {
"description": "The local folder paths, which can be outside the bundle root, to synchronize to the workspace when the bundle is deployed.",
"$ref": "#/$defs/slice/string" "$ref": "#/$defs/slice/string"
} }
}, },
@ -1248,46 +1320,70 @@
"type": "object", "type": "object",
"properties": { "properties": {
"artifacts": { "artifacts": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Artifact" "description": "The artifacts to include in the target deployment.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Artifact",
"markdownDescription": "The artifacts to include in the target deployment. See [_](#artifact)"
}, },
"bundle": { "bundle": {
"description": "The name of the bundle when deploying to this target.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Bundle" "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Bundle"
}, },
"cluster_id": { "cluster_id": {
"description": "The ID of the cluster to use for this target.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"compute_id": { "compute_id": {
"description": "Deprecated. The ID of the compute to use for this target.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"default": { "default": {
"description": "Whether this target is the default target.",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
}, },
"git": { "git": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Git" "description": "The Git version control settings for the target.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Git",
"markdownDescription": "The Git version control settings for the target. See [_](#git)."
}, },
"mode": { "mode": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Mode" "description": "The deployment mode for the target. Valid values are development or production.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Mode",
"markdownDescription": "The deployment mode for the target. Valid values are development or production. See [_](/dev-tools/bundles/deployment-modes.md)."
}, },
"permissions": { "permissions": {
"$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" "description": "The permissions for deploying and running the bundle in the target.",
"$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission",
"markdownDescription": "The permissions for deploying and running the bundle in the target. See [_](#permission)."
}, },
"presets": { "presets": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Presets" "description": "The deployment presets for the target.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Presets",
"markdownDescription": "The deployment presets for the target. See [_](#preset)."
}, },
"resources": { "resources": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Resources" "description": "The resource definitions for the target.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Resources",
"markdownDescription": "The resource definitions for the target. See [_](#resources)."
}, },
"run_as": { "run_as": {
"$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs" "description": "The identity to use to run the bundle.",
"$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs",
"markdownDescription": "The identity to use to run the bundle. See [_](#job_run_as) and [_](/dev-tools/bundles/run_as.md)."
}, },
"sync": { "sync": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Sync" "description": "The local paths to sync to the target workspace when a bundle is run or deployed.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Sync",
"markdownDescription": "The local paths to sync to the target workspace when a bundle is run or deployed. See [_](#sync)."
}, },
"variables": { "variables": {
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/variable.TargetVariable" "description": "The custom variable definitions for the target.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/variable.TargetVariable",
"markdownDescription": "The custom variable definitions for the target. See [_](/dev-tools/bundles/settings.md#variables) and [_](/dev-tools/bundles/variables.md)."
}, },
"workspace": { "workspace": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Workspace" "description": "The Databricks workspace for the target. _.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Workspace",
"markdownDescription": "The Databricks workspace for the target. [_](#workspace)"
} }
}, },
"additionalProperties": false "additionalProperties": false
@ -1304,51 +1400,67 @@
"type": "object", "type": "object",
"properties": { "properties": {
"artifact_path": { "artifact_path": {
"description": "The artifact path to use within the workspace for both deployments and workflow runs",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"auth_type": { "auth_type": {
"description": "The authentication type.",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"azure_client_id": { "azure_client_id": {
"description": "The Azure client ID",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"azure_environment": { "azure_environment": {
"description": "The Azure environment",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"azure_login_app_id": { "azure_login_app_id": {
"description": "The Azure login app ID",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"azure_tenant_id": { "azure_tenant_id": {
"description": "The Azure tenant ID",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"azure_use_msi": { "azure_use_msi": {
"description": "Whether to use MSI for Azure",
"$ref": "#/$defs/bool" "$ref": "#/$defs/bool"
}, },
"azure_workspace_resource_id": { "azure_workspace_resource_id": {
"description": "The Azure workspace resource ID",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"client_id": { "client_id": {
"description": "The client ID for the workspace",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"file_path": { "file_path": {
"description": "The file path to use within the workspace for both deployments and workflow runs",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"google_service_account": { "google_service_account": {
"description": "The Google service account name",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"host": { "host": {
"description": "The Databricks workspace host URL",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"profile": { "profile": {
"description": "The Databricks workspace profile name",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"resource_path": { "resource_path": {
"description": "The workspace resource path",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"root_path": { "root_path": {
"description": "The Databricks workspace root path",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
}, },
"state_path": { "state_path": {
"description": "The workspace state path",
"$ref": "#/$defs/string" "$ref": "#/$defs/string"
} }
}, },
@ -6161,36 +6273,49 @@
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Artifact" "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Artifact"
}, },
"bundle": { "bundle": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Bundle" "description": "The attributes of the bundle.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Bundle",
"markdownDescription": "The attributes of the bundle. See [_](/dev-tools/bundles/settings.md#bundle)"
}, },
"experimental": { "experimental": {
"description": "Defines attributes for experimental features.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Experimental" "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Experimental"
}, },
"include": { "include": {
"$ref": "#/$defs/slice/string" "$ref": "#/$defs/slice/string"
}, },
"permissions": { "permissions": {
"$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" "description": "Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle",
"$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission",
"markdownDescription": "Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle. See [_](/dev-tools/bundles/settings.md#permissions) and [_](/dev-tools/bundles/permissions.md)."
}, },
"presets": { "presets": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Presets" "description": "Defines bundle deployment presets.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Presets",
"markdownDescription": "Defines bundle deployment presets. See [_](/dev-tools/bundles/deployment-modes.md#presets)."
}, },
"resources": { "resources": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Resources" "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Resources",
"markdownDescription": "See [_](/dev-tools/bundles/resources.md)."
}, },
"run_as": { "run_as": {
"$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs" "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs"
}, },
"sync": { "sync": {
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Sync" "description": "The files and file paths to include or exclude in the bundle.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Sync",
"markdownDescription": "The files and file paths to include or exclude in the bundle. See [_](/dev-tools/bundles/)"
}, },
"targets": { "targets": {
"description": "Defines deployment targets for the bundle.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Target" "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Target"
}, },
"variables": { "variables": {
"description": "A Map that defines the custom variables for the bundle, where each key is the name of the variable, and the value is a Map that defines the variable.",
"$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/variable.Variable" "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/variable.Variable"
}, },
"workspace": { "workspace": {
"description": "Defines the Databricks workspace for the bundle.",
"$ref": "#/$defs/github.com/databricks/cli/bundle/config.Workspace" "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Workspace"
} }
}, },