Udostępnij przez

Dokumentacja konfiguracji

Ten artykuł dostarcza odniesienia do kluczy obsługiwanych przez konfigurację pakietów zasobów Databricks (YAML). Zobacz Co to są pakiety zasobów Databricks?.

Aby zapoznać się z kompletnymi przykładami pakietów, zobacz przykłady konfiguracji pakietu i oraz repozytorium na GitHubie bundle-examples.

Artefakty

Type: Map

Definiuje atrybuty do tworzenia artefaktów, gdzie każdy klucz jest nazwą artefaktu, a wartość jest mapą definiującą ustawienia kompilacji artefaktu. Aby uzyskać informacje o mapowaniu artifacts, zobacz artefakty .

Ustawienia artefaktu zdefiniowane na najwyższym poziomie konfiguracji pakietu można zastąpić w mapowaniu targets. Zobacz Nadpisanie z użyciem ustawień docelowych.

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>
Klawisz Typ Opis
build Struna Opcjonalny zestaw poleceń kompilacji do uruchamiania lokalnie przed wdrożeniem.
dynamic_version logiczny Czy zastosować poprawkę wersji koła dynamicznie na podstawie znacznika czasu pliku whl. Jeśli jest ustawiona wartość true, można wdrożyć nowy kod bez konieczności aktualizowania wersji w setup.py lub pyproject.toml. To ustawienie jest prawidłowe tylko wtedy, gdy type jest ustawione na whl. Zobacz artefakty.
executable Struna Typ pliku wykonywalnego. Prawidłowe wartości to bash, shi cmd.
files Kolejność Względna lub bezwzględna ścieżka do wygenerowanych plików artefaktów. Zobacz artefakty.name.files.
path Struna Ścieżka lokalna katalogu artefaktu.
type Struna Wymagane, jeśli artefakt jest kołem języka Python. Typ artefaktu. Prawidłowe wartości to whl i jar.

Przykład

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

artefakty.nazwa.pliki

Type: Sequence

Względna lub bezwzględna ścieżka do wygenerowanych plików artefaktów.

Klawisz Typ Opis
source Struna To jest wymagane. Plik źródłowy artefaktu.

pakiet

Type: Map

Atrybuty pakietu podczas wdrażania na tym docelowym środowisku.

Klawisz Typ Opis
cluster_id Struna Identyfikator klastra do uruchomienia pakietu. Zobacz cluster_id.
compute_id Struna Przestarzałe. Identyfikator obliczeniowy używany do uruchamiania pakietu.
databricks_cli_version Struna Wersja interfejsu wiersza polecenia usługi Databricks do użycia dla pakietu. Zobacz databricks_cli_version.
deployment Mapa Definicja wdrożenia pakietu. Aby uzyskać informacje o obsługiwanych atrybutach, zobacz Tryby wdrażania pakietu zasobów usługi Databricks. Zobacz bundle.deployment.
git Mapa Szczegóły kontroli wersji usługi Git skojarzone z Twoim pakietem. Aby uzyskać informacje o obsługiwanych atrybutach, zobacz git. Zobacz git.
name Struna Nazwa pakietu.
uuid Struna Zastrzeżony. Uniwersalny unikatowy identyfikator (UUID) dla pakietu, który jednoznacznie identyfikuje pakiet w wewnętrznych systemach usługi Databricks. Jest to generowane, gdy projekt pakietu jest inicjowany przy użyciu szablonu usługi Databricks (przy użyciu polecenia databricks bundle init).

pakiet.wdrożenie

Type: Map

Definicja wdrożenia pakietu

Klawisz Typ Opis
fail_on_active_runs logiczny Czy zakończyć niepowodzeniem aktywne przebiegi. W przypadku ustawienia wartości true wdrożenie, które jest uruchomione, może zostać przerwane.
lock Mapa Atrybuty blokady wdrożenia. Zobacz bundle.deployment.lock.

blokada.rozmieszczenia.paczki

Type: Map

Atrybuty blokady wdrożenia.

Klawisz Typ Opis
enabled logiczny Czy ta blokada jest włączona.
force logiczny Czy wymusić tę blokadę, jeśli jest włączona.

eksperymentalny

Type: Map

Definiuje atrybuty dla funkcji eksperymentalnych.

Klawisz Typ Opis
python Mapa Przestarzałe. Zamiast tego użyj mapowania języka Python najwyższego poziomu.
python_wheel_wrapper logiczny Czy używać opakowania typu wheel dla języka Python?
scripts Mapa Polecenia do uruchomienia.
use_legacy_run_as logiczny Czy używać starszego zachowania funkcji run_as.

