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 artefak yang akan dibuat secara otomatis selama penyebaran bundel yang dapat digunakan nanti dalam eksekusi bundel. Setiap kunci adalah nama artefak, dan nilainya adalah Peta yang menentukan pengaturan build artefak.

Petunjuk / Saran

Anda dapat menentukan, menggabungkan, dan mengambil alih pengaturan untuk artefak dalam bundel seperti yang dijelaskan dalam Mengambil alih dengan pengaturan target.

Ditambahkan dalam Databricks CLI versi 0.229.0

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

Kunci	Jenis	Deskripsi
build	string	Sekumpulan perintah build opsional untuk dijalankan secara lokal sebelum penyebaran. Untuk build roda Python, Databricks CLI mengasumsikan bahwa ia dapat menemukan penginstalan lokal paket Python wheel untuk menjalankan build, dan menjalankan perintah python setup.py bdist_wheel secara default selama setiap penyebaran bundel. Tentukan beberapa perintah build pada baris terpisah. Ditambahkan dalam Databricks CLI versi 0.229.0
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. Ditambahkan dalam Databricks CLI versi 0.245.0
executable	string	Jenis yang dapat dieksekusi. Nilai yang valid adalah bash, sh, dan cmd. Ditambahkan dalam Databricks CLI versi 0.229.0
files	Urutan	Jalur relatif atau absolut ke file artefak bawaan. Lihat artefak.name.files. Ditambahkan dalam Databricks CLI versi 0.229.0
path	string	Jalur lokal direktori untuk artefak. Jalur relatif terhadap lokasi file konfigurasi bundel. Untuk build roda Python, ini adalah jalur ke file file setup.py roda Python. Jika path tidak disertakan, Databricks CLI mencoba menemukan file roda setup.py Python di root bundel. Ditambahkan dalam Databricks CLI versi 0.229.0
type	string	Diperlukan jika artefak adalah roda Python. Jenis artefak. Nilai yang valid adalah whl dan jar. Pengaturan ini tidak perlu ditentukan untuk membangun artefak lain. Ditambahkan dalam Databricks CLI versi 0.229.0

Contoh

Konfigurasi berikut membangun roda Python menggunakan Puisi:

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

Konfigurasi berikut menjalankan pengujian dan membangun roda. Untuk tutorial bundel lengkap yang menggunakan artifacts untuk membangun roda, lihat Membuat file roda Python menggunakan Bundel Aset Databricks.

artifacts:
  default:
    type: whl
    build: |-
      # run tests
      python -m pytest tests/ -v

      # build the actual artifact
      python setup.py bdist_wheel

    path: .

Untuk contoh konfigurasi yang membangun JAR dan mengunggahnya ke Katalog Unity, lihat Bundel yang mengunggah file JAR ke Katalog Unity.

Artefak. name.files

Type: Sequence

Jalur relatif atau absolut ke file artefak bawaan. Gunakan source untuk menentukan artefak bawaan. Jalur relatif terhadap lokasi file konfigurasi bundel.

Ditambahkan dalam Databricks CLI versi 0.229.0

Kunci	Jenis	Deskripsi
source	string	Diperlukan. File sumber artefak. Ditambahkan dalam Databricks CLI versi 0.229.0

bundel

Type: Map

Atribut bundel saat mendeploy ke target ini.

File konfigurasi bundel hanya boleh berisi satu pemetaan tingkat bundle atas.

Pemetaan ini bundle harus berisi name pemetaan yang menentukan nama programatis (atau logis) untuk bundel. Contoh berikut mendeklarasikan bundel dengan nama hello-bundleterprogram (atau logis).

bundle:
  name: hello-bundle

bundle Pemetaan juga dapat menjadi bagian dari satu atau beberapa target dalam pemetaan targets tingkat atas. Masing-masing pemetaan anak bundle ini menentukan penggantian non-default pada tingkat target.

Ditambahkan dalam Databricks CLI versi 0.229.0

Kunci	Jenis	Deskripsi
cluster_id	string	ID kluster yang akan digunakan untuk menjalankan bundel. Kunci ini memungkinkan Anda menentukan ID kluster yang akan digunakan sebagai penimpaan untuk kluster yang ditentukan di tempat lain dalam file konfigurasi bundel. Untuk informasi tentang cara mengambil ID kluster, lihat URL dan ID sumber daya komputasi. Penimpaan cluster_id ditujukan hanya untuk skenario pengembangan dan hanya didukung untuk target yang memiliki pemetaan mode diatur ke development. Untuk informasi selengkapnya tentang target pemetaan, lihat target. Ditambahkan dalam Databricks CLI versi 0.229.0
compute_id	string	Tidak lagi direkomendasikan ID komputer yang akan digunakan untuk menjalankan bundel. Ditambahkan dalam Databricks CLI versi 0.229.0
databricks_cli_version	string	Versi Databricks CLI yang akan digunakan untuk bundel. Lihat bundle.databricks_cli_version. Ditambahkan dalam Databricks CLI versi 0.229.0
deployment	Peta	Definisi penerapan bundel. Untuk atribut yang didukung, lihat Mode penyebaran Bundel Aset Databricks. Lihat bundle.deployment. Ditambahkan dalam Databricks CLI versi 0.229.0
git	Peta	Detail kontrol versi Git yang terkait dengan bundel Anda. Untuk atribut yang didukung, lihat git. Ditambahkan dalam Databricks CLI versi 0.229.0
name	string	Nama bundel. Ditambahkan dalam Databricks CLI versi 0.229.0
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). Ditambahkan dalam Databricks CLI versi 0.236.0

