Compartilhar via

Referência de configuração

  • Artigo

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 de pacote, consulte Exemplos de configuração do pacote e Repositório GitHub de exemplos de pacote.

artefato

Define as configurações para criar um artefato.

Chave Tipo Descrição
build corda Um conjunto opcional de comandos de build a serem executados localmente antes da implantação.
executable corda O tipo executável. Os valores válidos são bash, sh e cmd.
files Mapeamento O caminho relativo ou absoluto para os arquivos de artefato criados, definido como artifact_file.
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.

artefatos

Define os atributos para compilar artefatos, em que cada chave é o nome do artefato e o valor é um Mapa que define as configurações de compilação do artefato . Para obter informações sobre o mapeamento artifacts, consulte artefatos.

As configurações de artefato definidas no nível superior da configuração do pacote podem ser substituídas no mapeamento de targets. Consulte Definir configurações de artefato nos Pacotes de Ativos do Databricks.

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

Exemplo

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

artifact_file

Define um arquivo de artefato em um pacote.

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

pacote

Os atributos do pacote. Consulte pacote.

Chave Tipo Descrição
cluster_id corda A ID de um cluster a ser usada para executar o pacote. Consulte cluster_id.
databricks_cli_version corda A versão da CLI do Databricks a ser usada para o pacote. Consulte databricks_cli_version.
deployment Mapeamento A definição da implantação do pacote. Para os atributos com suporte, consulte implantação e Modos de implantação do Pacote de Ativos do Databricks.
git Mapeamento Os detalhes do controle de versão do Git associados ao bundle. Para obter atributos com suporte, consulte git e git.
name corda Obrigatório 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).

implantação

Define atributos de implantação do pacote.

Chave Tipo Descrição
fail_on_active_runs Booliano Se deve falhar em execuções ativas. Se isso estiver definido como true uma implantação em execução poderá ser interrompida.
lock Mapeamento Os atributos de bloqueio de implantação. Consulte bloqueio.

experimental

Define atributos para recursos experimentais.

Chave Tipo Descrição
python_wheel_wrapper Booliano Se deve usar um wrapper de wheel do Python.
scripts Comando (cadeia de caracteres) Os comandos a serem executados
use_legacy_run_as Booliano Se deve usar o comportamento run_as herdado.

git

Define os detalhes do controle de versão do Git associados ao pacote. Consulte git.

Chave Tipo Descrição
origin_url corda A URL de origem do repositório. Consulte git.
branch corda O nome do branch do Git. Consulte git.

subvenção

Define o acesso aos objetos do Catálogo do Unity. Para obter mais informações, consulte Conectar-se ao armazenamento e serviços de objetos de nuvem usando o Catálogo do Unity.

Chave Tipo Descrição
principal corda Obrigatório O nome do principal que receberá privilégios.
privileges corda Obrigatório Os privilégios a serem concedidos à entidade especificada.

Exemplo

O exemplo a seguir define um esquema do Catálogo do Unity com concessões:

resources:
  schemas:
    my_schema:
      name: test-schema
      grants:
        - principal: users
          privileges:
            - CAN_MANAGE
        - principal: my_team
          privileges:
            - CAN_READ
      catalog_name: main
      comment: "my schema with grants"

bloqueio

Define os atributos de bloqueio de implantação do pacote.

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

permissão

Define uma permissão para uma entidade específica. Consulte permissões e Definir permissões para recursos em Pacotes de Ativos do Databricks.

Chave Tipo Descrição
group_name corda O nome do grupo que tem a permissão definida em level.
level corda Obrigatório A permissão autorizada para usuário, grupo ou entidade de serviço definida para esta permissão.
service_principal_name corda O nome da entidade de serviço que tem a permissão definida em level.
user_name corda O nome do usuário que tem a permissão definida em level.

permissões

Uma sequência que define as permissões a serem aplicadas a experimentos, trabalhos, pipelines e modelos 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 em Pacotes de Ativos do Databricks.

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

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 máximo de execuções simultâneas para um trabalho.
name_prefix corda O prefixo para execuções de trabalho do pacote.
pipelines_development Booliano Se as implantações de pipeline devem ser bloqueadas no modo de desenvolvimento.
source_linked_deployment Booliano 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.

