Yapılandırma referansı

Bu sayfada Bildirim temelli Otomasyon Paketleri (eski adı Databricks Varlık Paketleri) yapılandırması (YAML) tarafından desteklenen anahtarlar için başvuru sağlanır. Bkz. Bildirim temelli Otomasyon Paketleri nelerdir?.

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

Yapı

Type: Map

Paket çalıştırmalarında daha sonra kullanılabilecek paket dağıtımları sırasında otomatik olarak oluşturulacak yapıtları belirtir. Her anahtar yapıtın adıdır ve değer, yapıt derleme ayarlarını tanımlayan bir Harita'dır.

Tavsiye

Paketlerdeki yapıtların ayarlarını, Hedef ayarlarla geçersiz kılma bölümünde açıklandığı gibi tanımlayabilir, birleştirebilir ve geçersiz kılabilirsiniz.

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

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. Python tekerleği derlemeleri için Databricks CLI, derlemeleri çalıştırmak için Python wheel paketinin yerel bir yüklemesini bulabileceğini varsayar ve her paket dağıtımı sırasında varsayılan olarak komutunu python setup.py bdist_wheel çalıştırır. Ayrı satırlarda birden çok derleme komutu belirtin.
dynamic_version	Boolyen	Whl dosyasının zaman damgasına göre wheel sürümünü dinamik olarak yama yapmak. Bu true olarak ayarlanırsa, setup.py veya pyproject.toml'de sürümü güncelleştirmek zorunda kalmadan yeni kod dağıtılabilir. Ayar yalnızca typewhl olarak ayarlandığında geçerlidir. Databricks CLI sürüm 0.245.0'a eklendi
executable	Dize	Yürütülebilir dosya türü. Geçerli değerler bash, shve cmd.
files	Sıra	Oluşturulmuş artifakt dosyalarının göreli veya mutlak yolu. Bkz: yapıtlar.name.files.
path	Dize	Yapıtın dizininin yerel yolu. Yollar, paket yapılandırma dosyasının konumuna göredir. Python Wheel derlemeleri için, Python Wheel dosyasının setup.py dosyasının yoludur. Eğer path dahil edilmemişse, Databricks CLI, Python wheel dosyasının setup.py dosyasını paketin kökünde bulmayı dener.
type	Dize	Yapıt bir Python tekerleğiyse gereklidir. Yapıtın türü. Geçerli değerler: whl ve jar. Diğer yapıtları oluşturmak için bu ayarın belirtilmesi gerekmez.

Örnekler

Aşağıdaki yapılandırma, Şiir kullanarak bir Python tekerleği oluşturur:

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

Aşağıdaki yapılandırma testleri çalıştırır ve bir tekerlek oluşturur. Tekerlek oluşturmak için kullanılan artifacts eksiksiz bir paket öğreticisi için bkz. Bildirim temelli Otomasyon Paketlerini kullanarak Python tekerlek dosyası oluşturma.

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

      # build the actual artifact
      python setup.py bdist_wheel

    path: .

JAR oluşturan ve Unity Kataloğu'na yükleyen örnek bir yapılandırma için bkz. Unity Kataloğu'na JAR dosyası yükleyen paket.

Yapı. name.files

Type: Sequence

Oluşturulmuş artifakt dosyalarının göreli veya mutlak yolu. Yerleşik yapıtları belirtmek için kullanın source . Yollar, paket yapılandırma dosyasının konumuna göredir.

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

paket

Type: Map

Bu hedefe dağıtım yapılırken paket özellikleri.

Paket yapılandırma dosyası yalnızca bir üst düzey bundle eşleme içermelidir.

Bu bundle eşleme, paket için programlı (veya mantıksal) bir ad belirten bir eşleme içermelidir name . Aşağıdaki örnek, programatik (veya mantıksal) ad ile hello-bundle olarak bir paketi bildirir.

bundle:
  name: hello-bundle

Üst düzey bundle eşlemesindeki bir veya daha fazla hedefin alt öğesi de bir eşleme olabilir. Bu çocuk bundle eşlemelerin her biri, hedef düzeyde varsayılan olmayan özelleştirmeleri belirtir.

Anahtar	Tür	Açıklama
cluster_id	Dize	Paketi çalıştırmak için kullanılacak kümenin kimliği. Bu anahtar, paket yapılandırma dosyasının başka bir yerinde tanımlanan kümeler için geçersiz kılma olarak kullanılacak küme kimliğini belirtmenizi sağlar. Kümenin kimliğini alma hakkında bilgi için bkz . İşlem kaynağı URL'si ve kimliği. cluster_id geçersiz kılma yalnızca geliştirme senaryolarına yöneliktir ve yalnızca mode eşlemesi developmentolarak ayarlanmış hedef için desteklenir. Eşleme hakkında target daha fazla bilgi için hedeflere göz atın.
compute_id	Dize	Kullanım dışı. Paketi çalıştırmak için kullanılacak hesaplama biriminin kimliği.
databricks_cli_version	Dize	Paket için kullanılacak Databricks CLI sürümü. bkz. bundle.databricks_cli_version.
deployment	Harita	Paket dağıtımının tanımı. Desteklenen öznitelikler için bkz . Bildirim temelli Otomasyon Paketleri dağıtım modları. Bkz. bundle.deployment.
engine	Dize	Kullanılacak dağıtım altyapısı. Geçerli değerler: terraform ve direct. Varsayılan değer şudur: terraform. Bu yapılandırma, ortam değişkenine göre önceliklidir DATABRICKS_BUNDLE_ENGINE . Doğrudan dağıtım altyapısı hakkında bilgi için bkz. Doğrudan dağıtım altyapısına geçiş. Databricks CLI sürüm 0.295.0'a eklendi
git	Harita	Paketinizle ilişkili Git sürüm denetimi ayrıntıları. Desteklenen öznitelikler için bkz. git.
name	Dize	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. Databricks CLI sürüm 0.236.0'a eklendi