bundle.databricks_cli_version

Pemetaan bundle dapat berisi pemetaan databricks_cli_version yang membatasi versi Databricks CLI yang diperlukan oleh bundel. Ini dapat mencegah masalah yang disebabkan oleh penggunaan pemetaan yang tidak didukung dalam versi tertentu dari Databricks CLI.

Versi Databricks CLI sesuai dengan versi semantik dan databricks_cli_version pemetaan mendukung penentuan batasan versi. Jika nilai saat ini databricks --version tidak berada dalam batas yang ditentukan dalam pemetaan bundel databricks_cli_version , kesalahan terjadi ketika databricks bundle validate dijalankan pada bundel. Contoh berikut menunjukkan beberapa sintaks batasan versi umum:

bundle:
  name: hello-bundle
  databricks_cli_version: '0.218.0' # require Databricks CLI 0.218.0

bundle:
  name: hello-bundle
  databricks_cli_version: '0.218.*' # allow all patch versions of Databricks CLI 0.218

bundle:
  name: my-bundle
  databricks_cli_version: '>= 0.218.0' # allow any version of Databricks CLI 0.218.0 or higher

bundle:
  name: my-bundle
  databricks_cli_version: '>= 0.218.0, <= 1.0.0' # allow any Databricks CLI version between 0.218.0 and 1.0.0, inclusive

bundle.deployment

Type: Map

Definisi penyebaran paket

Ditambahkan dalam Databricks CLI versi 0.229.0

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. Ditambahkan dalam Databricks CLI versi 0.229.0
lock	Peta	Atribut kunci penyebaran. Lihat bundle.deployment.lock. Ditambahkan dalam Databricks CLI versi 0.229.0

bundle.deployment.lock

Type: Map

Atribut kunci penyebaran.

Ditambahkan dalam Databricks CLI versi 0.229.0

Kunci	Jenis	Deskripsi
enabled	Boolean	Apakah kunci ini diaktifkan. Ditambahkan dalam Databricks CLI versi 0.229.0
force	Boolean	Apakah perlu memaksa kunci ini jika diaktifkan? Ditambahkan dalam Databricks CLI versi 0.229.0

Eksperimen

Type: Map

Menentukan atribut untuk fitur eksperimental.

Ditambahkan dalam Databricks CLI versi 0.229.0

Kunci	Jenis	Deskripsi
python	Peta	Tidak lagi direkomendasikan Gunakan pemetaan python tingkat atas sebagai gantinya. Ditambahkan dalam Databricks CLI versi 0.238.0
python_wheel_wrapper	Boolean	Apakah akan menggunakan pembungkus roda Python. Ditambahkan dalam Databricks CLI versi 0.229.0
scripts	Peta	Perintah untuk dijalankan. Ditambahkan dalam Databricks CLI versi 0.229.0
skip_artifact_cleanup	Boolean	Menentukan apakah akan melewati penghapusan folder dalam .internalworkspace.artifact_path. Secara default, folder ini dihapus sebelum mengunggah artefak build baru (seperti roda Python) selama penyebaran. Atur ke true untuk mempertahankan artefak yang ada di seluruh penyebaran. Ditambahkan dalam Databricks CLI versi 0.254.0
skip_name_prefix_for_schema	Boolean	Apakah akan melewati penambahan awalan (diatur atau dihitung presets.name_prefix ketika mode: development) ke nama skema Katalog Unity yang ditentukan dalam bundel. Ditambahkan dalam Databricks CLI versi 0.255.0
use_legacy_run_as	Boolean	Apakah ingin menggunakan perilaku run_as lama. Ditambahkan dalam Databricks CLI versi 0.229.0

memasukkan

Type: Sequence

Menentukan daftar pola jalur yang berisi file konfigurasi untuk disertakan dalam bundel. Glob jalur ini adalah relatif terhadap lokasi file konfigurasi bundel di mana glob jalur tersebut ditentukan. Selain databricks.yml, Anda harus menggunakan include array untuk menentukan semua file konfigurasi yang akan disertakan dalam bundel.

Petunjuk / Saran

Untuk menyertakan atau mengecualikan file lain dalam bundel, gunakan sertakan dan kecualikan.

Array ini include hanya dapat muncul sebagai pemetaan pada tingkat teratas.

Ditambahkan dalam Databricks CLI versi 0.229.0

Contoh konfigurasi berikut mencakup tiga file konfigurasi. File-file ini berada di folder yang sama dengan file konfigurasi bundel:

include:
  - 'bundle.artifacts.yml'
  - 'bundle.resources.yml'
  - 'bundle.targets.yml'

Contoh konfigurasi berikut mencakup semua file dengan nama file yang dimulai dengan bundle dan diakhir dengan .yml. File-file ini berada di folder yang sama dengan file konfigurasi bundel:

include:
  - 'bundle*.yml'

izin

Type: Sequence

Menentukan izin untuk diterapkan ke sumber daya yang ditentukan dalam bundel, di mana setiap item dalam urutan adalah izin untuk entitas tertentu. Lihat Tetapkan izin untuk sumber daya dalam Bundel Aset Databricks.

Tingkat izin tingkat atas yang diizinkan adalah CAN_VIEW, , CAN_MANAGEdan CAN_RUN.

Jika Anda ingin menerapkan izin ke sumber daya tertentu, lihat Menentukan izin untuk sumber daya tertentu.

Ditambahkan dalam Databricks CLI versi 0.229.0

