Conectar-se ao Cloud Build

Esta página descreve como configurar o Cloud Build para armazenar artefatos criados em um repositório do Artifact Registry.

Antes de começar

  1. Se o repositório de destino não existir no Artifact Registry, Crie um novo repositório.

  2. Se o Cloud Build e o repositório estiverem em projetos diferentes ou se você estiver usando uma conta de serviço especificada pelo usuário para executar builds, conceda o papel de escritor do registro de artefatos à conta de serviço do build no projeto com os repositórios.

    A conta de serviço padrão do Cloud Build tem acesso para executar as seguintes ações com um repositório no mesmo projeto do Google Cloud:

Configurar um build do Docker

Depois de conceder permissões ao repositório de destino, você estará pronto para configurar o build.

Para configurar o build:

  1. No arquivo de configuração de build, adicione a etapa para criar e marcar a imagem.

    steps:
- name: 'gcr.io/cloud-builders/docker'
  args: [ 'build', '-t', '${_LOCATION}-docker.pkg.dev/$PROJECT_ID/${_REPOSITORY}/${_IMAGE}', '.' ]
images:
- '${_LOCATION}-docker.pkg.dev/$PROJECT_ID/${_REPOSITORY}/${_IMAGE}'

    Este snippet usa substituições do Cloud Build. Essa abordagem é útil se você quiser usar o mesmo arquivo de configuração de build para enviar imagens a repositórios de ambientes diferentes, como teste, preparo ou produção.

    • ${_LOCATION}, ${_REPOSITORY} e ${_IMAGE} são substituições definidas pelo usuário para o local, o nome e a imagem do repositório. Você especifica os valores desses variáveis no tempo de build.

    • $PROJECT_ID é uma substituição padrão que o Cloud Build resolve com o ID do projeto do Google Cloud para o build.

      • Se você executar o comando gcloud builds submit, o Cloud Build usará o ID do projeto ativo na sessão gcloud.
      • Se você usa um gatilho de compilação, o Cloud Build usa o ID do em que o Cloud Build está sendo executado.

      Como alternativa, você pode usar uma substituição definida pelo usuário em vez de $PROJECT_ID para especificar um ID do projeto no tempo de build.

  2. Quando estiver tudo pronto para executar o build, especifique os valores para as substituições definidas pelo usuário. Por exemplo, este comando substitui:

    • us-east1 para o local do repositório
    • my-repo, como o nome do repositório.
    • my-image como o nome da imagem.
    gcloud builds submit --config=cloudbuild.yaml \
  --substitutions=_LOCATION="us-east1",_REPOSITORY="my-repo",_IMAGE="my-image" .

Configurar um build do Go

Depois de conceder permissões ao repositório de destino, você estará pronto para configurar o build. As instruções a seguir descrevem como configurar seu build para fazer upload de um módulo Go para um repositório Go.

Para configurar o build:

  1. Para fazer upload de um módulo Go para o repositório Go no build, adicione as seguintes etapas ao arquivo de configuração do build:

    steps:
- name: gcr.io/cloud-builders/gcloud
args:
- 'artifacts'
- 'go'
- 'upload'
- '--project=$PROJECT_ID'
- '--location=${_LOCATION}'
- '--repository=${_REPOSITORY}'
- '--module-path=${_MODULE_PATH}'
- '--version=$TAG_NAME'

    O arquivo de configuração do build inclui o Cloud Build substituições. Essa abordagem é útil se você quiser usar o mesmo arquivo de configuração de build para fazer upload de pacotes para repositórios de ambientes diferentes, como teste, preparo ou produção.

    • ${_LOCATION}, ${_REPOSITORY} e ${_MODULE_PATH} são definidos pelo usuário do repositório, do nome do repositório e do módulo caminho. Você especifica os valores dessas variáveis no tempo de build.

    • $PROJECT_ID e $TAG_NAME são substituições padrão que o Cloud Build substitui pelo seguinte:

      • $PROJECT_ID foi substituído pelo ID do projeto do Google Cloud. para o build.

        • Se você executar o comando gcloud builds submit, o Cloud Build usa o ID do projeto ativo na sessão da gcloud.
        • Se você usa um gatilho de compilação, o Cloud Build usa o ID do em que o Cloud Build está sendo executado.

        Como alternativa, use uma substituição definida pelo usuário em vez de $PROJECT_ID para especificar um ID de projeto no momento do build.

      • $TAG_NAME é substituído pelo nome da sua tag para compatibilidade com a linguagem Go. de usar tags do Git como números de versão.

  2. Para instalar o pacote do repositório Go, adicione as seguintes etapas ao arquivo de configuração do build para:

    • Adicione um endpoint regional do Artifact Registry no local do repositório ao arquivo .netrc.
    • Execute a ferramenta de auxiliar de credenciais para atualizar os tokens OAuth.
    • Execute o comando go run. Também é possível alterar isso para go build para compilar o módulo, go test para executar testes ou go mod tidy para fazer o download. as dependências.

    Para a etapa do comando go, o GOPROXY é definido como a Repositório do Artifact Registry que hospeda dependências particulares. Você pode adicionar o proxy público à lista GOPROXY separada por vírgulas se o módulo tem dependências públicas.

    steps:
- name: golang
  entrypoint: go
  args: ['run', 'github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.1.0', 'add-locations', '--locations=${_LOCATION}']
  env:
  # Set GOPROXY to the public proxy to pull the credential helper tool
  - 'GOPROXY=https://proxy.golang.org'
- name: golang
  entrypoint: go
  args: ['run', 'github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.1.0', 'refresh']
  env:
  # Set GOPROXY to the public proxy to pull the credential helper tool
  - 'GOPROXY=https://proxy.golang.org'
- name: golang
  entrypoint: go
  args: ['run', '.']
  env:
  - 'GOPROXY=https://${_LOCATION}-go.pkg.dev/${_PROJECT_ID}/${_REPOSITORY}'
options:
  env:
  # Disable GO sumdb checks for private modules.
  - 'GONOSUMDB=${_MODULE_PATH}'

  3. Quando estiver tudo pronto para executar o build, especifique os valores para as substituições definidas pelo usuário. Por exemplo, este comando substitui:

    • us-east1 para o local do repositório
    • my-project para o ID do projeto
    • my-repo para o nome do repositório
    • example.com/greetings para o caminho do módulo.
    gcloud builds submit --config=cloudbuild.yaml \
  --substitutions=_LOCATION="us-east1",_PROJECT_ID="my-project",_REPOSITORY="my-repo",_MODULE_PATH="example.com/greetings" .

Configurar um build Java

Depois de conceder permissões ao repositório de destino, você estará pronto para configurar o build. As instruções a seguir descrevem como configurar seu build para fazer upload de um pacote Java para um repositório Maven.

Para configurar seu build:

  1. Configure a autenticação para Maven. Certifique-se de especificar o projeto de destino e o repositório corretos no arquivo pom.xml.

  2. No arquivo de configuração de versão do Cloud Build, adicione a etapa para fazer upload do pacote com o Maven:

    steps:
- name: gcr.io/cloud-builders/mvn
  args: ['deploy']

  3. Quando o arquivo de configuração de build estiver pronto, inicie o build com o seguinte comando:

    gcloud builds submit

Configurar um build do Node.js

Depois de conceder permissões ao repositório de destino, você estará pronto para configurar o build. As instruções a seguir descrevem como configurar seu build para fazer upload de um pacote Node.js em um repositório npm.

Para configurar seu build:

  1. Adicione o repositório do Artifact Registry ao arquivo .npmrc no projeto do Node.js. Ele fica no diretório com o arquivo package.json.

    @SCOPE:registry=https://LOCATION-npm.pkg.dev/PROJECT_ID/REPOSITORY
//LOCATION-npm.pkg.dev/PROJECT_ID/REPOSITORY/:always-auth=true
    • SCOPE-NAME é o nome do escopo do npm a ser associado ao repositório. O uso de escopos garante que você sempre publicar e instalar pacotes do repositório correto.
    • PROJECT_ID é o ID do projeto no Google Cloud.
    • LOCATION é o local regional ou multirregional do repositório.
    • REPOSITORY é o nome do repositório.

  2. Adicione um script que é atualizado no arquivo package.json do seu projeto. o token de acesso para autenticação no repositório.

    "scripts": {
 "artifactregistry-login": "npx google-artifactregistry-auth"
}

  1. No arquivo de configuração da versão, adicione a etapa para fazer upload do pacote para o repositório.

    steps:
- name: gcr.io/cloud-builders/npm
  args: ['run', 'artifactregistry-login']
- name: gcr.io/cloud-builders/npm
  args: ['publish', '${_PACKAGE}']

    ${_PACKAGE} é um Cloud Build. substituição que representa seu projeto Node.js diretório. Você pode especificar o diretório ao executar o comando para executar ser construído.

    Por exemplo, este comando faz upload do pacote de um diretório chamado src:

    gcloud builds submit --config=cloudbuild.yaml \
    --substitutions=_PACKAGE="src" .

Configurar um build do Python

Depois de conceder permissões ao repositório de destino, você vai poder configure seu build. As instruções a seguir descrevem como configurar seu build para carregar um pacote Python em um repositório Python e instalar o pacote usando pip.

Para criar e contêinerizar um aplicativo Python e enviá-lo a um repositório do Docker, consulte Como criar aplicativos Python na documentação do Cloud Build.

Para configurar seu build:

  1. No diretório que contém o arquivo de configuração de build do Cloud Build, crie um arquivo chamado requirements.txt com as seguintes dependências:

    twine
keyrings.google-artifactregistry-auth
    • O Twine é usado para fazer upload de pacotes para o Artifact Registry.
    • keyrings.google-artifactregistry-auth é o back-end do keyring do Artifact Registry que trata Autenticação com o Artifact Registry para pip e Twine.

  2. Para fazer upload de um pacote do Python para o repositório do Python no build, adicione o Siga estas etapas para o arquivo de configuração de build:

    steps:
- name: python
  entrypoint: pip
  args: ["install", "-r", "requirements.txt", "--user"]
- name: python
  entrypoint: python
  args:
  - '-m'
  - 'twine'
  - 'upload'
  - '--repository-url'
  - 'https://${_LOCATION}-python.pkg.dev/$PROJECT_ID/${_REPOSITORY}/'
  - 'dist/*'

    Neste snippet, a primeira etapa instala o Twine e o Artifact Registry back-end do keyring. A segunda etapa carrega seus arquivos Python construídos na Subdiretório dist. Ajuste os caminhos para requirements.txt e seus arquivos Python criados se eles não corresponderem ao snippet.

    O caminho do repositório inclui substituições do Cloud Build. Essa abordagem é útil se você quiser usar o mesmo arquivo de configuração de build para fazer upload de pacotes para repositórios de ambientes diferentes, como teste, preparo ou produção.

    • ${_LOCATION} e ${_REPOSITORY} são substituições definidas pelo usuário para as local do repositório, nome do repositório e nome do pacote. Você especifica valores dessas variáveis no tempo de build.

    • $PROJECT_ID é uma substituição padrão que o Cloud Build resolve com o ID do projeto do Google Cloud para o build.

      • Se você executar o comando gcloud builds submit, o Cloud Build usa o ID do projeto ativo na sessão da gcloud.
      • Se você usa um gatilho de compilação, o Cloud Build usa o ID do em que o Cloud Build está sendo executado.

      Como alternativa, você pode usar uma substituição definida pelo usuário em vez de $PROJECT_ID para especificar um ID do projeto no tempo de build.

  3. Para instalar o pacote do repositório Python, adicione uma etapa ao arquivo de configuração do build que execute o comando pip install.

      steps:
  - name: python
    entrypoint: pip
    args:
    - 'install'
    - '--index-url'
    - 'https://${_LOCATION}-python.pkg.dev/$PROJECT_ID/${_REPOSITORY}/simple/'
    - '${_PACKAGE}'
    - '--verbose'

    Esse snippet inclui uma substituição ${_PACKAGE} adicional para o nome do pacote.

  4. Quando estiver tudo pronto para executar o build, especifique os valores dos valores definidos pelo usuário de substituições. Por exemplo, este comando substitui:

    • us-east1 para o local do repositório
    • my-repo para o nome do repositório
    • my-package para o nome do pacote
    gcloud builds submit --config=cloudbuild.yaml \
  --substitutions=_LOCATION="us-east1",_REPOSITORY="my-repo",_PACKAGE="my-package" .