Udostępnij za pośrednictwem

Dokumentacja konfiguracji

  • Artykuł

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

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

artefakt

Definiuje ustawienia do utworzenia artefaktu.

Klucz Typ Opis
build Struna Opcjonalny zestaw poleceń kompilacji do uruchamiania lokalnie przed wdrożeniem.
executable Struna Typ pliku wykonywalnego. Prawidłowe wartości to bash, shi cmd.
files Mapa Ścieżka względna lub bezwzględna do skompilowanych plików artefaktów zdefiniowanych jako artifact_file.
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.

Artefakty

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 Define artifact settings in Databricks Asset Bundles (Definiowanie ustawień artefaktu w pakietach zasobów usługi Databricks).

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

Przykład

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

plik_artefaktu

Definiuje plik artefaktu w pakiecie.

Klucz Typ Opis
source Struna Wymagane. Plik źródłowy artefaktu.

pakiet

Atrybuty pakietu. Zobacz pakiet.

Klucz Typ Opis
cluster_id Struna Identyfikator klastra do uruchomienia pakietu. Zobacz cluster_id.
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 wdrażanie i Tryby wdrażania pakietu zasobów usługi Databricks.
git Mapa Szczegóły kontroli wersji usługi Git skojarzone z Twoim pakietem. Aby uzyskać informacje o obsługiwanych atrybutach, zobacz git i git.
name Struna Wymagane. 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).

Wdrożenie

Definiuje atrybuty wdrożenia pakietu.

Klucz Typ Opis
fail_on_active_runs Wartość logiczna Czy zakończyć niepowodzeniem aktywne przebiegi. Jeśli jest to ustawione na true wdrożenie, które jest uruchomione, może zostać przerwane.
lock Mapa Atrybuty blokady wdrożenia. Zobacz lock.

eksperymentalny

Definiuje atrybuty dla funkcji eksperymentalnych.

Klucz Typ Opis
python_wheel_wrapper Wartość logiczna Czy używać opakowania typu wheel dla języka Python?
scripts Polecenie (ciąg) Polecenia do uruchomienia
use_legacy_run_as Wartość logiczna Czy używać starszego zachowania funkcji run_as.

Git

Definiuje szczegóły kontroli wersji usługi Git skojarzone z pakietem. Zobacz git.

Klucz Typ Opis
origin_url Struna Adres URL źródła repozytorium. Zobacz git.
branch Struna Nazwa gałęzi Git. Zobacz git.

dotacja

Definiuje dostęp do obiektów katalogu Unity Catalog. Aby uzyskać więcej informacji, zobacz Jak połączyć się z magazynem obiektów w chmurze i usługami za pomocą katalogu Unity.

Klucz Typ Opis
principal Struna Wymagane. Nazwa głównego podmiotu, któremu zostaną przyznane uprawnienia.
privileges Struna Wymagane. Uprawnienia do przyznania określonemu podmiotowi.

Przykład

W poniższym przykładzie zdefiniowano schemat Unity Catalog z grantami.

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"

zamek

Definiuje atrybuty blokady wdrożenia pakietu.

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

pozwolenie

Definiuje uprawnienie dla określonej jednostki. Zobacz uprawnienia oraz Ustaw uprawnienia dla zasobów w pakietach zasobów Databricks.

Klucz Typ Opis
group_name Struna Nazwa grupy, która ma uprawnienie ustawione w level.
level Struna Wymagane. Dozwolone uprawnienie dla użytkownika, grupy, głównej jednostki usługi, zdefiniowane dla tego uprawnienia.
service_principal_name Struna Nazwa jednostki usługi, która ma uprawnienie ustawione w level.
user_name Struna Nazwa użytkownika, który ma uprawnienie ustawione w level.

Uprawnienia

Sekwencja, która definiuje uprawnienia stosowane do eksperymentów, zadań, potoków i modeli zdefiniowanych w pakiecie, gdzie każdy element w sekwencji jest to uprawnienie dla konkretnego obiektu.

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

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ń

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

Klucz 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 Wartość logiczna Określa, czy wdrożenia potoków powinny być zablokowane w trybie programowania.
source_linked_deployment Wartość logiczna 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 PAUSED lub UNPAUSED.

zasoby

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>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Klucz Typ Opis
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
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) katalogu
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)
volumes Mapa Definicje woluminów dla pakietu, gdzie każdy klucz jest nazwą woluminu. Zobacz wolumen (Unity Catalog)

uruchom_jako

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.

Klucz 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.

synchronizować

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

Klucz 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.

cel

Definiuje cele wdrożenia dla pakietu. Zobacz targets

Klucz 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.
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 Wartość logiczna 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 ustawienia wstępne .
resources Mapa Definicje zasobów dla obiektu docelowego. Zobacz zasoby.
run_as Mapa Tożsamość używana do uruchamiania pakietu. Zobacz run_as i Określ tożsamość przebiegu dla przepływu pracy pakietów zasobów usługi Databricks.
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 , substytucje oraz zmienne w pakietach zasobów usługi Databricks.
workspace Mapa Obszar roboczy usługi Databricks dla obiektu docelowego. obszaru roboczego

Zmiennych

Mapa, która definiuje zmienne niestandardowe dla pakietu, gdzie każdy klucz jest nazwą zmiennej, a wartość jest mapą, która definiuje zmienną. Zobacz Podstawienia i zmienne w pakietach zasobów Databricks.

Klucz Typ Opis
nazwa-zmiennej Mapa Definicja zmiennej. Zobacz nazwa-zmiennej.

nazwa-zmiennej

Każda definicja zmiennej ma następujące atrybuty:

Klucz Typ Opis
description Struna Opis zmiennej.
lookup Struna Nazwa alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principallub obiektu warehouse, dla którego ma pobrać identyfikator.
type Struna Typ zmiennej. Prawidłowe wartości to complex.

obszar roboczy

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

Klucz 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 Wartość logiczna Czy należy używać tożsamości zarządzanej w usłudze Azure?
azure_workspace_resource_id Struna Identyfikator zasobu obszaru roboczego platformy Azure.
client_id Struna Identyfikator klienta dla obszaru roboczego.
file_path Struna Ścieżka pliku w obszarze roboczym do użycia zarówno dla wdrożeń, jak i uruchomień przepływu pracy.
google_service_account Struna Nazwa konta usługi Google.
host Struna Adres URL hosta platformy obszaru roboczego 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.