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

Určuje artefakty, které se mají automaticky sestavit během nasazení sady, které je možné použít později v spuštění sady. Každý klíč je název artefaktu a hodnota je mapa, která definuje nastavení sestavení artefaktů.

Návod

Nastavení artefaktů v balíčcích můžete definovat, kombinovat a přepsat, jak je popsáno v přepsání pomocí cílových nastavení.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

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. V případě sestavení Python wheel balíčků rozhraní příkazového řádku Databricks předpokládá, že dokáže najít místní instalaci balíčku Pythonu wheel ke spuštění sestavení a při každém nasazení balíčku ve výchozím nastavení spustí příkaz python setup.py bdist_wheel. Zadejte více příkazů sestavení na samostatných řádcích.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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.
Přidání do Rozhraní příkazového řádku Databricks verze 0.245.0
executable Řetězec Typ spustitelného souboru. Platné hodnoty jsou bash, sha cmd.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
files Posloupnost Relativní nebo absolutní cesta k vytvořeným souborům artefaktů. Viz artefakty.name.files.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
path Řetězec Místní cesta k adresáři artefaktu. Cesty jsou relativní vzhledem k umístění konfiguračního souboru sady. V případě sestavení kol Pythonu se jedná o cestu k souboru setup.py kola Pythonu. Pokud path není zahrnutý, rozhraní příkazového řádku Databricks se pokusí najít soubor setup.py kola Pythonu v kořenovém adresáři sady.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
type Řetězec Vyžaduje se, pokud je artefakt kolečkem Pythonu. Typ artefaktu. Platné hodnoty jsou whl a jar. Toto nastavení není nutné zadávat, aby bylo možné sestavit další artefakty.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Příklady

Následující konfigurace sestaví kolo Pythonu pomocí básně:

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

Následující konfigurace spustí testy a sestaví kolo. Kompletní kurz sady, který používá artifacts k sestavení kola, najdete v tématu Vytvoření souboru kola Pythonu pomocí sad prostředků Databricks.

artifacts:
  default:
    type: whl
    build: |-
      # run tests
      python -m pytest tests/ -v

      # build the actual artifact
      python setup.py bdist_wheel

    path: .

Příklad konfigurace, která sestaví soubor JAR a nahraje ho do katalogu Unity, najdete v části Sada, která nahraje soubor JAR do katalogu Unity.

Artefakty. name.files

Type: Sequence

Relativní nebo absolutní cesta k vytvořeným souborům artefaktů. Slouží source k určení sestavených artefaktů. Cesty jsou relativní vzhledem k umístění konfiguračního souboru sady.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Klíč Typ Popis
source Řetězec Povinné Zdrojový soubor artefaktu.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

sada

Type: Map

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

Konfigurační soubor sady musí obsahovat pouze jedno mapování nejvyšší úrovně bundle .

Toto bundle mapování musí obsahovat name mapování, které určuje programový (nebo logický) název sady. Následující příklad deklaruje sadu s programovým (nebo logickým) názvem hello-bundle.

bundle:
  name: hello-bundle

Mapování bundle může být také podřízené jednomu nebo více cílům v mapování cílů na nejvyšší úrovni. Každé z těchto podřízených bundle mapování určuje jakákoli jiná než výchozí přepsání na cílové úrovni.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Klíč Typ Popis
cluster_id Řetězec ID clusteru, který se má použít ke spuštění sady. Tento klíč umožňuje zadat ID clusteru, které se má použít jako přepsání pro clustery definované jinde v konfiguračním souboru sady. Informace o tom, jak načíst ID clusteru, najdete v tématu Adresa URL a ID výpočetního prostředku.
Přepsání cluster_id je určeno pro scénáře pouze pro vývoj a je podporováno pouze pro cíl, který má mapování mode nastaveno na development. Další informace o mapování najdete v target tématu cíle.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
compute_id Řetězec Zavrhovaný. ID výpočetních prostředků, které se má použít ke spuštění sady.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
databricks_cli_version Řetězec Verze rozhraní příkazového řádku Databricks, kterou použít pro balíček. Viz bundle.databricks_cli_version.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
deployment Mapa Definice nasazení balíčku. Podporované atributy najdete v tématu Režimy nasazení sady prostředků Databricks. Viz bundle.deployment.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
git Mapa Podrobnosti o správě verzí Gitu, které jsou přidružené k vaší sadě. Podporované atributy najdete v Gitu.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
name Řetězec Název sady.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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).
Přidání do Rozhraní příkazového řádku Databricks verze 0.236.0

bundle.databricks_cli_version

Mapování bundle může obsahovat databricks_cli_version mapování, které omezuje verzi rozhraní příkazového řádku Databricks vyžadovanou balíčkem. To může zabránit problémům způsobeným použitím mapování, která nejsou podporována v určité verzi rozhraní příkazového řádku Databricks.

