Aracılığıyla paylaş

Yapılandırma referansı

  • Makale

Bu makale, Databricks Varlık Paketleri yapılandırması (YAML) tarafından desteklenen anahtarlar için bir referans sağlar. Bkz. Databricks Varlık Paketleri nedir?.

Tam paket örnekleri için bkz. Paket yapılandırma örnekleri ve paket örnekleri GitHub deposu.

artefakt

Yapıt oluşturmak için ayarları tanımlar.

Anahtar Tür Açıklama
build Dize Dağıtımdan önce yerel olarak çalıştırılacak isteğe bağlı bir derleme komutları kümesi.
executable Dize Yürütülebilir dosya türü. Geçerli değerler bash, shve cmd.
files Harita Yapıt dosyalarının göreli veya mutlak yolu, artifact_fileolarak tanımlanır.
path Dize Yapıtın dizininin yerel yolu.
type Dize Yapıt bir Python tekerleğiyse gereklidir. Yapıtın türü. Geçerli değerler: whl ve jar.

Yapı

Yapıt oluşturmak için öznitelikleri tanımlar; burada her anahtar yapıtın adıdır ve değer yapıt derleme ayarlarınıtanımlayan bir Eşlem'dir. artifacts eşlemesi hakkında bilgi için artefaktlarınabakın.

Paket yapılandırmasının en üst düzeyinde tanımlanan yapıt ayarları, targets eşlemesinde geçersiz kılınabilir. Databricks Varlık Paketleri'nde yapıt ayarlarını tanımlama bölümüne bakın.

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

Örnek

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

artefakt_dosyası

Paket içerisindeki bir nesne dosyasını belirler.

Anahtar Tür Açıklama
source Dize Gerekli. Yapıt kaynak dosyası.

paket

Paketin öznitelikleri. Bkz. paketi.

Anahtar Tür Açıklama
cluster_id Dize Paketi çalıştırmak için kullanılacak kümenin kimliği. Bkz. cluster_id.
databricks_cli_version Dize Paket için kullanılacak Databricks CLI sürümü. bkz. databricks_cli_version.
deployment Harita Paket dağıtımının tanımı. Desteklenen öznitelikler için bkz. dağıtım ve Databricks Varlık Paketi dağıtım modları.
git Harita Paketinizle ilişkili Git sürüm denetimi ayrıntıları. Desteklenen öznitelikler için bkz. git ve git.
name Dize Gerekli. Paketin adı.
uuid Dize Rezerve Edildi Databricks sistemlerinin içindeki paketi benzersiz bir şekilde tanımlayan paket için Evrensel Benzersiz Tanımlayıcı (UUID). Bu, bir paket projesi Databricks şablonu (databricks bundle init komutu kullanılarak) kullanılarak başlatıldığında oluşturulur.

Dağıtım

Paket dağıtım özniteliklerini tanımlar.

Anahtar Tür Açıklama
fail_on_active_runs Boolean Etkin çalıştırmalarda başarısız olup olmayacağı. Bu true olarak ayarlanırsa, çalışan bir dağıtım kesintiye uğrayabilir.
lock Harita Dağıtım kilidi öznitelikleri. Bkz. kilit.

Deneysel

Deneysel özelliklerin özniteliklerini tanımlar.

Anahtar Tür Açıklama
python_wheel_wrapper Boolean Python tekerlek sarmalayıcının kullanılıp kullanılmaymayacağı.
scripts Komut (Dize) Çalıştırılacak komutlar
use_legacy_run_as Boolean Eski run_as davranışının kullanılıp kullanılmaymayacağı.

hergele

Paketle ilişkili Git sürüm denetimi ayrıntılarını tanımlar. Bkz. git.

Anahtar Tür Açıklama
origin_url Dize Deponun kaynak URL'si. Bkz. git.
branch Dize Git şube adı Bkz. git.

bahşetmek

Unity Kataloğu nesnelerine erişimi tanımlar. Daha fazla bilgi için bkz. Unity Kataloğu'nu kullanarak bulut nesne depolamasına ve hizmetlerine bağlanma.

Anahtar Tür Açıklama
principal Dize Gerekli. Ayrıcalık verilecek sorumlunun adı.
privileges Dize Gerekli. Belirtilen varlığa verilmelidir ayrıcalıklar.

Örnek

Aşağıdaki örnek, grants içeren bir Unity Kataloğu şemasını tanımlar:

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"

