Referencia de configuración

En este artículo se proporciona referencia a las claves compatibles con la configuración de Conjuntos de recursos de Databricks (YAML). Consulte ¿Qué son las agrupaciones de recursos de Databricks?

Para obtener ejemplos completos de paquetes, consulte los ejemplos de configuración de paquetes y el repositorio de GitHub de ejemplos de paquetes .

artefacto

Se definen las configuraciones para construir un artefacto.

Clave	Tipo	Descripción
build	Cadena	Conjunto opcional de comandos de compilación que se ejecutarán localmente antes de la implementación.
executable	Cadena	Tipo ejecutable. Los valores válidos son bash, sh y cmd.
files	Mapa	Ruta de acceso relativa o absoluta a los archivos de artefactos compilados, definidos como artifact_file.
path	Cadena	Ruta de acceso local del directorio para el artefacto.
type	Cadena	Obligatorio si el artefacto es una rueda de Python. Tipo del artefacto. Los valores válidos son whl y jar.

artefactos

Definen los atributos para compilar artefactos, donde cada clave es el nombre del artefacto y el valor es un mapa que define la configuración de compilación del artefacto . Para obtener información sobre la asignación artifacts, consulte artefactos.

La configuración del artefacto definida en el nivel superior de la configuración de agrupación se puede invalidar en la asignación targets. Consulte Definición de la configuración de artefactos en agrupaciones de recursos de Databricks.

artifacts:
  <artifact-name>:
      <artifact-field-name>: <artifact-field-value>

Ejemplo

artifacts:
  default:
    type: whl
    build: poetry build
    path: .

artifact_file

Define un archivo de artefacto en una agrupación.

Clave	Tipo	Descripción
source	Cadena	Necesario. El archivo de origen del artefacto.

agrupación

Atributos de la agrupación. Consulte agrupación.

Clave	Tipo	Descripción
cluster_id	Cadena	Identificador de un clúster que se va a usar para ejecutar el paquete. Consulte el identificador del clúster .
databricks_cli_version	Cadena	La versión de la CLI de Databricks para usar con el paquete. Consulte databricks_cli_version.
deployment	Mapa	Definición de la implementación de agrupación. Para ver los atributos admitidos, consulte implementación y modos de implementación de la agrupación de recursos de Databricks.
git	Mapa	Detalles del control de versiones de Git asociados a tu paquete. Para ver los atributos admitidos, consulte git y git.
name	Cadena	Necesario. Nombre del lote.
uuid	Cadena	Reservado. Identificador único universal (UUID) para el lote que identifica de forma única el lote en sistemas internos de Databricks. Esto se genera cuando se inicializa un proyecto de agrupación mediante una plantilla de Databricks (mediante el comando databricks bundle init).

implementación

Define los atributos de implementación del paquete.

Clave	Tipo	Descripción
fail_on_active_runs	Booleano	Si se produce un error en las ejecuciones activas. Si se establece en true se puede interrumpir una implementación que se está ejecutando.
lock	Mapa	Atributos de bloqueo de la implementación. Consulte bloqueo.

experimental

Define atributos para las características experimentales.

Clave	Tipo	Descripción
python_wheel_wrapper	Booleano	Si se va a usar un contenedor de paquete wheel de Python.
scripts	Comando (cadena)	Los comandos para ejecutar
use_legacy_run_as	Booleano	Indica si se debe usar el comportamiento del run_as heredado.

git

Define los detalles del control de versiones de Git asociados a la agrupación. Consulte Git.

Clave	Tipo	Descripción
origin_url	Cadena	Dirección URL de origen del repositorio. Consulte Git.
branch	Cadena	Nombre de la rama de Git. Consulte Git.

subvención

Define el acceso a objetos de Catálogo de Unity. Para obtener más información, consulte Conexión al almacenamiento de objetos en la nube y servicios mediante Unity Catalog.

Clave	Tipo	Descripción
principal	Cadena	Necesario. El nombre del principal al que se le concederán privilegios.
privileges	Cadena	Necesario. Privilegios que se van a conceder a la entidad especificada.

Ejemplo

En el ejemplo siguiente se define un esquema de catálogo de Unity con concesiones:

resources:
  schemas:
    my_schema:
      name: test-schema
      grants:
        - principal: users
          privileges:
            - CAN_MANAGE
        - principal: my_team
          privileges:
            - CAN_READ
      catalog_name: main
      comment: "my schema with grants"

bloqueo

Define los atributos de bloqueo de implementación de agrupación.