Verze rozhraní příkazového řádku Databricks odpovídá sémantickému verzování a databricks_cli_version mapování podporuje specifikaci verzových omezení. Pokud aktuální databricks --version hodnota není v mezích zadaných v mapování sady databricks_cli_version, nastane chyba když je databricks bundle validate spuštěn na sadě. Následující příklady ukazují některé běžné syntaxe omezení verzí:

bundle:
  name: hello-bundle
  databricks_cli_version: '0.218.0' # require Databricks CLI 0.218.0
bundle:
  name: hello-bundle
  databricks_cli_version: '0.218.*' # allow all patch versions of Databricks CLI 0.218
bundle:
  name: my-bundle
  databricks_cli_version: '>= 0.218.0' # allow any version of Databricks CLI 0.218.0 or higher
bundle:
  name: my-bundle
  databricks_cli_version: '>= 0.218.0, <= 1.0.0' # allow any Databricks CLI version between 0.218.0 and 1.0.0, inclusive

bundle.deployment

Type: Map

Definice nasazení balíčku

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

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.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
lock Mapa Atributy blokování nasazení. Viz bundle.deployment.lock.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

bundle.deployment.lock

Type: Map

Atributy blokování nasazení.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Klíč Typ Popis
enabled logický Určuje, jestli je tento zámek povolený.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
force logický Zda se má tento zámek vynutit, pokud je povolený.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

pokusný

Type: Map

Definuje atributy pro experimentální funkce.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Klíč Typ Popis
python Mapa Zavrhovaný. Místo toho použijte mapování Pythonu nejvyšší úrovně.
Přidání do Rozhraní příkazového řádku Databricks verze 0.238.0
python_wheel_wrapper logický Zda použít obal ve formátu Python Wheel.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
scripts Mapa Příkazy ke spuštění.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
skip_artifact_cleanup logický Určuje, zda se má přeskočit odstranění .internal složky v rámci workspace.artifact_path. Ve výchozím nastavení se tato složka odstraní před nahráním nových artefaktů sestavení (jako jsou kola Pythonu) během nasazování. Nastaví se tak, aby true se zachovaly existující artefakty napříč nasazeními.
Přidání do Rozhraní příkazového řádku Databricks verze 0.254.0
skip_name_prefix_for_schema logický Určuje, jestli se má přeskočit přidání předpony (nastavené nebo presets.name_prefix vypočítané v mode: developmentpřípadě), do názvů schémat katalogu Unity definovaných v sadě.
Přidání do Rozhraní příkazového řádku Databricks verze 0.255.0
use_legacy_run_as logický Zda použít starší režim "run_as".
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

zahrnovat

Type: Sequence

Určuje seznam cest globů, které obsahují konfigurační soubory, které se mají zahrnout do sady. Tyto vzory cest jsou relativní vzhledem k umístění konfiguračního souboru balíčku, ve kterém jsou zadány vzory cest. databricks.ymlKromě , musíte použít include pole k určení všech konfiguračních souborů, které mají být zahrnuty do sady.

Návod

Pokud chcete do sady zahrnout nebo vyloučit jiné soubory, použijte zahrnutí a vyloučení.

Toto include pole se může zobrazit pouze jako mapování nejvyšší úrovně.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Následující příklad konfigurace obsahuje tři konfigurační soubory. Tyto soubory jsou ve stejné složce jako konfigurační soubor sady:

include:
  - 'bundle.artifacts.yml'
  - 'bundle.resources.yml'
  - 'bundle.targets.yml'

Následující příklad konfigurace zahrnuje všechny soubory s názvy souborů, které začínají bundle a končí na .yml. Tyto soubory jsou ve stejné složce jako konfigurační soubor sady:

include:
  - 'bundle*.yml'

oprávnění

Type: Sequence

Definuje oprávnění, která se mají použít u prostředků definovaných v sadě, kde každá položka v sekvenci představuje oprávnění pro konkrétní entitu. Viz Nastavení oprávnění pro prostředky v sadě prostředků Databricks.

Povolené úrovně oprávnění nejvyšší úrovně jsou CAN_VIEW, CAN_MANAGEa CAN_RUN.

Pokud chcete u konkrétního prostředku použít oprávnění, přečtěte si téma Definovat oprávnění pro konkrétní prostředek.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Klíč Typ Popis
group_name Řetězec Název skupiny, která má oprávnění nastavenou na úrovni.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
service_principal_name Řetězec Název service principalu, který má oprávnění nastaveno na úrovni.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
user_name Řetězec Jméno uživatele, který má oprávnění nastavenou na úrovni.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Příklad

Následující příklad konfigurace definuje úrovně oprávnění pro uživatele, skupinu a instanční objekt, které se použijí pro všechny prostředky definované v resources sadě:

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. Další informace naleznete v tématu Vlastní předvolby.