bundle.databricks_cli_version

Eşleme, bundle paketin gerektirdiği Databricks CLI sürümünü kısıtlayan bir databricks_cli_version eşleme içerebilir. Bu, Databricks CLI'nın belirli bir sürümünde desteklenmeyen eşlemelerin kullanılmasından kaynaklanan sorunları önleyebilir.

Databricks CLI sürümü anlamsal sürüm oluşturma ile uyumlu ve databricks_cli_version eşleme sürüm kısıtlamalarını belirtmeyi destekler. Geçerli databricks --version değeri, paketin databricks_cli_version eşlemesinde belirtilen sınırlar içinde değilse, databricks bundle validate pakette yürütüldüğünde bir hata oluşur. Aşağıdaki örneklerde bazı yaygın sürüm kısıtlaması söz dizimi gösterilmektedir:

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

Paket dağıtımının tanımı

Anahtar	Tür	Açıklama
fail_on_active_runs	Boolyen	Aktif çalıştırmalarda başarısız olup olmayacağı. Eğer bu doğru olarak ayarlanırsa, çalışmakta olan bir dağıtım kesilebilir.
lock	Harita	Dağıtım kilidi öznitelikleri. Bkz bundle.deployment.lock.

bundle.deployment.lock

Type: Map

Dağıtım kilidi öznitelikleri.

Anahtar	Tür	Açıklama
enabled	Boolyen	Bu kilidin etkinleştirilip etkinleştirilmediği.
force	Boolyen	Bu kilidin etkinleştirilmişse zorlanıp zorlanmayacağı.

Deneysel

Type: Map

Deneysel özelliklerin özniteliklerini tanımlar.

Anahtar	Tür	Açıklama
python	Harita	Kullanım dışı. Bunun yerine en üst düzey python eşlemesini kullanın. Databricks CLI sürüm 0.238.0'a eklendi
python_wheel_wrapper	Boolyen	Python tekerlek sarmalayıcının kullanılıp kullanılmaymayacağı.
record_deployment_history	Boolyen	Paket dağıtım geçmişinin kaydedilip kaydedilmeyeceği.
scripts	Harita	Çalıştırılacak komutlar.
skip_artifact_cleanup	Boolyen	içindeki .internalklasörü silme işleminin atlanıp atlanmayacağını workspace.artifact_path belirler. Varsayılan olarak, dağıtım sırasında yeni derleme yapıtları (Python tekerlekleri gibi) karşıya yüklenmeden önce bu klasör silinir. true Dağıtımlar arasında mevcut yapıtları korumak için olarak ayarlayın. Databricks CLI sürüm 0.254.0'a eklendi
skip_name_prefix_for_schema	Boolyen	Pakette presets.name_prefix tanımlanan Unity Kataloğu şemalarının adlarına ön ekin eklenip atlanmadığı (içinde ayarlanmış veya hesaplandığında mode: development) olup olmadığı. Databricks CLI sürüm 0.255.0'a eklendi
use_legacy_run_as	Boolyen	Eski run_as davranışının kullanılıp kullanılmaymayacağı.

içermek

Type: Sequence

Pakete eklenecek yapılandırma dosyalarını içeren yol globlarının listesini belirtir. Bu yol glob'ları, yol glob'larının belirtildiği paket yapılandırma dosyasının konumuna göre belirlenir. dışında databricks.yml, paketin include içine eklenecek tüm yapılandırma dosyalarını belirtmek için dizisini kullanmanız gerekir.

Tavsiye

Pakete diğer dosyaları dahil etmek veya hariç tutmak için dahil et ve dışla'yı kullanın.

Bu include dizi yalnızca en üst düzey eşleme olarak görünebilir.

Aşağıdaki örnek yapılandırma üç yapılandırma dosyası içerir. Bu dosyalar paket yapılandırma dosyasıyla aynı klasördedir:

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

Aşağıdaki örnek yapılandırma ile başlayan bundle ve ile .ymlbiten dosya adlarına sahip tüm dosyaları içerir. Bu dosyalar paket yapılandırma dosyasıyla aynı klasördedir:

include:
  - 'bundle*.yml'

izinler

Type: Sequence

Pakette tanımlanan kaynaklara uygulanacak izinleri tanımlar; burada dizideki her öğe belirli bir varlık için bir izindir. Bkz. Bildirim temelli Otomasyon Paketlerinde kaynaklar için izinleri ayarlama.

İzin verilen en üst düzey izin düzeyleri , CAN_VIEWve CAN_MANAGE'dırCAN_RUN.

Belirli bir kaynağa izin uygulamak istiyorsanız bkz. Belirli bir kaynak için izinleri tanımlama.

Anahtar	Tür	Açıklama
group_name	Dize	İzin düzeyi ayarlanmış olan grubun adı.
level	Dize	Bu izin, kullanıcı, grup ve hizmet sorumlusu için tanımlanan yetkilendirmeleri kapsamaktadır. Bu anahtar için geçerli değerler, izinlerin paketin en üst düzeyinde mi yoksa belirli bir kaynak için mi tanımlandığına bağlı olarak farklılık gösterir. Bkz. Bildirim temelli Otomasyon Paketlerinde kaynaklar için izinleri ayarlama.
service_principal_name	Dize	Düzeyinde ayarlanmış izni olan hizmet sorumlusunun adı.
user_name	Dize	Düzeyinde ayarlanmış izinlere sahip olan kullanıcının adı.

Örnek

Aşağıdaki örnek yapılandırma, pakette resources tanımlanan tüm kaynaklara uygulanan bir kullanıcı, grup ve hizmet sorumlusu için izin düzeylerini tanımlar:

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ı

Type: Map

