Compartilhar via

Referência de configuração

Este artigo fornece referência para chaves compatíveis com a configuração de Pacotes de Ativos do Databricks (YAML). Consulte O que são os Pacotes de Ativos do Databricks?.

Para obter exemplos completos do pacote, consulte Exemplos de configuração do Pacote e o repositório bundle-examples no GitHub.

artefatos

Type: Map

Define as características para criar artefatos, em que cada chave é o nome do artefato e o valor é um Mapa que define as configurações de criação do artefato. Para informações sobre o mapeamento artifacts, consulte artifacts.

As configurações de artefato definidas no nível superior da configuração do pacote podem ser substituídas no mapeamento de targets. Consulte Substituir com as configurações de destino.

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>
Chave Tipo Descrição
build corda Um conjunto opcional de comandos de build a serem executados localmente antes da implantação.
dynamic_version booleano Se a versão da roda será corrigida dinamicamente com base no carimbo de data/hora do arquivo whl. Se isso estiver definido como true, novos códigos poderão ser implantados sem a necessidade de atualizar a versão em setup.py ou pyproject.toml. Essa configuração só é válida quando type está definido como whl. Confira artefatos.
executable corda O tipo de executável. Os valores válidos são bash, sh e cmd.
files Sequência O caminho relativo ou absoluto para os arquivos de artefato criados. Confira artifacts.name.files.
path corda O caminho local do diretório do artefato.
type corda Necessário se o artefato for uma roda do Python. O tipo do artefato. Os valores válidos são whl e jar.

Exemplo

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

artifacts.name.files

Type: Sequence

O caminho relativo ou absoluto para os arquivos de artefato criados.

Chave Tipo Descrição
source corda Obrigatório O arquivo de origem do artefato.

pacote

Type: Map

As características do pacote ao implantar nesse destino.

Chave Tipo Descrição
cluster_id corda A ID de um cluster a ser usada para executar o pacote. Confira cluster_id.
compute_id corda Preterido. A ID da computação que será usada para executar o pacote.
databricks_cli_version corda A versão da CLI do Databricks a ser usada para o pacote. Confira databricks_cli_version.
deployment Mapeamento A definição da implantação do pacote. Para ver as características com suporte, confira Modos de implantação do Pacote de Ativos do Databricks. Confira bundle.deployment.
git Mapeamento Os detalhes do controle de versão do Git associados ao bundle. Para ver as características com suporte, confira Git. Confira Git.
name corda O nome do pacote.
uuid corda Reservado. Um UUID (Identificador Universal exclusivo) para o pacote que identifica exclusivamente o pacote em sistemas internos do Databricks. Isso é gerado quando um projeto de pacote é inicializado usando um modelo do Databricks (usando o comando databricks bundle init).

bundle.deployment

Type: Map

A definição da implantação do pacote

Chave Tipo Descrição
fail_on_active_runs booleano Se deve falhar em execuções ativas. Se isso estiver definido como verdadeiro, uma implantação em execução poderá ser interrompida.
lock Mapeamento As características de bloqueio da implantação. Confira bundle.deployment.lock.

bundle.deployment.lock

Type: Map

As características de bloqueio da implantação.

Chave Tipo Descrição
enabled booleano Se esse bloqueio está habilitado.
force booleano Se será necessário forçar esse bloqueio se ele estiver habilitado.

experimental

Type: Map

Define atributos para recursos experimentais.

Chave Tipo Descrição
python Mapeamento Preterido. Em vez disso, use o mapeamento de nível superior python.
python_wheel_wrapper booleano Se deve usar um wrapper do pacote wheel Python.
scripts Mapeamento Os comandos a serem executados.
use_legacy_run_as booleano Se deve usar o comportamento herdado run_as.

include

Type: Sequence

Especifica uma lista de globos de caminho que contêm arquivos de configuração a serem incluídos no pacote. Confira include.

permissões

Type: Sequence

Uma sequência que define as permissões a serem aplicadas aos recursos definidos no pacote, em que cada item na sequência é uma permissão para uma entidade específica.

Consulte permissões e Definir permissões para recursos nos Pacotes de Ativos do Databricks.

Chave Tipo Descrição
group_name corda O nome do grupo que tem o conjunto de permissões no nível.
level corda A permissão permitida para o usuário, grupo ou entidade de serviço definida para essaa permissão. Os valores válidos para essa chave são diferentes dependendo se as permissões são definidas no nível superior do pacote ou em um recurso específico. Consulte Definir permissões para recursos em Pacotes de Ativos do Databricks.
service_principal_name corda O nome da entidade de serviço que tem o conjunto de permissões no nível.
user_name corda O nome do usuário que tem o conjunto de permissões no nível.

Exemplo

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

predefinições

Type: Map

Define as predefinições de implantação de pacote. Consulte Predefinições personalizadas.

