Referensi konfigurasi

Artikel ini menyediakan referensi untuk kunci yang didukung oleh konfigurasi Bundel Aset Databricks (YAML). Lihat Apa itu Bundel Aset Databricks?.

Lihat contoh konfigurasi Bundel dan repositori GitHub contoh bundel untuk contoh bundel lengkap.

Artefak

Type: Map

Menentukan atribut untuk penyusunan artefak, di mana setiap kunci adalah nama artefak, dan nilainya adalah Pemetaan yang menentukan setelan penyusunan artefak. Untuk informasi tentang pemetaan artifacts, lihat artefak.

Pengaturan artefak yang ditentukan di level teratas dari konfigurasi bundel dapat diubah dalam pemetaan targets. Lihat Mengambil alih dengan pengaturan target.

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

Kunci	Jenis	Deskripsi
build	string	Sekumpulan perintah build opsional untuk dijalankan secara lokal sebelum penyebaran.
dynamic_version	Boolean	Apakah akan menambal versi roda secara dinamis berdasarkan tanda waktu file whl. Jika ini diatur ke true, kode baru dapat disebarkan tanpa harus memperbarui versi di setup.py atau pyproject.toml. Pengaturan ini hanya valid ketika type diatur ke whl. Lihat artefak .
executable	string	Jenis yang dapat dieksekusi. Nilai yang valid adalah bash, sh, dan cmd.
files	Urutan	Jalur relatif atau absolut ke file artefak bawaan. Lihat artefak.name.files.
path	string	Jalur lokal direktori untuk artefak.
type	string	Diperlukan jika artefak adalah roda Python. Jenis artefak. Nilai yang valid adalah whl dan jar.

Contoh

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

artefak.nama.berkas

Type: Sequence

Jalur relatif atau absolut ke file artefak bawaan.

Kunci	Jenis	Deskripsi
source	string	Diperlukan. File sumber artefak.

bundel

Type: Map

Atribut bundel saat mendeploy ke target ini.

Kunci	Jenis	Deskripsi
cluster_id	string	ID kluster yang akan digunakan untuk menjalankan bundel. Lihat cluster_id.
compute_id	string	Tidak lagi direkomendasikan ID komputer yang akan digunakan untuk menjalankan bundel.
databricks_cli_version	string	Versi Databricks CLI yang akan digunakan untuk bundel. Lihat databricks_cli_version.
deployment	Peta	Definisi penerapan bundel. Untuk atribut yang didukung, lihat Mode penyebaran Bundel Aset Databricks. Lihat bundle.deployment.
git	Peta	Detail kontrol versi Git yang terkait dengan bundel Anda. Untuk atribut yang didukung, lihat git. Lihat git.
name	string	Nama bundel.
uuid	string	Direservasi. Pengidentifikasi Unik Universal (UUID) untuk bundel yang secara unik mengidentifikasi bundel dalam sistem internal Databricks. Ini dihasilkan ketika proyek bundel diinisialisasi menggunakan templat Databricks (menggunakan perintah databricks bundle init).

paket.penerapan

Type: Map

Definisi penyebaran paket

Kunci	Jenis	Deskripsi
fail_on_active_runs	Boolean	Apakah akan gagal pada proses yang sedang berjalan. Jika ini diatur menjadi benar, proses yang sedang berjalan dapat terganggu.
lock	Peta	Atribut kunci penyebaran. Lihat bundle.deployment.lock.

bundel.penguncian.penempatan

Type: Map

Atribut kunci penyebaran.

Kunci	Jenis	Deskripsi
enabled	Boolean	Apakah kunci ini diaktifkan.
force	Boolean	Apakah perlu memaksa kunci ini jika diaktifkan?

Eksperimen

Type: Map

Menentukan atribut untuk fitur eksperimental.

Kunci	Jenis	Deskripsi
python	Peta	Tidak lagi direkomendasikan Gunakan pemetaan python tingkat atas sebagai gantinya.
python_wheel_wrapper	Boolean	Apakah akan menggunakan pembungkus roda Python.
scripts	Peta	Perintah untuk dijalankan.
use_legacy_run_as	Boolean	Apakah ingin menggunakan perilaku run_as lama.