Paket dağıtım ön ayarlarını tanımlar. Daha fazla bilgi için bkz . Özel ön ayarlar.

Ön ayar için özel durum belirtilmediği sürece, hem hem de modepresets ayarlanmışsa, ön ayarlar varsayılan mod davranışını geçersiz kılar ve tek tek kaynakların ayarları da ön ayarları geçersiz kılar.

Preset	Açıklama
artifacts_dynamic_version	Dağıtım sırasında whl yapıtlarının sürümünün dinamik olarak güncellenip güncellenmeyeceği. Geçerli değerler true veya false. Üst düzey artifacts.dynamic_version yapılandırma ayarı belirtilirse, bu ön ayarı geçersiz kılar. Databricks CLI sürüm 0.256.0'a eklendi
jobs_max_concurrent_runs	İşler için izin verilen maksimum eşzamanlı çalıştırma sayısı.
name_prefix	Kaynak isimlerinin başına eklenecek önek dizesi.
pipelines_development	İşlem hattı dağıtımlarının geliştirme modunda kilitlenmesi gerekip gerekmediği. Geçerli değerler true veya false.
source_linked_deployment	Dağıtım sırasında oluşturulan kaynakların çalışma alanı kopyaları yerine çalışma alanında kaynak dosyalara işaret edip etmediği. Databricks CLI sürüm 0.236.0'a eklendi
tags	Etiketleri destekleyen, işler ve deneyler dahil tüm kaynaklara uygulanan anahtar:değer etiket kümesi. Bildirim temelli Otomasyon Paketleri, kaynağın etiketlerini schema desteklemez.
trigger_pause_status	Tüm tetikleyicilere ve zamanlamalara uygulanacak duraklatma durumu. Geçerli değerler PAUSED veya UNPAUSED. mode development olarak ayarlanırsa, trigger_pause_status her zaman PAUSED olur.

piton

Type: Map

databricks-bundles paketiyle tanımlanan Python kodunun yüklenmesini yapılandırılır. Daha fazla bilgi için bkz . Python'da paket yapılandırması.

Databricks CLI sürüm 0.275.0'dan experimental taşındı

Anahtar	Tür	Açıklama
mutators	Sıra	Mutators, [my_project.mutators:add_default_cluster] gibi mutator işlevlerine yönelik tam niteleyici işlev yollarının bir listesini içerir. Databricks CLI sürüm 0.238.0'a eklendi
resources	Sıra	Kaynaklar, Python kodunda tanımlanan kaynakları yüklemek için tam işlev yollarının bir listesini içerir, örneğin ["my_project.resources:load_resources"] Databricks CLI sürüm 0.238.0'a eklendi
venv_path	Dize	Sanal ortamın yolu. Etkinleştirilirse Python kodu bu ortamda yürütülür. Devre dışı bırakılırsa varsayılan olarak geçerli kabukta bulunan Python yorumlayıcısını kullanır. Databricks CLI sürüm 0.238.0'a eklendi

Kaynaklar

Type: Map

Paketin kaynaklarını tanımlar; burada her anahtar kaynağın adıdır ve değer kaynağı tanımlayan bir Eşlem'dir. Bildirim temelli Otomasyon Paketleri desteklenen kaynaklar ve kaynak tanımı başvurusu hakkında daha fazla bilgi için bkz . Bildirim temelli Otomasyon Paketleri kaynakları.

Eşleme resources en üst düzey eşleme olarak görünebilir veya en üst düzey hedef eşlemesindeki bir veya daha fazla hedefin alt öğesi olabilir ve desteklenen kaynak türlerinden sıfır veya birini içerir. Her bir kaynak türü eşlemesi, her biri benzersiz bir ada sahip olması gereken bir veya daha fazla bireysel kaynak bildirimi içerir. Bu tek tek kaynak bildirimleri, kaynağı tanımlamak için ilgili nesnenin oluşturma işleminin YAML ile ifade edilen istek yükünü kullanır. Bir kaynağın desteklenen özellikleri, ilgili nesnenin desteklenen alanlarıdır.

Oluşturma işlemi isteği yükleri, Databricks REST API Başvurusu'nda belgelenmiştir ve komutu desteklenen tüm nesne şemalarını çıkış olarak verir. Ayrıca, paket yapılandırma dosyalarında databricks bundle validate bilinmeyen kaynak özellikleri bulunursa komut uyarı döndürür.

Paketlerde desteklenen kaynaklar ve yaygın yapılandırma ve örnekler hakkında daha fazla bilgi için bkz . Bildirim temelli Otomasyon Paketleri kaynakları ve Paket yapılandırma örnekleri.

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

