Konfigurációs referencia
Ez a cikk a Databricks Asset Bundles konfigurációja (YAML) által támogatott kulcsokra nyújt referenciát. Lásd Mik azok a Databricks-eszközcsomagok?.
A csomagra vonatkozó teljes példákért lásd Csomagkonfigurációs példákat és a csomagpéldák GitHub-adattárát.
műtárgy
Meghatározza az artefaktum létrehozásának beállításait.
Kulcs | Típus | Leírás |
---|---|---|
build |
Szál | Az üzembe helyezés előtt helyileg futtatandó buildparancsok választható készlete. |
executable |
Szál | A végrehajtható típus. Az érvényes értékek a következők: bash , sh és cmd . |
files |
Térkép | A beépített artefaktumfájlok relatív vagy abszolút elérési útja, meghatározva mint artifact_file. |
path |
Szál | Az artefaktum könyvtárának helyi elérési útja. |
type |
Szál | Kötelező, ha az összetevő Python-kerék. Az artefaktum típusa. Az érvényes értékek whl és jar . |
Műtárgyak
Meghatározza az összetevők létrehozásához szükséges attribútumokat, ahol az egyes kulcsok az összetevő neve, az érték pedig egy térkép, amely meghatározza a összetevő buildelési beállításait. A artifacts
leképezésről további információt összetevőkcímű témakörben talál.
A csomagkonfiguráció legfelső szintjén definiált összetevő-beállítások felülírhatók a targets
leképezésben. Lásd A Databricks-eszközcsomagokösszetevő-beállításainak definiálása című témakört.
artifacts:
<artifact-name>:
<artifact-field-name>: <artifact-field-value>
Példa
artifacts:
default:
type: whl
build: poetry build
path: .
artefaktum_fájl
Egy artefaktum fájlt definiál egy kötegben.
Kulcs | Típus | Leírás |
---|---|---|
source |
Szál | Szükséges. Az összetevő forrásfájlja. |
csomag
A csomag attribútumai. Lásd csomag.
Kulcs | Típus | Leírás |
---|---|---|
cluster_id |
Szál | A csomag futtatásához használandó klaszter azonosítója. Lásd cluster_id. |
databricks_cli_version |
Szál | A csomaghoz használandó Databricks CLI-verzió. Lásd databricks_cli_version. |
deployment |
Térkép | A csomag üzembe helyezésének definíciója. A támogatott attribútumokért lásd üzembe helyezési és Databricks-eszközcsomag üzembe helyezési módjait. |
git |
Térkép | A Csomaghoz társított Git-verziókövetési adatok. A támogatott attribútumokért lásd: git és git. |
name |
Szál | Szükséges. A csomag neve. |
uuid |
Szál | Fenntartott. A csomag univerzálisan egyedi azonosítója (UUID), amely egyedileg azonosítja a csomagot a belső Databricks-rendszerekben. Ez akkor jön létre, ha egy csomagprojekt inicializálása Databricks-sablonnal történik (a databricks bundle init paranccsal). |
telepítés
A csomag üzembehelyezési attribútumait határozza meg.
Kulcs | Típus | Leírás |
---|---|---|
fail_on_active_runs |
Boolean | Az aktív futtatások sikertelenségének lehetősége. Ha ez true -ra van állítva, egy futó üzembe helyezés megszakítható. |
lock |
Térkép | Az üzembehelyezési zárolás attribútumai. Lásd a(z) zár. |
kísérleti
A kísérleti funkciók attribútumait határozza meg.
Kulcs | Típus | Leírás |
---|---|---|
python_wheel_wrapper |
Boolean | A Python kerekes csomag használatának mérlegelése. |
scripts |
Parancs (karakterlánc) | A futtatandó parancsok |
use_legacy_run_as |
Boolean | Azt mérlegeljük, használjuk-e az örökölt run_as viselkedést. |
Git
Meghatározza a csomaghoz társított Git-verziókövetési adatokat. Lásd: git.
Kulcs | Típus | Leírás |
---|---|---|
origin_url |
Szál | Az adattár forrás URL-címe. Lásd: git. |
branch |
Szál | A Git-ág neve. Lásd: git. |
engedélyez
Meghatározza a Unity Catalog-objektumokhoz való hozzáférést. További információ: Csatlakozás a felhőbeli objektumtárhoz és -szolgáltatásokhoz a Unity Cataloghasználatával.
Kulcs | Típus | Leírás |
---|---|---|
principal |
Szál | Szükséges. Annak a felelősnek a neve, aki jogosultságokat kap. |
privileges |
Szál | Szükséges. A megadott entitásnak adható jogosultságok. |
Példa
Az alábbi példa egy Unity Catalog-sémát határoz meg támogatásokkal:
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"
zár
Meghatározza a csomag üzembehelyezési zárolási attribútumait.
Kulcs | Típus | Leírás |
---|---|---|
enabled |
Boolean | Engedélyezve van-e a zárolás. |
force |
Boolean | Meg kell-e kényszeríteni ezt a zárolási funkciót, ha engedélyezett. |
engedély
Egy adott entitás engedélyét határozza meg. Lásd: engedélyek és Erőforrások beállítása a Databricks-eszközcsomagokban.
Kulcs | Típus | Leírás |
---|---|---|
group_name |
Szál | Annak a csoportnak a neve, amelynek az engedélykészlete a level -ban van meghatározva. |
level |
Szál | Szükséges. Az engedélyre vonatkozóan definiált engedélyezett jogosultság a felhasználók, csoportok és szolgáltatásfők számára. |
service_principal_name |
Szál | Annak a szolgáltatási főazonosítónak a neve, amely engedéllyel rendelkezik a level helyen. |
user_name |
Szál | Annak a felhasználónak a neve, akinek a jogosultság level van beállítva. |
Engedélyek
A kötegben meghatározott kísérletekre, feladatokra, műveletekre és modellekre vonatkozó engedélyeket meghatározó sorozat, amelyben a sorozat minden eleme egy adott entitáshoz tartozó engedély.
Lásd: engedélyek és Erőforrások beállítása a Databricks-eszközcsomagokban.
Példa
permissions:
- level: CAN_VIEW
group_name: test-group
- level: CAN_MANAGE
user_name: someone@example.com
- level: CAN_RUN
service_principal_name: 123456-abcdef
Előbeállítások
A csomag üzembehelyezési előbeállításait határozza meg. Lásd: egyéni beállítások.
Kulcs | Típus | Leírás |
---|---|---|
jobs_max_concurrent_runs |
Egész szám | Egy feladat maximális egyidejű futtatásainak száma. |
name_prefix |
Szál | A csoport feladatfuttatásainak előtagja. |
pipelines_development |
Boolean | Meghatározza, hogy a pipeline telepítések fejlesztési módban legyenek-e zárolva. |
source_linked_deployment |
Boolean | Azt, hogy összekapcsolják-e az üzembe helyezést a csomag forrásával. |
tags |
Térkép | A csomag telepítésének címkéi. |
trigger_pause_status |
Szál | Szüneteltetés állapota, amely az összes feladat-eseményindítóra és ütemezésre érvényes. Az érvényes értékek PAUSED vagy UNPAUSED . |
Erőforrások
Egy térkép, amely meghatározza a csomag erőforrásait, ahol minden kulcs az erőforrás neve, az érték pedig egy térkép, amely meghatározza az erőforrást. További információ a Databricks-eszközcsomagok által támogatott erőforrásokról és az erőforrásdefiníciós referenciaról: Databricks Asset Bundles-erőforrások.
resources:
<resource-type>s:
<resource-name>:
<resource-field-name>: <resource-field-value>
Kulcs | Típus | Leírás |
---|---|---|
clusters |
Térkép | A csomag fürtdefiníciói, ahol minden kulcs egy fürt neve. Lásd csoport |
dashboards |
Térkép | A csomag irányítópult-definíciói, ahol minden kulcs az irányítópult neve. Lásd irányítópult |
experiments |
Térkép | A köteg kísérletdefiníciói, ahol minden kulcs a kísérlet neve. Lásd kísérlet |
jobs |
Térkép | A csomag feladatdefiníciói, ahol minden kulcs a feladat neve. Lásd feladat |
model_serving_endpoints |
Térkép | A csomag végpontdefinícióit kiszolgáló modell, ahol minden kulcs a végpontot kiszolgáló modell neve. Lásd: model_serving_endpoint |
models |
Térkép | A csomag modelldefiníciói, ahol minden kulcs a modell neve. Lásd: modell (örökölt) |
pipelines |
Térkép | A csomag folyamatdefiníciói, ahol minden kulcs a folyamat neve. Lásd folyamatvonal |
quality_monitors |
Térkép | A csomag minőségi monitorozási definíciói, ahol minden kulcs a minőségfigyelő neve. Lásd: quality_monitor (Unity Catalog) |
registered_models |
Térkép | A csomag regisztrált modelldefiníciói, ahol minden kulcs a Unity Katalógusban regisztrált modell neve. Lásd: registered_model (Unity Catalog) |
schemas |
Térkép | A csomag sémadefiníciói, ahol minden kulcs a séma neve. Lásd vázlatot (Unity Catalog) |
volumes |
Térkép | A köteg kötetdefiníciói, ahol minden kulcs a kötet neve. Lásd kötet (Unity Catalog) |
run_as
A Databricks Asset Bundles-munkafolyamatok futtatásakor használandó identitás. Lásd: Databricks Asset Bundles-munkafolyamat futtatási identitásának megadása.
Kulcs | Típus | Leírás |
---|---|---|
service_principal_name |
Szál | Egy aktív szolgáltatási főazonosító alkalmazásazonosítója. A mező beállításához servicePrincipal/user szerepkör szükséges. |
user_name |
Szál | Egy aktív munkaterület-felhasználó e-mail-címe. A nem rendszergazdai felhasználók ezt a mezőt csak saját e-mail-címükre állíthatják be. |
szinkronizál
A csomagba felvenni vagy kizárni kívánt fájlok és fájlelérési utak. Lásd szinkron.
Kulcs | Típus | Leírás |
---|---|---|
exclude |
Következés | A csomagból kizárandó fájlok vagy mappák listája. |
include |
Következés | A csomagba felvenni kívánt fájlok vagy mappák listája. |
paths |
Következés | A helyi mappa elérési útjai, amelyek a csomag gyökérkönyvtárán kívül is lehetnek, szinkronizálandók a munkaterülettel, amikor a csomag üzembe van helyezve. |
cél
A csomag üzembehelyezési céljait határozza meg. Lásd célok
Kulcs | Típus | Leírás |
---|---|---|
artifacts |
Térkép | A céltelepítésbe tartalmazandó elemek. Lásd: tárgyak. |
bundle |
Térkép | A csomagattribútumok a célra való telepítéskor. |
cluster_id |
Szál | A célhoz használatos klaszter azonosítója. |
compute_id |
Szál | Elavult. A célhoz használni kívánt számítás azonosítója. |
default |
Boolean | Azt jelzi, hogy ez-e az alapértelmezett cél. |
git |
Térkép | A cél Git-verziókövetési beállításai. Lásd: git. |
mode |
Szál | A cél üzembehelyezési módja. Az érvényes értékek development vagy production . Lásd Databricks-eszközcsomag üzembe helyezési módjait. |
permissions |
Következés | A csomag célban való üzembe helyezésére és futtatására vonatkozó engedélyek. Lásd: engedélyek. |
presets |
Térkép | A cél telepítési beállításai. Lásd: előbeállítások. |
resources |
Térkép | A cél erőforrás-definíciói. Lásd erőforrások. |
run_as |
Térkép | A csomag futtatásához használandó identitás. Lásd: run_as és A Databricks Asset Bundles-munkafolyamat futtatási identitásának megadása. |
sync |
Térkép | A csomag futtatásakor vagy üzembe helyezésekor a cél-munkaterületre szinkronizálandó helyi útvonalak. Lásd szinkron. |
variables |
Térkép | A cél egyéni változódefiníciói. Lásd: változók és Helyettesítések és változók a Databricks-eszközcsomagokban. |
workspace |
Térkép | A Databricks-munkaterület a cél számára. munkaterület |
Változók
A köteg egyéni változóit meghatározó térkép, ahol minden kulcs a változó neve, az érték pedig egy térkép, amely meghatározza a változót. Lásd: Helyettesítések és változók a Databricks-eszközcsomagokban.
Kulcs | Típus | Leírás |
---|---|---|
változó-név | Térkép | Egy változó definíciója. Lásd változónév. |
változó-név
Minden változódefiníció a következő attribútumokkal rendelkezik:
Kulcs | Típus | Leírás |
---|---|---|
description |
Szál | A változó leírása. |
lookup |
Szál | Annak a alert , cluster_policy , cluster , dashboard , instance_pool , job , metastore , pipeline , query , service_principal vagy warehouse objektumnak a neve, amelyhez az azonosítót le szeretné kérni. |
type |
Szál | A változó típusa. Az érvényes értékek a következők: complex . |
Munkaterület
Meghatározza a csomaghoz tartozó Databricks-munkaterületet. Lásd munkaterület.
Kulcs | Típus | Leírás |
---|---|---|
artifact_path |
Szál | A munkaterületen az üzembe helyezésekhez és a munkafolyamat-futtatásokhoz használandó összetevő elérési útja |
auth_type |
Szál | A hitelesítési típus. |
azure_client_id |
Szál | Az Azure-ügyfél azonosítója. |
azure_environment |
Szál | Az Azure-környezet. |
azure_login_app_id |
Szál | Az Azure bejelentkezési alkalmazás azonosítója. |
azure_tenant_id |
Szál | Az Azure-bérlő azonosítója. |
azure_use_msi |
Boolean | Használjunk-e MSI-t az Azure-hoz? |
azure_workspace_resource_id |
Szál | Az Azure-munkaterület erőforrás-azonosítója. |
client_id |
Szál | A munkaterület ügyfélazonosítója. |
file_path |
Szál | A munkaterületen az üzembe helyezéshez és a munkafolyamat-futtatáshoz használandó fájl elérési útja. |
google_service_account |
Szál | A Google szolgáltatásfiók neve. |
host |
Szál | A Databricks-munkaterület gazdagépének URL-címe. |
profile |
Szál | A Databricks-munkaterület profilneve. |
resource_path |
Szál | A munkaterület erőforrás-elérési útja. |
root_path |
Szál | A Databricks-munkaterület gyökérútvonala. |
state_path |
Szál | A munkaterület állapotának útvonala. |