kilit

Paket dağıtım kilidi özniteliklerini tanımlar.

Anahtar Tür Açıklama
enabled Boolean Bu kilidin etkinleştirilip etkinleştirilmediği.
force Boolean Etkinse bu kilidin zorlanıp zorlanmayacağı.

izin

Belirli bir varlık için bir izin tanımlar. Bakınız izinleri ve Databricks Varlık Paketleri'nde kaynaklar için izinleri ayarlama .

Anahtar Tür Açıklama
group_name Dize level'de izni ayarlanmış grubun adı.
level Dize Gerekli. Bu izin, kullanıcı, grup ve hizmet sorumlusu için tanımlanan yetkilendirmeleri kapsamaktadır.
service_principal_name Dize level'de ayarlanmış izni olan hizmet sorumlusunun adı.
user_name Dize level'de izni ayarlanmış olan kullanıcının adı.

izinler

Paket içinde tanımlanan deneylere, işlere, işlem hatlarına ve modellere uygulanacak izinleri tanımlayan bir Dizi, burada dizideki her öğe belirli bir varlık için bir izin’dir.

Bakınız izinleri ve Databricks Varlık Paketleri'nde kaynaklar için izinleri ayarlama .

Örnek

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

Önayarları

Paket dağıtım ön ayarlarını tanımlar. Bkz. Özel ön ayarlar.

Anahtar Tür Açıklama
jobs_max_concurrent_runs Tam sayı Bir iş için maksimum eşzamanlı çalıştırma sayısı.
name_prefix Dize paketin iş yürütmeleri için ön ek.
pipelines_development Boolean İşlem hattı dağıtımlarının geliştirme modunda kilitlenmesi gerekip gerekmediği.
source_linked_deployment Boolean Dağıtımın paket kaynağına bağlanıp bağlanmayacağı.
tags Harita Paket dağıtımının etiketleri.
trigger_pause_status Dize Tüm iş tetikleyicilerine ve zamanlamalarına uygulanacak duraklatma durumu. Geçerli değerler PAUSED veya UNPAUSED.

Kaynaklar

Paket için kaynakları tanımlayan bir Harita; burada her anahtar kaynağın adını, her değer ise kaynağı tanımlayan bir Harita içerir. Databricks Varlık Paketleri tarafından desteklenen kaynaklar ve kaynak tanımı rehberi hakkında daha fazla bilgi için bkz. Databricks Varlık Paketleri kaynakları.

resources:
  <resource-type>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Anahtar Tür Açıklama
clusters Harita Paketin küme tanımları; burada her anahtar bir kümenin adıdır. Bkz. küme
dashboards Harita Paketin pano tanımları; burada her anahtar panonun adıdır. Bkz. gösterge paneli
experiments Harita Paketin deneme tanımları; burada her anahtar denemenin adıdır. Bkz. deneme
jobs Harita Paketin iş tanımları; burada her anahtar işin adıdır. bkz. iş
model_serving_endpoints Harita Paket için uç nokta tanımlarını sunan model; burada her anahtar uç noktaya hizmet veren modelin adıdır. Bkz. model_serving_endpoint
models Harita Paketin model tanımları; burada her anahtar modelin adıdır. Bkz. modeli (eski)
pipelines Harita Her anahtarın işlem hattının adı olduğu paket için işlem hattı tanımları. Bakınız boru hattı
quality_monitors Harita Paketin kalite izleyici tanımları; burada her anahtar kalite izleyicisinin adıdır. Bkz. kalite_monitörü (Unity Kataloğu)
registered_models Harita Paketin kayıtlı model tanımları; burada her anahtar Unity Kataloğu kayıtlı modelinin adıdır. Bkz. registered_model (Unity Kataloğu)
schemas Harita Paketin şema tanımları; burada her anahtar şemanın adıdır. Bkz. şeması (Unity Kataloğu)
volumes Harita Paketin birim tanımları; burada her anahtar birimin adıdır. Bkz. cilt (Unity Katalogu)

run_as

Databricks Varlık Paketleri iş akışlarını çalıştırırken kullanılacak kimlik. bkz. Databricks Varlık Paketleri iş akışıiçin çalıştırma kimliği belirtme.

