Pular para o conteúdo principal

Perfis de configuração do Databricks

Um perfil de configuração do Databricks armazena as configurações de autenticação no arquivo .databrickscfg . Os perfis de configuração facilitam a alternância entre diferentes espaços de trabalho, ambientes ou métodos de autenticação sem alterar o código.

Ferramentas, SDKs, scripts e aplicativos podem referenciar perfis de configuração para autenticar com o Databricks. Todas as ferramentas e SDKs que implementam autenticação unificada suportam perfis de configuração.

O que é um perfil de configuração?​

Um perfil de configuração é uma seção nomeada no arquivo .databrickscfg que contém o seguinte:

  • Credenciais de autenticação, como tokens ou credenciais de entidade de serviço.
  • URL workspace ou account Databricks
  • Configurações opcionais específicas para o seu método de autenticação.

Crie vários perfis em um único arquivo .databrickscfg para gerenciar conexões com diferentes espaços de trabalho ou ambientes, como desenvolvimento, teste e produção.

Criar um perfil de configuração​

Crie um perfil de configuração usando a CLI do Databricks ou editando manualmente o arquivo .databrickscfg .

Crie um perfil com a CLI​

A maneira mais fácil de criar um perfil de configuração para autenticação interativa de usuários é com a CLI do Databricks:

Bash
databricks auth login --host <workspace-url>

A CLI abre seu navegador da web para concluir o fluxo de autenticação. Após efetuar o login, a CLI salva as credenciais como um perfil de configuração.

Criar um perfil manualmente​

Para criar um perfil de configuração manualmente:

  1. Crie um arquivo chamado .databrickscfg em seu diretório pessoal:

    • Unix, Linux, macOS: ~/.databrickscfg
    • Windows: %USERPROFILE%\.databrickscfg

  2. Adicione um perfil com o seguinte formato:

    [<profile-name>]
    <field-name> = <field-value>

    Substitua os marcadores de posição:

    • <profile-name>Um nome único como DEFAULT, DEVELOPMENT ou PRODUCTION
    • <field-name> e <field-value>: Os campos de autenticação para o seu método de autenticação

Por exemplo, para autenticação OAuth máquina a máquina (M2M), o arquivo .databrickscfg tem a seguinte aparência:

[DEFAULT]
host          = https://<workspace-url>
client_id     = <client-id>
client_secret = <client-secret>

Criar vários perfis​

Defina vários perfis no mesmo arquivo .databrickscfg para gerenciar diferentes espaços de trabalho ou ambientes. Cada perfil deve ter um nome único.

[DEFAULT]
host          = https://production-workspace-url
client_id     = <production-client-id>
client_secret = <production-client-secret>

[DEVELOPMENT]
host          = https://dev-workspace-url
client_id     = <dev-client-id>
client_secret = <dev-client-secret>

[STAGING]
host          = https://staging-workspace-url
client_id     = <staging-client-id>
client_secret = <staging-client-secret>

Combinar tipos de autenticação​

Defina vários métodos de autenticação em perfis separados dentro do seu arquivo de configuração. Isso é útil quando você deseja usar credenciais diferentes para diferentes fluxos de trabalho ou ferramentas. Por exemplo, você pode usar a autenticação nativa cloud para uso interativo e credenciais OAuth para automação:

[DEFAULT]
host = https://<workspace-url>

[SERVICE_PRINCIPAL]
host          = https://<workspace-url>
client_id     = <client-id>
client_secret = <client-secret>

Para obter mais informações sobre os tipos de autenticação e seus campos obrigatórios, consulte Autenticação unificadaDatabricks.

Utilize um perfil de configuração​

Após criar um perfil de configuração, faça referência a ele em suas ferramentas e código. Se você não especificar um nome de perfil, as ferramentas e SDKs do Databricks usarão automaticamente o perfil DEFAULT .

Para usar um perfil diferente de DEFAULT, especifique o nome do perfil:

Com a CLI do Databricks:

Bash
databricks workspace list --profile DEVELOPMENT

Com variável de ambiente:

Bash
export DATABRICKS_CONFIG_PROFILE=DEVELOPMENT
databricks workspace list

Com o SDK do Python:

Python
from databricks.sdk import WorkspaceClient

# Specify profile in code
w = WorkspaceClient(profile="DEVELOPMENT")

# Or use environment variable DATABRICKS_CONFIG_PROFILE

Melhores práticas​

  • Use o perfil padrão para seu workspace mais comum para minimizar a necessidade de especificar nomes de perfil.
  • Use nomes de perfil descritivos como PRODUCTION, DEVELOPMENT ou STAGING em vez de nomes genéricos.
  • Proteja seu arquivo .databrickscfg definindo permissões de arquivo restritas (legível apenas pelo seu usuário).
  • Não commit .databrickscfg no controle de versão. Adicione-o ao seu arquivo .gitignore .
  • Use entidade de serviço para cargas de trabalho de produção em vez de access tokens pessoal.
  • Alterne suas credenciais regularmente e atualize seus perfis de acordo.

Solução de problemas​

Caso o perfil não seja encontrado, verifique o seguinte:

  • O arquivo .databrickscfg está no seu diretório pessoal.
  • Você usa o nome de perfil exato.
  • O arquivo não se chama .databrickscfg.txt ou algo semelhante.

Se a autenticação falhar, verifique o seguinte:

  • Suas credenciais estão válidas e não expiraram.
  • A URL host está correta.
  • Você possui as permissões necessárias para as operações que está tentando realizar.

Teste seus perfis de configuração usando a CLI do Databricks:

Bash
# Inspect a specific profile
databricks auth env --profile DEVELOPMENT

# List all profiles
databricks auth profiles

Para obter mais informações, consulte Testar seus perfis de configuração.

Saber mais​

Última atualização em