Référence de configuration
Cet article fournit des informations de référence sur les clés prises en charge par la configuration YAML (Databricks Asset Bundles). Consultez Que sont les packs de ressources Databricks ?.
Pour obtenir des exemples complets de paquets, consultez les exemples de configuration de paquets et le dépôt GitHub bundle-examples .
artefact
Définit les paramètres pour générer un artefact.
Clé | Catégorie | Description |
---|---|---|
build |
Chaîne | Ensemble facultatif de commandes de build à exécuter localement avant le déploiement. |
executable |
Chaîne | Le type exécutable. Les valeurs correctes sont bash , sh et cmd . |
files |
Mappage | Chemin d’accès relatif ou absolu aux fichiers d’artefacts générés, définis en tant que artifact_file. |
path |
Chaîne | Chemin d’accès local du répertoire de l’artefact. |
type |
Chaîne | Obligatoire si l’artefact est une roue Python. Type de l’artefact. Les valeurs valides sont whl et jar . |
artifacts
Définit les attributs pour générer des artefacts, où chaque clé est le nom de l’artefact, et la valeur est une carte qui définit les paramètres de génération d’artefacts . Pour plus d’informations sur le mappage de artifacts
, consultez les artifacts.
Les paramètres d’artefact définis dans le niveau supérieur de la configuration de l’offre groupée peuvent être substitués dans le mappage targets
. Voir Définir les paramètres des artefacts dans les Databricks Asset Bundles.
artifacts:
<artifact-name>:
<artifact-field-name>: <artifact-field-value>
Exemple
artifacts:
default:
type: whl
build: poetry build
path: .
artifact_file
Définit un fichier d’artefact dans une offre groupée.
Clé | Catégorie | Description |
---|---|---|
source |
Chaîne | Obligatoire. Fichier source de l’artefact. |
offre groupée
Les attributs de l'offre groupée. Consultez l’offre groupée.
Clé | Catégorie | Description |
---|---|---|
cluster_id |
Chaîne | ID d’un cluster à utiliser pour exécuter le bundle. Voir cluster_id. |
databricks_cli_version |
Chaîne | Version de l’interface CLI Databricks à utiliser pour l’offre groupée. Voir databricks_cli_version. |
deployment |
Mappage | La définition du déploiement de l’offre groupée. Pour connaître les attributs pris en charge, consultez le déploiement et les modes de déploiement de Databricks Asset Bundle . |
git |
Mappage | Détails du contrôle de version Git associés à votre offre groupée. Pour connaître les attributs pris en charge, consultez git et git. |
name |
Chaîne | Obligatoire. Le nom de l’offre groupée. |
uuid |
Chaîne | Réservé. Identificateur unique universel (UUID) pour le bundle qui identifie de manière unique le bundle dans les systèmes internes de Databricks. Cela est généré lorsqu’un projet groupé est initialisé à l’aide d’un modèle Databricks (à l’aide de la commande databricks bundle init ). |
déploiement
Définit les attributs de déploiement de l’offre groupée.
Clé | Catégorie | Description |
---|---|---|
fail_on_active_runs |
Booléen | Indique s'il y a échec des exécutions actives. Si cette valeur est définie sur true un déploiement en cours d’exécution peut être interrompu. |
lock |
Mappage | Les attributs de verrou de déploiement. Voir le verrou. |
expérimental
Définit des attributs pour les fonctionnalités expérimentales.
Clé | Catégorie | Description |
---|---|---|
python_wheel_wrapper |
Booléen | Indique s’il faut utiliser un wrapper de roue Python. |
scripts |
Commande (chaîne) | Commandes à exécuter |
use_legacy_run_as |
Booléen | Indique s’il faut utiliser le comportement hérité de run_as. |
git
Définit les détails du contrôle de version Git associés à l’offre groupée. Voir git.
Clé | Catégorie | Description |
---|---|---|
origin_url |
Chaîne | URL d’origine du référentiel. Voir git. |
branch |
Chaîne | Nom de la branche Git. Voir git. |
subvention
Définit l’accès aux objets du catalogue Unity. Pour plus d’informations, consultez Se connecter au stockage d’objets cloud et aux services à l’aide du catalogue Unity.
Clé | Catégorie | Description |
---|---|---|
principal |
Chaîne | Obligatoire. Nom du principal qui recevra des privilèges. |
privileges |
Chaîne | Obligatoire. Privilèges à accorder à l’entité spécifiée. |
Exemple
L’exemple suivant définit un schéma de catalogue Unity avec des subventions :
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"
lock
Définit les attributs de verrou de déploiement de l’offre groupée.
Clé | Catégorie | Description |
---|---|---|
enabled |
Booléen | Indique si ce verrou est activé. |
force |
Booléen | Indique s’il faut forcer ce verrou s’il est activé. |
autorisation
Définit une autorisation pour une entité spécifique. Voir les autorisations et Définir les autorisations pour les ressources dans les offres groupées des ressources Databricks.
Clé | Catégorie | Description |
---|---|---|
group_name |
Chaîne | Le nom du groupe qui a le jeu d’autorisations dans level . |
level |
Chaîne | Obligatoire. Autorisation autorisée pour l’utilisateur, le groupe, le principal de service défini pour cette autorisation. |
service_principal_name |
Chaîne | Nom du principal de service dont l’autorisation est définie dans level . |
user_name |
Chaîne | Nom de l’utilisateur disposant de l’autorisation définie dans level . |
autorisations
Séquence qui définit les autorisations à appliquer aux expériences, aux travaux, aux pipelines et aux modèles définis dans le bundle, où chaque élément de la séquence est une autorisation pour une entité spécifique.
Voir les autorisations et Définir les autorisations pour les ressources dans les offres groupées des ressources Databricks.
Exemple
permissions:
- level: CAN_VIEW
group_name: test-group
- level: CAN_MANAGE
user_name: someone@example.com
- level: CAN_RUN
service_principal_name: 123456-abcdef
Préréglages
Définit des paramètres prédéfinis de déploiement d'ensemble. Consultez les Préréglages personnalisés.
Clé | Catégorie | Description |
---|---|---|
jobs_max_concurrent_runs |
Integer | Nombre maximal d’exécutions simultanées pour une tâche. |
name_prefix |
Chaîne | Le préfixe pour les exécutions de tâches de l'ensemble. |
pipelines_development |
Booléen | Indique si les déploiements de pipeline doivent être verrouillés en mode de développement. |
source_linked_deployment |
Booléen | Indique s'il faut lier le déploiement à la source du pack. |
tags |
Mappage | Les balises pour le déploiement de l’offre groupée. |
trigger_pause_status |
Chaîne | État de pause à appliquer à tous les déclencheurs et planifications de travail. Les valeurs valides sont PAUSED ou UNPAUSED . |
ressources
Un mappage qui définit les ressources de l’offre groupée, où chaque clé est le nom de la ressource et la valeur est une carte qui définit la ressource. Pour plus d’informations sur les ressources prises en charge par Databricks Asset Bundles et la référence de définition de ressource, consultez ressources Databricks Asset Bundles.
resources:
<resource-type>s:
<resource-name>:
<resource-field-name>: <resource-field-value>
Clé | Catégorie | Description |
---|---|---|
clusters |
Mappage | Définitions de cluster pour le bundle, où chaque clé est le nom d’un cluster. Voir le cluster |
dashboards |
Mappage | Définitions des tableaux de bord du bundle, où chaque clé représente le nom du tableau de bord. Consultez le tableau de bord |
experiments |
Mappage | Définitions d’expérience pour le bundle, où chaque clé est le nom de l’expérience. Voir l'expérience |
jobs |
Mappage | Les définitions des tâches pour le paquet, où chaque clé est le nom de la tâche. Voir le travail |
model_serving_endpoints |
Mappage | Les définitions des points de terminaison pour la mise en service du modèle pour l'ensemble, où chaque clé est le nom du point de terminaison de mise en service du modèle. Voir model_serving_endpoint |
models |
Mappage | Définitions de modèle pour le bundle, où chaque clé est le nom du modèle. Voir modèle (hérité) |
pipelines |
Mappage | Les définitions de pipeline pour l'ensemble, où chaque clé représente le nom du pipeline. Voir le pipeline |
quality_monitors |
Mappage | Les définitions du moniteur de qualité pour l'ensemble, où chaque clef est le nom du moniteur de qualité. Voir quality_monitor (Unity Catalog) |
registered_models |
Mappage | Définitions de modèle enregistrées pour l'ensemble, où chaque clé est le nom du modèle enregistré du Unity Catalog. Voir registered_model (Unity Catalog) |
schemas |
Mappage | Définitions de schéma pour le bundle, où chaque clé est le nom du schéma. Consultez le schéma (catalogue Unity) |
volumes |
Mappage | Les définitions de volumes pour l'ensemble, où chaque clé représente le nom du volume. Voir volume (Unity Catalog) |
run_as
Identité à utiliser lors de l’exécution de flux de travail Databricks Asset Bundles. Consultez le point . Spécifiez une identité d'exécution pour un flux de travail Databricks Asset Bundles.
Clé | Catégorie | Description |
---|---|---|
service_principal_name |
Chaîne | L'identifiant de la demande d'un mandant de service actif. La définition de ce champ nécessite le rôle servicePrincipal/user . |
user_name |
Chaîne | E-mail d’un utilisateur d’espace de travail actif. Les utilisateurs non administrateurs ne peuvent définir ce champ que sur leur propre e-mail. |
synchronisation
Fichiers et chemins d’accès aux fichiers à inclure ou exclure dans le bundle. Consultez la synchronisation.
Clé | Catégorie | Description |
---|---|---|
exclude |
Séquence | Liste de fichiers ou de dossiers à exclure de l’offre groupée. |
include |
Séquence | Liste de fichiers ou de dossiers à inclure dans le bundle. |
paths |
Séquence | Les chemins d’accès au dossier local, qui peuvent se trouver en dehors de la racine du bundle, pour se synchroniser avec l’espace de travail lorsque le bundle est déployé. |
cible
Définit des cibles de déploiement pour l’offre groupée. Voir Cibles
Clé | Catégorie | Description |
---|---|---|
artifacts |
Mappage | Artefacts à inclure dans le déploiement cible. Consultez artifacts. |
bundle |
Mappage | Les attributs de l’offre groupée lors du déploiement sur cette cible. |
cluster_id |
Chaîne | ID du cluster à utiliser pour cette cible. |
compute_id |
Chaîne | Obsolète. L'ID de l'unité de calcul à utiliser pour cet objectif. |
default |
Booléen | Indique si cette cible est la cible par défaut. |
git |
Mappage | Paramètres de contrôle de version Git pour la cible. Voir git. |
mode |
Chaîne | Mode de déploiement de la cible. Les valeurs valides sont development ou production . Consultez les modes de déploiement de Databricks Asset Bundle . |
permissions |
Séquence | Les autorisations pour le déploiement et l’exécution du paquet sur la cible. Consultez les autorisations. |
presets |
Mappage | Paramètres prédéfinis de déploiement pour la cible. Consultez les préréglages. |
resources |
Mappage | Définitions de ressources pour la cible. Consultez les ressources. |
run_as |
Mappage | Identité à utiliser pour exécuter le bundle. Voir run_as et Spécifier une identité d’exécution pour le flux de travail d’un pack de ressources Databricks. |
sync |
Mappage | Les chemins d’accès locaux à synchroniser avec l’espace de travail cible lorsqu’un bundle est exécuté ou déployé. Consultez la synchronisation. |
variables |
Mappage | Définitions de variables personnalisées pour la cible. Consultez les variables et les substitutions et les variables dans les bundles d'actifs Databricks. |
workspace |
Mappage | L’espace de travail Databricks pour la cible. espace de travail |
variables
Carte qui définit les variables personnalisées pour le bundle, chaque clé représentant le nom de la variable et chaque valeur est une Carte qui définit la variable. Consultez les variables et les substitutions et les variables dans les offres groupées d'actifs Databricks.
Clé | Catégorie | Description |
---|---|---|
nom de variable | Mappage | Définition d’une variable. Voir le nom de la variable. |
nom de variable
Chaque définition de variable a les attributs suivants :
Clé | Catégorie | Description |
---|---|---|
description |
Chaîne | Description de la variable. |
lookup |
Chaîne | Nom du alert , cluster_policy , cluster , dashboard , instance_pool , job , metastore , pipeline , query , service_principal ou objet warehouse pour lequel récupérer un ID. |
type |
Chaîne | Type de la variable. Les valeurs valides sont complex . |
espace de travail
Définit l’espace de travail Databricks pour le bundle. Consultez l’espace de travail.
Clé | Catégorie | Description |
---|---|---|
artifact_path |
Chaîne | Le chemin d’accès de l’artefact à utiliser dans l’espace de travail pour les déploiements et les exécutions des flux de données |
auth_type |
Chaîne | Le type d’authentification. |
azure_client_id |
Chaîne | ID de client Azure |
azure_environment |
Chaîne | Environnement Azure. |
azure_login_app_id |
Chaîne | ID d’application de connexion Azure. |
azure_tenant_id |
Chaîne | ID de locataire Azure. |
azure_use_msi |
Booléen | Indique s’il faut utiliser MSI pour Azure. |
azure_workspace_resource_id |
Chaîne | ID de ressource de l’espace de travail Azure. |
client_id |
Chaîne | ID client de l’espace de travail. |
file_path |
Chaîne | Chemin de fichier à utiliser dans l’espace de travail pour les déploiements et les exécutions de flux de travail. |
google_service_account |
Chaîne | Nom du compte de service Google. |
host |
Chaîne | URL de l’hôte de l’espace de travail Databricks. |
profile |
Chaîne | Le nom du profil de l’espace de travail Databricks. |
resource_path |
Chaîne | Le chemin d'accès de ressource de l’espace de travail. |
root_path |
Chaîne | Chemin racine de l’espace de travail Databricks. |
state_path |
Chaîne | Le chemin d’accès de l’état de l’espace de travail. |