Sdílet prostřednictvím

Referenční informace ke konfiguraci

Tento článek obsahuje referenční informace o klíčích podporovaných konfigurací sady prostředků Databricks (YAML). Podívejte se na Co jsou Databricks Asset Bundles?.

Kompletní příklady svazků najdete v tématu Příklady konfigurace svazku a úložiště GitHub svazků.

Artefakty

Type: Map

Definuje atributy pro sestavení artefaktů, kde každý klíč je název artefaktu, a hodnota je mapa, která definuje nastavení sestavení artefaktů. Informace o mapování artifacts naleznete v tématu artefakty.

Nastavení artefaktů definovaná na nejvyšší úrovni konfigurace sady je možné přepsat v mapování targets. Viz Přepsání s nastavením cíle.

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>
Klíč Typ Popis
build Řetězec Volitelná sada příkazů sestavení, které se mají spustit místně před nasazením.
dynamic_version logický Zda se má verze kola dynamicky opravovat na základě časového razítka souboru whl. Pokud je tato možnost nastavena na true, můžete nasadit nový kód, aniž byste museli aktualizovat verzi v setup.py nebo pyproject.toml. Toto nastavení je platné pouze v případě, že type je nastavena hodnota whl. Viz artefakty.
executable Řetězec Typ spustitelného souboru. Platné hodnoty jsou bash, sha cmd.
files Posloupnost Relativní nebo absolutní cesta k vytvořeným souborům artefaktů. Viz artefakty.name.files.
path Řetězec Místní cesta k adresáři artefaktu.
type Řetězec Vyžaduje se, pokud je artefakt kolečkem Pythonu. Typ artefaktu. Platné hodnoty jsou whl a jar.

Příklad

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

Artefakty. name.files

Type: Sequence

Relativní nebo absolutní cesta k vytvořeným souborům artefaktů.

Klíč Typ Popis
source Řetězec Povinné Zdrojový soubor artefaktu.

sada

Type: Map

Atributy balíčku při nasazování na tento cíl.

Klíč Typ Popis
cluster_id Řetězec ID clusteru, který se má použít ke spuštění sady. Viz cluster_id.
compute_id Řetězec Zavrhovaný. ID výpočetních prostředků, které se má použít ke spuštění sady.
databricks_cli_version Řetězec Verze rozhraní příkazového řádku Databricks, kterou použít pro balíček. Viz databricks_cli_version.
deployment Mapa Definice nasazení balíčku. Podporované atributy najdete v tématu Režimy nasazení sady prostředků Databricks. Viz bundle.deployment.
git Mapa Podrobnosti o správě verzí Gitu, které jsou přidružené k vaší sadě. Podporované atributy najdete v Gitu. Viz git.
name Řetězec Název sady.
uuid Řetězec Rezervovaný. Univerzální jedinečný identifikátor (UUID) pro sadu, která jednoznačně identifikuje sadu v interních systémech Databricks. To se vygeneruje, když se projekt sady inicializuje pomocí šablony Databricks (pomocí příkazu databricks bundle init).

nasazení balíčku

Type: Map

Definice nasazení balíčku

Klíč Typ Popis
fail_on_active_runs logický Zda selhat během aktivních běhů. Pokud je nastavená hodnota true, může být přerušeno nasazení, které je spuštěno.
lock Mapa Atributy blokování nasazení. Viz bundle.deployment.lock.

bundle.deployment.lock

Type: Map

Atributy blokování nasazení.

Klíč Typ Popis
enabled logický Určuje, jestli je tento zámek povolený.
force logický Zda se má tento zámek vynutit, pokud je povolený.

pokusný

Type: Map

Definuje atributy pro experimentální funkce.

Klíč Typ Popis
python Mapa Zavrhovaný. Místo toho použijte mapování Pythonu nejvyšší úrovně.
python_wheel_wrapper logický Zda použít obal ve formátu Python Wheel.
scripts Mapa Příkazy ke spuštění.
use_legacy_run_as logický Zda použít starší režim "run_as".

