Delen via

Configuratiegids

  • Artikel

Dit artikel bevat naslaginformatie over sleutels die worden ondersteund door de configuratie van Databricks Asset Bundles (YAML). Zie Wat zijn Databricks Assetbundels?.

Zie Bundelconfiguratievoorbeelden en de GitHub-opslagplaats met bundelvoorbeeldenvoor volledige bundelvoorbeelden.

artefact

Hiermee definieert u de instellingen voor het bouwen van een artefact.

Sleutel Type Beschrijving
build Snaar Een optionele set buildopdrachten die lokaal moeten worden uitgevoerd vóór de implementatie.
executable Snaar Het uitvoerbare type. Geldige waarden zijn bash, shen cmd.
files Kaart Het relatieve of absolute pad naar de ingebouwde artefactbestanden, gedefinieerd als artifact_file.
path Snaar Het lokale pad van de map voor het artefact.
type Snaar Vereist als het artefact een Python-wiel is. Het type artefact. Geldige waarden zijn whl en jar.

Artefacten

Definieert de kenmerken voor het bouwen van artefacten, waarbij elke sleutel de naam van het artefact is en de waarde een kaart is die de build-instellingen voor het artefact definieert. Voor informatie over de artifacts-toewijzing, zie de -artefacten.

Artefactinstellingen die zijn gedefinieerd op het hoogste niveau van de bundelconfiguratie, kunnen worden overschreven in de targets mapping. Zie Artefactinstellingen definiëren in Databricks Asset Bundles.

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

Voorbeeld

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

artefactbestand

Definieert een artefactbestand in een bundel.

Sleutel Type Beschrijving
source Snaar Vereist. Het artefact-bronbestand.

bundel

De kenmerken van de bundel. Zie bundel.

Sleutel Type Beschrijving
cluster_id Snaar De id van een cluster dat moet worden gebruikt om de bundel uit te voeren. Zie cluster_id.
databricks_cli_version Snaar De Databricks CLI-versie die moet worden gebruikt voor de bundel. Zie databricks_cli_version.
deployment Kaart De definitie van de bundelimplementatie. Zie implementatie- en implementatiemodi van Databricks Asset Bundlevoor ondersteunde kenmerken.
git Kaart De details van het Git-versiebeheer die aan uw bundel zijn gekoppeld. Zie git- en git-voor ondersteunde kenmerken.
name Snaar Vereist. De naam van de bundel.
uuid Snaar Gereserveerd. Een UUID (Universally Unique Identifier) voor de bundel die de bundel uniek identificeert in interne Databricks-systemen. Dit wordt gegenereerd wanneer een bundelproject wordt geïnitialiseerd met behulp van een Databricks-sjabloon (met behulp van de opdracht databricks bundle init).

Uitrol

Definieert bundelimplementatiekenmerken.

Sleutel Typ Beschrijving
fail_on_active_runs Booleaans Of het uitvoeren van actieve uitvoeringen mislukt. Als dit is ingesteld op true een implementatie die wordt uitgevoerd, kan worden onderbroken.
lock Kaart De inzetvergrendelingsattributen. Zie vergrendelen.

experimenteel

Definieert kenmerken voor experimentele functies.

Sleutel Type Beschrijving
python_wheel_wrapper Booleaans Of u een Python wiel-wrapper wilt gebruiken.
scripts Opdracht (tekenreeks) De opdrachten die moeten worden uitgevoerd
use_legacy_run_as Booleaans Of u het oudere run_as gedrag wilt gebruiken.

Git

Hiermee definieert u de details van git-versiebeheer die zijn gekoppeld aan de bundel. Zie git.

Sleutel Type Beschrijving
origin_url Snaar De oorspronkelijke URL van de opslagplaats. Zie git.
branch Snaar De naam van de Git-vertakking. Zie git.

verlenen

Hiermee definieert u de toegang tot Unity Catalog-objecten. Zie Verbinding maken met opslag en services voor cloudobjecten met behulp van Unity Catalogvoor meer informatie.

Sleutel Type Beschrijving
principal Snaar Vereist. De naam van de principal waaraan bevoegdheden worden verleend.
privileges Snaar Vereist. De bevoegdheden die moeten worden verleend aan de opgegeven entiteit.

Voorbeeld

In het volgende voorbeeld wordt een Unity Catalog-schema met subsidies gedefinieerd:

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"

slot

Hiermee definieert u de vergrendelingskenmerken van de bundelimplementatie.