zawierać

Type: Sequence

Określa listę wzorców ścieżek, które zawierają pliki konfiguracyjne do uwzględnienia w pakiecie. Zobacz dołączanie.

uprawnienia

Type: Sequence

Sekwencja, która definiuje uprawnienia do stosowania do zasobów zdefiniowanych w pakiecie, gdzie każdy element w sekwencji jest uprawnieniem dla określonej jednostki.

Zobacz uprawnienia oraz Ustaw uprawnienia dla zasobów w pakietach zasobów Databricks.

Klawisz Typ Opis
group_name Struna Nazwa grupy, która ma uprawnienie ustawione na określonym poziomie.
level Struna Dozwolone uprawnienie dla użytkownika, grupy, głównej jednostki usługi, zdefiniowane dla tego uprawnienia. Prawidłowe wartości tego klucza różnią się w zależności od tego, czy uprawnienia są zdefiniowane na najwyższym poziomie pakietu, czy dla określonego zasobu. Zobacz Ustawianie uprawnień dla zasobów w pakietach zasobów usługi Databricks.
service_principal_name Struna Nazwa jednostki usługi, która ma uprawnienia ustawione na określonym poziomie.
user_name Struna Nazwa użytkownika, który ma uprawnienia ustawione na poziomie.

Przykład

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

Ustawień

Type: Map

Definiuje domyślne ustawienia wdrożenia pakietu. Zobacz Niestandardowe ustawienia wstępne.

Klawisz Typ Opis
jobs_max_concurrent_runs Liczba całkowita Maksymalna liczba współbieżnych przebiegów dla zadania.
name_prefix Struna Prefiks dla przebiegów zadań pakietu.
pipelines_development logiczny Określa, czy wdrożenia potoków powinny być zablokowane w trybie programowania.
source_linked_deployment logiczny Czy połączyć wdrożenie ze źródłem pakietu.
tags Mapa Tagi wdrożenia pakietu.
trigger_pause_status Struna Stan wstrzymania, który ma być stosowany do wszystkich wyzwalaczy i harmonogramów zadań. Prawidłowe wartości to WSTRZYMANE lub WZNOWIONE.

pyton

Type: Map

Konfiguruje ładowanie kodu języka Python zdefiniowanego za pomocą pakietu databricks-bundles. Aby uzyskać więcej informacji, zobacz Konfiguracja pakietu w języku Python.

Klawisz Typ Opis
mutators Kolejność Mutatory zawierają listę w pełni kwalifikowanych ścieżek funkcji do funkcji mutatora, takich jak [my_project.mutators:add_default_cluster].
resources Kolejność Zasoby zawierają listę w pełni kwalifikowanych ścieżek funkcji do ładowania zasobów zdefiniowanych w kodzie języka Python, takich jak ["my_project.resources:load_resources"]
venv_path Struna Ścieżka do środowiska wirtualnego. Jeśli to ustawienie jest włączone, kod języka Python jest wykonywany w tym środowisku. Jeśli to ustawienie jest wyłączone, domyślnie używa interpretera języka Python dostępnego w bieżącej powłoce.

zasoby

Type: Map

Mapa, która definiuje zasoby dla pakietu, gdzie każdy klucz jest nazwą zasobu, a wartość jest mapą definiującą zasób. Aby uzyskać więcej informacji na temat zasobów obsługiwanych przez pakiety Databricks oraz dokumentacji definicji zasobów, zobacz zasoby pakietów Databricks.

resources:
  <resource-type>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Klawisz Typ Opis