zahrnovat

Type: Sequence

Určuje seznam cest globů, které obsahují konfigurační soubory, které se mají zahrnout do sady. Viz include.

oprávnění

Type: Sequence

Sekvence, která definuje oprávnění, která se mají použít u prostředků definovaných v sadě, kde každá položka v sekvenci je oprávnění pro konkrétní entitu.

Viz oprávnění a Nastavte oprávnění pro prostředky v balíčcích prostředků Databricks.

Klíč Typ Popis
group_name Řetězec Název skupiny, která má oprávnění nastavenou na úrovni.
level Řetězec Povolení povolené pro uživatele, skupinu nebo služební účet definované pro toto oprávnění. Platné hodnoty pro tento klíč se liší v závislosti na tom, jestli jsou oprávnění definována na nejvyšší úrovni sady nebo pro konkrétní prostředek. Viz Nastavení oprávnění pro prostředky v sadě prostředků Databricks.
service_principal_name Řetězec Název service principalu, který má oprávnění nastaveno na úrovni.
user_name Řetězec Jméno uživatele, který má oprávnění nastavenou na úrovni.

Příklad

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

předvolby

Type: Map

Definuje přednastavení nasazení balíčku. Viz Vlastní nastavení.

Klíč Typ Popis
jobs_max_concurrent_runs Celé číslo Maximální počet souběžných spuštění pro úlohu.
name_prefix Řetězec Předpona pro spuštění úloh balíku.
pipelines_development logický Určuje, jestli by se nasazování pipeline měla uzamknout v režimu vývoje.
source_linked_deployment logický Určuje, zda má být nasazení propojeno se zdrojem balíčku.
tags Mapa Značky pro nasazení balíčku.
trigger_pause_status Řetězec Stav pozastavení, který se použije pro všechny triggery a plány úloh. Platné hodnoty jsou PAUSED nebo UNPAUSED.

krajta

Type: Map

Konfiguruje načítání kódu Pythonu definovaného pomocí balíčku databricks-bundles. Další informace najdete v tématu Konfigurace balíčku v Pythonu.

Klíč Typ Popis
mutators Posloupnost Mutátory obsahují seznam plně kvalifikovaných cest funkcí k funkcím mutátoru, například [my_project.mutators:add_default_cluster].
resources Posloupnost Prostředky obsahují seznam plně kvalifikovaných cest funkcí pro načtení prostředků definovaných v kódu Pythonu, například ["my_project.resources:load_resources"]
venv_path Řetězec Cesta k virtuálnímu prostředí. Pokud je tato možnost povolená, kód Pythonu se spustí v tomto prostředí. Pokud je tato možnost zakázaná, ve výchozím nastavení se použije interpret Pythonu dostupný v aktuálním prostředí.

prostředky

Type: Map

Mapa, která definuje prostředky pro sadu, kde každý klíč je název prostředku, a hodnota je mapa, která definuje prostředek. Další informace o podporovaných prostředcích Databricks Asset Bundles a referenční definici prostředků najdete v tématu prostředky Databricks Asset Bundles.

resources:
  <resource-type>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Klíč Typ Popis