Clave	Tipo	Descripción
enabled	Booleano	Si este bloqueo está habilitado.
force	Booleano	Si se va a forzar este bloqueo si está habilitado.

permiso

Define un permiso para una entidad específica. Consulte permisos y Establecimiento de permisos para recursos en agrupaciones de recursos de Databricks.

Clave	Tipo	Descripción
group_name	Cadena	Nombre del grupo que tiene el permiso establecido en level.
level	Cadena	Necesario. El permiso permitido para usuario, grupo, o entidad de servicio está definido por este permiso.
service_principal_name	Cadena	Nombre de la entidad de servicio que tiene el permiso establecido en level.
user_name	Cadena	Nombre del usuario que tiene el permiso establecido en level.

permisos

Secuencia que define los permisos para aplicar a experimentos, trabajos, canalizaciones y modelos definidos en el conjunto, donde cada elemento de la secuencia es un permiso para una entidad específica.

Consulte permisos y Establecimiento de permisos para recursos en agrupaciones de recursos de Databricks.

Ejemplo

permissions:
  - level: CAN_VIEW
    group_name: test-group
  - level: CAN_MANAGE
    user_name: someone@example.com
  - level: CAN_RUN
    service_principal_name: 123456-abcdef

valores preestablecidos

Define los valores preestablecidos de implementación de agrupación. Consulte Valores preestablecidos personalizados.

Clave	Tipo	Descripción
jobs_max_concurrent_runs	Entero	Número máximo de ejecuciones simultáneas para un trabajo.
name_prefix	Cadena	Prefijo para ejecuciones de trabajo de la agrupación.
pipelines_development	Booleano	Si las implementaciones de canalización deben bloquearse en modo de desarrollo.
source_linked_deployment	Booleano	Si se va a vincular la implementación al origen de la agrupación.
tags	Mapa	Etiquetas para la implementación de la agrupación.
trigger_pause_status	Cadena	Estado de pausa que se aplicará a todos los desencadenadores y programaciones del trabajo. Los valores válidos son PAUSED y UNPAUSED.

recursos

Mapa que define los recursos de la agrupación, donde cada clave es el nombre del recurso y el valor es un mapa que define el recurso. Para obtener más información sobre los recursos admitidos de agrupación de recursos de Databricks y la referencia de definición de recursos, consulte Recursos de agrupaciones de recursos de Databricks.

resources:
  <resource-type>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>

Clave	Tipo	Descripción
clusters	Mapa	Las definiciones de clúster para la agrupación, donde cada clave es el nombre de un clúster. Consulte el clúster
dashboards	Mapa	Las definiciones del tablero de control para el paquete, donde cada clave es el nombre del tablero de control. Consulte el panel
experiments	Mapa	Las definiciones del experimento para la agrupación, donde cada clave es el nombre del experimento. Consulte el experimento
jobs	Mapa	Las definiciones de tareas para el paquete, donde cada clave es el nombre del trabajo. Consulte el trabajo
model_serving_endpoints	Mapa	El modelo que atiende las definiciones de punto de conexión para la agrupación, donde cada clave es el nombre del punto de conexión de servicio del modelo. Consulte model_serving_endpoint
models	Mapa	Las definiciones de modelo para la agrupación, donde cada clave es el nombre del modelo. Consulte el modelo (heredado)
pipelines	Mapa	Las definiciones de canalización para la agrupación, donde cada clave es el nombre de la canalización. Consulte la canalización
quality_monitors	Mapa	Las definiciones del monitor de calidad para la agrupación, donde cada clave es el nombre del monitor de calidad. Consulte quality_monitor (Unity Catalog)
registered_models	Mapa	Las definiciones de modelo registradas para la agrupación, donde cada clave es el nombre del modelo registrado del catálogo de Unity. Consulte registered_model (Unity Catalog)
schemas	Mapa	Las definiciones de esquema para la agrupación, donde cada clave es el nombre del esquema. Consulte el esquema (Catálogo de Unity)
volumes	Mapa	Las definiciones de volumen para la agrupación, donde cada clave es el nombre del volumen. Consulte volumen (Unity Catalog)

run_as

Identidad que se va a usar al ejecutar flujos de trabajo de agrupaciones de recursos de Databricks. Consulte Especificación de una identidad de ejecución para un flujo de trabajo de agrupaciones de recursos de Databricks.

