Partager via

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). Veuillez consulter la section Que sont-les Databricks Asset Bundles ?.

Pour obtenir des exemples complets de paquets, consultez les exemples de configuration de paquets et le dépôt GitHub bundle-examples .

artefacts

Type: Map

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 de l’artefact. Pour en savoir plus sur le mappage de artifacts, consultez artifacts.

Les paramètres d’artefact définis dans le niveau supérieur de la configuration du bundle peuvent être remplacés dans le mappage targets. Consultez Remplacer par les paramètres cibles.

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>
Clé Type Descriptif
build Chaîne Ensemble facultatif de commandes de build à exécuter localement avant le déploiement.
dynamic_version Booléen Indique s’il faut corriger la version du wheel de manière dynamique en fonction du timestamp du fichier whl. Si cette valeur est définie true, le nouveau code peut être déployé sans avoir à mettre à jour la version dans setup.py ou pyproject.toml. Ce paramètre n’est valide que lorsqu’il type est défini sur whl. Voir artifacts.
executable Chaîne Type exécutable. Les valeurs valides sont bash, sh et cmd.
files Sequence Chemin d’accès relatif ou absolu aux fichiers d’artefact générés. Voir artifacts.name.files.
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.

Exemple

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

artifacts.name.files

Type: Sequence

Chemin d’accès relatif ou absolu aux fichiers d’artefact générés.

Clé Type Descriptif
source Chaîne Obligatoire. Fichier source de l’artefact.

service

Type: Map

Attributs du bundle lors du déploiement sur cette cible.

Clé Type Descriptif
cluster_id Chaîne ID d’un cluster à utiliser pour exécuter le bundle. Voir cluster_id.
compute_id Chaîne Obsolète. ID du calcul à utiliser pour exécuter le bundle.
databricks_cli_version Chaîne Version de l’interface CLI Databricks à utiliser pour l’offre groupée. Voir databricks_cli_version.
deployment Mappage Définition du déploiement du bundle. Pour connaître les attributs pris en charge, consultez les modes de déploiement databricks Asset Bundle. Consultez bundle.deployment.
git Mappage Détails du contrôle de version Git associés à votre offre groupée. Pour les attributs pris en charge, consultez git. Voir git.
name Chaîne Nom du bundle.
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).

bundle.deployment

Type: Map

Définition du déploiement de paquet

Clé Type Descriptif
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 Attributs de verrou de déploiement. Consultez bundle.deployment.lock.

bundle.deployment.lock

Type: Map

Attributs de verrou de déploiement.

Clé Type Descriptif
enabled Booléen Indique si ce verrou est activé.
force Booléen Indique s’il faut forcer ce verrou s’il est activé.

expérimental

Type: Map

Définit des attributs pour les fonctionnalités expérimentales.

Clé Type Descriptif
python Mappage Obsolète. Utilisez plutôt le mappage Python de niveau supérieur.
python_wheel_wrapper Booléen Indique s’il faut utiliser un wrapper de wheel Python.
scripts Mappage Commandes à exécuter.
use_legacy_run_as Booléen Indique s’il faut utiliser le comportement hérité de run_as.

inclure

Type: Sequence

Spécifie une liste de globs de chemin d’accès qui contiennent des fichiers de configuration à inclure dans le bundle. Voir inclure.

autorisations

Type: Sequence

Séquence qui définit les autorisations à appliquer aux ressources définies dans le bundle, où chaque élément de la séquence est une autorisation pour une entité spécifique.

Voir permissions et Définir des autorisations pour les ressources dans les bundles de ressources Databricks.

Clé Type Descriptif
group_name Chaîne Le nom du groupe dont les permissions sont définies à un certain niveau.
level Chaîne Autorisation autorisée pour l’utilisateur, le groupe, le principal de service défini pour cette autorisation. Les valeurs valides pour cette clé sont différentes selon que les autorisations sont définies au niveau supérieur de l’offre groupée ou pour une ressource spécifique. Consultez Définir des autorisations pour les ressources dans les bundles de ressources Databricks.
service_principal_name Chaîne Nom du principal de service dont l’autorisation est définie dans le niveau.
user_name Chaîne Nom de l’utilisateur disposant de l’autorisation définie au niveau.

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