memasukkan

Type: Sequence

Menentukan daftar pola jalur yang berisi file konfigurasi untuk disertakan dalam bundel. Lihat include.

izin

Type: Sequence

Urutan yang menentukan izin untuk diterapkan ke sumber daya yang ditentukan dalam bundel, di mana setiap item dalam urutan adalah izin untuk entitas tertentu.

Lihat izin dan Atur izin untuk sumber daya di Bundel Aset Databricks.

Kunci	Jenis	Deskripsi
group_name	string	Nama grup yang memiliki pengaturan izin pada tingkat tertentu.
level	string	Izin yang diizinkan untuk pengguna, grup, atau entitas layanan yang ditetapkan untuk izin ini. Nilai yang valid untuk kunci ini berbeda tergantung pada apakah izin ditentukan di tingkat atas bundel atau untuk sumber daya tertentu. Lihat Tetapkan izin untuk sumber daya dalam Bundel Aset Databricks.
service_principal_name	string	Nama perwakilan layanan yang memiliki izin yang ditetapkan pada tingkat.
user_name	string	Nama pengguna yang izinnya ditetapkan pada tingkat tertentu.

Contoh

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

Preset

Type: Map

Menentukan pengaturan awal penyebaran bundel. Lihat preset kustom .

Kunci	Jenis	Deskripsi
jobs_max_concurrent_runs	Integer	Eksekusi bersamaan maksimum untuk tugas.
name_prefix	string	Awalan untuk pelaksanaan pekerjaan dari bundel.
pipelines_development	Boolean	Apakah pengembangan pipeline harus dikunci saat dalam mode pengembangan.
source_linked_deployment	Boolean	Apakah ingin menautkan penyebaran ke sumber paket.
tags	Peta	Tag-tag untuk penyebaran bundel.
trigger_pause_status	string	Status jeda untuk diterapkan pada semua pemicu dan jadwal pekerjaan. Nilai yang valid DIJEDA atau TIDAK DIPAUSI.

ular sawah

Type: Map

Mengonfigurasi pemuatan kode Python yang ditentukan dengan paket databricks-bundles. Untuk informasi selengkapnya, lihat Konfigurasi bundel di Python.

Kunci	Jenis	Deskripsi
mutators	Urutan	Mutator berisi daftar jalur fungsi yang sepenuhnya memenuhi syarat ke fungsi mutator, seperti [my_project.mutators:add_default_cluster].
resources	Urutan	Sumber daya berisi daftar jalur fungsi yang sepenuhnya memenuhi syarat untuk memuat sumber daya yang ditentukan dalam kode Python, seperti ["my_project.resources:load_resources"]
venv_path	string	Jalur ke lingkungan virtual. Jika diaktifkan, kode Python dijalankan dalam lingkungan ini. Jika dinonaktifkan, defaultnya menggunakan penerjemah Python yang tersedia di shell saat ini.

Sumber daya

Type: Map

Peta yang menentukan sumber daya untuk bundel, di mana setiap kunci adalah nama sumber daya, dan nilainya adalah Peta yang menentukan sumber daya. Untuk informasi selengkapnya tentang Sumber daya yang didukung Bundel Aset Databricks, dan referensi definisi sumber daya, lihat sumber daya Bundel Aset Databricks.

resources:
  <resource-type>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>

