Configuração de autenticação para a extensão Databricks para Visual Studio Code

Este artigo descreve como configurar a autenticação entre a extensão Databricks para Visual Studio Code e seu workspace Databricks. Consulte O que é a extensão Databricks para Visual Studio Code?

A extensão Databricks para Visual Studio Code implementa partes do padrão de autenticação unificada do cliente Databricks , uma abordagem arquitetônica e programática consolidada e consistente para autenticação. Esta abordagem ajuda a tornar a configuração e a automação da autenticação com Databricks mais centralizada e previsível. Ele permite que você configure a autenticação do Databricks uma vez e, em seguida, use essa configuração em várias ferramentas e SDKs do Databricks sem mais alterações na configuração de autenticação.

As informações a seguir pressupõem que você já instalou a extensão Databricks para Visual Studio Code. Consulte Instalar a extensão Databricks para Visual Studio Code.

Observação

Se você já concluiu o tutorial da extensão VSCode para Databricks: execução do Python em clusters e como Job e deseja continuar usando a autenticação access token pessoal do Databricks que você configurou nesse tutorial, avance para Selecionar clusters para o Databricks extensão para Visual Studio Code.

Dependendo do tipo de autenticação que você deseja usar, conclua as instruções para o tipo de autenticação do Databricks de destino.

Configurar a autenticação com um perfil de configuração

Observação

O procedimento a seguir usa a extensão Databricks para o Visual Studio Code, versão 1, que está disponível de forma geral. Para concluir este procedimento para a extensão Databricks para Visual Studio Code, versão 2, atualmente em Private Preview, pule para Configurar a autenticação com um perfil de configuração e a versão 2 da extensão.

As instruções a seguir pressupõem que você já configurou um perfil de configuração do Databricks com os campos obrigatórios para o seu tipo de autenticação do Databricks. Consulte Perfis de configuração do Databricks e a tab ou seção Perfil para seu tipo de autenticação em Autenticação para automação do Databricks - visão geral.

Por exemplo, se quiser autenticar utilizando Databricks a access token autenticação pessoal , crie o seu pessoal access token fazendo o seguinte:

  1. No workspace do Databricks, clique no nome de usuário do Databricks na barra superior e selecione Configurações do usuário na lista suspensa.

  2. Clique em Desenvolvedor.

  3. Ao lado do access token, clique em gerenciar.

  4. Clique em Gerar novos tokens.

  5. (Opcional) Insira um comentário que o ajude a identificar esse token no futuro e altere o tempo de vida padrão do token de 90 dias. Para criar um token sem vida útil (não recomendado), deixe a caixa Duração (dias) vazia (em branco).

  6. Clique em Gerar.

  7. Copie o token exibido em um local seguro e clique em Concluído.

Observação

Certifique-se de salvar os tokens copiados em um local seguro. Não compartilhe seus tokens copiados com outras pessoas. Se você perder os tokens copiados, não poderá regenerar exatamente os mesmos tokens. Em vez disso, você deve repetir este procedimento para criar novos tokens. Se você perder os tokens copiados ou acreditar que os tokens foram comprometidos, o Databricks recomenda fortemente que você exclua imediatamente esses tokens do seu workspace clicando no ícone da lixeira (Revogar) ao lado dos tokens na página access tokens .

Se não for possível criar ou usar tokens no seu workspace, isso pode ocorrer porque o administrador do workspace desativou os tokens ou não lhe deu permissão para criar ou usar tokens. Consulte o administrador do workspace ou o seguinte:

E, por exemplo, para criar um perfil de configuração denominado DEFAULT para seu access token pessoal, faça o seguinte:

Observação

O procedimento a seguir usa a CLI do Databricks para criar um perfil de configuração do Databricks com o nome DEFAULT. Se você já tiver um perfil de configuração DEFAULT , este procedimento substituirá seu perfil de configuração DEFAULT existente.

Para verificar se você já tem um perfil de configuração DEFAULT e para view as configurações desse perfil, se existir, use a CLI do Databricks para executar o comando databricks auth env --profile DEFAULT.

