Dela via

Konfigurationsreferens

  • Artikel

Den här artikeln ger en referens för nycklar som stöds av Databricks Asset Bundles-konfiguration (YAML). Se avsnitt Vad är Databricks-tillgångspaket?.

Fullständiga paketexempel finns i Exempel på paketkonfiguration och GitHub-lagringsplats med paketexempel.

artefakt

Definierar inställningarna för att skapa en artefakt.

Nyckel Typ Beskrivning
build Sträng En valfri uppsättning build-kommandon som ska köras lokalt före distributionen.
executable Sträng Den körbara typen. Giltiga värden är bash, shoch cmd.
files Karta Den relativa eller absoluta sökvägen till de skapade artefaktfilerna, definierad som artifact_file.
path Sträng Den lokala sökvägen till katalogen för artefakten.
type Sträng Krävs om artefakten är ett Python-hjul. Artefaktens typ. Giltiga värden är whl och jar.

Artefakter

Definierar attributen för att skapa artefakter, där varje nyckel är namnet på artefakten och värdet är en tabell som definierar artefaktbygginställningar. Information om artifacts mappning finns i artefakter.

Artefaktinställningar som definierats på den högsta nivån i paketkonfigurationen kan åsidosättas i targets-mappningen. Se Definiera artefaktinställningar i Databricks-tillgångspaket.

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

Exempel

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

artefaktfil

Definierar en artefaktfil i ett paket.

Nyckel Typ Beskrivning
source Sträng Krävs. Artefaktkällfilen.

bunt

Attributen för paketet. Se paket.

Nyckel Typ Beskrivning
cluster_id Sträng ID:t för ett kluster som ska användas för att köra paketet. Se cluster_id.
databricks_cli_version Sträng Databricks CLI-versionen som ska användas för paketet. Se databricks_cli_version.
deployment Karta Definitionen av paketdistributionen. För attribut som stöds, se distributionslägena och Databricks Asset Bundle.
git Karta Information för Git-versionskontroll som är associerad med ditt bundle. För attribut som stöds, se git och git.
name Sträng Krävs. Namnet på paketet.
uuid Sträng Reserverad. En universellt unik identifierare (UUID) för paketet som unikt identifierar paketet i interna Databricks-system. Detta genereras när ett paketprojekt initieras med hjälp av en Databricks-mall (med kommandot databricks bundle init).

implementering

Definierar paketdistributionsattribut.

Nyckel Typ Beskrivning
fail_on_active_runs Boolesk Om aktiva körningar ska misslyckas eller inte. Om detta är inställt på true kan en distribution som körs avbrytas.
lock Karta Attributen för distributionslås. Se -lås.

experimentell

Definierar attribut för experimentella funktioner.

Nyckel Typ Beskrivning
python_wheel_wrapper Boolesk Om du vill använda en Python-hjulomslutning.
scripts Kommando (sträng) Kommandona som ska köras
use_legacy_run_as Boolesk Om du vill använda det äldre run_as beteendet.

Git

Definierar information om Git-versionskontroll som är associerade med paketet. Se git.

Nyckel Typ Beskrivning
origin_url Sträng Lagringsplatsens ursprungs-URL. Se git.
branch Sträng Git-grenens namn. Se git.

bevilja

Definierar åtkomst till Unity Catalog-objekt. Mer information finns i Ansluta till molnobjektlagring och -tjänster med hjälp av Unity Catalog.

Nyckel Typ Beskrivning
principal Sträng Krävs. Namnet på den huvudman som ska beviljas behörigheter.
privileges Sträng Krävs. Behörigheterna att bevilja den angivna entiteten.

Exempel

I följande exempel definieras ett Unity Catalog-schema med bidrag:

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"

lås

Definierar paketdistributionslåsattributen.

Nyckel Typ Beskrivning
enabled Boolesk Om låset är aktiverat.
force Boolesk Om låset ska framtvingas om det är aktiverat.