Kunci	Jenis	Deskripsi
alerts	Peta	Definisi peringatan (v2) untuk bundel, di mana masing-masing kunci adalah nama dari peringatan. Lihat pemberitahuan.
apps	Peta	Definisi aplikasi Databricks untuk bundel, di mana setiap kunci adalah nama aplikasi. Lihat aplikasi.
clusters	Peta	Definisi kluster untuk bundel, di mana setiap kunci adalah nama kluster. Lihat kluster.
dashboards	Peta	Definisi dasbor untuk paket, di mana setiap kunci merupakan nama dasbor. Lihat dasbor.
database_catalogs	Peta	Definisi katalog database untuk bundel, di mana setiap kunci adalah nama katalog database. Lihat database_catalog.
database-instances	Peta	Definisi instans database untuk bundel, di mana setiap kunci adalah nama instans database. Lihat database_instance.
experiments	Peta	Definisi eksperimen untuk bundel, di mana setiap kunci adalah nama eksperimen. Lihat eksperimen.
jobs	Peta	Definisi tugas dalam bundel, di mana setiap kunci merupakan nama tugas. Lihat pekerjaan.
model_serving_endpoints	Peta	Model yang melayani definisi titik akhir untuk bundel, di mana setiap kunci adalah nama model yang melayani titik akhir. Lihat model_serving_endpoint.
models	Peta	Definisi dari model-model dalam bundel, di mana setiap kunci mewakili nama model. Lihat model (warisan).
pipelines	Peta	Definisi alur untuk bundel, di mana setiap kunci adalah nama alur. Lihat pipeline.
quality_monitors	Peta	Definisi monitor kualitas untuk bundel, di mana setiap kunci menunjukkan nama monitor kualitas. Lihat quality_monitor (Katalog Unity).
registered_models	Peta	Definisi model yang terdaftar untuk bundel, di mana setiap kunci adalah nama dari model yang terdaftar di Katalog Unity. Lihat registered_model (Katalog Unity).
schemas	Peta	Definisi skema untuk bundel, di mana setiap kunci adalah nama skema. Lihat skema (Katalog Unity).
secret_scopes	Peta	Definisi cakupan rahasia untuk bundel, di mana setiap kunci adalah nama cakupan rahasia. Lihat secret_scope.
sql_warehouses	Peta	Definisi gudang SQL untuk bundel, di mana setiap kunci adalah nama gudang SQL. Lihat sql_warehouse.
synced_database_tables	Peta	Definisi tabel database yang disinkronkan untuk bundel, di mana setiap kunci adalah nama tabel database. Lihat synced_database_table.
volumes	Peta	Definisi volume untuk bundel, di mana setiap kunci berfungsi sebagai nama volume. Lihat volume (Unity Catalog).

jalankan_sebagai

Type: Map

Identitas yang digunakan saat menjalankan alur kerja Bundel Aset Databricks. Lihat Tentukan identitas eksekusi untuk alur kerja Bundel Aset Databricks.

Kunci	Jenis	Deskripsi
service_principal_name	string	ID aplikasi dari prinsipal layanan aktif. Mengatur bidang ini memerlukan peran servicePrincipal/user.
user_name	string	Email pengguna ruang kerja aktif. Pengguna non-admin hanya dapat mengatur bidang ini ke email mereka sendiri.

Skrip

Type: Map

Skrip yang dapat dijalankan menggunakan bundle run. Lihat Menjalankan skrip.

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>

Kunci	Jenis	Deskripsi
content	string	Perintah yang akan dijalankan

penyelarasan

Type: Map

File-file dan jalur berkas yang dimasukkan atau dikecualikan dalam bundel. Lihat sinkronisasi.

Kunci	Jenis	Deskripsi
exclude	Urutan	Daftar file atau folder yang akan dikecualikan dari bundel.
include	Urutan	Daftar file atau folder yang akan disertakan dalam bundel.
paths	Urutan	Jalur folder lokal, yang dapat berada di luar root bundel, untuk disinkronkan ke ruang kerja saat bundel diimplementasikan.

sasaran

Type: Map

Menentukan target penyebaran untuk paket. Lihat target

targets:
  <target-name>:
    <target-field-name>: <target-field-value>