Anahtar Tür Açıklama
service_principal_name Dize Etkin hizmet sorumlusunun uygulama kimliği. Bu alanın ayarlanması için servicePrincipal/user rolü gerekir.
user_name Dize Etkin çalışma alanı kullanıcısının e-posta adresi. Yönetici olmayan kullanıcılar bu alanı yalnızca kendi e-postalarına ayarlayabilir.

Eşitleme

Pakete eklenecek veya hariç tutulacak dosyalar ve dosya yolları. Bkz. eşitleme .

Anahtar Tür Açıklama
exclude Sıra Paket dışında tutulacak dosya veya klasörlerin listesi.
include Sıra Pakete eklenecek dosya veya klasörlerin listesi.
paths Sıra Paket dağıtıldığında çalışma alanıyla senkronize edilecek, paket kökü dışında olabilen yerel klasör yolları.

hedef

Paket için dağıtım hedeflerini tanımlar. Bkz. hedefleri

Anahtar Tür Açıklama
artifacts Harita Hedef dağıtıma eklenecek unsurlar. Bkz. yapıtları.
bundle Harita Bu hedefe dağıtım yapılırken paket özellikleri.
cluster_id Dize Bu hedef için kullanılacak kümenin kimliği.
compute_id Dize Kullanım dışı. Bu hedef için kullanılacak hesaplama biriminin kimliği.
default Boolean Bu hedefin varsayılan hedef olup olmadığı.
git Harita Hedef için Git sürüm denetimi ayarları. Bkz. git.
mode Dize Hedefin dağıtım modu. Geçerli değerler development veya production. Bkz. Databricks Varlık Paketi dağıtım modları.
permissions Sıra Paketi hedefte dağıtma ve çalıştırma izinleri. bkz.izinleri.
presets Harita Hedef için dağıtım ön ayarları. bkz. ön ayarları.
resources Harita Hedef için kaynak tanımları. Bkz. kaynakları.
run_as Harita Paketi çalıştırmak için kullanılacak kimlik. bkz. run_as ve Databricks Varlık Paketleri iş akışıiçin bir çalıştırma kimliği belirtme.
sync Harita Paket çalıştırıldığında veya dağıtıldığında hedef çalışma alanıyla eşitlenecek yerel yollar. Bkz. eşitleme .
variables Harita Hedef için özel değişken tanımları. Databricks Varlık Paketleri'ndeki Değiştirmeler ve değişkenler ve ile değişkenler kısmına bakın.
workspace Harita Hedef için Databricks çalışma alanı. çalışma alanı

Değişken

Paketin özel değişkenlerini tanımlayan bir Eşleme, burada her anahtar değişkenin adını ve her değer, değişkeni tanımlayan bir Harita’yı belirtir. Bkz. Databricks Varlık PaketleriDeğiştirmeleri ve değişkenleri.

Anahtar Tür Açıklama
değişken adı Harita Değişkenin tanımı. Bakınız değişken-adı.

değişken adı

Her değişken tanımı aşağıdaki özniteliklere sahiptir:

Anahtar Tür Açıklama
description Dize Değişkenin açıklaması.
lookup Dize Kimliği alınacak alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalveya warehouse nesnesinin adı.
type Dize Değişkenin türü. Geçerli değerler şunlardır: complex.

çalışma alanı

Paket için Databricks çalışma alanını tanımlar. Bkz. çalışma alanı.

Anahtar Tür Açıklama
artifact_path Dize Hem dağıtımlar hem de iş akışı çalıştırmaları için çalışma alanında kullanılacak yapıt yolu
auth_type Dize Kimlik doğrulama türü.
azure_client_id Dize Azure istemci kimliği.
azure_environment Dize Azure ortamı.
azure_login_app_id Dize Azure oturum açma uygulaması kimliği.
azure_tenant_id Dize Azure kiracı kimliği.
azure_use_msi Boolean Azure için MSI kullanılıp kullanılmaymayacağı.
azure_workspace_resource_id Dize Azure çalışma alanı kaynak kimliği.
client_id Dize Çalışma alanının istemci kimliği.
file_path Dize Hem dağıtımlar hem de iş akışı çalıştırmaları için çalışma alanında kullanılacak dosya yolu.
google_service_account Dize Google hizmet hesabı adı.
host Dize Databricks çalışma alanı sunucu URL'si.
profile Dize Databricks çalışma alanı için profil adı.
resource_path Dize Çalışma alanı kaynak yolu.
root_path Dize Databricks çalışma alanı kök yolu.
state_path Dize Çalışma alanı durum yolu.