Kunci	Jenis	Deskripsi
group_name	string	Nama grup yang memiliki pengaturan izin pada tingkat tertentu. Ditambahkan dalam Databricks CLI versi 0.229.0
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. Ditambahkan dalam Databricks CLI versi 0.229.0
service_principal_name	string	Nama perwakilan layanan yang memiliki izin yang ditetapkan pada tingkat. Ditambahkan dalam Databricks CLI versi 0.229.0
user_name	string	Nama pengguna yang izinnya ditetapkan pada tingkat tertentu. Ditambahkan dalam Databricks CLI versi 0.229.0

Contoh

Contoh konfigurasi berikut menentukan tingkat izin untuk pengguna, grup, dan perwakilan layanan, yang diterapkan ke semua sumber daya yang ditentukan dalam resources bundel:

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. Untuk informasi selengkapnya, lihat Prasetel kustom.

Kecuali pengecualian ditentukan untuk prasetel, jika dan modepresets diatur, prasetel mengambil alih perilaku mode default, dan pengaturan sumber daya individual mengambil alih prasetel.

Ditambahkan dalam Databricks CLI versi 0.229.0

Pengaturan Awal	Deskripsi
artifacts_dynamic_version	Apakah akan memperbarui versi whl artefak secara dinamis selama penyebaran. Nilai yang valid adalah true atau false. Jika pengaturan konfigurasi artifacts.dynamic_version di tingkat atas ditentukan, pengaturan tersebut akan menggantikan prasetel ini. Ditambahkan dalam Databricks CLI versi 0.256.0
jobs_max_concurrent_runs	Jumlah maksimum pelaksanaan bersamaan yang diizinkan untuk tugas. Ditambahkan dalam Databricks CLI versi 0.229.0
name_prefix	String awalan yang ditambahkan pada nama sumber daya. Ditambahkan dalam Databricks CLI versi 0.229.0
pipelines_development	Apakah pengembangan pipeline harus dikunci saat dalam mode pengembangan. Nilai yang valid adalah true atau false. Ditambahkan dalam Databricks CLI versi 0.229.0
source_linked_deployment	Apakah sumber daya yang dibuat selama penyebaran menunjuk ke file sumber di ruang kerja alih-alih salinan ruang kerja mereka. Ditambahkan dalam Databricks CLI versi 0.236.0
tags	Sekumpulan tag kunci:nilai yang berlaku untuk semua sumber daya dengan dukungan tag, termasuk tugas dan eksperimen. Bundel Aset Databricks tidak mendukung tag untuk schema sumber daya. Ditambahkan dalam Databricks CLI versi 0.229.0
trigger_pause_status	Status jeda untuk diterapkan pada semua pemicu dan jadwal. Nilai yang valid adalah PAUSED atau UNPAUSED. Jika mode diatur ke development, trigger_pause_status selalu PAUSED. Ditambahkan dalam Databricks CLI versi 0.229.0

ular sawah

Type: Map

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

Dipindahkan dari experimental dalam Databricks CLI versi 0.275.0

Kunci	Jenis	Deskripsi
mutators	Urutan	Mutator berisi daftar jalur fungsi yang sepenuhnya memenuhi syarat ke fungsi mutator, seperti [my_project.mutators:add_default_cluster]. Ditambahkan dalam Databricks CLI versi 0.238.0
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"] Ditambahkan dalam Databricks CLI versi 0.238.0
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. Ditambahkan dalam Databricks CLI versi 0.238.0

Sumber daya

Type: Map

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.

Pemetaan resources dapat muncul sebagai pemetaan tingkat atas, atau dapat menjadi anak dari satu atau beberapa target dalam pemetaan target tingkat atas, dan mencakup nol atau salah satu jenis sumber daya yang didukung. Setiap pemetaan jenis sumber daya mencakup satu atau beberapa deklarasi sumber daya individual, yang masing-masing harus memiliki nama yang unik. Deklarasi sumber daya individual ini menggunakan payload permintaan operasi buat objek yang sesuai, yang dinyatakan dalam YAML, untuk menentukan sumber daya. Properti yang didukung untuk sumber daya adalah bidang yang didukung dari objek yang bersangkutan.

Payload permintaan operasi pembuatan didokumentasikan dalam Referensi REST API Databricks, dan perintah databricks bundle schema menghasilkan semua skema objek yang didukung. Selain itu, databricks bundle validate perintah mengembalikan peringatan jika properti sumber daya yang tidak diketahui ditemukan dalam file konfigurasi bundel.

Untuk informasi selengkapnya tentang sumber daya yang didukung dalam bundel, serta konfigurasi dan contoh umum, lihat sumber daya Bundel Aset Databricks dan contoh konfigurasi Bundel .