tillåtelse

Definierar en behörighet för en viss entitet. Se behörigheter och Ange behörigheter för resurser i Databricks-tillgångspaket.

Nyckel Typ Beskrivning
group_name Sträng Namnet på den grupp som har behörighetsuppsättningen i level.
level Sträng Krävs. Den tillåtna behörigheten för användare, grupp, tjänstens huvudnamn som definierats för den här behörigheten.
service_principal_name Sträng Namnet på tjänstens principal som har behörighet i level.
user_name Sträng Namnet på den användare som har behörighet satt i level.

Behörigheter

En sekvens som definierar behörigheterna för experiment, jobb, pipelines och modeller som definierats i paketet, där varje objekt i sekvensen är en behörighet för en viss entitet.

Se behörigheter och Ange behörigheter för resurser i Databricks-tillgångspaket.

Exempel

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

Förinställningar

Definierar förinställningar för paketdistribution. Se Anpassade förinställningar.

Nyckel Typ Beskrivning
jobs_max_concurrent_runs Heltal Maximalt antal samtidiga körningar för ett jobb.
name_prefix Sträng Prefixet för jobbkörningar av paketet.
pipelines_development Boolesk Om pipelineutplaceringar ska vara låsta i utvecklingsläge.
source_linked_deployment Boolesk Om distributionen ska länkas till paketkällan.
tags Karta Taggarna för paketdistributionen.
trigger_pause_status Sträng En pausstatus som ska tillämpas på alla jobbutlösare och scheman. Giltiga värden är PAUSED eller UNPAUSED.

Resurser

En karta som definierar resurserna för paketet, där varje nyckel är namnet på resursen, och värdet är en karta som definierar resursen. Mer information om resurser som stöds av Databricks-tillgångspaket och referens för resursdefinitioner finns i Databricks Asset Bundles-resurser.

resources:
  <resource-type>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Nyckel Typ Beskrivning
clusters Karta Klusterdefinitionerna för paketet, där varje nyckel är namnet på ett kluster. Se kluster
dashboards Karta Instrumentpanelsdefinitionerna för paketet, där varje nyckel är namnet på instrumentpanelen. Se instrumentpanel
experiments Karta Experimentdefinitionerna för paketet, där varje nyckel är namnet på experimentet. Se -experimentet
jobs Karta Jobbdefinitionerna för paketet, där varje nyckel är namnet på jobbet. Se jobb
model_serving_endpoints Karta Modellen som betjänar slutpunktsdefinitioner för paketet, där varje nyckel är namnet på modellen som betjänar slutpunkten. Se model_serving_endpoint
models Karta Modelldefinitionerna för paketet, där varje nyckel är namnet på modellen. Se modell (äldre)
pipelines Karta Pipelinedefinitionerna för paketet, där varje nyckel är namnet på pipelinen. Se rörledning
quality_monitors Karta Kvalitetsövervakarens definitioner för paketet, där varje nyckel är namnet på kvalitetsövervakaren. Se kvalitetsövervakning (Unity Catalog)
registered_models Karta De registrerade modelldefinitionerna för paketet, där varje nyckel är namnet på den registrerade Unity Catalog-modellen. Se registered_model (Unity Catalog)
schemas Karta Schemadefinitionerna för paketet, där varje nyckel är namnet på schemat. Se schema (Unity Catalog)
volumes Karta Volymdefinitionerna för paketet, där varje nyckel är namnet på volymen. Se volym (Unity Catalog)

kör_som

Identiteten som ska användas vid körning av arbetsflöden med Databricks-tillgångspaket. Se Ange en körningsidentitet för ett Databricks Asset Bundles-arbetsflöde.

Nyckel Typ Beskrivning
service_principal_name Sträng Applikations-ID för ett aktivt tjänstekonto. Att ställa in det här fältet kräver rollen servicePrincipal/user.
user_name Sträng E-postmeddelandet för en aktiv arbetsyteanvändare. Användare som inte är administratörer kan bara ange det här fältet till sin egen e-post.