Anahtar	Tür	Açıklama
alerts	Harita	Paket için uyarı (v2) tanımlarıdır ve burada her anahtar uyarının adıdır. Uyarıya bakın. Databricks CLI sürüm 0.279.0'a eklendi
apps	Harita	Paketin Databricks uygulama tanımları; burada her anahtar uygulamanın adıdır. Bkz. uygulama. Databricks CLI sürüm 0.239.0'a eklendi
catalogs	Harita	Paketin katalog (Unity Kataloğu) tanımları; burada her anahtar bir kataloğun adıdır. Bkz. kataloglar. Databricks CLI sürüm 0.287.0'a eklendi
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. Bakınız gösterge paneli. Databricks CLI sürüm 0.232.0'a eklendi
database_catalogs	Harita	Paketin veritabanı kataloğu tanımları; burada her anahtar veritabanı kataloğunun adıdır. Bkz. database_catalog. Databricks CLI sürüm 0.265.0'a eklendi
database_instances	Harita	Her anahtarın veritabanı örneğinin adı olduğu paket için veritabanı örneği tanımları. Bkz. database_instance. Databricks CLI sürüm 0.265.0'a eklendi
experiments	Harita	Paketin deneme tanımları; burada her anahtar denemenin adıdır. Bakınız deneme.
external_locations	Harita	Paketin dış konum tanımları; burada her anahtar konumun adıdır. Bkz. external_location (Unity Kataloğu). Databricks CLI sürüm 0.289.0'a eklendi
genie_spaces	Harita	Paket için Genie aracısı tanımlarıdır ve burada her anahtar Genie aracısının adıdır. Bkz. genie_space. Databricks CLI sürüm 1.3.0'a eklendi
jobs	Harita	Paketin iş tanımları; burada her anahtar işin adıdır. İşe bakın.
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. model (eski).
pipelines	Harita	Her anahtarın işlem hattının adı olduğu paket için işlem hattı tanımları. Bkz. işlem hattı.
postgres_branches	Harita	Paketin Postgres dal tanımları; burada her anahtar Lakebase dalının adıdır. bkz. postgres_branch. Databricks CLI sürüm 0.287.0'a eklendi
postgres_catalogs	Harita	Paketin Postgres katalog tanımları; burada her anahtar kataloğun adıdır. Bkz. postgres_catalog. Databricks CLI sürüm 1.0.0'a eklendi
postgres_databases	Harita	Paketin Postgres veritabanı tanımları; burada her anahtar veritabanının adıdır. bkz. postgres_database. Databricks CLI sürüm 1.4.0'a eklendi
postgres_endpoints	Harita	Paketin Postgres uç noktası tanımları; burada her anahtar Lakebase işlem uç noktasının adıdır. Bkz. postgres_endpoint. Databricks CLI sürüm 0.287.0'a eklendi
postgres_projects	Harita	Paketin Postgres proje tanımları; burada her anahtar Lakebase projesinin adıdır. Bkz. postgres_project. Databricks CLI sürüm 0.287.0'a eklendi
postgres_roles	Harita	Paketin Postgres rol tanımları; burada her anahtar rolün adıdır. Bkz. postgres_role. Databricks CLI sürüm 1.4.0'a eklendi
postgres_synced_tables	Harita	Paket için Postgres eşitlenmiş tablo tanımlarıdır ve burada her anahtar eşitlenen tablonun adıdır. Bkz. postgres_synced_table. Databricks CLI sürüm 1.0.0'a eklendi
quality_monitors	Harita	Paketin kalite izleyici tanımları; burada her anahtar kalite izleyicisinin adıdır. Bkz. quality_monitor (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).
secret_scopes	Harita	Paketin gizli dizi kapsamı tanımlarıdır ve burada her anahtar gizli dizi kapsamının adıdır. Bkz. secret_scope. Databricks CLI sürüm 0.252.0'a eklendi
sql_warehouses	Harita	Paketin SQL ambar tanımları; burada her anahtar SQL ambarının adıdır. Bkz. sql_warehouse. Databricks CLI sürüm 0.260.0'a eklendi
synced_database_tables	Harita	Paket için eşitlenmiş veritabanı tablosu tanımları; burada her anahtar veritabanı tablosunun adıdır. Bkz. synced_database_table. Databricks CLI sürüm 0.266.0'a eklendi
vector_search_endpoints	Harita	Paketin AI Search uç noktası tanımları; burada her anahtar AI Search uç noktasının adıdır. Bkz. vector_search_endpoint. Databricks CLI sürüm 0.298.0'a eklendi
vector_search_indexes	Harita	Paketin vektör arama dizini tanımları; burada her anahtar vektör arama dizininin adıdır. bkz. vector_search_index. Databricks CLI sürüm 1.1.0'a eklendi
volumes	Harita	Paketin birim tanımları; burada her anahtar birimin adıdır. Bkz. cilt (Unity Kataloğu). Databricks CLI sürüm 0.236.0'a eklendi

Örnek

Aşağıdaki örnek yapılandırma bir iş kaynağını tanımlar:

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

run_as

Type: Map

Bildirim temelli Otomasyon Paketleri kaynaklarını çalıştırmak için kullanılacak kimlik (user_name veya service_principal_name). Bir paket işi veya işlem hattını dağıtmak için kullanılan kimliği, işi veya işlem hattını çalıştırmak için kullanılan kimlikten ayırma olanağı sağlar. Bkz. Bildirim temelli Otomasyon 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.

Komut dosyaları

Type: Map

bundle run kullanılarak çalıştırılabilecek betikler. scripts eşlemesindeki her adlandırılmış betik, komutları içeren içerik barındırır. Bkz. Betikleri yürütme.

Databricks CLI sürüm 0.259.0'a eklendi

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

Anahtar	Tür	Açıklama
content	Dize	Çalıştırılacak komutlar Databricks CLI sürüm 0.259.0'a eklendi

Örnekler

scripts:
  my_script:
    content: uv run pytest -m dev

Eşitleme

Type: Map

Pakete eklenecek veya hariç tutulacak dosyalar ve dosya yolları.

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

dahil et ve dışla

include eşlemesi içindeki exclude ve sync eşlemeleri, aşağıdaki kurallara bağlı olarak paket dağıtımlarına dahil edilen veya hariç tutulacak dosya veya klasörlerin listesini belirtir:

• Paketin kökündeki bir .gitignore dosyasında bulunan dosya ve yol globlarının herhangi bir listesine bağlı olarak, include haritalandırması, dosya glob'ları, yol glob'ları veya her ikisini de içerebilen bir liste içerebilir ve bu liste paketin köküne göre açıkça dahil edilir.
• Paketin kökündeki bir .gitignore dosyadaki dosya ve yol glob'larının listesinin yanı sıra eşlemedeki include dosya ve yol globlarının listesine bağlı olarak, exclude eşleme açıkça dışlamak için paketin köküne göre dosya globları, yol glob'ları veya her ikisini de içerebilir.