Para criar um perfil de configuração com um nome diferente de DEFAULT, substitua a parte DEFAULT de --profile DEFAULT no comando databricks configure a seguir por um nome diferente para o perfil de configuração.

  1. Use a CLI do Databricks para criar um perfil de configuração do Databricks chamado DEFAULT que usa a autenticação access token pessoal do Databricks. Para fazer isso, execute o seguinte comando:

    databricks configure --profile DEFAULT
    
  2. Para o prompt Databricks Host, insira o URL da instância do espaço de trabalho do Databricks, por exemplo https://1234567890123456.7.gcp.databricks.com.

  3. Para o prompt access tokenpessoal, insira o access token pessoal do Databricks para seu workspace.

Depois de ter seu perfil de configuração do Databricks pronto, com seu projeto e a extensão abertos, faça o seguinte:

  1. No painel Configuração , clique em Configurar Databricks.

    Observação

    Se Configurar Databricks não estiver visível, clique no ícone de engrenagem (Configurar workspace) ao lado de Configuração .

    Ícone de engrenagem para definir as configurações workspace 1
  2. No comando Palette, para Databricks Host, insira o URL da instância do seu espaço de trabalho, por exemplo https://1234567890123456.7.gcp.databricks.com. Em seguida, pressione Enter.

  3. Selecione o perfil de configuração do Databricks de destino na lista da URL.

A extensão cria uma pasta oculta em seu projeto chamada .databricks se ela ainda não existir. A extensão também cria nesta pasta um arquivo chamado project.json se ainda não existir. Este arquivo contém a URL que você inseriu, juntamente com alguns detalhes de autenticação do Databricks que a extensão Databricks para Visual Studio Code precisa para operar.

A extensão também adiciona um arquivo .gitignore oculto ao projeto se o arquivo não existir ou se um .gitignore existente não puder ser encontrado em nenhuma pasta pai. Se um novo arquivo .gitignore for criado, a extensão adicionará uma entrada .databricks/ a esse novo arquivo. Se a extensão encontrar um arquivo .gitignore existente, ela adicionará uma entrada .databricks/ ao arquivo existente.

Continue com Selecione um clusters para a extensão Databricks para Visual Studio Code.

Configurar a autenticação OAuth U2M

Observação

O procedimento a seguir usa a extensão Databricks para o Visual Studio Code, versão 1, que está disponível de forma geral. Para concluir este procedimento para a extensão Databricks para Visual Studio Code, versão 2, atualmente em Private Preview, pule para Configurar a autenticação OAuth U2M com a versão 2 da extensão.

O Databricks é compatível com a autenticação OAuth de usuário para máquina (U2M). Isso permite que o senhor gere um token de acesso OAuth de curta duração (uma hora), o que elimina o risco de expor acidentalmente tokens de vida mais longa, como o token de acesso pessoal da Databricks, por meio de check-ins de controle de versão ou outros meios. Isso também permite uma melhor invalidação e delimitação de escopo da sessão no lado do servidor.

Para concluir a configuração da autenticação OAuth U2M, com seu projeto e a extensão abertos, faça o seguinte:

  1. No painel Configuração , clique em Configurar Databricks.

    Observação

    Se Configurar Databricks não estiver visível, clique no ícone de engrenagem (Configurar workspace) ao lado de Configuração .

    Ícone de engrenagem para definir as configurações workspace 1
  2. No comando Palette, para Databricks Host, insira o URL da instância do seu espaço de trabalho, por exemplo https://1234567890123456.7.gcp.databricks.com. Em seguida, pressione Enter.

  3. Selecione OAuth (usuário para máquina).

  4. Conclua as instruções na tela do seu navegador da Web para concluir a autenticação com sua account do Databricks. Se solicitado, permita o acesso a todas as APIs .

A extensão cria uma pasta oculta em seu projeto chamada .databricks se ela ainda não existir. A extensão também cria nesta pasta um arquivo chamado project.json se ainda não existir. Este arquivo contém a URL que você inseriu, juntamente com alguns detalhes de autenticação do Databricks que a extensão Databricks para Visual Studio Code precisa para operar.

A extensão também adiciona um arquivo .gitignore oculto ao projeto se o arquivo não existir ou se um .gitignore existente não puder ser encontrado em nenhuma pasta pai. Se um novo arquivo .gitignore for criado, a extensão adicionará uma entrada .databricks/ a esse novo arquivo. Se a extensão encontrar um arquivo .gitignore existente, ela adicionará uma entrada .databricks/ ao arquivo existente.

Continue com Selecione um clusters para a extensão Databricks para Visual Studio Code.