alerts Mapa Definicje alertu (wersja 2) dla pakietu, gdzie każdy klucz jest nazwą alertu. Zobacz alert.
apps Mapa Definicje aplikacji Databricks dla pakietu, gdzie każdy klucz jest nazwą aplikacji. Zobacz aplikację.
clusters Mapa Definicje klastra dla pakietu, gdzie każdy klucz jest nazwą klastra. Zobacz klaster.
dashboards Mapa Definicje pulpitu nawigacyjnego dla pakietu, w których każdy klucz jest nazwą pulpitu nawigacyjnego. Zobacz pulpit nawigacyjny.
database_catalogs Mapa Definicje wykazu baz danych dla pakietu, w którym każdy klucz jest nazwą wykazu baz danych. Zobacz database_catalog.
database-instances Mapa Definicje wystąpienia bazy danych dla pakietu, w którym każdy klucz jest nazwą wystąpienia bazy danych. Zobacz database_instance.
experiments Mapa Definicje eksperymentów dla pakietu, w których każdy klucz jest nazwą eksperymentu. Zobacz eksperyment.
jobs Mapa Definicje zadań dla pakietu, gdzie każdy klucz jest nazwą zadania. Zobacz zadanie.
model_serving_endpoints Mapa Model obsługujący definicje punktów końcowych dla pakietu, w którym każdy klucz jest nazwą punktu końcowego obsługującego model. Zobacz model_serving_endpoint.
models Mapa Definicje modelu dla pakietu, gdzie każdy klucz jest nazwą modelu. Zobacz model (starsza wersja).
pipelines Mapa Definicje przepływów pracy dla pakietu, gdzie każdy klucz jest nazwą przepływu pracy. Zobacz potok.
quality_monitors Mapa Definicje monitora jakości dla pakietu, gdzie każdy klucz jest nazwą monitora jakości. Zobacz quality_monitor (Unity Catalog).
registered_models Mapa Zarejestrowane definicje modeli dla pakietu, gdzie każdy klucz to nazwa modelu zarejestrowanego w Unity Catalog. Zobacz registered_model (Unity Catalog).
schemas Mapa Definicje schematu dla pakietu, gdzie każdy klucz jest nazwą schematu. Zobacz schemat (Unity Catalog).
secret_scopes Mapa Definicje zakresów tajnych dla pakietu, gdzie każdy klucz jest nazwą zakresu tajnego. Zobacz secret_scope.
sql_warehouses Mapa Definicje usługi SQL Warehouse dla pakietu, gdzie każdy klucz jest nazwą magazynu SQL. Zobacz sql_warehouse.
synced_database_tables Mapa Zsynchronizowane definicje tabeli bazy danych dla pakietu, gdzie każdy klucz jest nazwą tabeli bazy danych. Zobacz synced_database_table.
volumes Mapa Definicje woluminów dla pakietu, gdzie każdy klucz jest nazwą woluminu. Zobacz wolumin (Unity Catalog).

uruchom jako

Type: Map

Identyfikator tożsamości używany przy uruchamianiu przepływów pracy pakietów zasobów Databricks. Zobacz Określ tożsamość przebiegu dla przepływu pracy pakietów zasobów usługi Databricks.

Klawisz Typ Opis
service_principal_name Struna Identyfikator aplikacji aktywnej jednostki usługi. Ustawienie tego pola wymaga roli servicePrincipal/user.
user_name Struna Adres e-mail aktywnego użytkownika obszaru roboczego. Użytkownicy niebędący administratorami mogą ustawić to pole tylko na własną wiadomość e-mail.

Skrypty

Type: Map

Skrypty, które można uruchomić przy użyciu polecenia bundle run. Zobacz Wykonywanie skryptów.

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>
Klawisz Typ Opis
content Struna Polecenia do uruchomienia

synchroniczny

Type: Map

Pliki i ścieżki plików do uwzględnienia lub wykluczenia w pakiecie. Zobacz sync.

Klawisz Typ Opis
exclude Kolejność Lista plików lub folderów do wykluczenia z pakietu.
include Kolejność Lista plików lub folderów do uwzględnienia w pakiecie.
paths Kolejność Ścieżki folderów lokalnych, które mogą znajdować się poza głównym katalogiem pakietu, przeznaczone do synchronizacji z obszarem roboczym po wdrożeniu pakietu.

Cele

Type: Map

Definiuje cele wdrożenia dla pakietu. Zobacz targets

targets:
  <target-name>:
    <target-field-name>: <target-field-value>
Klawisz Typ Opis
artifacts Mapa Artefakty do uwzględnienia w wdrożeniu docelowym. Zobacz artefakty.
bundle Mapa Atrybuty pakietu podczas wdrażania na tym docelowym środowisku. Zobacz pakiet.
cluster_id Struna Identyfikator klastra do użycia dla tego obiektu docelowego.
compute_id Struna Przestarzałe. Identyfikator zasobu obliczeniowego do użycia dla tego obiektu docelowego.
default logiczny Czy ten element jest domyślnym obiektem docelowym?
git Mapa Ustawienia kontroli wersji usługi Git dla miejsca docelowego. Zobacz git.
mode Struna Tryb wdrażania dla obiektu docelowego. Prawidłowe wartości to development lub production. Zobacz Tryby wdrażania zasobów pakietu usługi Databricks.
permissions Kolejność Uprawnienia do wdrażania i uruchamiania pakietu w obiekcie docelowym. Zobacz uprawnienia.
presets Mapa Ustawienia wstępne wdrożenia dla obiektu docelowego. Zobacz predefiniowane ustawienia.
resources Mapa Definicje zasobów dla obiektu docelowego. Zobacz zasoby.
run_as Mapa Tożsamość używana do uruchomienia pakietu, patrz Określ tożsamość uruchomienia dla przepływu pracy pakietów zasobów Databricks. Zobacz run_as.
sync Mapa Lokalne ścieżki do synchronizacji z docelową przestrzenią roboczą podczas uruchamiania lub wdrażania pakietu. Zobacz sync.
variables Mapa Definicje zmiennych niestandardowych dla obiektu docelowego. Zobacz zmienne.
workspace Mapa Obszar roboczy usługi Databricks dla obiektu docelowego. Zobacz obszar roboczy.