Ditambahkan dalam Databricks CLI versi 0.229.0

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. Ditambahkan dalam Databricks CLI versi 0.279.0
apps	Peta	Definisi aplikasi Databricks untuk bundel, di mana setiap kunci adalah nama aplikasi. Lihat aplikasi. Ditambahkan dalam Databricks CLI versi 0.239.0
catalogs	Peta	Definisi katalog (Unity Catalog) untuk bundel, di mana setiap kunci adalah nama katalog. Lihat katalog. Ditambahkan dalam Databricks CLI versi 0.287.0
clusters	Peta	Definisi kluster untuk bundel, di mana setiap kunci adalah nama kluster. Lihat kluster. Ditambahkan dalam Databricks CLI versi 0.229.0
dashboards	Peta	Definisi dasbor untuk paket, di mana setiap kunci merupakan nama dasbor. Lihat dasbor. Ditambahkan dalam Databricks CLI versi 0.232.0
database_catalogs	Peta	Definisi katalog database untuk bundel, di mana setiap kunci adalah nama katalog database. Lihat database_catalog. Ditambahkan dalam Databricks CLI versi 0.265.0
database_instances	Peta	Definisi instans database untuk bundel, di mana setiap kunci adalah nama instans database. Lihat database_instance. Ditambahkan dalam Databricks CLI versi 0.265.0
experiments	Peta	Definisi eksperimen untuk bundel, di mana setiap kunci adalah nama eksperimen. Lihat eksperimen. Ditambahkan dalam Databricks CLI versi 0.229.0
jobs	Peta	Definisi tugas dalam bundel, di mana setiap kunci merupakan nama tugas. Lihat pekerjaan. Ditambahkan dalam Databricks CLI versi 0.229.0
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. Ditambahkan dalam Databricks CLI versi 0.229.0
models	Peta	Definisi dari model-model dalam bundel, di mana setiap kunci mewakili nama model. Lihat model (warisan). Ditambahkan dalam Databricks CLI versi 0.229.0
pipelines	Peta	Definisi alur untuk bundel, di mana setiap kunci adalah nama alur. Lihat pipeline. Ditambahkan dalam Databricks CLI versi 0.229.0
postgres_branches	Peta	Definisi cabang Postgres untuk bundel, di mana setiap kunci adalah nama cabang Lakebase. Lihat postgres_branch. Ditambahkan dalam Databricks CLI versi 0.287.0
postgres_endpoints	Peta	Definisi titik akhir Postgres untuk bundel, di mana setiap kunci adalah nama titik akhir komputasi Lakebase. Lihat postgres_endpoint. Ditambahkan dalam Databricks CLI versi 0.287.0
postgres_projects	Peta	Definisi proyek Postgres untuk bundel, di mana setiap kunci adalah nama proyek Lakebase. Lihat postgres_project. Ditambahkan dalam Databricks CLI versi 0.287.0
quality_monitors	Peta	Definisi monitor kualitas untuk bundel, di mana setiap kunci menunjukkan nama monitor kualitas. Lihat quality_monitor (Katalog Unity). Ditambahkan dalam Databricks CLI versi 0.229.0
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). Ditambahkan dalam Databricks CLI versi 0.229.0
schemas	Peta	Definisi skema untuk bundel, di mana setiap kunci adalah nama skema. Lihat skema (Katalog Unity). Ditambahkan dalam Databricks CLI versi 0.229.0
secret_scopes	Peta	Definisi cakupan rahasia untuk bundel, di mana setiap kunci adalah nama cakupan rahasia. Lihat secret_scope. Ditambahkan dalam Databricks CLI versi 0.252.0
sql_warehouses	Peta	Definisi gudang SQL untuk bundel, di mana setiap kunci adalah nama gudang SQL. Lihat sql_warehouse. Ditambahkan di Databricks CLI versi 0.260.0
synced_database_tables	Peta	Definisi tabel database yang disinkronkan untuk bundel, di mana setiap kunci adalah nama tabel database. Lihat synced_database_table. Ditambahkan dalam Databricks CLI versi 0.266.0
volumes	Peta	Definisi volume untuk bundel, di mana setiap kunci berfungsi sebagai nama volume. Lihat volume (Unity Catalog). Ditambahkan dalam Databricks CLI versi 0.236.0

Contoh

Contoh konfigurasi berikut mendefinisikan sumber daya pekerjaan:

resources:
  jobs:
    hello-job:
      name: hello-job
      tasks:
        - task_key: hello-task
          existing_cluster_id: 1234-567890-abcde123
          notebook_task:
            notebook_path: ./hello.py

jalankan_sebagai

Type: Map

Identitas (user_name atau service_principal_name) yang digunakan untuk menjalankan alur kerja Bundel Aset Databricks. Ini menyediakan kemampuan untuk memisahkan identitas yang digunakan untuk menyebarkan pekerjaan bundel atau alur dari yang digunakan untuk menjalankan pekerjaan atau alur. Lihat Tentukan identitas eksekusi untuk alur kerja Bundel Aset Databricks.

Ditambahkan dalam Databricks CLI versi 0.229.0

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

Skrip

Type: Map

Skrip yang dapat dijalankan menggunakan bundle run. Setiap skrip bernama dalam scripts pemetaan berisi konten dengan perintah. Lihat Menjalankan skrip.

Ditambahkan dalam Databricks CLI versi 0.259.0

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

Kunci	Jenis	Deskripsi
content	string	Perintah yang akan dijalankan Ditambahkan dalam Databricks CLI versi 0.259.0

Contoh

scripts:
  my_script:
    content: uv run pytest -m ${bundle.target}

penyelarasan

Type: Map

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

Ditambahkan dalam Databricks CLI versi 0.229.0

Kunci	Jenis	Deskripsi
exclude	Urutan	Daftar file atau folder yang akan dikecualikan dari bundel. Lihat menyertakan dan mengecualikan. Ditambahkan dalam Databricks CLI versi 0.229.0
include	Urutan	Daftar file atau folder yang akan disertakan dalam bundel. Lihat menyertakan dan mengecualikan. Ditambahkan dalam Databricks CLI versi 0.229.0
paths	Urutan	Jalur folder lokal, yang dapat berada di luar root bundel, untuk disinkronkan ke ruang kerja saat bundel diimplementasikan. Lihat sync.paths. Ditambahkan dalam Databricks CLI versi 0.229.0