Sleutel Type Beschrijving
enabled Booleaans Of deze vergrendeling is ingeschakeld.
force Booleaans Of deze vergrendeling moet worden afgedwongen als deze is ingeschakeld.

toestemming

Hiermee definieert u een machtiging voor een specifieke entiteit. Zie machtigingen en Machtigingen instellen voor resources in Databricks Asset Bundles.

Sleutel Type Beschrijving
group_name Snaar De naam van de groep met de toestemmingenset in level.
level Snaar Vereist. De toestemmingen voor gebruiker, groep en service-principal die voor deze machtiging zijn gedefinieerd.
service_principal_name Snaar De naam van de service-principal met de machtigingen die zijn ingesteld in level.
user_name Snaar De naam van de gebruiker met de machtiging die is ingesteld in level.

Machtigingen

Een reeks die de machtigingen definieert die moeten worden toegepast op experimenten, taken, pijplijnen en modellen die in de bundel zijn gedefinieerd, waarbij elk item in de reeks een machtiging is voor een specifieke entiteit.

Zie machtigingen en Machtigingen instellen voor resources in Databricks Asset Bundles.

Voorbeeld

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

Voorinstellingen

Definieert vooraf ingestelde bundelimplementaties. Zie Aangepaste voorinstellingen.

Sleutel Type Beschrijving
jobs_max_concurrent_runs Geheel getal De maximale gelijktijdige uitvoeringen voor een taak.
name_prefix Snaar Het voorvoegsel voor taakuitvoeringen van de bundel.
pipelines_development Booleaans Of pijplijnimplementaties moeten worden vergrendeld in de ontwikkelingsmodus.
source_linked_deployment Booleaans Of de implementatie moet worden gekoppeld aan de bundelbron.
tags Kaart De tags voor de bundelimplementatie.
trigger_pause_status Snaar Een onderbrekingsstatus die moet worden toegepast op alle taaktriggers en -planningen. Geldige waarden zijn PAUSED of UNPAUSED.

middelen

Een kaart die de resources voor de bundel definieert, waarbij elke sleutel de naam van de resource is en de waarde een kaart is die de resource definieert. Zie Databricks Asset Bundles-resourcesvoor meer informatie over ondersteunde resources, en de referentie voor resource-definities van Databricks Asset Bundles.

resources:
  <resource-type>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Sleutel Type Beschrijving
clusters Kaart De clusterdefinities voor de bundel, waarbij elke sleutel de naam van een cluster is. Zie cluster
dashboards Kaart De dashboarddefinities voor de bundel, waarbij elke sleutel de naam van het dashboard is. Zie dashboard
experiments Kaart De experimentdefinities voor de bundel, waarbij elke sleutel de naam van het experiment is. Zie experiment
jobs Kaart De taakdefinities voor de bundel, waarbij elke sleutel de naam van de taak is. Zie taak
model_serving_endpoints Kaart Het model dat eindpuntdefinities voor de bundel bedient, waarbij elke sleutel de naam is van het eindpunt dat het model bedient. Zie model-serving-endpoint
models Kaart De modeldefinities voor de bundel, waarbij elke sleutel de naam van het model is. Zie model (verouderd)
pipelines Kaart De pijplijndefinities voor de bundel, waarbij elke sleutel de naam van de pijplijn is. Zie pijplijn
quality_monitors Kaart De kwaliteitsmonitordefinities voor de bundel, waarbij elke sleutel de naam is van de kwaliteitsmonitor. Zie quality_monitor (Unity Catalog)
registered_models Kaart De geregistreerde modeldefinities voor de bundel, waarbij elke sleutel de naam is van het geregistreerde Unity Catalog-model. Zie geregistreerd_model (Unity Catalog)
schemas Kaart De schemadefinities voor de bundel, waarbij elke sleutel de naam van het schema is. Zie schema (Unity Catalog)
volumes Kaart De volumedefinities voor de bundel, waarbij elke sleutel de naam van het volume is. Zie volume (Unity Catalog)

uitvoeren_als

De identiteit die moet worden gebruikt bij het uitvoeren van Databricks Asset Bundles-werkstromen. Zie Een uitvoeringsidentiteit opgeven voor een Databricks Asset Bundles-werkstroom.

Sleutel Type Beschrijving
service_principal_name Draad De toepassings-id van een actieve service-principal. Voor het instellen van dit veld is de servicePrincipal/user rol vereist.
user_name Snaar Het e-mailadres van een actieve werkruimtegebruiker. Niet-beheerders kunnen dit veld alleen instellen op hun eigen e-mail.