Configurar a autenticação com um perfil de configuração e a versão 2 da extensão

Observação

A extensão Databricks para Visual Studio Code, versão 2, está em Private Preview.

As instruções a seguir pressupõem que o senhor já tenha definido um perfil de configuração do Databricks com os campos necessários para o tipo de autenticação do Databricks. Para criar um perfil, consulte Perfis de configuração do Databricks. Para definir as configurações corretas para o perfil, consulte o Profile tab ou a seção para o seu tipo de autenticação em Authentication for Databricks automation - overview. A interface de usuário da extensão às vezes se refere a esses perfis de configuração como perfis da CLI do Databricks ou apenas perfis.

Para selecionar o perfil de configuração que o senhor deseja que a extensão use, com o projeto e a extensão abertos, faça o seguinte

  1. No painel Configuration (Configuração ), clique em Auth Type (Tipo de autenticação) e, em seguida, clique no ícone de engrenagem(Sign in to Databricks workspace).

    Faça login na Databricks workspace
  2. Na paleta de comandos, selecione o perfil de configuração de destino do Databricks na lista.

  3. Continue com Selecione um clusters para a extensão Databricks para Visual Studio Code.

Se o senhor não tiver um perfil de configuração, poderá criar um que autentique usando um Databricks pessoal access token, por exemplo, da seguinte forma:

  1. Com o projeto e a extensão abertos, no painel Configuração, clique em Tipo de autenticação ou Login no Databricks e, em seguida, clique no ícone de engrenagem(Sign in to Databricks workspace).

    Faça login na Databricks workspace
  2. Na paleta de comandos, selecione Personal access token.

  3. Preencha os prompts na tela para fazer o seguinte:

    1. Digite um nome para o perfil de autenticação associado do Databricks.

    2. Gere o access token pessoal em seu Databricks workspace e, em seguida, copie o valor dos tokens.

    3. Retorne à extensão e insira o valor dos tokens copiados.

  4. Continue com Selecione um clusters para a extensão Databricks para Visual Studio Code.

Configurar a autenticação OAuth U2M com a versão 2 da extensão

Observação

A extensão Databricks para Visual Studio Code, versão 2, está em Private Preview.

O Databricks é compatível com a autenticação OAuth de usuário para máquina (U2M). Isso permite que o senhor gere um token de acesso OAuth de curta duração (uma hora), o que elimina o risco de expor acidentalmente tokens de vida mais longa, como o token de acesso pessoal da Databricks, por meio de check-ins de controle de versão ou outros meios. Isso também permite uma melhor invalidação e delimitação de escopo da sessão no lado do servidor.

Para concluir a configuração da autenticação OAuth U2M, com seu projeto e a extensão abertos, faça o seguinte:

  1. No painel Configuration (Configuração ), clique em Auth Type (Tipo de autenticação) e, em seguida, clique no ícone de engrenagem(Sign in to Databricks workspace).

    Faça login na Databricks workspace
  2. Se o senhor já tiver um perfil de configuração de autenticação nessa lista que tenha o rótulo Authenticate using OAuth (User to Machine) e que saiba que corresponde ao host de destino do Databricks, selecione-o na lista e faça o seguinte:

    1. Se solicitado, conclua todas as instruções na tela do navegador da Web para concluir a autenticação na Databricks.

    2. Se também for solicitado, permita o acesso a todos os aplicativos.

    3. Avance para Selecionar um cluster para a extensão Databricks para Visual Studio Code.

  3. Na paleta de comandos, para Selecionar método de autenticação, clique em OAuth (usuário para máquina).

  4. Em Select authentication method (Selecionar método de autenticação), selecione OAuth (usuário para máquina).

  5. Digite um nome para o perfil de autenticação associado do Databricks.

  6. No painel Configuração, clique em Login no Databricks.

    Faça login na Databricks
  7. Na paleta de comandos, em Select authentication method (Selecionar método de autenticação), selecione o nome do perfil de configuração de autenticação que o senhor acabou de criar.

  8. Se solicitado, conclua todas as instruções na tela do navegador da Web para concluir a autenticação na Databricks. Se também for solicitado, permita o acesso a todos os aplicativos.

  9. Depois de fazer o login com sucesso, retorne ao Visual Studio Code.

  10. Continue com Selecione um clusters para a extensão Databricks para Visual Studio Code.