Belirtilen dosya ve klasörlerin tüm yolları, belirtilen paket yapılandırma dosyasının konumuna göre belirlenir.

include ve exclude dosya ve yol desenlerinin söz dizimi standart .gitignore desen söz dizimini takip eder. Bkz. gitignore Desen Formatı.

Örneğin, aşağıdaki .gitignore dosya aşağıdaki girdileri içeriyorsa:

.databricks
my_package/dist

Paket yapılandırma dosyası aşağıdaki include eşlemeyi içerir:

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

Ardından, dosya uzantısına my_package/dist sahip klasördeki *.whl tüm dosyalar eklenir. Klasördeki my_package/dist diğer dosyalar dahil değildir.

Ancak, paket yapılandırma dosyası da aşağıdaki exclude eşlemeyi içeriyorsa:

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

Ardından, my_package/dist dosya uzantısına sahip ve *.whl klasöründe bulunan dosyalar arasından, adı delete-me.whl olmayan tüm dosyalar eklenir. Klasördeki my_package/dist diğer dosyalar da dahil değildir.

Belirli bir hedef için sync eşlemesi, targets eşlemesinde de bildirilebilir. Hedefte bildirilen tüm sync eşlemeler, en üst düzey sync eşleme bildirimleriyle birleştirilir. Örneğin, önceki örneğe devam edersek, include düzeyindeki aşağıdaki eşleme, en üst düzey targets eşlemedeki include eşlemeyle sync birleştirilir.

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

sync.paths

sync eşleme, çalışma alanıyla eşitlenecek yerel yolları belirten bir paths eşleme içerebilir. paths eşlemesi, ortak dosyaları paketler arasında paylaşmanıza olanak tanır ve paket kökü dışında bulunan dosyaları eşitlemek için kullanılabilir. (Paket kökü, databricks.yml dosyasının konumudur.) Bu, özellikle birden çok paketi barındıran ve kitaplıkları, kod dosyalarını veya yapılandırmayı paylaşmak istediğiniz tek bir deponuz olduğunda kullanışlıdır.

Belirtilen yollar, paths eşlemesinin ayarlandığı klasöre sabitlenmiş dosyalara ve dizinlere göre olmalıdır. Bir veya daha fazla yol değeri, dizin yapısında paket kökünün bir üst düzeyine kadar geçerse, klasör yapısının bozulmadan kalmasını sağlamak için kök yol dinamik olarak belirlenir. Örneğin, paket kök klasörünün adı my_bundle olduğunda, databricks.yml içindeki bu yapılandırma, paket kök dizini ile onun bir düzey üzerinde bulunan common klasörünü senkronize eder.

sync:
  paths:
    - ../common
    - .

Bu paketin dağıtılması, çalışma alanında aşağıdaki klasör yapısına neden olur:

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

Hedef

Type: Map

Paket için dağıtım hedefi bağlamlarını tanımlar. Her hedef benzersiz bir yapıt koleksiyonu, Azure Databricks çalışma alanı ayarları ve bazen hedefe özgü kaynak ayrıntılarıdır.

Eşleme targets , bir veya birden fazla hedef eşlemeden oluşur ve her birinin benzersiz bir programatik (veya mantıksal) ada sahip olması gerekir. Bu eşleme isteğe bağlıdır ancak kesinlikle önerilir.

Eşleme içindeki targets ayarlar üst düzey çalışma alanında, yapıtlarda ve kaynak eşlemelerinde belirtilen ayarlardan önceliklidir.

Hedef,en üst düzey değişkenlerin değerlerini de geçersiz kılabilir.

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

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. Bkz. paket.
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	Boolyen	Bu hedefin varsayılan hedef olup olmadığı. Hedefleri görün.name.default.
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. Hedefleri görün.name.mode ve Bildirim temelli Otomasyon Paketleri dağıtım modları.
permissions	Sıra	Paketi hedefte dağıtma ve çalıştırma izinleri. Bkz. izinler.
presets	Harita	Hedef için dağıtım ön ayarları. Hedefleri görün.name.presets.
resources	Harita	Hedef için kaynak tanımları. Kaynaklara bakın.
run_as	Harita	Paketi çalıştırmak için kullanılacak kimlik. Bildirim temelli Otomasyon Paketleri iş akışı için run_as ve Çalıştırma kimliği belirtme bölümüne bakın.
sync	Harita	Bir paket çalıştırıldığında veya dağıtıldığında hedef çalışma alanıyla senkronize edilecek yerel yollar. Bkz. eşitleme .
variables	Harita	Hedef için özel değişken tanımları. Bkz . değişkenler.
workspace	Harita	Hedef için Databricks çalışma alanı. Bkz. çalışma alanı.

Hedef. name.default

Paket komutları için bir hedef varsayılanı belirtmek için default eşlemesini trueolarak ayarlayın. Örneğin, adlı dev bu hedef varsayılan hedeftir:

targets:
  dev:
    default: true

Varsayılan hedef yapılandırılmamışsa veya işleri veya işlem hatlarını belirli bir hedef içinde doğrulamak, dağıtmak ve çalıştırmak istiyorsanız paket komutlarının seçeneğini kullanın -t .

Aşağıdaki komutlar, my_job ve dev hedefleri içinde prod doğrular, dağıtır ve çalıştırır:

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

Aşağıdaki örnekte iki hedef bildirmektedir. İlk hedefin adı dev vardır ve paket komutları için hedef belirtilmediğinde kullanılan varsayılan hedeftir. İkinci hedefin adı prod olup, yalnızca bu hedef paket komutları için belirtildiğinde kullanılır.

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

Hedef. name.mode

Kolay geliştirme ve CI/CD en iyi uygulamalarını kolaylaştırmak için Bildirim temelli Otomasyon Paketleri, üretim öncesi ve üretim iş akışları için varsayılan davranışları ayarlayan hedefler için dağıtım modları sağlar. Bazı davranışlar da hedefler kullanılarak yapılandırılabilir.name.presets.

