Configurar a autenticação no Artifact Registry para repositórios de pacotes do Python

Nesta página, descrevemos como configurar a autenticação com um Artifact Registry. repositório de pacotes do Python.

É necessário se autenticar no Artifact Registry ao usar um aplicativo de terceiros para se conectar a um repositório.

Não é necessário configurar a autenticação para o Cloud Build ou o Google Cloud ambientes de execução, como o Google Kubernetes Engine e o Cloud Run, mas recomendamos Verifique se as permissões necessárias estão configurados.

Antes de começar

  1. Se o repositório de destino não existir, crie um novo repositório de pacotes Python.
  2. Verifique se o Python 3 está instalado. Para instruções de instalação, consulte a Tutorial do Google Cloud para configurar o Python.
  3. Verifique se a conta de usuário ou de serviço que você está usando tem as permissões necessárias para acessar o repositório.

  4. Install the Google Cloud CLI, then initialize it by running the following command: 

    gcloud init
  5. (Opcional) Configure padrões para comandos da CLI gcloud.

Visão geral

O Artifact Registry é compatível com os seguintes métodos de autenticação.

Biblioteca de chaveiro do Python (recomendado)
O Artifact Registry fornece um back-end de keyring para armazenar as credenciais como se conectar aos repositórios do Artifact Registry.
Autenticação por senha
Use esta opção quando não for possível usar o keyring e você precisar de uma opção compatível com autenticação básica por senha.

As instruções nesta documentação descrevem como configurar o pip como o único índice de pacotes que o pip pesquisa. Recomendamos usar repositórios virtuais para pesquisar pacotes nos seus pacotes particulares em Artifact Registry e pacotes públicos do PyPI em vez de configurar vários índices de pacotes no arquivo de configuração pip. A ferramenta pip não procura índices de pacotes em nenhuma ordem específica. Por isso, os consumidores podem fazer o download ou instalar por engano um pacote público com o mesmo nome de um dos seus pacotes particulares. Os repositórios virtuais permitem configurar prioridades para fontes upstream para reduzir esse risco de confusão de dependência.

Como autenticar com keyring

O keyring do Python oferece aos aplicativos uma forma de acessar back-ends de keyring, ou seja, armazenamento de credenciais do sistema operacional e de terceiros.

O Artifact Registry oferece keyrings.google-artifactregistry-auth back-end do keyring para processar a autenticação repositórios do Artifact Registry.

Ordem de pesquisa de credenciais

Quando você usa o back-end do keyring do Artifact Registry, suas credenciais são que não são armazenados no projeto Python. Em vez disso, o Artifact Registry busca credenciais na seguinte ordem:

  1. Application Default Credentials (ADC), uma estratégia que procura credenciais na seguinte ordem:

    1. Credenciais definidas na variável de ambiente GOOGLE_APPLICATION_CREDENTIALS.

    2. credenciais que a conta de serviço padrão do Compute Engine Funções do Google Kubernetes Engine, Cloud Run, App Engine ou Cloud Run oferece.

  2. Credenciais fornecidas pela Google Cloud CLI, incluindo credenciais de usuário de o comando gcloud auth application-default login.

A variável GOOGLE_APPLICATION_CREDENTIALS torna a conta a autenticação explícita, o que facilita a solução de problemas. Se você não usar a variável, verifique se todas as contas que o ADC pode usar têm as permissões necessárias. Por exemplo, o conta de serviço padrão para VMs do Compute Engine, nós do Google Kubernetes Engine e as revisões do Cloud Run têm acesso somente leitura aos repositórios. Se você pretendem fazer upload desses ambientes usando a conta de serviço padrão, é necessário modificar as permissões.

Como configurar o keyring

