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 sad najdete v tématu Příklady konfigurace sady a příklady sady prostředků v úložišti GitHub.

artefakt

Definuje nastavení pro sestavení artefaktu.

Klíč	Typ	Popis
build	Řetězec	Volitelná sada ne výchozích příkazů sestavení, které se mají spustit místně před nasazením.
executable	Řetězec	Typ spustitelného souboru. Platné hodnoty jsou bash, sha cmd.
files	Mapa	Zdrojové soubory artefaktu definované jako artifact_file.
path	Řetězec	Umístění, kam se uloží vytvořený artefakt.
type	Řetězec	Povinné Typ artefaktu. Platné hodnoty jsou whl.

Artefakty

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 Definování nastavení artefaktů v balíčku prostředků Databricks.

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

Příklad

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

artefakt_soubor

Definuje soubor artefaktu v sadě.

Klíč	Typ	Popis
source	Řetězec	Povinné Cesta k souborům použitým k sestavení artefaktu.

balíček

Atributy balíčku. Podívejte se na sadu .

Klíč	Typ	Popis
cluster_id	Řetězec	ID clusteru, který se má použít ke spuštění sady. Viz cluster_id.
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 u nasazení a režimů nasazení sady Databricks Asset Bundle .
git	Mapa	Podrobnosti o správě verzí Gitu, které jsou přidružené k vaší sadě. Podporované atributy viz git a git.
name	Řetězec	Povinné 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í

Definuje atributy nasazení sady.

Klíč	Typ	Popis
fail_on_active_runs	Booleovský	Zda selhat během aktivních běhů. Pokud je tato možnost nastavená na true může být přerušeno nasazení, které běží.
lock	Mapa	Atributy blokování nasazení. Viz zámek.

pokusný

Definuje atributy pro experimentální funkce.

Klíč	Typ	Popis
python_wheel_wrapper	Booleovský	Zda použít obal ve formátu Python Wheel.
scripts	Příkaz (řetězec)	Příkazy ke spuštění
use_legacy_run_as	Booleovský	Zda použít starší režim "run_as".

git

Definuje podrobnosti o správě verzí Gitu, které jsou přidružené k sadě. Viz git.

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

grant

Definuje přístup k objektům katalogu Unity. Další informace najdete v tématu Jak se připojit ke cloudovému úložišti objektů a službám pomocí Katalogu Unity.

Klíč	Typ	Popis
principal	Řetězec	Povinné Název subjektu, kterému budou udělena oprávnění.
privileges	Řetězec	Povinné Oprávnění k udělení zadané entitě.

Příklad

Následující příklad definuje schéma katalogu Unity s granty:

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"

zamknout / zámek

Definuje atributy zámku pro nasazení sady.

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

povolení

Definuje 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 v level.
level	Řetězec	Povinné Povolení povolené pro uživatele, skupinu nebo služební účet definované pro toto oprávnění.
service_principal_name	Řetězec	Název služebního principála, který má oprávnění nastavena v level.
user_name	Řetězec	Jméno uživatele, který má oprávnění nastaveno v level.

oprávnění

Sekvence, která definuje oprávnění, která se mají použít pro experimenty, úlohy, kanály a modely definované 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.

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

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

Klíč	Typ	Popis
jobs_max_concurrent_runs	Integer	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	Booleovský	Určuje, jestli by se nasazování pipeline měla uzamknout v režimu vývoje.
source_linked_deployment	Booleovský	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.

prostředky

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>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>

Klíč	Typ	Popis
clusters	Mapa	Definice clusteru pro sadu, kde každý klíč je název clusteru. Podívej se na cluster
dashboards	Mapa	Definice řídicího panelu pro sadu, kde každý klíč je název řídicího panelu. Viz řídicího panelu
experiments	Mapa	Definice experimentů pro sadu, kde každý klíč je název experimentu. Viz experimentu
jobs	Mapa	Definice úloh pro sadu, kde každý klíč je název úlohy. Viz ú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. Podívejte se na 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. Podívejte se na quality_monitor (katalogu Unity)
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)
volumes	Mapa	Definice objemů pro balík, kde každý klíč je název objemu. Viz svazku (Katalog Unity)

run_as

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.

synchronizovat

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íl

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

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.
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	Booleovský	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. Viz oprávnění.
presets	Mapa	Přednastavení nasazení pro cíl. Viz předvolby .
resources	Mapa	Definice prostředků pro cíl. Viz prostředky.
run_as	Mapa	Identita, která se má použít ke spuštění sady. Viz run_as a Určete identitu spuštění pro pracovní postup Databricks Asset Bundles.
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. Vizte proměnné a nahrazení a proměnné v balíčcích prostředků Databricks.
workspace	Mapa	Pracovní prostor Databricks pro konkrétní účel. pracovního prostoru

proměnné

Mapa, která definuje vlastní proměnné pro sadu, kde každý klíč je název proměnné, a hodnota je Mapa, která definuje proměnnou. Viz náhrady a proměnné v sadách prostředků Databricks.

Klíč	Typ	Popis
název proměnné	Mapa	Definice proměnné. Viz název proměnné.

název proměnné

Každá definice proměnné má následující atributy:

Klíč	Typ	Popis
description	Řetězec	Popis proměnné.
lookup	Řetězec	Název alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalnebo warehouse objekt, pro který se má načíst ID.
type	Řetězec	Typ proměnné. Platné hodnoty jsou complex.

pracovní plocha

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	Booleovský	Určuje, jestli se má MSI používat 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.