synkronisering

De filer och filsökvägar som ska inkluderas eller exkluderas i paketet. Se synkronisera.

Nyckel Typ Beskrivning
exclude Sekvens En lista över filer eller mappar som ska undantas från paketet.
include Sekvens En lista över filer eller mappar som ska ingå i paketet.
paths Sekvens De lokala mappsökvägarna, som kan ligga utanför paketroten, ska synkroniseras till arbetsytan när paketet distribueras.

mål

Definierar distributionsmål för paketet. Se riktar sig mot

Nyckel Typ Beskrivning
artifacts Karta Artefakterna som ska inkluderas i måldistributionen. Se artefakter.
bundle Karta Paketattributen vid distribution till det här målet.
cluster_id Sträng ID:t för klustret som ska användas för det här målet.
compute_id Sträng Föråldrad. ID:t för den beräkning som ska användas för det här målet.
default Boolesk Om det här målet är standardmålet.
git Karta Inställningarna för Git-versionskontroll för målet. Se git.
mode Sträng Deploymentsläget för målobjektet. Giltiga värden är development eller production. Se distributionslägena för Databricks Asset Bundle.
permissions Sekvens Behörigheter för att distribuera och köra paketet i målsystemet. Se behörigheter.
presets Karta Distributionsförinställningar för målet. Se förinställningar.
resources Karta Resursdefinitionerna för målet. Se resurser.
run_as Karta Identiteten som ska användas för att köra paketet. Se run_as och Ange en körningsidentitet för ett Databricks Asset Bundles-arbetsflöde.
sync Karta De lokala sökvägarna för att synkronisera till målarbetsytan när ett paket körs eller distribueras. Se synkronisera.
variables Karta De anpassade variabeldefinitionerna för målet. Se variabler och substitutioner och variabler i Databricks Asset Bundles.
workspace Karta Databricks-arbetsytan för målmiljön. arbetsyta

Variabler

En karta som definierar de anpassade variablerna för paketet, där varje nyckel är namnet på variabeln, och värdet är en karta som definierar variabeln. Se substitutioner och variabler i Databricks-tillgångspaket.

Nyckel Typ Beskrivning
variabelnamn Karta Definitionen av en variabel. Se variabelnamn.

variabelnamn

Varje variabeldefinition har följande attribut:

Nyckel Typ Beskrivning
description Sträng Beskrivningen av variabeln.
lookup Sträng Namnet på alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principaleller warehouse objekt som ett ID ska hämtas för.
type Sträng Typen av variabel. Giltiga värden är complex.

arbetsyta

Definierar Databricks-arbetsytan för paketet. Se arbetsyta.

Nyckel Typ Beskrivning
artifact_path Sträng Artefaktsökvägen som ska användas på arbetsytan för både distributioner och arbetsflödeskörningar
auth_type Sträng Autentiseringstypen.
azure_client_id Sträng Azure-klient-ID.
azure_environment Sträng Azure-miljön.
azure_login_app_id Sträng Azure-inloggningsappens ID.
azure_tenant_id Sträng Azure-klientorganisations-ID
azure_use_msi Boolesk Om du vill använda MSI för Azure.
azure_workspace_resource_id Sträng Resurs-ID:t för Azure-arbetsytan.
client_id Sträng Klient-ID för arbetsytan.
file_path Sträng Filsökvägen som ska användas på arbetsytan för både distributioner och arbetsflödeskörningar.
google_service_account Sträng Namnet på Google-tjänstkontot.
host Sträng Databricks-arbetsytans värd-URL.
profile Sträng Profilnamnet för Databricks-arbetsytan.
resource_path Sträng Sökvägen till resursen för arbetsyta.
root_path Sträng Rotvägen för Databricks arbetsyta.
state_path Sträng Arbetsytans tillståndssökväg.