Ayrıntılar için bkz . Bildirim temelli Otomasyon Paketleri dağıtım modları.

Tavsiye

Paketlerin çalıştırma kimliklerini ayarlamak için, run_as başlığında açıklandığı gibi her hedef için belirtebilirsiniz.

Hedefin geliştirme hedefi olarak işleneceğini belirtmek için mode eşleme kümesini developmentolarak ekleyin. Hedefin üretim hedefi olarak işleneceğini belirtmek için mode eşleme kümesini productionolarak ekleyin. Örneğin, adlı prod bu hedef bir üretim hedefi olarak değerlendirilir:

targets:
  prod:
    mode: production

Hedef. name.presets

Eşlemeyi kullanarak mode hedef dağıtım presets davranışlarından bazılarını özelleştirebilirsiniz.

Kullanılabilir ön ayarların listesi için bkz. Özel ön ayarlar.

Aşağıdaki örnekte, tüm üretim kaynaklarına ön ek ekleyen ve etiketleyen özelleştirilmiş bir üretim hedefi gösterilmektedir:

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

Değişken

Type: Map

Paket için özel bir değişken tanımlar. Her değişken için, aşağıdaki biçimi kullanarak isteğe bağlı bir açıklama, varsayılan değer, özel değişkenin karmaşık bir tür olup olmadığı veya kimlik değeri almak için arama yapın:

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>

Uyarı

string typeolarak ayarlanmadığı sürece değişkenlerin complextüründe olduğu varsayılır. Bkz . Karmaşık değişken tanımlama.

Paket yapılandırması içinde özel bir değişkene başvurmak için yerine ${var.<variable_name>}kullanın.

Özel değişkenler ve değiştirmeler hakkında daha fazla bilgi için bkz. Bildirim temelli Otomasyon Paketleri'nde Değiştirmeler ve değişkenler.

Anahtar	Tür	Açıklama
default	Herhangi biri	Değişkenin varsayılan değeri.
description	Dize	Değişkenin açıklaması.
lookup	Harita	Kimliği alınacak alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalveya warehouse nesnesinin adı. Bkz. değişkenler.name.lookup.
type	Dize	Değişkenin türü, basit veya karmaşık. Bu anahtarı yalnızca değişken karmaşıksa ayarlayın. Geçerli değerler: complex.

Değişken. name.lookup

Type: Map

Kimliğinin alınacağı uyarı, cluster_policy, küme, pano, instance_pool, iş, meta veri deposu, işlem hattı, sorgu, service_principal veya ambar nesnesinin adı. Arama kullanma hakkında bilgi için bkz. Nesnenin kimlik değerini alma.

Anahtar	Tür	Açıklama
alert	Dize	Kimliği alınacak uyarının adı.
cluster	Dize	Kimlik alınacak kümenin adı.
cluster_policy	Dize	cluster_policy için ID'si alınacak olan ad.
dashboard	Dize	Kimliğinin alınacağı panonun adı.
instance_pool	Dize	Kimlik alınacak instance_pool adı.
job	Dize	Kimliği alınacak işin adı.
metastore	Dize	Kimliği alınacak meta veri deposunun adı.
notification_destination	Dize	Kimlik alınması gereken notification_destination'ın adı. Databricks CLI sürüm 0.236.0'a eklendi
pipeline	Dize	Kimlik alınacak işlem hattının adı.
query	Dize	Kimlik alınacak sorgunun adı.
service_principal	Dize	ID alınacak olan service_principal adı.
warehouse	Dize	Kimlik alınacak ambarın adı.

çalışma alanı

Type: Map

Paket için Databricks çalışma alanını tanımlar. Paket yapılandırma dosyası, kullanılacak varsayılan olmayan Azure Databricks çalışma alanı ayarlarını belirtmek için yalnızca bir üst düzey workspace eşleme içerebilir.

Önemli

Geçerli Databricks çalışma alanı yolları /Workspace ile başlar, yapıtlar için ise /Volumesde desteklenir. Özel çalışma alanı yollarına otomatik olarak "/Workspace" ön eki eklenir, bu nedenle özel yolunuzda "${workspace.file_path}" gibi herhangi bir çalışma alanı yolu değişimi kullanıyorsanız, yolun başına "/Workspace" eklemenize gerek yoktur.