sertakan dan kecualikan

Pemetaan include dan exclude dalam pemetaan sync menentukan daftar file atau folder yang akan disertakan dalam, atau dikecualikan dari, penyebaran bundel, tergantung pada aturan berikut:

• Berdasarkan setiap daftar glob file dan jalur dalam .gitignore file di folder root bundel, include pemetaan dapat berisi daftar glob file, glob jalur, atau keduanya, relatif terhadap folder root bundel, untuk secara eksplisit dimasukkan.
• Berdasarkan daftar file dan glob jalur apa pun dalam .gitignore file di akar bundel, ditambah daftar glob file dan jalur dalam pemetaan include, pemetaan exclude dapat berisi daftar glob file, glob jalur, atau keduanya yang perlu dikecualikan secara eksplisit, relatif terhadap akar bundel.

Semua jalur ke file dan folder tertentu relatif terhadap lokasi file konfigurasi bundel tempat file tersebut ditentukan.

Sintaks untuk include pola exclude file dan jalur mengikuti sintaks pola standar .gitignore . Lihat Pola Format gitignore.

Misalnya, jika file berikut .gitignore berisi entri berikut:

.databricks
my_package/dist

Dan file konfigurasi bundel berisi pemetaan berikut include :

sync:
  include:
    - my_package/dist/*.whl

Kemudian semua file dalam my_package/dist folder dengan ekstensi *.whl file disertakan. File lain dalam my_package/dist folder tidak disertakan.

Namun, jika file konfigurasi bundel juga berisi pemetaan berikut exclude :

sync:
  include:
    - my_package/dist/*.whl
  exclude:
    - my_package/dist/delete-me.whl

Kemudian semua file dalam my_package/dist folder dengan ekstensi *.whlfile , kecuali untuk file bernama delete-me.whl, disertakan. File lain dalam my_package/dist folder juga tidak disertakan.

Pemetaan sync juga dapat dideklarasikan dalam pemetaan targets untuk target tertentu. Setiap pemetaan sync yang dideklarasikan dalam target digabungkan dengan setiap deklarasi pemetaan tingkat atas sync. Misalnya, melanjutkan dengan contoh sebelumnya, pemetaan include berikut pada tingkat targets menggabung dengan pemetaan include di tingkat pemetaan sync atas.

targets:
  dev:
    sync:
      include:
        - my_package/dist/delete-me.whl

sync.paths

Pemetaan sync dapat berisi pemetaan paths yang menentukan jalur lokal untuk disinkronkan ke dalam ruang kerja. Pemetaan paths memungkinkan Anda berbagi file umum di seluruh bundel, dan dapat digunakan untuk menyinkronkan file yang terletak di luar akar bundel. (Akar bundel adalah lokasi file databricks.yml.) Ini sangat berguna ketika Anda memiliki satu repositori yang menghosting beberapa bundel dan ingin berbagi pustaka, file kode, atau konfigurasi.

Jalur yang ditentukan harus relatif terhadap file dan direktori yang terletak di folder tempat paths pemetaan diatur. Jika satu atau beberapa nilai jalur menaiki direktori menuju leluhur dari akar bundel, jalur akar ditentukan secara dinamis untuk memastikan bahwa struktur folder tetap utuh. Misalnya, jika folder akar bundel diberi nama my_bundle maka konfigurasi ini dalam databricks.yml menyinkronkan common folder yang terletak satu tingkat di atas akar bundel dan akar bundel itu sendiri:

sync:
  paths:
    - ../common
    - .

Penyebaran bundel ini menghasilkan struktur folder berikut di ruang kerja:

common/
  common_file.txt
my_bundle/
  databricks.yml
  src/
    ...

sasaran

Type: Map

Menentukan konteks target penyebaran untuk bundel. Setiap target adalah kumpulan artefak unik, pengaturan ruang kerja Azure Databricks, dan terkadang detail sumber daya khusus target.

Pemetaan targets terdiri dari satu atau beberapa pemetaan target, yang masing-masing harus memiliki nama terprogram (atau logis) yang unik. Pemetaan ini bersifat opsional tetapi sangat disarankan.

Pengaturan dalam targets pemetaan lebih diutamakan daripada pengaturan yang ditentukan di ruang kerja tingkat atas, artefak, dan pemetaan sumber daya .

Target juga dapat mengambil alih nilai variabel tingkat atas apa pun.

Ditambahkan dalam Databricks CLI versi 0.229.0

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

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

Target. name.default

Untuk menentukan target default untuk perintah bundel, setel pemetaan default ke true. Misalnya, target bernama dev ini adalah target default:

targets:
  dev:
    default: true

Jika target default tidak dikonfigurasi, atau jika Anda ingin memvalidasi, menyebarkan, dan menjalankan pekerjaan atau alur dalam target tertentu, gunakan -t opsi perintah bundel.

Perintah berikut memvalidasi, menyebarkan, dan menjalankan my_job dalam target dev dan prod.

databricks bundle validate
databricks bundle deploy -t dev
databricks bundle run -t dev my_job

databricks bundle validate
databricks bundle deploy -t prod
databricks bundle run -t prod my_job

Contoh berikut mendeklarasikan dua target. Target pertama memiliki nama dev dan merupakan target default yang digunakan ketika tidak ada target yang ditentukan untuk perintah bundel. Target kedua memiliki nama prod dan hanya digunakan ketika target ini ditentukan untuk perintah bundel.

targets:
  dev:
    default: true
  prod:
    workspace:
      host: https://<production-workspace-url>

Target. name.mode

Untuk memfasilitasi pengembangan yang mudah dan praktik terbaik CI/CD, Bundel Aset Databricks menyediakan mode penyebaran untuk target yang menetapkan perilaku default untuk alur kerja pra-produksi dan produksi. Beberapa perilaku juga dapat dikonfigurasi menggunakan target.name.presets.

Untuk detailnya, lihat Mode penyebaran Bundel Aset Databricks.

Petunjuk / Saran

Untuk mengatur identitas eksekusi untuk bundel, Anda dapat menentukan run_as untuk setiap target, seperti yang dijelaskan dalam Menentukan identitas eksekusi untuk alur kerja Bundel Aset Databricks.

Untuk menentukan bahwa target diperlakukan sebagai target pengembangan, tambahkan mode set pemetaan ke development. Untuk menentukan bahwa target diperlakukan sebagai target produksi, tambahkan mode set pemetaan ke production. Misalnya, target bernama prod ini diperlakukan sebagai target produksi:

targets:
  prod:
    mode: production

Target. name.presets

Anda dapat menyesuaikan beberapa perilaku penyebaran mode target menggunakan presets pemetaan.

Untuk daftar preset yang tersedia, lihat Preset kustom.

Contoh berikut menunjukkan target produksi yang disesuaikan yang menambahkan awalan dan menandai semua sumber daya produksi.

targets:
  prod:
    mode: production
    presets:
      name_prefix: 'production_' # prefix all resource names with production_
      tags:
        prod: true

Variabel

Type: Map

Menentukan variabel kustom untuk bundel. Untuk setiap variabel, atur deskripsi opsional, nilai default, apakah variabel kustom adalah jenis kompleks, atau pencarian untuk mengambil nilai ID, menggunakan format berikut:

variables:
  <variable-name>:
    description: <variable-description>
    default: <optional-default-value>
    type: <optional-type-value> # "complex" is the only valid value
    lookup:
      <optional-object-type>: <optional-object-name>

Nota

Variabel diasumsikan berjenis string, kecuali type diatur ke complex. Lihat Menentukan variabel kompleks.

Untuk mereferensikan variabel kustom dalam konfigurasi bundel, gunakan substitusi ${var.<variable_name>}.

Untuk informasi selengkapnya tentang variabel dan substitusi kustom, lihat Substitusi dan variabel dalam Bundel Aset Databricks.

Ditambahkan dalam Databricks CLI versi 0.229.0

Kunci	Jenis	Deskripsi
default	Apa saja	Nilai default untuk variabel. Ditambahkan dalam Databricks CLI versi 0.229.0
description	string	Deskripsi variabel. Ditambahkan dalam Databricks CLI versi 0.229.0
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. Ditambahkan dalam Databricks CLI versi 0.229.0
type	string	Jenis variabel, sederhana atau kompleks. Hanya atur kunci ini jika variabelnya kompleks. Nilai yang valid: complex. Ditambahkan dalam Databricks CLI versi 0.229.0

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.

Ditambahkan dalam Databricks CLI versi 0.229.0

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

ruang kerja

Type: Map

Menentukan ruang kerja Databricks untuk bundel. File konfigurasi bundel hanya dapat berisi satu pemetaan tingkat workspace atas untuk menentukan pengaturan ruang kerja Azure Databricks non-default yang akan digunakan.

Penting

Jalur ruang kerja Databricks yang valid dimulai dengan /Workspace atau untuk artefak, /Volumesjuga didukung. Jalur ruang kerja kustom secara otomatis diawali dengan /Workspace, jadi jika Anda menggunakan penggantian jalur ruang kerja apa pun di jalur kustom Anda seperti ${workspace.file_path}, Anda tidak perlu menambahkan /Workspace ke jalur tersebut.

Ditambahkan dalam Databricks CLI versi 0.229.0

Kunci	Jenis	Deskripsi
artifact_path	string	Jalur artefak yang akan digunakan dalam ruang kerja untuk penyebaran dan jalannya alur kerja Ditambahkan dalam Databricks CLI versi 0.229.0
auth_type	string	Jenis autentikasi yang akan digunakan, terutama penting dalam kasus di mana Databricks CLI menyimpulkan jenis autentikasi yang tidak terduga. Lihat Mengotorisasi akses ke sumber daya Azure Databricks. Ditambahkan dalam Databricks CLI versi 0.229.0
azure_client_id	string	ID klien Azure. Lihat Autentikasi ruang kerja. Ditambahkan dalam Databricks CLI versi 0.229.0
azure_environment	string	Lingkungan Azure. Lihat Autentikasi ruang kerja. Ditambahkan dalam Databricks CLI versi 0.229.0
azure_login_app_id	string	ID aplikasi masuk Azure. Lihat Autentikasi ruang kerja. Ditambahkan dalam Databricks CLI versi 0.229.0
azure_tenant_id	string	ID penyewa Azure. Lihat Autentikasi ruang kerja. Ditambahkan dalam Databricks CLI versi 0.229.0
azure_use_msi	Boolean	Apakah akan menggunakan MSI untuk Azure. Lihat Autentikasi ruang kerja. Ditambahkan dalam Databricks CLI versi 0.229.0
azure_workspace_resource_id	string	ID sumber daya ruang kerja Azure. Lihat Autentikasi ruang kerja. Ditambahkan dalam Databricks CLI versi 0.229.0
client_id	string	ID klien untuk ruang kerja. Lihat Autentikasi ruang kerja. Ditambahkan dalam Databricks CLI versi 0.229.0
file_path	string	Jalur file yang akan digunakan dalam ruang kerja untuk penyebaran dan alur kerja berjalan. Lihat workspace.file_path. Ditambahkan dalam Databricks CLI versi 0.229.0
google_service_account	string	Nama akun layanan Google. Lihat Autentikasi ruang kerja. Ditambahkan dalam Databricks CLI versi 0.229.0
host	string	URL host ruang kerja Databricks. Lihat Nama instans ruang kerja, URL, dan ID. host Mengatur pemetaan menginstruksikan Databricks CLI untuk menemukan profil yang cocok dalam file Anda .databrickscfg lalu menggunakan bidang profil tersebut untuk menentukan jenis autentikasi Databricks mana yang akan digunakan. Jika beberapa profil dengan bidang yang host cocok ada di dalam file Anda .databrickscfg , maka Anda harus menggunakan profile pemetaan (atau --profile opsi baris perintah atau -p ) untuk menentukan profil. Ditambahkan dalam Databricks CLI versi 0.229.0
profile	string	Nama profil ruang kerja Databricks. Lihat workspace.profile. Ditambahkan dalam Databricks CLI versi 0.229.0
resource_path	string	Jalur sumber daya ruang kerja Ditambahkan dalam Databricks CLI versi 0.230.0
root_path	string	Jalur akar ruang kerja Databricks. Lihat workspace.root_path. Ditambahkan dalam Databricks CLI versi 0.229.0
state_path	string	Jalur status ruang kerja. Kunci ini default ke jalur ${workspace.root}/state default dan mewakili jalur dalam ruang kerja Anda untuk menyimpan informasi status Terraform tentang penyebaran. Ditambahkan dalam Databricks CLI versi 0.229.0

Autentikasi ruang kerja

Pemetaan ruang kerja juga dapat berisi pemetaan untuk menentukan mekanisme autentikasi Databricks yang akan digunakan. Jika tidak ditentukan dalam pemetaan ruang kerja tingkat atas, mereka harus ditentukan dalam pemetaan ruang kerja sebagai anak dari satu atau beberapa target dalam pemetaan target tingkat atas.

• Untuk autentikasi komputer-ke-mesin (M2M) OAuth, pemetaan client_id digunakan. Atau, Anda dapat mengatur nilai ini dalam variabel DATABRICKS_CLIENT_IDlingkungan lokal . Atau Anda dapat membuat profil konfigurasi dengan nilai client_id dan kemudian menentukan nama profil dengan pemetaan profile (atau dengan menggunakan opsi --profile atau -p saat menjalankan perintah validate, deploy, run, dan destroy bundle dengan Databricks CLI). Lihat Mengotorisasi akses perwakilan layanan ke Azure Databricks dengan OAuth.

  Nota

  Anda tidak dapat menentukan nilai rahasia Azure Databricks OAuth dalam file konfigurasi bundel. Sebagai gantinya, atur variabel DATABRICKS_CLIENT_SECRETlingkungan lokal . Atau Anda dapat menambahkan nilai client_secret ke profil konfigurasi dan kemudian menentukan nama profil dengan pemetaan profile (atau dengan menggunakan opsi --profile atau -p saat menjalankan perintah validate, deploy, run, dan destroy bundel dengan Databricks CLI).

• Untuk autentikasi Azure CLI, pemetaan azure_workspace_resource_id digunakan. Atau, Anda dapat mengatur nilai ini dalam variabel DATABRICKS_AZURE_RESOURCE_IDlingkungan lokal . Atau Anda dapat membuat profil konfigurasi dengan nilai azure_workspace_resource_id dan kemudian menentukan nama profil dengan pemetaan profile (atau dengan menggunakan opsi --profile atau -p saat menjalankan perintah validate, deploy, run, dan destroy bundle dengan Databricks CLI). Lihat Mengautentikasi dengan Azure CLI.

• Untuk autentikasi rahasia klien Azure dengan perwakilan layanan, pemetaan azure_workspace_resource_id, azure_tenant_id, dan azure_client_id digunakan. Atau, Anda dapat mengatur nilai-nilai ini dalam variabel DATABRICKS_AZURE_RESOURCE_IDlingkungan lokal , , ARM_TENANT_IDdan ARM_CLIENT_ID, masing-masing. Atau Anda dapat membuat profil konfigurasi dengan nilai azure_workspace_resource_id, azure_tenant_id, dan azure_client_id lalu menentukan nama profil dengan pemetaan profile (atau dengan menggunakan opsi --profile atau -p saat menjalankan perintah untuk memvalidasi, menyebarkan, menjalankan, dan menghancurkan bundel dengan Databricks CLI). Lihat Mengautentikasi dengan perwakilan layanan Microsoft Entra.

  Nota

  Anda tidak dapat menentukan nilai rahasia klien Azure dalam file konfigurasi bundel. Sebagai gantinya, atur variabel ARM_CLIENT_SECRETlingkungan lokal . Atau Anda dapat menambahkan nilai azure_client_secret ke profil konfigurasi dan kemudian menentukan nama profil dengan pemetaan profile (atau dengan menggunakan opsi --profile atau -p saat menjalankan perintah validate, deploy, run, dan destroy bundel dengan Databricks CLI).

• Untuk autentikasi identitas terkelola Azure, pemetaan azure_use_msi, azure_client_id, dan azure_workspace_resource_id digunakan. Atau, Anda dapat mengatur nilai-nilai ini dalam variabel ARM_USE_MSIlingkungan lokal , , ARM_CLIENT_IDdan DATABRICKS_AZURE_RESOURCE_ID, masing-masing. Atau Anda dapat membuat profil konfigurasi dengan nilai azure_use_msi, azure_client_id, dan azure_workspace_resource_id lalu menentukan nama profil dengan pemetaan profile (atau dengan menggunakan opsi --profile atau -p saat menjalankan perintah untuk memvalidasi, menyebarkan, menjalankan, dan menghancurkan bundel dengan Databricks CLI). Lihat Mengautentikasi dengan identitas terkelola Azure.

• Pemetaan azure_environment menentukan jenis lingkungan Azure (seperti Publik, UsGov, Tiongkok, dan Jerman) untuk sekumpulan titik akhir API tertentu. Nilai defaultnya adalah PUBLIC. Atau, Anda dapat mengatur nilai ini dalam variabel ARM_ENVIRONMENTlingkungan lokal . Atau Anda dapat menambahkan nilai azure_environment ke profil konfigurasi dan kemudian menentukan nama profil dengan pemetaan profile (atau dengan menggunakan opsi --profile atau -p saat menjalankan perintah validate, deploy, run, dan destroy bundel dengan Databricks CLI).

• Pemetaannya azure_login_app_id tidak operasional dan disediakan untuk penggunaan internal.

workspace.root_path

Pemetaan workspace ini dapat berisi pemetaan root_path untuk menentukan jalur akar non-default yang digunakan dalam ruang kerja, baik untuk penyebaran maupun pengoperasian alur kerja, misalnya:

workspace:
  root_path: /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/my-envs/${bundle.target}

Secara default, untuk root_path Databricks CLI menggunakan jalur default /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/${bundle.target}, yang menggunakan substitusi.

workspace.artifact_path

Pemetaan workspace ini juga dapat berisi artifact_path pemetaan untuk menentukan jalur artefak non-default yang akan digunakan dalam ruang kerja baik untuk penyebaran maupun pelaksanaan alur kerja, misalnya:

workspace:
  artifact_path: /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/my-envs/${bundle.target}/artifacts

Secara default, untuk artifact_path Databricks CLI menggunakan jalur default ${workspace.root}/artifacts, yang menggunakan substitusi.

Nota

Pemetaan artifact_path tidak mendukung jalur Databricks File System (DBFS).

workspace.file_path

Pemetaan workspace ini juga dapat mencakup pemetaan file_path untuk menentukan jalur file bukan bawaan yang akan digunakan dalam ruang kerja untuk penyebaran dan pelaksanaan alur kerja, misalnya:

workspace:
  file_path: /Workspace/Users/${workspace.current_user.userName}/.bundle/${bundle.name}/my-envs/${bundle.target}/files

Secara default, untuk file_path Databricks CLI menggunakan jalur default ${workspace.root}/files, yang menggunakan substitusi.

Penting

Anda tidak dapat menentukan variabel kustom untuk nilai autentikasi ini dengan menggunakan sintaks.${var.*}

workspace.profile

Nota

Databricks merekomendasikan agar Anda menggunakan pemetaan host (atau opsi --profile atau -p saat menjalankan perintah memvalidasi, menyebarkan, menjalankan, dan menghapus bundel dengan Databricks CLI) alih-alih pemetaan profile, karena ini membuat file konfigurasi bundel Anda lebih portabel.

Pemetaan profile menentukan nama profil konfigurasi yang akan digunakan untuk mengautentikasi ke ruang kerja Azure Databricks ini. Profil konfigurasi ini dikaitkan dengan profil yang Anda buat saat mengatur Databricks CLI.

Objek umum

Git

Type: Map

Menentukan detail pengendalian versi git. Ini berguna untuk menyebarkan metadata penyebaran yang dapat digunakan nanti untuk mengidentifikasi sumber daya. Misalnya, Anda dapat melacak asal repositori dari tugas yang diterapkan oleh CI/CD.

Setiap kali Anda menjalankan bundle perintah seperti validate, deploy atau run, bundle perintah mengisi pohon konfigurasi perintah dengan pengaturan default berikut:

Untuk mengambil atau mengambil alih pengaturan Git, bundel Anda harus berada dalam direktori yang terkait dengan repositori Git, misalnya direktori lokal yang diinisialisasi dengan menjalankan git clone perintah. Jika direktori tidak terkait dengan repositori Git, pengaturan Git ini kosong.

Kunci	Jenis	Deskripsi
branch	string	Nama cabang Git saat ini. Ini adalah nilai yang sama dengan yang akan Anda dapatkan jika Anda menjalankan perintah git branch --show-current dari repositori kloning Anda. Anda dapat menggunakan substitusi untuk merujuk ke nilai ini dengan file konfigurasi bundel Anda, sebagai ${bundle.git.branch}.
origin_url	string	URL asal repositori. Ini adalah nilai yang sama dengan yang akan Anda dapatkan jika Anda menjalankan perintah git config --get remote.origin.url dari repositori kloning Anda. Anda dapat menggunakan substitusi untuk merujuk ke nilai ini dengan file konfigurasi bundel Anda, sebagai ${bundle.git.origin_url}.

Contoh

Anda dapat mengambil alih origin_url pengaturan dan branch dalam git pemetaan pemetaan tingkat bundle atas Anda jika diperlukan:

bundle:
  git:
    origin_url: <some-non-default-origin-url>
    branch: <some-non-current-branch-name>