Bagikan melalui

Referensi konfigurasi

  • Artikel

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

Untuk contoh bundel lengkap, lihat contoh konfigurasi Bundel dan repositori GitHub contoh bundel .

artefak

Menentukan pengaturan untuk membangun artefak.

Kunci Jenis Deskripsi
build Tali Sekumpulan perintah build opsional untuk dijalankan secara lokal sebelum penyebaran.
executable Tali Jenis yang dapat dieksekusi. Nilai yang valid adalah bash, sh, dan cmd.
files Peta Jalur relatif atau absolut ke file artefak bawaan, didefinisikan sebagai artifact_file.
path Tali Jalur lokal direktori untuk artefak.
type String Diperlukan jika artefak adalah roda Python. Jenis artefak. Nilai yang valid adalah whl dan jar.

Artefak

Menentukan atribut untuk membangun artefak, di mana setiap kunci adalah nama artefak, dan nilainya adalah Map yang menentukan pengaturan artefak build . Untuk informasi tentang pemetaan artifacts, lihat artefak .

Pengaturan artefak yang ditentukan di level teratas dari konfigurasi bundel dapat diubah dalam pemetaan targets. Lihat Menentukan pengaturan artefak di Bundel Aset Databricks.

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

Contoh

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

artifact_file

Mendefinisikan file artefak dalam bundel.

Kunci Jenis Deskripsi
source Tali Diperlukan. File sumber artefak.

paket

Atribut-atribut dari bundel. Lihat bundel .

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

Penyebaran

Menentukan atribut penyebaran bundel.

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

Eksperimen

Menentukan atribut untuk fitur eksperimental.

Kunci Jenis Deskripsi
python_wheel_wrapper Boolean Apakah akan menggunakan pembungkus roda Python.
scripts Perintah (String) Perintah yang akan dijalankan
use_legacy_run_as Boolean Apakah ingin menggunakan perilaku run_as lama.

Git

Menentukan detail kontrol versi Git yang terkait dengan bundel. Lihat git.

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

Hibah

Menentukan akses ke objek Katalog Unity. Untuk informasi selengkapnya, lihat Menghubungkan dengan penyimpanan objek dan layanan cloud menggunakan Unity Catalog.

Kunci Jenis Deskripsi
principal String Diperlukan. Nama prinsipal yang akan diberikan hak istimewa.
privileges Tali Diperlukan. Hak istimewa untuk diberikan kepada entitas yang ditentukan.

Contoh

Contoh berikut mendefinisikan skema Unity Catalog dengan hibah:

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"

kunci

Menentukan atribut kunci penyebaran bundel.

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

izin

Menentukan izin untuk entitas tertentu. Lihat izin izin dan Mengatur izin untuk sumber daya di Bundel Aset Databricks.

Kunci Jenis Deskripsi
group_name Tali/String Nama grup yang memiliki pengaturan izin dalam level.
level Tali Diperlukan. Izin yang diizinkan untuk pengguna, grup, perwakilan layanan yang ditentukan untuk izin ini.
service_principal_name Rangkaian Nama perwakilan layanan yang memiliki izin yang ditetapkan dalam level.
user_name Tali Nama pengguna yang izin pengaturannya ada di level.

Perizinan

Urutan yang menentukan izin untuk diterapkan ke eksperimen, pekerjaan, alur, dan model yang ditentukan dalam bundel, di mana setiap item dalam urutan adalah sebuah izin bagi entitas tertentu.

Lihat izin dan Tetapkan izin untuk sumber daya dalam Bundel Aset Databricks.

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

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 untuk penyebaran bundel.
trigger_pause_status string Status jeda untuk diterapkan ke semua pemicu dan jadwal pekerjaan. Nilai yang valid adalah PAUSED atau UNPAUSED.

Sumber daya

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>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Kunci Jenis Deskripsi
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
experiments Peta Definisi eksperimen untuk bundel, di mana setiap kunci adalah nama eksperimen. Lihat eksperimen
jobs Peta Definisi pekerjaan untuk bundel, di mana setiap kunci adalah nama pekerjaan. 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 model untuk bundel, di mana setiap kunci adalah nama model. Lihat model (warisan)
pipelines Peta Definisi alur untuk bundel, di mana setiap kunci adalah nama alur. Lihat alur
quality_monitors Peta Definisi monitor kualitas untuk bundel, di mana setiap kunci adalah 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)
volumes Peta Definisi volume untuk bundel, di mana setiap kunci berfungsi sebagai nama volume. Lihat volume (Katalog Unity)

run_as

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

Kunci Jenis Deskripsi
service_principal_name Tali 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.

Sinkronisasi

File dan jalur file untuk disertakan 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 akar bundel, untuk menyinkronkan ke ruang kerja saat bundel disebarkan.

Target

Menentukan target penyebaran untuk bundel. Lihat target

Kunci Jenis Deskripsi
artifacts Peta Artefak yang harus disertakan dalam penempatan target. Lihat artefak .
bundle Peta Atribut bundel saat mendeploy ke target ini.
cluster_id String ID kluster yang akan digunakan untuk target ini.
compute_id Tali 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 Tali 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 preset .
resources Peta Definisi sumber daya untuk target. Lihat sumber daya .
run_as Peta Identitas yang digunakan untuk menjalankan bundel. Lihat run_as dan Menentukan identitas eksekusi untuk alur kerja Bundel Aset Databricks.
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 dan serta Substitusi dan variabel dalam Bundel Aset Databricks.
workspace Peta Ruang kerja Databricks untuk target. ruang kerja

Variabel

Peta yang menentukan variabel kustom untuk bundel, di mana setiap kunci adalah nama variabel, dan nilainya adalah Peta yang menentukan variabel. Lihat Substitusi dan variabel di Bundel Aset Databricks.

Kunci Jenis Deskripsi
nama variabel Peta Definisi variabel. Lihat nama variabel.

nama variabel

Setiap definisi variabel memiliki atribut berikut:

Kunci Jenis Deskripsi
description Tali Deskripsi variabel.
lookup String Nama objek alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, atau warehouse untuk mengambil ID.
type String Jenis variabel. Nilai yang valid adalah complex.

ruang kerja

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 Tali Jenis autentikasi.
azure_client_id Tali ID klien Azure.
azure_environment Tali 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 Tali ID klien untuk ruang kerja.
file_path Tali Jalur file yang digunakan dalam ruang kerja untuk penyebaran dan pelaksanaan alur kerja.
google_service_account String Nama akun layanan Google.
host Tali URL host untuk ruang kerja Databricks.
profile String Nama profil ruang kerja Databricks.
resource_path string Jalur sumber daya ruang kerja.
root_path Tali Jalur akar ruang kerja Databricks.
state_path String Jalur status ruang kerja.