Pokud není pro předvolbu zadána výjimka, pokud jsou nastaveny obě mode a presets jsou nastaveny, přednastavení přepíší výchozí chování režimu a nastavení jednotlivých prostředků přepíší přednastavení.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Preset Popis
artifacts_dynamic_version Určuje, jestli se má dynamicky aktualizovat verze whl artefaktů během nasazování. Platné hodnoty jsou true nebo false. Pokud je zadané nastavení konfigurace nejvyšší úrovně artifacts.dynamic_version, přepíše tuto předvolbu.
Přidání do Rozhraní příkazového řádku Databricks verze 0.256.0
jobs_max_concurrent_runs Počet maximálních povolených souběžných spuštění pro úlohy
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
name_prefix Řetězec předpony, který se přidá před názvy zdrojů.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
pipelines_development Určuje, jestli by se nasazování pipeline měla uzamknout v režimu vývoje. Platné hodnoty jsou true nebo false.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
source_linked_deployment Určuje, jestli prostředky vytvořené během nasazení odkazují na zdrojové soubory v pracovním prostoru místo jejich kopií v pracovním prostoru.
Přidání do Rozhraní příkazového řádku Databricks verze 0.236.0
tags Sada tagů ve formátu key:value, které se vztahují na všechny zdroje podporující tagy, včetně úloh a experimentů. Sady prostředků Databricks nepodporují tagy pro prostředek schema.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
trigger_pause_status Stav pozastavení, který se použije pro všechny triggery a plány. Platné hodnoty jsou PAUSED nebo UNPAUSED.
Je-li mode nastavena na development, trigger_pause_status je vždy PAUSED.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

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.

Přesunuto z experimental rozhraní příkazového řádku Databricks verze 0.275.0

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].
Přidání do Rozhraní příkazového řádku Databricks verze 0.238.0
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"]
Přidání do Rozhraní příkazového řádku Databricks verze 0.238.0
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í.
Přidání do Rozhraní příkazového řádku Databricks verze 0.238.0

prostředky

Type: Map

Definuje prostředky pro sadu, kde každý klíč je název prostředku, a hodnota je mapa, která prostředek definuje. 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.

Mapování resources se může zobrazit jako mapování nejvyšší úrovně nebo může být podřízeným objektem jednoho nebo více cílů v mapování cílů nejvyšší úrovně a zahrnuje nula nebo jeden z podporovaných typů prostředků. Každé mapování typu prostředku zahrnuje jednu nebo více jednotlivých deklarací prostředků, které musí mít jedinečný název. Tyto deklarace jednotlivých prostředků k definování prostředku používají datovou část požadavku odpovídajícího objektu create, vyjádřenou v YAML. Podporované vlastnosti prostředku jsou odpovídající podporovaná pole objektu.

Datové části žádosti o vytvoření operace jsou zdokumentované v referenčních informacích k rozhraní REST API Databricks a databricks bundle schema příkaz vypíše všechna podporovaná schémata objektů. Kromě toho příkaz databricks bundle validate vrátí upozornění, pokud se v konfiguračních souborech sady nacházejí neznámé vlastnosti prostředků.