Anahtar	Tür	Açıklama
account_id	Dize	Databricks hesap kimliği. Databricks CLI sürüm 0.296.0'a eklendi
artifact_path	Dize	Hem dağıtımlar hem de iş çalıştırmaları için çalışma alanında kullanılacak yapıt yolu
auth_type	Dize	Kullanılacak kimlik doğrulama türü, özellikle Databricks CLI'nin beklenmeyen bir kimlik doğrulama türü çıkardığı durumlarda önemlidir. Bkz. Azure Databricks kaynaklarına erişimi yetkilendirme.
azure_client_id	Dize	Azure istemci kimliği. Bkz . Çalışma alanı kimlik doğrulaması.
azure_environment	Dize	Azure ortamı. Bkz . Çalışma alanı kimlik doğrulaması.
azure_login_app_id	Dize	Azure oturum açma uygulaması kimliği. Bkz . Çalışma alanı kimlik doğrulaması.
azure_tenant_id	Dize	Azure kiracı kimliği. Bkz . Çalışma alanı kimlik doğrulaması.
azure_use_msi	Boolyen	Azure için MSI kullanılıp kullanılmaymayacağı. Bkz . Çalışma alanı kimlik doğrulaması.
azure_workspace_resource_id	Dize	Azure çalışma alanı kaynak kimliği. Bkz . Çalışma alanı kimlik doğrulaması.
client_id	Dize	Çalışma alanının istemci kimliği. Bkz . Çalışma alanı kimlik doğrulaması.
file_path	Dize	Hem dağıtımlar hem de iş çalıştırmaları için çalışma alanında kullanılacak dosya yolu. bkz. workspace.file_path.
google_service_account	Dize	Google hizmet hesabı adı. Bkz . Çalışma alanı kimlik doğrulaması.
host	Dize	Databricks çalışma alanı ana bilgisayar URL'si. Bkz: Çalışma alanı örneği adları, URL'ler ve kimlikler. Eşlemeyi host ayarlamak, Databricks CLI'ya dosyanızda .databrickscfg eşleşen bir profil bulmasını ve ardından kullanılacak Databricks kimlik doğrulama türünü belirlemek için bu profilin alanlarını kullanmasını gerektirir. Dosyanızda eşleşen host alana sahip birden çok profil varsa, bir profil belirtmek için eşlemeyi .databrickscfgprofile (veya komut --profile satırı seçeneklerini) kullanmanız -p gerekir.
profile	Dize	Databricks çalışma alanı profil adı. Bkz . workspace.profile.
resource_path	Dize	Çalışma alanı kaynak yolu Databricks CLI sürüm 0.230.0'a eklendi
root_path	Dize	Databricks çalışma alanı kök yolu. Bkz. workspace.root_path.
state_path	Dize	Çalışma alanı durum yolu. Bu anahtar varsayılan olarak öğesinin varsayılan yolunu ${workspace.root}/state kullanır ve dağıtımlar hakkındaki Terraform durum bilgilerini depolamak için çalışma alanınızdaki yolu temsil eder.
workspace_id	Tamsayı	Databricks çalışma alanı kimliği. Databricks CLI sürüm 0.285.0'a eklendi

çalışma alanı kimlik doğrulaması

Çalışma alanı eşlemesi, kullanılacak Databricks kimlik doğrulama mekanizmasını belirtmek için eşlemeler de içerebilir. Üst düzey çalışma alanı eşlemesinde belirtilmezlerse, bir çalışma alanı eşlemesinde en üst düzey hedef eşlemesindeki bir veya daha fazla hedefin alt öğesi olarak belirtilmelidir.

• OAuth makineden makineye (M2M) kimlik doğrulaması için eşleme client_id kullanılır. Alternatif olarak, bu değeri DATABRICKS_CLIENT_IDyerel ortam değişkeninde ayarlayabilirsiniz. Ya da client_id değeriyle bir yapılandırma profili oluşturabilir ve ardından profile eşlemesi ile profilin adını belirtebilirsiniz (veya Databricks CLI ile bundle doğrulama, dağıtma, çalıştırma ve yok etme komutlarını çalıştırırken --profile veya -p seçeneklerini kullanarak). Bkz. OAuth ile Azure Databricks'e hizmet sorumlusu erişimini yetkilendirme.

  Uyarı

  Paket yapılandırma dosyasında Azure Databricks OAuth gizli dizi değeri belirtemezsiniz. Bunun yerine yerel ortam değişkenini DATABRICKS_CLIENT_SECRETayarlayın. Ya da client_secret değerini bir yapılandırma profiline ekleyebilir ve ardından eşleme ile profile profilin adını veya doğrulama, dağıtma, çalıştırma ve yok etme komutlarını Databricks CLI ile çalıştırırken --profile veya -p seçeneklerini kullanarak belirtebilirsiniz.

• Azure CLI kimlik doğrulaması için eşleme azure_workspace_resource_id kullanılır. Alternatif olarak, bu değeri DATABRICKS_AZURE_RESOURCE_IDyerel ortam değişkeninde ayarlayabilirsiniz. Ya da azure_workspace_resource_id değeriyle bir yapılandırma profili oluşturabilir ve ardından profile eşlemesi ile profilin adını belirtebilirsiniz (veya Databricks CLI ile bundle doğrulama, dağıtma, çalıştırma ve yok etme komutlarını çalıştırırken --profile veya -p seçeneklerini kullanarak). Bkz. Azure CLI ile kimlik doğrulaması.

• Hizmet sorumlularıyla Azure istemci gizli anahtarı kimlik doğrulaması için azure_workspace_resource_id, azure_tenant_id ve azure_client_id eşlemeleri kullanılır. Alternatif olarak, bu değerleri sırasıyla , DATABRICKS_AZURE_RESOURCE_IDve ARM_TENANT_IDARM_CLIENT_IDyerel ortam değişkenlerinde ayarlayabilirsiniz. Alternatif olarak, azure_workspace_resource_id, azure_tenant_id ve azure_client_id değerleriyle bir yapılandırma profili oluşturabilir ve ardından profile eşlemesi ile profilin adını belirtebilirsiniz (ya da Databricks CLI ile doğrulama, dağıtma, çalıştırma ve yok etme komutlarını çalıştırırken --profile veya -p seçeneklerini kullanarak). Bkz. Microsoft Entra hizmet sorumlularıyla kimlik doğrulaması.

  Uyarı

  Paket yapılandırma dosyasında bir Azure istemci gizli anahtarı değeri belirtemezsiniz. Bunun yerine yerel ortam değişkenini ARM_CLIENT_SECRETayarlayın. Ya da azure_client_secret değerini bir yapılandırma profiline ekleyebilir ve ardından eşleme ile profile profilin adını veya doğrulama, dağıtma, çalıştırma ve yok etme komutlarını Databricks CLI ile çalıştırırken --profile veya -p seçeneklerini kullanarak belirtebilirsiniz.