Para configurar a autenticação com o back-end de chaveiro do Artifact Registry:

  1. Instale a biblioteca do keyring.

    pip install keyring

  2. Instale o back-end do Artifact Registry.

    pip install keyrings.google-artifactregistry-auth

  3. Liste os back-ends para confirmar a instalação.

    keyring --list-backends

    A lista precisa incluir

    • ChainerBackend(priority:10)
    • GooglePythonAuth(priority: 9)

  4. Execute o comando a seguir para imprimir a configuração do repositório no e adicionar ao seu projeto Python.

    gcloud artifacts print-settings python --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION

    Substitua os seguintes valores:

    • PROJECT é o ID do projeto. Se essa sinalização for omitida, o projeto padrão ou atual é usado.
    • REPOSITORY é o ID do repositório. Se você tiver configurado um repositório do Artifact Registry padrão, ele será usado quando essa sinalização for omitida no comando.
    • LOCATION é o local regional ou multirregional do repositório.

  5. Adicione as configurações abaixo ao arquivo .pypirc. O local padrão é:

    • Linux e macOS: $HOME/.pypirc
    • Windows: %USERPROFILE%\.pypirc
    [distutils]
index-servers =
    PYTHON-REPO-ID

[PYTHON-REPO-ID]
repository = https://LOCATION-python.pkg.dev/PROJECT/REPOSITORY/

    Substitua os seguintes valores:

    • PYTHON-REPO-ID é um ID do repositório que pode ser referenciado com ferramentas como o Twine.
    • PROJECT é o ID do projeto. Se essa sinalização for omitida, o projeto padrão ou atual é usado.
    • REPOSITORY é o ID do repositório. Se você tiver configurado um repositório do Artifact Registry padrão, ele será usado quando essa sinalização for omitida no comando.
    • LOCATION é o local regional ou multirregional do repositório.

  6. Adicione seu repositório ao arquivo de configuração pip. O local do arquivo se você quer atualizar o arquivo por usuário para o ambiente virtual que você usa.

    Para o arquivo associado ao usuário do sistema operacional:

    • Unix: $HOME/.config/pip/pip.conf ou $HOME/.pip/pip.conf
    • macOS: /Library/Application Support/pip/pip.conf ou $HOME/.config/pip/pip.conf
    • Windows: %APPDATA%\pip\pip.ini ou %USERPROFILE%\pip\pip.ini

    Para ambientes virtuais:

    • Unix e macOS: $VIRTUAL_ENV/pip.conf
    • Windows: %VIRTUAL_ENV%\pip.ini

    Para configurar o pip para pesquisar apenas seu repositório, use o index-url e verifique se não há outros índices de pacote configurados com a configuração extra-index-url.

    [global]
index-url = https://LOCATION-python.pkg.dev/PROJECT/REPOSITORY/simple/

    A string /simple/ no fim do caminho do repositório indica que o implementa a API Python Simple Repository (em inglês).

Seu ambiente Python agora está configurado para autenticar com o Artifact Registry.

Autenticação de chaveiro com credenciais do usuário

Depois de configurar o chaveiro, você poderá usá-lo com suas credenciais de usuário na CLI gcloud. Faça login na Google Cloud CLI antes de se conectar em um repositório de pacotes do Python.

Execute este comando:

gcloud auth login

Autenticação de chaveiro com credenciais da conta de serviço

Depois de configurar o keyring, você configura um serviço. para a autenticação.

  1. Criar um serviço conta de serviço ou escolha uma conta de serviço que você usa para automação.
  2. Conceda o papel específico do Artifact Registry à conta de serviço para dar acesso ao repositório.

  3. Use uma das seguintes opções para fazer a autenticação com sua conta de serviço:

    • Application Default Credentials (recomendado)

      Atribua o local do arquivo de chave da conta de serviço à variável GOOGLE_APPLICATION_CREDENTIALS para que o auxiliar de credenciais do Artifact Registry possa conseguir sua chave ao se conectar com os repositórios. 

      export GOOGLE_APPLICATION_CREDENTIALS=KEY-FILE

    • Credenciais da CLI gcloud

      Antes de se conectar a um repositório, faça login como a conta de serviço. Evite esta opção se você estiver se conectando a repositórios de VMs do Compute Engine já que o Artifact Registry encontra as credenciais da conta de serviço antes das credenciais na CLI gcloud.

      gcloud auth activate-service-account --key-file=KEY-FILE

    Substitua KEY-FILE pelo caminho para a conta de serviço. arquivo de chave.