Pro více informací o prostředcích podporovaných v balíčcích, stejně jako o běžné konfiguraci a příkladech, viz prostředky Databricks Asset Bundles a příklady konfigurace balíčků.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

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í.
Přidání do Rozhraní příkazového řádku Databricks verze 0.279.0
apps Mapa Definice aplikace Databricks pro sadu, kde každý klíč je název aplikace. Viz aplikace.
Přidáno v Rozhraní příkazového řádku Databricks verze 0.239.0
catalogs Mapa Definice katalogu (Katalog Unity) pro sadu, kde každý klíč je název katalogu. Podívejte se na katalogy.
Přidání do Rozhraní příkazového řádku Databricks verze 0.287.0
clusters Mapa Definice clusteru pro sadu, kde každý klíč je název clusteru. Viz cluster.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
dashboards Mapa Definice řídicího panelu pro sadu, kde každý klíč je název řídicího panelu. Podívejte se na řídicí panel .
Přidání do Rozhraní příkazového řádku Databricks verze 0.232.0
database_catalogs Mapa Definice katalogu databází pro sadu, kde každý klíč je název katalogu databáze. Viz database_catalog.
Přidání do Rozhraní příkazového řádku Databricks verze 0.265.0
database_instances Mapa Definice instance databáze pro sadu, kde každý klíč je název instance databáze. Viz database_instance.
Přidání do Rozhraní příkazového řádku Databricks verze 0.265.0
experiments Mapa Definice experimentů pro sadu, kde každý klíč je název experimentu. Viz experiment.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
jobs Mapa Definice úloh pro sadu, kde každý klíč je název úlohy. Podívejte se na úlohu.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
models Mapa Definice modelu pro sadu, kde každý klíč je název modelu. Viz model (starší verze).
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
pipelines Mapa Definice kanálu pro sadu, kde každý klíč je název kanálu. Viz kanál.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
postgres_branches Mapa Definice větve Postgres pro sadu, kde každý klíč je název větve Lakebase. Viz postgres_branch.
Přidání do Rozhraní příkazového řádku Databricks verze 0.287.0
postgres_endpoints Mapa Definice koncového bodu Postgres pro sadu, kde každý klíč je název koncového bodu výpočetního bodu Lakebase. Viz postgres_endpoint.
Přidání do Rozhraní příkazového řádku Databricks verze 0.287.0
postgres_projects Mapa Definice projektu Postgres pro sadu, kde každý klíč je název projektu Lakebase. Viz postgres_project.
Přidání do Rozhraní příkazového řádku Databricks verze 0.287.0
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).
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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).
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
schemas Mapa Definice schématu pro sadu, kde každý klíč je název schématu. Viz schéma (katalog Unity).
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
secret_scopes Mapa Definice tajných rozsahů pro sadu, kde každý klíč je název tajného rozsahu. Viz secret_scope.
Přidání do Rozhraní příkazového řádku Databricks verze 0.252.0
sql_warehouses Mapa Definice SQL skladů pro sadu, kde každý klíč představuje název SQL skladu. Viz sql_warehouse.
Přidání do Rozhraní příkazového řádku Databricks verze 0.260.0
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.
Přidání do Rozhraní příkazového řádku Databricks verze 0.266.0
volumes Mapa Definice objemů pro balík, kde každý klíč je název objemu. Podívejte se na svazek (Katalog Unity).
Přidání do Rozhraní příkazového řádku Databricks verze 0.236.0

Příklad

Následující příklad konfigurace definuje prostředek úlohy.

resources:
  jobs:
    hello-job:
      name: hello-job
      tasks:
        - task_key: hello-task
          existing_cluster_id: 1234-567890-abcde123
          notebook_task:
            notebook_path: ./hello.py

run_as

Type: Map

Identita (user_name nebo service_principal_name), která se má použít ke spuštění pracovních postupů Sady prostředků Databricks. Poskytuje možnost oddělit identitu použitou k nasazení úlohy sady nebo potrubí od identity použité k spuštění úlohy nebo potrubí. Viz Specifikujte identifikátor spuštění pro pracovní postup Balíčky prostředků Databricks.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

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.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

skripty

Type: Map

Skripty, které lze spustit pomocí bundle run. Každý pojmenovaný skript v scripts mapování obsahuje obsah s příkazy. Viz Spouštění skriptů.

Přidání do Rozhraní příkazového řádku Databricks verze 0.259.0

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>
Klíč Typ Popis
content Řetězec Příkazy ke spuštění
Přidání do Rozhraní příkazového řádku Databricks verze 0.259.0

Příklady

scripts:
  my_script:
    content: uv run pytest -m ${bundle.target}

synchronizace

Type: Map

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

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Klíč Typ Popis
exclude Posloupnost Seznam souborů nebo složek, které chcete ze sady vyloučit. Viz zahrnutí a vyloučení.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
include Posloupnost Seznam souborů nebo složek, které se mají zahrnout do sady. Viz zahrnutí a vyloučení.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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. Viz sync.paths.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

zahrnutí a vyloučení

Mapování include a exclude v rámci mapování sync určuje seznam souborů nebo složek, které mají být zahrnuty, nebo vyloučeny z nasazení balíčků, v závislosti na následujících pravidlech:

  • Na základě jakéhokoli seznamu globů souborů a cest v souboru v kořenovém adresáři sady může mapování obsahovat seznam globů souborů, globů cest nebo obojího vzhledem ke kořenovému adresáři sady, které mají být explicitně zahrnuty.
  • Na základě libovolného seznamu globů souborů a cest v souboru v .gitignore kořenovém adresáři balíčku a seznamu globů souborů a cest v include mapování může mapování exclude obsahovat seznam globů souborů, globů cest nebo obojího vzhledem ke kořenovému adresáři balíčku pro explicitní vyloučení.

Všechny cesty k zadaným souborům a složkám jsou relativní vzhledem k umístění konfiguračního souboru sady, ve kterém jsou zadané.

Syntaxe vzorů include souborů a exclude cest se řídí standardní .gitignore syntaxí vzorů. Podívejte se na formát vzoru .gitignore.

Pokud například následující .gitignore soubor obsahuje následující položky:

.databricks
my_package/dist

Konfigurační soubor sady obsahuje následující include mapování:

sync:
  include:
    - my_package/dist/*.whl

Všechny soubory ve my_package/dist složce s příponou *.whl souboru jsou zahrnuty. Žádné jiné soubory ve my_package/dist složce nejsou zahrnuty.

Pokud však konfigurační soubor sady obsahuje také následující exclude mapování:

sync:
  include:
    - my_package/dist/*.whl
  exclude:
    - my_package/dist/delete-me.whl

Všechny soubory ve složce my_package/dist s příponou *.whl, kromě souboru s názvem delete-me.whl, jsou zahrnuty. Všechny ostatní soubory ve složce my_package/dist také nejsou zahrnuty.

Mapování sync lze také deklarovat v rámci targets mapování pro určitou cílovou oblast. Jakékoli sync mapování deklarované v rámci cíle je sloučeno s deklaracemi mapování nejvyšší úrovně sync. Například v návaznosti na předchozí příklad se následující include mapování na úrovni targets sloučí s mapováním include v mapování nejvyšší úrovně sync.

targets:
  dev:
    sync:
      include:
        - my_package/dist/delete-me.whl

sync.paths

Mapování sync může obsahovat paths mapování, které určuje místní cesty k synchronizaci s pracovním prostorem. Mapování paths umožňuje sdílet společné soubory napříč sadami a je možné je použít k synchronizaci souborů umístěných mimo kořen sady. (Kořen sady je umístění souboru databricks.yml.) To je užitečné zejména v případě, že máte jedno úložiště, které hostuje více sad a chcete sdílet knihovny, soubory kódu nebo konfiguraci.

Zadané cesty musí být relativní vzhledem k souborům a adresářům ukotveným ve složce, ve které paths je nastavené mapování. Pokud jedna nebo více hodnot cesty prochází adresářem do nadřazeného adresáře kořenového, je kořenová cesta dynamicky určena, aby se zajistilo, že struktura složek zůstane zachována. Pokud je například kořenová složka sady pojmenovaná my_bundle , pak tato konfigurace synchronizuje databricks.ymlcommon složku umístěnou o jednu úroveň nad kořenem sady a samotným kořenem sady:

sync:
  paths:
    - ../common
    - .

Nasazení této sady má za následek následující strukturu složek v pracovním prostoru:

common/
  common_file.txt
my_bundle/
  databricks.yml
  src/
    ...

cíle

Type: Map

Definuje kontexty cíle nasazení pro sadu. Každý cíl je jedinečná kolekce artefaktů, nastavení pracovního prostoru Azure Databricks a někdy podrobnosti o prostředku specifickém pro konkrétní cíl.

Mapování targets se skládá z jednoho nebo více cílových mapování, které musí mít jedinečný programový (nebo logický) název. Toto mapování je volitelné, ale důrazně doporučujeme.

Nastavení v rámci targets mapování mají přednost před nastavením zadaným v pracovním prostoru nejvyšší úrovně, v mapování artefaktů a prostředků .

Cíl může také přepsat hodnoty jakýchkoli proměnných nejvyšší úrovně.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

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.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
bundle Mapa Atributy balíčku při nasazování na tento cíl. Viz balíček.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
cluster_id Řetězec ID clusteru, který se má použít pro tento cíl.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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. Podívejte se na cíle.name.default.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
git Mapa Nastavení správy verzí Gitu pro cílový objekt. Viz git.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
mode Řetězec Režim nasazení pro cíl. Platné hodnoty jsou development nebo production. Podívejte se na cíle.name.mode a Režimy nasazení sady prostředků Databricks
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
permissions Posloupnost Oprávnění pro nasazení a spuštění sady v cíli. Zobrazit oprávnění
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
presets Mapa Přednastavení nasazení pro cíl. Podívejte se na cíle.name.presets.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
resources Mapa Definice prostředků pro cíl. Podívejte se na zdroje informací.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
run_as Mapa Identita, která se má použít ke spuštění sady. Viz run_as a zadání identity spuštění pro pracovní postup Sady prostředků Databricks.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
sync Mapa Místní cesty pro synchronizaci s cílovým pracovním prostorem při spuštění nebo nasazení sady. Viz synchronizace.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
variables Mapa Definice vlastních proměnných pro cíl. Viz proměnné.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
workspace Mapa Pracovní prostor Databricks pro konkrétní účel. Viz pracovní prostor.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Cíle. name.default

Chcete-li zadat cílové výchozí nastavení pro příkazy sady, nastavte default mapování na true. Například tento cíl pojmenovaný dev je výchozí cíl.

targets:
  dev:
    default: true

Pokud není nakonfigurovaný výchozí cíl nebo pokud chcete ověřit, nasadit a spustit úlohy nebo kanály v rámci konkrétního cíle, použijte -t možnost příkazů sady.

Následující příkazy ověřují, nasazují a spouštějí my_job v cílech dev a prod:

databricks bundle validate
databricks bundle deploy -t dev
databricks bundle run -t dev my_job
databricks bundle validate
databricks bundle deploy -t prod
databricks bundle run -t prod my_job

Následující příklad deklaruje dva cíle. První cíl má název dev a je výchozím cílem, který se použije v případě, že pro příkazy sady není zadaný žádný cíl. Druhý cíl má název prod a používá se pouze v případě, že je tento cíl zadán pro příkazy sady.

targets:
  dev:
    default: true
  prod:
    workspace:
      host: https://<production-workspace-url>

Cíle. name.mode

Pro usnadnění snadného vývoje a osvědčených postupů CI/CD poskytuje sady prostředků Databricks režimy nasazení pro cíle, které nastavují výchozí chování pro předprodukční a produkční pracovní postupy. Některé chování je také možné konfigurovat pomocí cílů.name.presets.

Podrobnosti najdete v tématu Režimy nasazení sady prostředků Databricks.

Návod

Pokud chcete nastavit identity spuštění pro sady, můžete zadat identitu spuštění run_as pro každý cíl, jak je popsáno v části Určení identity spuštění pro pracovní postup sady prostředků Databricks.

Chcete-li určit, že cíl je považován za cíl vývoje, přidejte mode mapování nastavené na development. Chcete-li určit, že cíl je považován za produkční cíl, přidejte mode mapování nastavené na production. Tento název cíle prod se například považuje za produkční cíl:

targets:
  prod:
    mode: production

Cíle. name.presets

Pomocí mapování můžete přizpůsobit některé chování cílového presets nasazenímode.

Seznam dostupných předvoleb najdete v tématu Vlastní předvolby.

Následující příklad ukazuje přizpůsobené cílové nastavení produkce, které předponuje a označuje všechny produkční prostředky:

targets:
  prod:
    mode: production
    presets:
      name_prefix: 'production_' # prefix all resource names with production_
      tags:
        prod: true

proměnné

Type: Map

Definuje vlastní proměnnou pro sadu. Pro každou proměnnou nastavte volitelný popis, výchozí hodnotu, určete, zda je vlastní proměnná komplexním typem, nebo použijte vyhledávání k načtení hodnoty ID pomocí následujícího formátu:

variables:
  <variable-name>:
    description: <variable-description>
    default: <optional-default-value>
    type: <optional-type-value> # "complex" is the only valid value
    lookup:
      <optional-object-type>: <optional-object-name>

Poznámka:

Proměnné se předpokládají jako typ string, pokud type nejsou nastaveny na complexhodnotu . Viz Definice komplexní proměnné.

Pokud chcete odkazovat na vlastní proměnnou v rámci konfigurace sady, použijte náhradu ${var.<variable_name>}.

Další informace o vlastních proměnných a substitucích viz v tématu Substituce a proměnné v Databricks Asset Bundles.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Klíč Typ Popis
default Jakýkoliv Výchozí hodnota proměnné.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
description Řetězec Popis proměnné.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

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.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

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

pracovní prostor

Type: Map

Definuje pracovní prostor Databricks pro balíček. Konfigurační soubor sady může obsahovat pouze jedno mapování nejvyšší úrovně workspace, které určuje nevýchozí nastavení pracovního prostoru Azure Databricks k použití.

Důležité

Platné cesty pracovního prostoru Databricks začínají buď /Workspace, nebo pro artefakty, /Volumesse také podporuje. Vlastní cesty pracovního prostoru mají automaticky předponu /Workspace, takže pokud použijete jakoukoli náhradu cesty pracovního prostoru ve své vlastní cestě, například ${workspace.file_path}, nemusíte k cestě přidávat /Workspace na začátek.

Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

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
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
auth_type Řetězec Typ ověřování, který se má použít, zvlášť důležité v případech, kdy rozhraní příkazového řádku Databricks odvodí neočekávaný typ ověřování. Podívejte se na autorizaci přístupu k prostředkům Azure Databricks.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
azure_client_id Řetězec ID klienta Azure. Viz ověřování pracovního prostoru.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
azure_environment Řetězec Prostředí Azure. Viz ověřování pracovního prostoru.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
azure_login_app_id Řetězec ID přihlašovací aplikace Azure. Viz ověřování pracovního prostoru.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
azure_tenant_id Řetězec Identifikátor tenanta Azure. Viz ověřování pracovního prostoru.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
azure_use_msi logický Určuje, jestli se má msi používat pro Azure. Viz ověřování pracovního prostoru.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
azure_workspace_resource_id Řetězec ID prostředku pracovního prostoru Azure. Viz ověřování pracovního prostoru.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
client_id Řetězec ID klienta pro pracovní prostor. Viz ověřování pracovního prostoru.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
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. Viz workspace.file_path.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
google_service_account Řetězec Název účtu služby Google. Viz ověřování pracovního prostoru.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
host Řetězec Adresa URL hostitele pracovního prostoru Databricks Viz názvy instancí pracovního prostoru, adresy URL a ID.
Nastavení mapování host dává rozhraní příkazového řádku Databricks pokyn vyhledat odpovídající profil v souboru .databrickscfg a poté použít pole tohoto profilu k určení, který typ ověřování Databricks použít. Pokud v .databrickscfg souboru existuje více profilů s odpovídajícím host polem, musíte k určení profilu použít profile mapování (nebo --profile-p možnosti příkazového řádku).
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
profile Řetězec Název profilu pracovního prostoru Databricks. Viz workspace.profile.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
resource_path Řetězec Cesta zdroje pracovního prostoru
Přidání do Rozhraní příkazového řádku Databricks verze 0.230.0
root_path Řetězec Kořenová cesta pracovního prostoru Databricks Viz workspace.root_path.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0
state_path Řetězec Cesta stavu pracovního prostoru. Tento klíč je výchozí výchozí cestou ${workspace.root}/state a představuje cestu v rámci pracovního prostoru pro ukládání informací o stavu Terraformu o nasazeních.
Přidání do Rozhraní příkazového řádku Databricks verze 0.229.0

Ověřování pracovního prostoru

Mapování pracovního prostoru může také obsahovat mapování k určení mechanismu ověřování Databricks, který se má použít. Pokud nejsou zadány v mapování pracovních prostorů nejvyšší úrovně, musí být zadány v mapování pracovního prostoru jako podřízené z jednoho nebo více cílů v mapování cílů nejvyšší úrovně.

  • Pro ověřování M2M (machine-to-machine) OAuth se používá mapování client_id . Alternativně můžete tuto hodnotu nastavit v místní proměnné prostředí DATABRICKS_CLIENT_ID. Nebo můžete vytvořit konfigurační profil s client_id hodnotou a pak zadat název profilu pomocí profile mapování (nebo pomocí --profile nebo -p možností při spuštění příkazů validate, deploy, run a destroy pomocí rozhraní příkazového řádku Databricks). Viz Autorizace přístupu instančního objektu k Azure Databricks pomocí OAuth.

    Poznámka:

    V konfiguračním souboru sady nemůžete zadat hodnotu tajného klíče Azure Databricks OAuth. Místo toho nastavte proměnnou prostředí DATABRICKS_CLIENT_SECRET. Nebo můžete přidat client_secret hodnotu do konfiguračního profilu a pak zadat název profilu pomocí profile mapování (nebo využít možnosti --profile nebo -p při provádění příkazů pro ověření, nasazení, spuštění a destrukci v Databricks CLI).

  • Pro ověřování Azure CLI se používá mapování azure_workspace_resource_id . Alternativně můžete tuto hodnotu nastavit v místní proměnné prostředí DATABRICKS_AZURE_RESOURCE_ID. Nebo můžete vytvořit konfigurační profil s azure_workspace_resource_id hodnotou a pak zadat název profilu pomocí profile mapování (nebo pomocí --profile nebo -p možností při spuštění příkazů validate, deploy, run a destroy pomocí rozhraní příkazového řádku Databricks). Viz Ověřování pomocí Azure CLI.

  • Pro ověřování tajného kódu klienta Azure pomocí aplikačních objektů se používají mapování azure_workspace_resource_id, azure_tenant_id a azure_client_id. Alternativně můžete tyto hodnoty nastavit v proměnných místního prostředí DATABRICKS_AZURE_RESOURCE_ID, ARM_TENANT_ID a ARM_CLIENT_ID v uvedeném pořadí. Nebo můžete vytvořit konfigurační profil s hodnotami azure_workspace_resource_id, azure_tenant_id a azure_client_id a poté zadat název profilu s mapováním profile (nebo pomocí možností --profile nebo -p při spuštění příkazů validate, deploy, run a destroy s rozhraním příkazového řádku Databricks). Viz Ověřování pomocí instančních objektů Microsoft Entra.

    Poznámka:

    V konfiguračním souboru sady nelze zadat hodnotu tajného klíče klienta Azure. Místo toho nastavte proměnnou prostředí ARM_CLIENT_SECRET. Nebo můžete přidat azure_client_secret hodnotu do konfiguračního profilu a pak zadat název profilu pomocí profile mapování (nebo využít možnosti --profile nebo -p při provádění příkazů pro ověření, nasazení, spuštění a destrukci v Databricks CLI).

  • Pro ověřování spravovaných identit Azure se používají mapování azure_use_msi, azure_client_id a azure_workspace_resource_id. Alternativně můžete tyto hodnoty nastavit v proměnných místního prostředí ARM_USE_MSI, ARM_CLIENT_ID a DATABRICKS_AZURE_RESOURCE_ID v uvedeném pořadí. Nebo můžete vytvořit konfigurační profil s hodnotami azure_use_msi, azure_client_id a azure_workspace_resource_id a poté zadat název profilu s mapováním profile (nebo pomocí možností --profile nebo -p při spuštění příkazů validate, deploy, run a destroy s rozhraním příkazového řádku Databricks). Viz Ověřování pomocí spravovaných identit Azure.

  • Mapování azure_environment určuje typ prostředí Azure (například Public, UsGov, Čína a Německo) pro konkrétní sadu koncových bodů rozhraní API. Výchozí hodnota je PUBLIC. Alternativně můžete tuto hodnotu nastavit v místní proměnné prostředí ARM_ENVIRONMENT. Nebo můžete přidat azure_environment hodnotu do konfiguračního profilu a pak zadat název profilu pomocí profile mapování (nebo využít možnosti --profile nebo -p při provádění příkazů pro ověření, nasazení, spuštění a destrukci v Databricks CLI).

  • Mapování azure_login_app_id není funkční a je vyhrazené pro interní použití.

workspace.root_path

Toto workspace mapování může obsahovat root_path mapování určující nevýchozí kořenovou cestu, která se má použít v rámci pracovního prostoru pro nasazení a spouštění pracovních postupů, například:

workspace:
  root_path: /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/my-envs/${bundle.target}

Ve výchozím nastavení používá Databricks CLI pro root_path výchozí cestu /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/${bundle.target}, která používá náhrady.

workspace.artifact_path

Toto workspace mapování může také obsahovat artifact_path mapování, které určuje cestu artefaktu, která není výchozí, která se má použít v rámci pracovního prostoru pro nasazení i spuštění pracovního postupu, například:

workspace:
  artifact_path: /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/my-envs/${bundle.target}/artifacts

Ve výchozím nastavení používá Databricks CLI pro artifact_path výchozí cestu ${workspace.root}/artifacts, která používá náhrady.

Poznámka:

Mapování artifact_path nepodporuje cesty systému souborů Databricks (DBFS).

workspace.file_path

Toto workspace mapování může také obsahovat file_path mapování určující cestu k souboru, která není výchozí, která se má použít v rámci pracovního prostoru pro nasazení i spuštění pracovního postupu, například:

workspace:
  file_path: /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/my-envs/${bundle.target}/files

Ve výchozím nastavení používá Databricks CLI pro file_path výchozí cestu ${workspace.root}/files, která používá náhrady.

Důležité

Vlastní proměnné pro tyto ověřovací hodnoty nelze zadat pomocí ${var.*} syntaxe.

workspace.profile

Poznámka:

Databricks doporučuje, abyste místo mapování host použili --profile mapování (nebo možnosti -p nebo profile při spuštění příkazů validate, deploy, run a destroy s příkazovým rozhraním Databricks), protože díky tomu jsou konfigurační soubory sady přenosnější.

Mapování profile určuje název konfiguračního profilu, který se má použít k ověření v tomto pracovním prostoru Azure Databricks. Tento konfigurační profil odpovídá tomu, který jste vytvořili při nastavování Databricks CLI.

Běžné objekty

Git

Type: Map

Definuje podrobnosti správy verzí Gitu. To je užitečné pro šíření metadat nasazení, která lze použít později k identifikaci prostředků. Můžete například sledovat původ úložiště úlohy nasazené CI/CD.

Pokaždé, když spustíte příkaz, jako je bundle, například validate, deploy nebo run, příkaz bundle naplní konfigurační strom příkazu následujícím výchozím nastavením:

Pokud chcete načíst nebo přepsat nastavení Gitu, musí být vaše sada v adresáři přidruženém k úložišti Git, například v místním adresáři inicializovaném spuštěním git clone příkazu. Pokud adresář není přidružený k úložišti Git, jsou tato nastavení Gitu prázdná.

Klíč Typ Popis
branch Řetězec Aktuální název větve Git. Jedná se o stejnou hodnotu, jakou byste získali, pokud jste příkaz git branch --show-current spustili z klonovaného úložiště. Můžete použít substituce k odkazování na tuto hodnotu s vašimi konfiguračními soubory svazku, jako ${bundle.git.branch}.
origin_url Řetězec Počáteční adresa URL úložiště. Jedná se o stejnou hodnotu, jakou byste získali, pokud jste příkaz git config --get remote.origin.url spustili z klonovaného úložiště. Můžete použít substituce k odkazování na tuto hodnotu s vašimi konfiguračními soubory svazku, jako ${bundle.git.origin_url}.

Příklady

V případě potřeby můžete přepsat nastavení a branch nastavení origin_url v git rámci mapování nejvyšší úrovněbundle:

bundle:
  git:
    origin_url: <some-non-default-origin-url>
    branch: <some-non-current-branch-name>