Type: Map

Définit des paramètres prédéfinis de déploiement d'ensemble. Consultez Préréglages personnalisés.

Clé Type Descriptif
jobs_max_concurrent_runs Nombre entier Nombre maximal d’exécutions simultanées pour une tâche.
name_prefix Chaîne Préfixe pour les exécutions de travaux du bundle.
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 Balises pour le déploiement du bundle.
trigger_pause_status Chaîne État de pause à appliquer à tous les déclencheurs et planifications de travail. Les valeurs valides sont « SUSPENDU » et « NON SUSPENDU ».

python

Type: Map

Configure le chargement du code Python défini avec le package databricks-bundles. Pour plus d’informations, consultez La configuration de bundle dans Python.

Clé Type Descriptif
mutators Sequence Les mutateurs comportent une liste de chemins d’accès complets aux fonctions de mutation, comme [my_project.mutators:add_default_cluster].
resources Sequence Les ressources contiennent une liste de chemins de fonction complets pour charger des ressources définies dans le code Python, par exemple ["my_project.resources:load_resources"]
venv_path Chaîne Chemin d’accès à l’environnement virtuel. Si cette option est activée, le code Python s’exécute dans cet environnement. Si elle est désactivée, elle utilise par défaut l’interpréteur Python disponible dans l’interpréteur de commandes actuel.

Ressources

Type: Map

Mappage qui définit les ressources du bundle, où chaque clé est le nom de la ressource et la valeur est un mappage 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>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Clé Type Descriptif
alerts Mappage Définitions d’alerte (v2) pour le bundle, où chaque clé est le nom de l’alerte. Consultez l’alerte.
apps Mappage Définitions de l’application Databricks pour le bundle, où chaque clé est le nom de l’application. Voir l’application.
clusters Mappage Définitions de cluster pour le bundle, où chaque clé est le nom d’un cluster. Voir 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.
database_catalogs Mappage Définitions du catalogue de bases de données pour le bundle, où chaque clé est le nom du catalogue de bases de données. Voir database_catalog.
database-instances Mappage Définitions d’instance de base de données pour le bundle, où chaque clé est le nom de l’instance de base de données. Voir database_instance.
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 Définitions des points de terminaison de mise en service de modèles pour le bundle, où chaque clé est le nom du point de terminaison. Voir model_serving_endpoint.
models Mappage Définitions de modèle pour le bundle, où chaque clé est le nom du modèle. Consultez le modèle (hérité).
pipelines Mappage Définitions de pipeline pour le bundle, où chaque clé représente le nom du pipeline. Consultez pipeline.
quality_monitors Mappage Définitions du moniteur de qualité pour le bundle, où chaque clé 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).
secret_scopes Mappage Définitions de l’étendue de secret pour le bundle, où chaque clé correspond au nom de l’étendue de secret. Voir secret_scope.
sql_warehouses Mappage Définitions de l’entrepôt SQL pour le bundle, où chaque clé est le nom de l’entrepôt SQL. Voir sql_warehouse.
synced_database_tables Mappage Définitions de table de base de données synchronisées pour le bundle, où chaque clé est le nom de la table de base de données. Voir synced_database_table.
volumes Mappage Les définitions de volumes pour l'ensemble, où chaque clé représente le nom du volume. Consultez Volume (Unity Catalog).

run_as

Type: Map

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é Type Descriptif
service_principal_name Chaîne ID d’application d’un principal 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.

Scripts

Type: Map

Scripts qui peuvent être exécutés à l’aide de bundle run. Consultez Exécuter des scripts.

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>
Clé Type Descriptif
content Chaîne Commandes à exécuter

synchronisation

Type: Map

Fichiers et chemins d’accès aux fichiers à inclure ou exclure dans le bundle. Voir sync.