Como autenticar com uma chave de conta de serviço

Use essa abordagem quando precisar de autenticação com um nome de usuário e uma senha.

As chaves da conta de serviço são credenciais de longa duração. Use as seguintes diretrizes para limitar o acesso aos seus repositórios:

  • Considere usar uma conta de serviço dedicada para interagir com repositórios.
  • Conceda o papel mínimo do Artifact Registry exigido pela conta de serviço. Por exemplo, atribua o leitor do Artifact Registry a uma conta de serviço que faz o download apenas de artefatos.
  • Se os grupos na sua organização exigirem níveis diferentes de acesso a repositórios específicos, conceda acesso no nível do repositório em vez de no nível do projeto.
  • Siga as práticas recomendadas para gerenciar as credenciais.

Para configurar a autenticação:

  1. Crie uma conta de serviço para agir em nome do seu aplicativo ou escolha uma conta de serviço atual que você usa para automação.

    Você precisará do local do arquivo de chave da conta de serviço para configurar a autenticação com o Artifact Registry. Para contas existentes, é possível ver as chaves e criar novas chaves na página "Contas de serviço".

    Acesse a página Contas de serviço

  2. Conceda o acesso papel do Artifact Registry para que a conta de serviço forneça o repositório acesso.

  3. Execute o comando a seguir para imprimir a configuração do repositório no e adicionar ao seu projeto Python.

    gcloud artifacts print-settings python --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --json-key=KEY-FILE

    Substitua os seguintes valores:

    • PROJECT é o ID do projeto. Se essa sinalização for omitida, o projeto padrão ou atual é usado.
    • REPOSITORY é o ID do repositório. Se você tiver configurado um repositório do Artifact Registry padrão, ele será usado quando essa sinalização for omitida no comando.
    • LOCATION é o local regional ou multirregional do repositório.
    • KEY-FILE é o caminho para o arquivo de chaves JSON da conta de serviço.

  4. Adicione as configurações abaixo ao arquivo .pypirc. O local padrão é do arquivo de configuração pip por usuário é:

    • Linux e macOS: $HOME/.pypirc
    • Windows: %USERPROFILE%\.pypirc
    [distutils]
index-servers =
    PYTHON-REPO-ID

[PYTHON-REPO-ID]
repository = https://LOCATION-python.pkg.dev/PROJECT/REPOSITORY/
username: _json_key_base64
password: KEY

    Substitua os seguintes valores:

    • PYTHON-REPO-ID é um ID do repositório que pode ser referenciado com ferramentas como o Twine.
    • PROJECT é o ID do projeto. Se essa sinalização for omitida, o projeto padrão ou atual é usado.
    • REPOSITORY é o ID do repositório. Se você tiver configurado um repositório do Artifact Registry padrão, ele será usado quando essa sinalização for omitida no comando.
    • LOCATION é o local regional ou multirregional do repositório.
    • KEY é a chave codificada em base64 no arquivo de chave da conta de serviço.

  5. Adicione seu repositório ao arquivo de configuração pip. O local do arquivo de configuração pip se você quer atualizar o arquivo por usuário para o ambiente virtual que você usa.

    Para o arquivo associado ao usuário do sistema operacional:

    • Unix: $HOME/.config/pip/pip.conf ou $HOME/.pip/pip.conf
    • macOS: /Library/Application Support/pip/pip.conf ou $HOME/.config/pip/pip.conf
    • Windows: %APPDATA%\pip\pip.ini ou %USERPROFILE%\pip\pip.ini

    Para ambientes virtuais:

    • Unix e macOS: $VIRTUAL_ENV/pip.conf
    • Windows: %VIRTUAL_ENV%\pip.ini

    Adicione a seguinte linha ao arquivo de configuração pip:

    [global]
index-url = https://_json_key_base64:KEY@LOCATION-python.pkg.dev/PROJECT/REPOSITORY/simple/
    • KEY a chave privada no arquivo de chave da conta de serviço.
    • A string /simple/ no final do caminho do repositório indica que o repositório implementa a API Python Simple Repository.

A seguir