Clave	Tipo	Descripción
service_principal_name	Cadena	Identificador de aplicación de una entidad de servicio activa. Establecer este campo requiere el rol servicePrincipal/user.
user_name	Cadena	Correo electrónico de un usuario de área de trabajo activa. Los usuarios que no son administradores solo pueden establecer este campo en su propio correo electrónico.

sincronización

Los archivos y rutas de archivo a incluir o excluir en el paquete. Consulte sincronización.

Clave	Tipo	Descripción
exclude	Secuencia	Lista de archivos o carpetas que se van a excluir de la agrupación.
include	Secuencia	Lista de archivos o carpetas que se van a incluir en la agrupación.
paths	Secuencia	Las rutas de acceso a carpetas locales, que pueden ubicarse fuera de la raíz del paquete, para sincronizarlas en el área de trabajo cuando se implementa el paquete.

objetivo

Define los destinos de implementación para la agrupación. Consulte destinos

Clave	Tipo	Descripción
artifacts	Mapa	Artefactos que se van a incluir en la implementación de destino. Consulte artefactos.
bundle	Mapa	Atributos de agrupación al implementar en este destino.
cluster_id	Cadena	Identificador del clúster que se va a usar para este destino.
compute_id	Cadena	En desuso. Identificador del proceso que se va a usar para este destino.
default	Booleano	Si este destino es el destino predeterminado.
git	Mapa	Configuración del control de versiones de Git para el destino. Consulte Git.
mode	Cadena	Modo de implementación del destino. Los valores válidos son development y production. Consulte Modos de implementación de la agrupación de recursos de Databricks.
permissions	Secuencia	Permisos para implementar y ejecutar el paquete en el destino objetivo. Consulte los permisos.
presets	Mapa	Valores preestablecidos de implementación para el destino. Consulte valores preestablecidos.
resources	Mapa	Definiciones de recursos para el objetivo. Consulte los recursos.
run_as	Mapa	La identidad a utilizar para ejecutar el paquete. Consulte run_as y Especificar una identidad de ejecución para un flujo de trabajo de agrupaciones de recursos de Databricks.
sync	Mapa	Las rutas de acceso locales que se van a sincronizar con el área de trabajo de destino cuando se ejecuta o se implementa una agrupación. Consulte sincronización.
variables	Mapa	Definiciones de variables personalizadas para el destino. Consulte variables y Sustituciones y variables en agrupaciones de recursos de Databricks.
workspace	Mapa	Área de trabajo de Databricks para el destino. área de trabajo

variables

Mapa que define las variables personalizadas para la agrupación, donde cada clave es el nombre de la variable y el valor es un mapa que define la variable. Consulte Sustituciones y variables en agrupaciones de recursos de Databricks.

Clave	Tipo	Descripción
variable-name	Mapa	Definición de una variable. Consulte variable-name.

variable-name

Cada definición de variable tiene los siguientes atributos:

Clave	Tipo	Descripción
description	Cadena	Descripción de la variable.
lookup	Cadena	Nombre del alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, o warehouse objeto para el que se va a recuperar un identificador.
type	Cadena	Tipo de la variable. Los valores válidos son complex.

área de trabajo

Define el área de trabajo de Databricks para la agrupación. Consulte el área de trabajo.

Clave	Tipo	Descripción
artifact_path	Cadena	Ruta de acceso del artefacto que se va a usar en el área de trabajo para las implementaciones y ejecuciones de flujo de trabajo.
auth_type	Cadena	El tipo de autenticación.
azure_client_id	Cadena	Identificador de cliente de Azure.
azure_environment	Cadena	Entorno de Azure.
azure_login_app_id	Cadena	Identificador de la aplicación de inicio de sesión de Azure.
azure_tenant_id	Cadena	Identificador del inquilino de Azure.
azure_use_msi	Booleano	Si se usa MSI para Azure.
azure_workspace_resource_id	Cadena	Identificador de recurso del área de trabajo de Azure.
client_id	Cadena	Identificador de cliente del área de trabajo.
file_path	Cadena	Ruta de archivo a utilizar en el área de trabajo tanto para implementaciones como para ejecuciones de flujo de trabajo.
google_service_account	Cadena	Nombre de la cuenta de servicio de Google.
host	Cadena	Dirección URL del host del área de trabajo de Databricks.
profile	Cadena	Nombre del perfil del área de trabajo de Databricks.
resource_path	Cadena	Ruta de acceso del recurso del área de trabajo.
root_path	Cadena	Ruta de acceso raíz del área de trabajo de Databricks.
state_path	Cadena	Ruta de estado del área de trabajo.