Chave Tipo Descrição
jobs_max_concurrent_runs Número Inteiro O número máximo de execuções simultâneas para um trabalho.
name_prefix corda O prefixo para execuções de trabalho do pacote.
pipelines_development booleano Se as implantações de pipeline devem ser bloqueadas no modo de desenvolvimento.
source_linked_deployment booleano Se deve vincular a implantação à origem do pacote.
tags Mapeamento Os rótulos para a implantação do pacote.
trigger_pause_status corda Um status de pausa a ser aplicado a todos os gatilhos e agendamentos de trabalho. Os valores válidos são PAUSED ou UNPAUSED.

python

Type: Map

Configura o carregamento do código Python definido com o pacote databricks-bundles. Para obter mais informações, consulte a Configuração de Pacotes no Python.

Chave Tipo Descrição
mutators Sequência Os mutadores contém uma lista de caminhos de função totalmente qualificados para funções mutadoras, como [my_project.mutators:add_default_cluster].
resources Sequência Os recursos contém uma lista de caminhos de função totalmente qualificados para carregar recursos definidos no código Python, como ["my_project.resources:load_resources"]
venv_path corda O caminho para o ambiente virtual. Se habilitado, o código Python é executado nesse ambiente. Se estiver desabilitado, o padrão será usar o interpretador Python disponível no shell atual.

recursos

Type: Map

Um mapa que define os recursos do pacote, em que cada chave é o nome do recurso e o valor é um Mapa que define o recurso. Para obter mais informações sobre os recursos com suporte dos Pacotes de Ativos do Databricks e a referência de definição de recursos, consulte Recursos de Pacotes de Ativos do Databricks.

resources:
  <resource-type>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Chave Tipo Descrição
alerts Mapeamento As definições de alerta (v2) para o conjunto, onde cada chave é o nome do alerta. Consulte o alerta.
apps Mapeamento As definições de aplicativos do Databricks para o pacote, em que cada chave é o nome do aplicativo. Confira aplicativo.
clusters Mapeamento As definições de cluster para o pacote, em que cada chave é o nome de um cluster. Confira cluster.
dashboards Mapeamento As definições de dashboard para o pacote, em que cada chave é o nome do dashboard. Confira dashboard.
database_catalogs Mapeamento As definições do catálogo de banco de dados para o pacote, em que cada chave é o nome do catálogo de banco de dados. Veja database_catalog.
database-instances Mapeamento As definições de instância de banco de dados para o pacote, em que cada chave é o nome da instância do banco de dados. Veja database_instance.
experiments Mapeamento As definições de experimento para o pacote, em que cada chave é o nome do experimento. Confira experimento.
jobs Mapeamento As definições de tarefas para o pacote, onde cada chave é o nome da tarefa. Confira trabalho.
model_serving_endpoints Mapeamento As definições de ponto de extremidade do serviço de modelo para o pacote, em que cada chave é o nome do ponto de extremidade do serviço de modelo. Confira model_serving_endpoint.
models Mapeamento As definições de modelo para o pacote, em que cada chave é o nome do modelo. Confira modelo (herdado).
pipelines Mapeamento As definições de pipeline para o pacote, em que cada chave é o nome do pipeline. Confira pipeline.
quality_monitors Mapeamento As definições do monitor de qualidade para o pacote, em que cada chave é o nome do monitor de qualidade. Confira quality_monitor (Catálogo do Unity).
registered_models Mapeamento As definições de modelo registradas para o pacote, onde cada chave corresponde ao nome de um modelo registrado no Catálogo Unity. Confira registered_model (Catálogo do Unity).
schemas Mapeamento As definições de esquema para o pacote, em que cada chave é o nome do esquema. Confira schema (Catálogo do Unity).
secret_scopes Mapeamento As definições de escopo secreto para o pacote, em que cada chave é o nome do escopo do segredo. Consulte secret_scope.
sql_warehouses Mapeamento As definições do SQL Warehouse para o pacote, em que cada chave é o nome do SQL Warehouse. Consulte sql_warehouse.
synced_database_tables Mapeamento As definições da tabela de banco de dados sincronizada para o pacote, em que cada chave é o nome da tabela de banco de dados. Veja synced_database_table.
volumes Mapeamento As definições de volume para o conjunto, em que cada chave é o nome do volume. Confira volume (Catálogo do Unity).

run_as

Type: Map

A identidade a ser usada ao executar fluxos de trabalho de Pacotes de Ativos do Databricks. Consulte Especificar uma identidade de execução para um fluxo de trabalho do Pacotes de Ativos do Databricks.

Chave Tipo Descrição
service_principal_name corda A ID do aplicativo de uma entidade de serviço ativa. Definir este campo requer a função servicePrincipal/user.
user_name corda O e-mail de um usuário ativo do workspace. Usuários não administradores só podem definir esse campo como seu próprio email.

scripts

Type: Map

Os scripts que podem ser executados usando bundle run. Consulte Executar scripts.

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>
Chave Tipo Descrição
content corda Os comandos a serem executados

sincronização

Type: Map

Os arquivos e caminhos de arquivo a serem incluídos ou excluídos no pacote. Consulte sincronização.

