PipAuthenticate@1 - Python pip authenticate v1 task

Sintaxe

# Python pip authenticate v1
# Authentication task for the pip client used for installing Python distributions.
- task: PipAuthenticate@1
  inputs:
  # Feeds and Authentication
    #artifactFeeds: # string. My feeds (select below). 
    #pythonDownloadServiceConnections: # string. Feeds from external organizations. 
    #onlyAddExtraIndex: false # boolean. Don't set primary index URL. Default: false.

Insumos

Opções de controlo de tarefas

Todas as tarefas têm opções de controle, além de suas entradas de tarefas. Para obter mais informações, consulte Opções de controle de e propriedades de tarefas comuns.

Variáveis de saída

Comentários

Fornece autenticação para o cliente pip que é usado para instalar distribuições Python.

• Quando devo executar esta tarefa no meu pipeline?
• E se eu quiser que meus dutos possam salvar de fontes a montante?
• Meu agente está por trás de um proxy da web. O PipAuthenticate configurará o pip para usar meu proxy?
• Meu Pipeline precisa acessar um feed em um projeto diferente

Quando devo executar esta tarefa no meu pipeline?

Essa tarefa deve ser executada antes de usar pip para baixar distribuições Python para uma fonte de pacote autenticada, como Artefatos do Azure. Não existem outros requisitos de encomenda. Várias invocações desta tarefa não empilharão credenciais. Cada execução da tarefa apagará todas as credenciais armazenadas anteriormente.

E se eu quiser que meus pipelines possam salvar de fontes upstream?

Verifique a tabela de permissões para determinar quais permissões você deseja que seu pipeline tenha. Em seguida, determine a qual identidade você deseja conceder essas permissões. Para salvar pacotes de fontes upstream, sua identidade precisa de Feed and Upstream Reader (Collaborator) permissões.

Meu agente está por trás de um proxy da web. O PipAuthenticate configurará o pip para usar meu proxy?

Não. Embora essa tarefa em si funcione atrás de um proxy da Web que seu agente tenha sido configurado para usar, ele não configura pip para usar o proxy.

Para tal, pode:

• Defina as variáveis de ambiente http_proxy, https_proxy e, opcionalmente, no_proxy às suas configurações de proxy. Consulte de diretrizes oficiais do Pip para obter detalhes. Estas são variáveis comumente usadas, que outras ferramentas não-Python (por exemplo, curl) também podem usar.

  Atenção

  As variáveis http_proxy e no_proxy diferenciam maiúsculas de minúsculas nos sistemas operacionais Linux e Mac e devem ser minúsculas. A tentativa de usar uma variável do Azure Pipelines para definir a variável de ambiente não funcionará, pois ela será convertida em maiúsculas. Em vez disso, defina as variáveis de ambiente na máquina do agente auto-hospedado e reinicie o agente.

• Adicione as configurações de proxy ao arquivo de configuração pip arquivo usando proxy chave.
• Use a opção de linha de comando --proxy para especificar proxy no formato [user:passwd@]proxy.server:port.

Meu pipeline precisa acessar um feed em um projeto diferente

Se o pipeline estiver sendo executado em um projeto diferente do projeto que hospeda o feed, você deverá configurar o outro projeto para conceder acesso de leitura/gravação ao serviço de compilação. Consulte permissões de pacote no de Pipelines do Azure para obter mais detalhes.

Exemplos

Baixar distribuições Python de feeds do Azure Artifacts sem consultar o registro oficial do Python

Neste exemplo, estamos definindo a autenticação para download de feeds privados de Artefatos do Azure. A tarefa de autenticação cria variáveis de ambiente PIP_INDEX_URL e PIP_EXTRA_INDEX_URL necessárias para baixar as distribuições. A tarefa define as variáveis com credenciais de autenticação que a tarefa gera para os feeds de Artefatos fornecidos. HelloTestPackage devem estar presentes em myTestFeed1 ou myTestFeed2; caso contrário, a instalação falhará.

Para feeds de escopo de projeto que estão em um projeto diferente de onde o pipeline está sendo executado, você deve conceder manualmente ao projeto e ao feed acesso ao serviço de compilação do projeto do pipeline.

- task: PipAuthenticate@1
  displayName: 'Pip Authenticate'
  inputs:
    # Provide list of feed names which you want to authenticate.
    # Project scoped feeds must include the project name in addition to the feed name.
    artifactFeeds: 'project1/myTestFeed1, myTestFeed2'

# Use command line tool to 'pip install'.
- script: |
    pip install HelloTestPackage

Consulte o registro oficial do Python e, em seguida, baixe distribuições Python dos feeds do Azure Artifacts

Neste exemplo, estamos definindo a autenticação para download de um feed privado de Artefatos do Azure, mas pypi é consultado primeiro. A tarefa authenticate cria uma variável de ambiente PIP_EXTRA_INDEX_URL, que contém as credenciais de autenticação necessárias para baixar as distribuições. HelloTestPackage será baixado dos feeds autenticados somente se não estiver presente em pypi.

Para feeds de escopo de projeto que estão em um projeto diferente de onde o pipeline está sendo executado, você deve conceder manualmente ao projeto e ao feed acesso ao serviço de compilação do projeto do pipeline.

- task: PipAuthenticate@1
  displayName: 'Pip Authenticate'
  inputs:
    # Provide list of feed names which you want to authenticate.
    # Project scoped feeds must include the project name in addition to the feed name.
    artifactFeeds: 'project1/myTestFeed1, myTestFeed2'
    # Setting this variable to "true" will force pip to get distributions from official python registry first and fallback to feeds mentioned above if distributions are not found there.
    onlyAddExtraIndex: true

# Use command line tool to 'pip install'.
- script: |
    pip install HelloTestPackage

Baixar distribuições Python de outros servidores Python privados

Neste exemplo, estamos definindo a autenticação para download de um servidor de distribuição Python externo. Crie uma conexão de pip service entrada para o serviço externo. A tarefa authenticate usa a conexão de serviço para criar uma variável de ambiente PIP_INDEX_URL, que contém credenciais de autenticação necessárias para baixar as distribuições. HelloTestPackage tem de estar presente na ligação de serviço pypitest; caso contrário, a instalação falhará. Se você quiser que pypi sejam consultados primeiro, defina onlyAddExtraIndex para true.

- task: PipAuthenticate@1
  displayName: 'Pip Authenticate'
  inputs:
    # In this case, name of the service connection is "pypitest". 
    pythonDownloadServiceConnections: pypitest

# Use command line tool to 'pip install'.
- script: |
    pip install HelloTestPackage

Requerimentos