recursos

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>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Chave Tipo Descrição
clusters Mapeamento As definições de cluster para o pacote, em que cada chave é o nome de um cluster. Consulte cluster
dashboards Mapeamento As definições do painel de controle para o pacote, onde cada chave é o nome do painel de controle. Confira painel
experiments Mapeamento As definições de experimento para o pacote, em que cada chave é o nome do experimento. Consulte experimento
jobs Mapeamento As definições de tarefas para o pacote, onde cada chave é o nome da tarefa. Consulte trabalho
model_serving_endpoints Mapeamento O modelo que serve definições de ponto de extremidade para o pacote, em que cada chave é o nome do ponto de extremidade do serviço do modelo. Consulte model_serving_endpoint
models Mapeamento As definições de modelo para o pacote, em que cada chave é o nome do modelo. Veja o modelo (legado)
pipelines Mapeamento As definições de pipeline para o pacote, em que cada chave é o nome do pipeline. Consulte pipeline
quality_monitors Mapeamento As definições do monitor de qualidade para o pacote, em que cada chave é o nome do monitor de qualidade. Consulte 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. Consulte registered_model (Catálogo do Unity)
schemas Mapeamento As definições de esquema para o pacote, em que cada chave é o nome do esquema. Consulte esquema (Catálogo do Unity)
volumes Mapeamento As definições de volume para o conjunto, em que cada chave é o nome do volume. Confira o tomo (Catálogo do Unity)

run_as

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 dos Pacotes de Ativos do Databricks.

Chave Tipo Descrição
service_principal_name corda ID de 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.

sincronizar

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.

destino

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

Chave Tipo Descrição
artifacts Mapeamento Os artefatos a serem incluídos na implantação de destino. Confira artefatos.
bundle Mapeamento Os atributos do pacote ao serem implantados nesse destino.
cluster_id corda A ID do cluster a ser usada para esse destino.
compute_id corda Preterido. A ID da computação a ser usada para esse destino.
default Booliano Se esse destino é o destino padrão.
git Mapeamento As configurações de controle de versão do Git para o destino. Consulte 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 As predefinições de implantação para o destino. Consulte predefinições.
resources Mapeamento As definições de recurso para o destino. Consulte recursos.
run_as Mapeamento A identidade a ser usada para executar o pacote. Consulte run_as e Especificar uma identidade de execução para um fluxo de trabalho dos Pacotes de Ativos do Databricks.
sync Mapeamento Os caminhos locais para sincronizar 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. Consulte variáveis e Substituições e variáveis nos Pacotes de Ativos do Databricks.
workspace Mapeamento O workspace do Databricks para o destino. workspace

variáveis

Um mapa que define as variáveis personalizadas para o pacote, em que cada chave é o nome da variável e o valor é um Mapa que define a variável. Consulte Substituições e variáveis nos Pacotes de Ativos do Databricks.

Chave Tipo Descrição
nome da variável Mapeamento A definição de uma variável. Consulte nome de variável.

nome da variável

Cada definição de variável tem os seguintes atributos:

Chave Tipo Descrição
description corda A descrição da variável.
lookup corda O nome do objeto alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalou warehouse para o qual recuperar uma ID.
type corda O tipo da variável. Os valores válidos são complex.

workspace

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 dentro do workspace 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 ID do locatário do Azure.
azure_use_msi Booliano Se o MSI deve ser usado para o Azure.
azure_workspace_resource_id corda A ID do recurso do workspace do Azure.
client_id corda A ID do cliente para o workspace.
file_path corda O caminho do arquivo a ser usado dentro do workspace para implantações e execuções de fluxo de trabalho.
google_service_account corda O nome da conta de serviço do Google.
host corda A URL do host do workspace do Databricks.
profile corda O nome do perfil do workspace do Databricks.
resource_path corda O caminho do recurso do workspace.
root_path corda O caminho raiz do workspace do Databricks.
state_path corda O caminho de estado do workspace.