Chave Tipo Descrição
exclude Sequência Uma lista de arquivos ou pastas a serem excluídos do pacote.
include Sequência Uma lista de arquivos ou pastas a serem incluídos no pacote.
paths Sequência Os caminhos das pastas locais, que podem estar fora da raiz do pacote, devem ser sincronizados com o espaço de trabalho quando o pacote for implantado.

targets

Type: Map

Define os destinos de implantação para o pacote. Confira targets

targets:
  <target-name>:
    <target-field-name>: <target-field-value>
Chave Tipo Descrição
artifacts Mapeamento Os artefatos a serem incluídos na implantação de destino. Confira artefatos.
bundle Mapeamento As características do pacote ao implantar nesse destino. Consulte o pacote.
cluster_id corda A ID do cluster que será usado para esse destino.
compute_id corda Preterido. A ID da computação a ser usada para esse destino.
default booleano Se esse destino é o destino padrão.
git Mapeamento As configurações de controle de versão do Git para o destino. Confira Git.
mode corda O modo de implantação para o destino. Os valores válidos são development ou production. Confira Modos de implantação do Pacote de Ativos do Databricks.
permissions Sequência As permissões para implantar e executar o pacote no destino. Consulte permissões.
presets Mapeamento Os predefinições de implantação para o destino. Consulte as predefinições.
resources Mapeamento As definições de recursos para o destino. Consulte os recursos.
run_as Mapeamento A identidade que será usada para executar o pacote, consulte Especificar uma identidade de execução para um fluxo de trabalho do Pacotes de Ativos do Databricks. Veja run_as.
sync Mapeamento Os caminhos locais a serem sincronizados com o espaço de trabalho de destino quando um pacote for executado ou implantado. Consulte sincronização.
variables Mapeamento As definições personalizadas de variáveis para o alvo. Confira variáveis.
workspace Mapeamento O workspace do Databricks para o destino. Consulte workspace.

variáveis

Type: Map

Define uma variável personalizada para o pacote. Confira variáveis.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>
Chave Tipo Descrição
default Qualquer O valor padrão da variável.
description corda A descrição da variável.
lookup Mapeamento O nome do objeto alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalou warehouse para o qual recuperar uma ID. Confira variables.name.lookup.
type corda O tipo da variável, simples ou complexa. Defina essa chave somente se a variável for complexa. Valores válidos: complex.

variables.name.lookup

Type: Map

O nome do objeto de alerta, cluster_policy, cluster, dashboard, instance_pool, trabalho, metastore, pipeline, consulta, service_principal ou warehouse para o qual recuperar uma ID. Para obter informações sobre como usar a pesquisa, consulte Recuperar o valor da ID de um objeto.

Chave Tipo Descrição
alert corda O nome do alerta para o qual recuperar uma ID.
cluster corda O nome do cluster para o qual recuperar uma ID.
cluster_policy corda O nome do cluster_policy para o qual recuperar uma ID.
dashboard corda O nome do dashboard para o qual recuperar uma ID.
instance_pool corda O nome do instance_pool para o qual recuperar uma ID.
job corda O nome do trabalho para o qual recuperar uma ID.
metastore corda O nome do metastore para o qual recuperar uma ID.
notification_destination corda O nome do notification_destination para o qual recuperar uma ID.
pipeline corda O nome do pipeline para o qual recuperar uma ID.
query corda O nome da consulta para o qual recuperar uma ID.
service_principal corda O nome do service_principal para o qual recuperar uma ID.
warehouse corda O nome do warehouse para o qual recuperar uma ID.

espaço de trabalho

Type: Map

Define o espaço de trabalho do Databricks para o pacote. Consulte workspace.

Chave Tipo Descrição
artifact_path corda O caminho do artefato a ser usado no espaço de trabalho para implantações e execuções de fluxo de trabalho
auth_type corda O tipo de autenticação.
azure_client_id corda A ID do cliente do Azure
azure_environment corda O ambiente do Azure
azure_login_app_id corda A ID do aplicativo de logon do Azure
azure_tenant_id corda A ID do locatário do Azure
azure_use_msi booleano Se deve usar MSI para o Azure
azure_workspace_resource_id corda A ID do recurso do espaço de trabalho do Azure
client_id corda A ID do cliente do espaço de trabalho
file_path corda Caminho do arquivo a ser usado no espaço de trabalho para implantações e execuções de fluxo de trabalho
google_service_account corda Nome da conta de serviço do Google
host corda URL do host do workspace do Databricks
profile corda Nome do perfil do workspace do Databricks
resource_path corda Caminho do recurso do espaço de trabalho
root_path corda Caminho raiz do workspace do Databricks
state_path corda Caminho de estado do espaço de trabalho

Objetos comuns

Git

Type: Map

Define os detalhes do controle de versão do Git.

Chave Tipo Descrição
branch corda O nome do GIT branch. Confira Git.
origin_url corda A URL de origem do repositório. Confira Git.
  • Last updated on