alerts Mapa Definice výstrahy (v2) pro sadu, kde každý klíč je název výstrahy. Podívejte se na upozornění.
apps Mapa Definice aplikace Databricks pro sadu, kde každý klíč je název aplikace. Viz aplikace.
clusters Mapa Definice clusteru pro sadu, kde každý klíč je název clusteru. Viz cluster.
dashboards Mapa Definice řídicího panelu pro sadu, kde každý klíč je název řídicího panelu. Podívejte se na řídicí panel .
database_catalogs Mapa Definice katalogu databází pro sadu, kde každý klíč je název katalogu databáze. Viz database_catalog.
database-instances Mapa Definice instance databáze pro sadu, kde každý klíč je název instance databáze. Viz database_instance.
experiments Mapa Definice experimentů pro sadu, kde každý klíč je název experimentu. Viz experiment.
jobs Mapa Definice úloh pro sadu, kde každý klíč je název úlohy. Podívejte se na úlohu.
model_serving_endpoints Mapa Definice koncových bodů obsluhy modelu pro balíček, kde každý klíč je název koncového bodu obsluhy modelu. Viz model_serving_endpoint.
models Mapa Definice modelu pro sadu, kde každý klíč je název modelu. Viz model (starší verze).
pipelines Mapa Definice kanálu pro sadu, kde každý klíč je název kanálu. Viz kanál.
quality_monitors Mapa Definice monitorování kvality pro sadu, kde každý klíč je název monitorování kvality. Viz také quality_monitor (Unity Catalog).
registered_models Mapa Definice registrovaného modelu pro sadu, kde každý klíč je název zaregistrovaného modelu Katalogu Unity. Viz registered_model (katalog Unity).
schemas Mapa Definice schématu pro sadu, kde každý klíč je název schématu. Viz schéma (katalog Unity).
secret_scopes Mapa Definice tajných rozsahů pro sadu, kde každý klíč je název tajného rozsahu. Viz secret_scope.
sql_warehouses Mapa Definice SQL skladů pro sadu, kde každý klíč představuje název SQL skladu. Viz sql_warehouse.
synced_database_tables Mapa Definice synchronizované databázové tabulky pro sadu, kde každý klíč je název tabulky databáze. Viz synced_database_table.
volumes Mapa Definice objemů pro balík, kde každý klíč je název objemu. Podívejte se na svazek (Katalog Unity).

run_as

Type: Map

Identita, která se má použít při spouštění pracovních postupů Databricks Asset Bundles. Viz Specifikujte identifikátor spuštění pro pracovní postup Balíčky prostředků Databricks.

Klíč Typ Popis
service_principal_name Řetězec ID aplikace aktivního služebního principála. Nastavení tohoto pole vyžaduje roli servicePrincipal/user.
user_name Řetězec E-mail aktivního uživatele pracovního prostoru Uživatelé, kteří nejsou správci, můžou toto pole nastavit jenom na vlastní e-mail.

skripty

Type: Map

Skripty, které lze spustit pomocí bundle run. Viz Spouštění skriptů.

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>
Klíč Typ Popis
content Řetězec Příkazy ke spuštění

synchronizace

Type: Map

Soubory a cesty k souborům, které chcete zahrnout nebo vyloučit do sady. Viz synchronizace.

Klíč Typ Popis
exclude Posloupnost Seznam souborů nebo složek, které chcete ze sady vyloučit.
include Posloupnost Seznam souborů nebo složek, které se mají zahrnout do sady.
paths Posloupnost Místní cesty ke složkám, které mohou být mimo kořen sady, by se měly synchronizovat s pracovním prostorem při nasazení sady.

cíle

Type: Map

Definuje cíle nasazení pro balíček. Podívejte se na cíle 

targets:
  <target-name>:
    <target-field-name>: <target-field-value>
Klíč Typ Popis
artifacts Mapa Artefakty, které se mají zahrnout do cílového nasazení. Viz artefakty.
bundle Mapa Atributy balíčku při nasazování na tento cíl. Viz balíček.
cluster_id Řetězec ID clusteru, který se má použít pro tento cíl.
compute_id Řetězec Zavrhovaný. ID výpočetních prostředků, které se mají použít pro tento cíl.
default logický Určuje, jestli je tento cíl výchozím cílem.
git Mapa Nastavení správy verzí Gitu pro cílový objekt. Viz git.
mode Řetězec Režim nasazení pro cíl. Platné hodnoty jsou development nebo production. Viz režimy nasazení sady prostředků Databricks.
permissions Posloupnost Oprávnění pro nasazení a spuštění sady v cíli. Zobrazit oprávnění
presets Mapa Přednastavení nasazení pro cíl. Viz přednastavení.
resources Mapa Definice prostředků pro cíl. Podívejte se na zdroje informací.
run_as Mapa Identita, která se má použít ke spuštění sady prostředků, najdete v tématu Určení identity spuštění pro pracovní postup Sady prostředků Databricks. Viz run_as.
sync Mapa Místní cesty pro synchronizaci s cílovým pracovním prostorem při spuštění nebo nasazení sady. Viz synchronizace.
variables Mapa Definice vlastních proměnných pro cíl. Viz proměnné.
workspace Mapa Pracovní prostor Databricks pro konkrétní účel. Viz pracovní prostor.