synchroniseren

De bestanden en bestandspaden die in de bundel moeten worden opgenomen of uitgesloten. Zie synchronisatie.

Sleutel Type Beschrijving
exclude Volgorde Een lijst met bestanden of mappen die moeten worden uitgesloten van de bundel.
include Volgorde Een lijst met bestanden of mappen die moeten worden opgenomen in de bundel.
paths Volgorde De lokale mappaden, die zich buiten de hoofdmap van de bundel kunnen bevinden, om te synchroniseren met de werkruimte wanneer de bundel wordt geïmplementeerd.

doel

Definieert implementatiedoelen voor de bundel. Zie doelen

Sleutel Type Beschrijving
artifacts Kaart De artefacten die moeten worden opgenomen in de doelimplementatie. Zie artefacten.
bundle Kaart De bundelkenmerken voor implementatie naar deze doelomgeving.
cluster_id Snaar De id van het cluster dat voor dit doel moet worden gebruikt.
compute_id Snaar Verouderd. De ID van de computereenheid die voor dit doel moet worden gebruikt.
default Booleaans Of dit doel het standaarddoel is.
git Kaart De instellingen voor Git-versiebeheer voor het doel. Zie git.
mode Snaar De implementatiemodus voor het doel. Geldige waarden zijn development of production. Zie implementatiemodi voor Databricks Asset Bundle.
permissions Volgorde De machtigingen voor het implementeren en uitvoeren van de bundel in het doelsysteem. Zie machtigingen.
presets Kaart De voorinstellingen voor implementatie voor het doelwit. Zie voorinstellingen.
resources Kaart De hulpmiddeldefinities voor het beoogde doel. Zie bronnen.
run_as Kaart De identiteit die moet worden gebruikt om de bundel uit te voeren. Zie run_as en Geef een uitvoeringsidentiteit op voor een Databricks Asset Bundles-werkstroom.
sync Kaart De lokale paden voor synchronisatie met de doelwerkruimte wanneer een bundel wordt uitgevoerd of geïmplementeerd. Zie sync.
variables Kaart De aangepaste variabeledefinities voor het doel. Zie variabelen en variabelen en vervangingen in Databricks Asset Bundles.
workspace Kaart De Databricks-werkruimte voor de beoogde doelstelling. werkruimte

Variabelen

Een kaart waarmee de aangepaste variabelen voor de bundel worden gedefinieerd, waarbij elke sleutel de naam van de variabele is en de waarde een kaart is waarmee de variabele wordt gedefinieerd. Zie Vervangingen en variabelen in Databricks Asset Bundles.

Sleutel Type Beschrijving
variabele-naam Kaart De definitie van een variabele. Zie variabelenaam.

variabele-naam

Elke variabeledefinitie heeft de volgende kenmerken:

Sleutel Type Beschrijving
description Snaar De beschrijving van de variabele.
lookup Snaar De naam van de alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalof warehouse object waarvoor een id moet worden opgehaald.
type Snaar Het type variabele. Geldige waarden zijn complex.

Werkruimte

Hiermee definieert u de Databricks-werkruimte voor de bundel. Zie werkruimte.

Sleutel Type Beschrijving
artifact_path Snaar Het artefactpad dat in de werkruimte gebruikt wordt voor zowel implementaties als werkstroomruns
auth_type Snaar Het verificatietype.
azure_client_id Snaar De Azure-client-ID.
azure_environment Snaar De Azure-omgeving.
azure_login_app_id Snaar De aanmeldings-app-id van Azure.
azure_tenant_id Snaar De Azure-tenant-ID.
azure_use_msi Booleaans Of u MSI wilt gebruiken voor Azure.
azure_workspace_resource_id Snaar De resource-id van de Azure-werkruimte.
client_id touwtje De client-id voor de werkruimte.
file_path Snaar Het bestandspad dat in de werkruimte moet worden gebruikt voor implementaties en werkstroomuitvoeringen.
google_service_account Snaar De naam van het Google-serviceaccount.
host Snaar De Host-URL van de Databricks-werkruimte.
profile Snaar De naam van het Databricks-werkruimteprofiel.
resource_path Snaar Het resourcepad voor de werkruimte.
root_path Snaar Het hoofdpad van de Databricks-werkruimte.
state_path Touwtje Het pad naar de werkruimtestatus.