Kunci	Jenis	Deskripsi
artifacts	Peta	Artefak yang harus disertakan dalam penempatan target. Lihat artefak .
bundle	Peta	Atribut bundel saat mendeploy ke target ini. Lihat bundel.
cluster_id	string	ID kluster yang akan digunakan untuk target ini.
compute_id	string	Tidak lagi direkomendasikan ID komputasi yang akan digunakan untuk target ini.
default	Boolean	Apakah target ini adalah target default.
git	Peta	Pengaturan kontrol versi Git untuk target. Lihat git.
mode	string	Mode penerapan untuk target. Nilai yang valid adalah development atau production. Lihat mode penerapan Bundel Aset Databricks .
permissions	Urutan	Izin untuk menyebarkan dan menjalankan bundel pada target. Lihat izin.
presets	Peta	Prasetel penyebaran untuk sasaran. Lihat prasetel.
resources	Peta	Definisi sumber daya untuk target. Lihat sumber daya.
run_as	Peta	Identitas yang akan digunakan untuk menjalankan bundel, lihat Menentukan identitas eksekusi untuk alur kerja Bundel Aset Databricks. Lihat run_as.
sync	Peta	Jalur lokal yang akan disinkronkan ke ruang kerja target ketika paket dijalankan atau diterapkan. Lihat sinkronisasi.
variables	Peta	Definisi variabel kustomisasi untuk target. Lihat variabel.
workspace	Peta	Ruang kerja Databricks untuk target. Lihat ruang kerja .

Variabel

Type: Map

Menentukan variabel kustom untuk bundel. Lihat variabel.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>

Kunci	Jenis	Deskripsi
default	Apa saja	Nilai default untuk variabel.
description	string	Deskripsi variabel.
lookup	Peta	Nama objek alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, atau warehouse untuk mengambil ID. Lihat variabel.name.lookup.
type	string	Jenis variabel, sederhana atau kompleks. Hanya atur kunci ini jika variabelnya kompleks. Nilai yang valid: complex.

Variabel. name.lookup

Type: Map

Nama pemberitahuan, cluster_policy, kluster, dasbor, instance_pool, pekerjaan, metastore, alur, kueri, service_principal, atau objek gudang untuk mengambil ID. Untuk informasi tentang menggunakan pencarian, lihat Mengambil nilai ID objek.

Kunci	Jenis	Deskripsi
alert	string	Nama pemberitahuan untuk mengambil ID.
cluster	string	Nama kluster untuk mendapatkan ID.
cluster_policy	string	Nama dari cluster_policy yang digunakan untuk mengambil ID.
dashboard	string	Nama dasbor yang digunakan untuk mendapatkan ID.
instance_pool	string	Nama instance_pool untuk mengambil ID.
job	string	Nama pekerjaan untuk mengambil ID.
metastore	string	Nama metastore yang ingin Anda ambil ID-nya.
notification_destination	string	Nama notification_destination yang dimaksud untuk memperoleh ID-nya.
pipeline	string	Nama saluran untuk mengambil ID.
query	string	Nama kueri yang digunakan untuk mengambil ID.
service_principal	string	Nama service_principal yang digunakan untuk mengambil ID.
warehouse	string	Nama gudang untuk mengambil ID.

ruang kerja

Type: Map

Menentukan ruang kerja Databricks untuk bundel. Lihat ruang kerja .

Kunci	Jenis	Deskripsi
artifact_path	string	Jalur artefak yang akan digunakan dalam ruang kerja untuk penyebaran dan jalannya alur kerja
auth_type	string	Jenis autentikasi.
azure_client_id	string	ID klien Azure
azure_environment	string	Lingkungan Azure
azure_login_app_id	string	ID aplikasi masuk Azure
azure_tenant_id	string	ID penyewa Azure
azure_use_msi	Boolean	Apakah akan menggunakan MSI untuk Azure
azure_workspace_resource_id	string	ID sumber daya ruang kerja Azure
client_id	string	ID klien untuk ruang kerja
file_path	string	Jalur file yang akan digunakan dalam ruang kerja untuk penyebaran dan eksekusi alur kerja
google_service_account	string	Nama akun layanan Google
host	string	URL host untuk ruang kerja Databricks
profile	string	Nama profil ruang kerja Databricks
resource_path	string	Jalur sumber daya ruang kerja
root_path	string	Jalur akar ruang kerja Databricks
state_path	string	Jalur status ruang kerja

Objek umum

Git

Type: Map

Menentukan detail pengendalian versi git.

Kunci	Jenis	Deskripsi
branch	string	Nama cabang Git. Lihat git.
origin_url	string	URL asal repositori. Lihat git.