Zmiennych

Type: Map

Definiuje zmienną niestandardową dla pakietu. Zobacz zmienne.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>
Klawisz Typ Opis
default Jakikolwiek Wartość domyślna zmiennej.
description Struna Opis zmiennej.
lookup Mapa Nazwa alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principallub obiektu warehouse, dla którego ma pobrać identyfikator. Zobacz zmienne.name.lookup.
type Struna Typ zmiennej, prostej lub złożonej. Ustaw ten klucz tylko wtedy, gdy zmienna jest złożona. Prawidłowe wartości: complex.

Zmiennych. name.lookup

Type: Map

Nazwa alertu, polityki klastra, klastra, pulpitu nawigacyjnego, instance_pool, zadania, magazynu metadanych, potoku, zapytania, głównego serwisu lub obiektu magazynu, dla którego należy pobrać identyfikator. Aby uzyskać informacje o korzystaniu z wyszukiwania, zobacz Pobieranie wartości identyfikatora obiektu.

Klawisz Typ Opis
alert Struna Nazwa alertu, dla którego ma być pobrany identyfikator.
cluster Struna Nazwa klastra, dla którego ma być pobierany identyfikator.
cluster_policy Struna Nazwa cluster_policy, dla której ma zostać pobrane ID.
dashboard Struna Nazwa pulpitu nawigacyjnego, dla którego ma być pobierany identyfikator.
instance_pool Struna Nazwa instance_pool, dla której ma być pobierany identyfikator.
job Struna Nazwa zadania, dla którego ma być pobierany identyfikator.
metastore Struna Nazwa magazynu metadanych, dla którego ma być pobierany identyfikator.
notification_destination Struna Nazwa celu powiadomienia, dla którego należy pobrać identyfikator.
pipeline Struna Nazwa potoku, dla którego ma być pobierany identyfikator.
query Struna Nazwa zapytania, dla którego ma być pobrany identyfikator.
service_principal Struna Nazwa głównego obiektu usługi, dla którego należy uzyskać identyfikator.
warehouse Struna Nazwa magazynu, dla którego ma być pobierany identyfikator.

obszar roboczy

Type: Map

Definiuje obszar roboczy usługi Databricks dla pakietu. Zobacz obszar roboczy.

Klawisz Typ Opis
artifact_path Struna Ścieżka artefaktu do użycia w obszarze roboczym zarówno dla wdrożeń, jak i przebiegów przepływu pracy
auth_type Struna Typ uwierzytelniania.
azure_client_id Struna Identyfikator klienta platformy Azure
azure_environment Struna Środowisko platformy Azure
azure_login_app_id Struna Identyfikator aplikacji logowania platformy Azure
azure_tenant_id Struna Identyfikator dzierżawy platformy Azure
azure_use_msi logiczny Czy używać MSI (tożsamości usługi zarządzanej) dla platformy Azure
azure_workspace_resource_id Struna Identyfikator zasobu obszaru roboczego platformy Azure
client_id Struna Identyfikator klienta obszaru roboczego
file_path Struna Ścieżka pliku do użycia w obszarze roboczym dla wdrożeń i przebiegów przepływu pracy
google_service_account Struna Nazwa konta usługi Google
host Struna Adres URL hosta obszaru roboczego usługi Databricks
profile Struna Nazwa profilu obszaru roboczego usługi Databricks
resource_path Struna Ścieżka zasobu obszaru roboczego
root_path Struna Ścieżka główna obszaru roboczego usługi Databricks
state_path Struna Ścieżka stanu obszaru roboczego

Typowe obiekty

Git

Type: Map

Definiuje szczegóły kontroli wersji usługi Git.

Klawisz Typ Opis
branch Struna Nazwa gałęzi Git. Zobacz git.
origin_url Struna Adres URL źródła repozytorium. Zobacz git.
  • Last updated on