• Azure yönetilen kimlik doğrulaması için , azure_use_msive azure_client_id eşlemeleri azure_workspace_resource_idkullanılır. Alternatif olarak, bu değerleri sırasıyla , ARM_USE_MSIve ARM_CLIENT_IDDATABRICKS_AZURE_RESOURCE_IDyerel ortam değişkenlerinde ayarlayabilirsiniz. Alternatif olarak, azure_use_msi, azure_client_id ve azure_workspace_resource_id değerleriyle bir yapılandırma profili oluşturabilir ve ardından profile eşlemesi ile profilin adını belirtebilirsiniz (ya da Databricks CLI ile doğrulama, dağıtma, çalıştırma ve yok etme komutlarını çalıştırırken --profile veya -p seçeneklerini kullanarak). Bkz. Azure yönetilen kimlikleriyle kimlik doğrulaması.

• azure_environment eşlemesi belirli bir API uç noktası kümesi için Azure ortam türünü (Genel, UsGov, Çin ve Almanya gibi) belirtir. Varsayılan değer şudur: PUBLIC. Alternatif olarak, bu değeri ARM_ENVIRONMENTyerel ortam değişkeninde ayarlayabilirsiniz. Ya da azure_environment değerini bir yapılandırma profiline ekleyebilir ve ardından eşleme ile profile profilin adını veya doğrulama, dağıtma, çalıştırma ve yok etme komutlarını Databricks CLI ile çalıştırırken --profile veya -p seçeneklerini kullanarak belirtebilirsiniz.

• azure_login_app_id eşleme işlemsel değildir ve iç kullanım için ayrılmıştır.

workspace.root_path

Bu workspace eşleme, hem dağıtımlar hem de iş akışı çalıştırmaları için çalışma alanında kullanılacak varsayılan olmayan bir kök yol belirtmek için bir root_path eşleme içerebilir, örneğin:

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

Varsayılan olarak, Databricks CLI, değişkenlerini kullanarak varsayılan yolunu kullanır.

Önemli

Üretim /Sharedolarak bir /Shared/.bundle/prod/... yol (örneğinroot_path) kullanmayın. Klasör /Shared tüm çalışma alanı kullanıcıları tarafından yazılabilir; başka bir deyişle herkes dağıtılan üretim kodunuzu, iş tanımlarınızı ve kitaplıklarınızı değiştirebilir. Bunun yerine, yazma erişimi ACL'lerle denetlenen bir klasöre dağıtın ve yalnızca paketi dağıtan kimliğe yazma erişimi verin.

Databricks, bir hizmet sorumlusu kullanarak üretim paketlerini dağıtmanızı ve üretimde yazma erişimini bu hizmet sorumlusuyla root_path kısıtlamanızı önerir.

workspace.artifact_path

Bu workspace eşleme, hem dağıtımlar hem de iş çalıştırmaları için çalışma alanında kullanılacak varsayılan olmayan bir yapıt yolu belirtmek için bir artifact_path eşleme de içerebilir, örneğin:

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

Varsayılan olarak, Databricks CLI, değişkenlerini kullanarak varsayılan yolunu kullanır.

Uyarı

Eşleme artifact_path, Databricks Dosya Sistemi (DBFS) yollarını desteklemez.

workspace.file_path

Bu workspace eşleme, hem dağıtımlar hem de iş çalıştırmaları için çalışma alanında kullanılacak varsayılan olmayan bir dosya yolu belirtmek için bir file_path eşleme de içerebilir, örneğin:

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

Varsayılan olarak, Databricks CLI, değişkenlerini kullanarak varsayılan yolunu kullanır.

Önemli

Söz dizimini kullanarak bu kimlik doğrulama değerleri için ${var.*} belirtemezsiniz.

workspace.profile

Uyarı

Databricks, paket yapılandırma dosyalarınızın daha taşınabilir olmasını sağlamak için, host eşlemesi yerine --profile eşlemesini (veya paket doğrulama, dağıtma, çalıştırma ve yok etme komutlarını Databricks CLI ile çalıştırırken -p veya profile seçeneklerini) kullanmanızı önerir.

Eşleme, profile bu Azure Databricks çalışma alanında kimlik doğrulaması yapmak için kullanılacak yapılandırma profilinin adını belirtir. Bu yapılandırma profili, Databricks CLI'yı ayarlarken oluşturduğunuz profille eşler.

Ortak nesneler

Git

Type: Map

Git sürüm denetimi ayrıntılarını tanımlar. Bu, daha sonra kaynakları tanımlamak için kullanılabilecek dağıtım meta verilerini yaymak için kullanışlıdır. Örneğin, CI/CD tarafından dağıtılan bir işin depo kaynağını izleyebilirsiniz.

bundle komutunu, validate, deploy veya run gibi bir komutu her çalıştırdığınızda, bundle komutu, komutun yapılandırma ağacını aşağıdaki varsayılan ayarlarla doldurur:

Git ayarlarını almak veya geçersiz kılmak için paketinizin git deposuyla ilişkilendirilmiş bir dizin içinde olması gerekir. Örneğin, komutu çalıştırılarak git clone başlatılan yerel dizin. Dizin bir Git deposuyla ilişkilendirilmemişse, bu Git ayarları boş olur.

Anahtar	Tür	Açıklama
branch	Dize	Geçerli Git dal adı. Bu, klonlanmış deponuzdan git branch --show-current komutunu çalıştırdığınızda elde edeceğiniz değerle aynıdır. Paket yapılandırma dosyalarınızda bu değere ikâme kullanarak başvurabilirsiniz.
origin_url	Dize	Deponun kaynak URL'si. Bu, klonlanmış deponuzdan git config --get remote.origin.url komutunu çalıştırdığınızda elde edeceğiniz değerle aynıdır. Paket yapılandırma dosyalarınızda bu değere ikâme kullanarak başvurabilirsiniz.

Örnekler

Gerekirse, ve ayarlarını üst düzey eşlemenizin eşlemesi içinde origin_url geçersiz kılabilirsiniz branchgit:bundle

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