Clé Type Descriptif
exclude Sequence Liste de fichiers ou de dossiers à exclure de l’offre groupée.
include Sequence Liste de fichiers ou de dossiers à inclure dans le bundle.
paths Sequence 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é.

cibles

Type: Map

Définit des cibles de déploiement pour l’offre groupée. Voir targets

targets:
  <target-name>:
    <target-field-name>: <target-field-value>
Clé Type Descriptif
artifacts Mappage Artefacts à inclure dans le déploiement cible. Voir artifacts.
bundle Mappage Attributs du bundle lors du déploiement sur cette cible. Voir bundle.
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 Sequence Autorisations pour le déploiement et l’exécution du bundle sur la cible. Consultez les autorisations.
presets Mappage Paramètres prédéfinis de déploiement pour la cible. Voir 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, consultez Spécifier une identité d’exécution pour un flux de travail Databricks Asset Bundles. Voir run_as.
sync Mappage Chemins d’accès locaux à synchroniser avec l’espace de travail cible lorsqu’un bundle est exécuté ou déployé. Voir sync.
variables Mappage Définitions de variables personnalisées pour la cible. Consultez les variables.
workspace Mappage Espace de travail Databricks pour la cible. Voir workspace.

variables

Type: Map

Définit une variable personnalisée pour le bundle. Consultez les variables.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>
Clé Type Descriptif
default N'importe lequel Valeur par défaut de la variable.
description Chaîne Description de la variable.
lookup Mappage Nom du alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalou objet warehouse pour lequel récupérer un ID. Consultez les variables.name.lookup.
type Chaîne Type de la variable, simple ou complexe. Définissez cette clé uniquement si la variable est complexe. Valeurs valides : complex.

variables.name.lookup

Type: Map

Nom de l’alerte, cluster_policy, cluster, tableau de bord, instance_pool, travail, metastore, pipeline, requête, service_principal ou objet d’entrepôt pour lequel récupérer un ID. Pour plus d’informations sur l’utilisation de la recherche, consultez Récupérer la valeur d’ID d’un objet.

Clé Type Descriptif
alert Chaîne Nom de l’alerte pour laquelle un ID doit être récupéré.
cluster Chaîne Nom du cluster pour lequel récupérer un ID.
cluster_policy Chaîne Nom du cluster_policy pour lequel un ID doit être récupéré.
dashboard Chaîne Nom du tableau de bord pour lequel un ID doit être récupéré.
instance_pool Chaîne Nom du instance_pool pour lequel récupérer un ID.
job Chaîne Nom du travail pour lequel récupérer un ID.
metastore Chaîne Nom du metastore pour lequel un ID doit être récupéré.
notification_destination Chaîne Nom de la notification_destination pour laquelle récupérer un ID.
pipeline Chaîne Nom du pipeline pour lequel un ID doit être récupéré.
query Chaîne Nom de la requête pour laquelle récupérer un ID.
service_principal Chaîne Nom du service_principal pour lequel récupérer un ID.
warehouse Chaîne Nom de l’entrepôt pour lequel récupérer un ID.

espace de travail

Type: Map

Définit l’espace de travail Databricks pour le bundle. Voir workspace.

Clé Type Descriptif
artifact_path Chaîne Chemin d’accès de l’artefact à utiliser dans l’espace de travail pour les déploiements et les exécutions des workflows
auth_type Chaîne Type d’authentification.
azure_client_id Chaîne L'identifiant 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 workflows
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 Nom du profil de l’espace de travail Databricks
resource_path Chaîne Chemin d’accès des ressources de l’espace de travail
root_path Chaîne Chemin racine de l’espace de travail Databricks
state_path Chaîne Chemin d’accès de l’état de l’espace de travail

Les objets courants

Git

Type: Map

Définit les détails du contrôle de version git.

Clé Type Descriptif
branch Chaîne Nom de la branche Git. Voir git.
origin_url Chaîne URL d’origine du référentiel. Voir git.
  • Last updated on