proměnné

Type: Map

Definuje vlastní proměnnou pro sadu. Viz proměnné.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>
Klíč Typ Popis
default Jakýkoliv Výchozí hodnota proměnné.
description Řetězec Popis proměnné.
lookup Mapa Název alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalnebo warehouse objekt, pro který se má načíst ID. Viz proměnné.name.lookup.
type Řetězec Typ proměnné, jednoduché nebo složité. Tento klíč nastavte pouze v případě, že je proměnná složitá. Platné hodnoty: complex.

proměnné. name.lookup

Type: Map

Název výstrahy, cluster_policy, clusteru, řídicího panelu, instance_pool, úlohy, metastoru, kanálu, dotazu, service_principal nebo objektu skladu, pro který se má načíst ID. Informace o použití vyhledávání naleznete v tématu Načtení hodnoty ID objektu.

Klíč Typ Popis
alert Řetězec Název výstrahy, jejíž ID má být načteno.
cluster Řetězec Název clusteru, pro který se má načíst ID.
cluster_policy Řetězec Název cluster_policy, pro který se má načíst ID.
dashboard Řetězec Název řídicího panelu, pro který je třeba načíst ID.
instance_pool Řetězec Název „instance_pool“, pro které se má získat ID.
job Řetězec Název úlohy, pro kterou se má načíst ID.
metastore Řetězec Název metastoru, pro který se má načíst ID.
notification_destination Řetězec Název "notification_destination", pro který má být načteno ID.
pipeline Řetězec Název kanálu, pro který se má načíst ID.
query Řetězec Název dotazu, pro který se má načíst ID.
service_principal Řetězec Název service_principal, pro který se má načíst ID.
warehouse Řetězec Název skladu, pro který se má načíst ID.

pracovní prostor

Type: Map

Definuje pracovní prostor Databricks pro balíček. Viz pracovní prostor.

Klíč Typ Popis
artifact_path Řetězec Cesta artefaktu, která se má použít v rámci pracovního prostoru pro nasazení i spuštění pracovního postupu
auth_type Řetězec Typ ověřování.
azure_client_id Řetězec ID klienta Azure
azure_environment Řetězec Prostředí Azure
azure_login_app_id Řetězec ID přihlašovací aplikace Azure
azure_tenant_id Řetězec ID klienta Azure
azure_use_msi logický Zda se má používat MSI pro Azure
azure_workspace_resource_id Řetězec ID prostředku pracovního prostoru Azure
client_id Řetězec ID klienta pro pracovní prostor
file_path Řetězec Cesta k souboru, která se má použít v rámci pracovního prostoru pro nasazení i spuštění pracovního postupu
google_service_account Řetězec Název účtu služby Google
host Řetězec Adresa URL hostitele pracovního prostoru Databricks
profile Řetězec Název profilu pracovního prostoru Databricks
resource_path Řetězec Cesta zdroje pracovního prostoru
root_path Řetězec Kořenová cesta pracovního prostoru Databricks
state_path Řetězec Cesta stavu pracovního prostoru

Běžné objekty

Git

Type: Map

Definuje podrobnosti správy verzí Gitu.

Klíč Typ Popis
branch Řetězec Název větve Git. Viz git.
origin_url Řetězec Počáteční adresa URL úložiště. Viz git.
  • Last updated on