Como implantar no Cloud Run usando o Cloud Build

Nesta página, explicamos como implantar automaticamente os serviços do Cloud Run usando o Cloud Build. Se você não estiver familiarizado com o Cloud Build, leia as guias de início rápido e a visão geral da configuração da compilação primeiro.

O Cloud Run permite executar contêineres sem estado em um ambiente sem servidor. Com o Cloud Build, é possível implantar imagens de contêiner do Container Registry (descontinuado) e do Artifact Registry no Cloud Run. É possível implantar uma imagem atual, criar e implantar uma imagem ou automatizar a implantação.

Antes de começar

  • Ative as APIs Cloud Build, Cloud Run, Container Registry, and Resource Manager.

    Ative as APIs

  • Prepare o código-fonte do aplicativo. O código-fonte precisa ser armazenado em um repositório, como o Cloud Source Repositories, o GitHub ou o Bitbucket.

  • Para executar os comandos gcloud desta página, instale a Google Cloud CLI.

Permissões do IAM obrigatórias

Se a imagem estiver armazenada no mesmo projeto do Google Cloud em que você quer implantar ou se a imagem for pública no Container Registry, serão necessárias as seguintes permissões do IAM:

Para implantar no Cloud Run, conceda os papéis de administrador e usuário da conta de serviço do Cloud Run à conta de serviço do Cloud Build:

  1. Abra a página Configurações do Cloud Build no Console do Google Cloud.

    Acessar a página de configurações do Cloud Build

  2. No painel de permissões da conta de serviço, defina o status do papel Administrador do Cloud Run como ATIVADO:

    Captura de tela da página de permissões da conta de serviço

  3. No pop-up "Etapas adicionais", clique em CONCEDER ACESSO A TODAS AS CONTAS DE SERVIÇO.

Como criar e implantar um contêiner

O Cloud Build permite que você crie a imagem de contêiner, armazene-a no Container Registry e implante a imagem no Cloud Run.

Para criar e implantar uma imagem de contêiner:

  1. No diretório raiz do projeto, crie um arquivo de configuração chamado cloudbuild.yaml.

  2. No arquivo de configuração de build, adicione etapas de build do docker para criar a imagem e enviá-la ao Container Registry e adicione uma etapa de build do gcloud para invocar o comando gcloud run deploy a fim de implantar a imagem no Cloud Run:

    steps:
    # Build the container image
    - name: 'gcr.io/cloud-builders/docker'
      args: ['build', '-t', 'gcr.io/PROJECT_ID/IMAGE', '.']
    # Push the container image to Container Registry
    - name: 'gcr.io/cloud-builders/docker'
      args: ['push', 'gcr.io/PROJECT_ID/IMAGE']
    # Deploy container image to Cloud Run
    - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
      entrypoint: gcloud
      args: ['run', 'deploy', 'SERVICE_NAME', '--image', 'gcr.io/PROJECT_ID/IMAGE', '--region', 'SERVICE_REGION']
    images:
    - gcr.io/PROJECT_ID/IMAGE
    

    Em que:

    • SERVICE_NAME é o nome do serviço do Cloud Run.
    • SERVICE_REGION é a região do serviço do Cloud Run em que você está implantando.
    • PROJECT_ID é o ID do projeto do Google Cloud em que a imagem está armazenada.
    • IMAGE é o nome da imagem no Container Registry.
  3. Navegue até o diretório raiz do projeto e execute o comando a seguir, em que BUILD_REGION é uma das regiões de build com suporte para executar o build:

     gcloud builds submit --region=BUILD_REGION
    

Após a conclusão, uma mensagem de sucesso é exibida junto com o URL do serviço implantado.

Implantação contínua

Automatize a implantação do software no Cloud Run criando gatilhos do Cloud Build. Configure os acionadores para criar e implantar imagens sempre que atualizar o código-fonte.

Para automatizar a implantação:

  1. Na raiz do repositório, adicione um arquivo de configuração chamado cloudbuild.yaml com as etapas para criar a imagem, enviá-la para o Container Registry e invocar o comando gcloud run deploy:

      steps:
      # Build the container image
      - name: 'gcr.io/cloud-builders/docker'
        args: ['build', '-t', 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA', '.']
      # Push the container image to Container Registry
      - name: 'gcr.io/cloud-builders/docker'
        args: ['push', 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA']
      # Deploy container image to Cloud Run
      - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
        entrypoint: gcloud
        args:
        - 'run'
        - 'deploy'
        - 'SERVICE_NAME'
        - '--image'
        - 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA'
        - '--region'
        - 'SERVICE_REGION'
      images:
      - 'gcr.io/$PROJECT_ID/SERVICE_NAME:$COMMIT_SHA'
    

    Em que:

    • SERVICE_NAME é o nome do serviço do Cloud Run.
    • SERVICE_REGION é a região do serviço do Cloud Run que você está implantando.

    O uso da variável de substituição $COMMIT_SHA é preenchido pelo Cloud Build quando acionado a partir de um repositório git.

  2. Crie um gatilho de compilação com o arquivo de configuração criado na etapa anterior:

    1. Acesse a página Gatilhos:

      Acessar a página "Gatilhos"

    2. Clique em Criar gatilho.

    3. No campo Nome, insira um nome para o gatilho.

    4. Em Região, selecione a região do seu gatilho.

    5. Em Evento, selecione o evento do repositório para iniciar o gatilho.

    6. Em Origem, selecione o repositório e o nome da ramificação ou da tag que iniciará o gatilho. Para mais informações sobre como especificar quais ramificações precisam ser criadas automaticamente, consulte Como criar um gatilho de compilação.

    7. Em Configuração, selecione Arquivo de configuração do Cloud Build (YAML ou JSON)

    8. No campo local do arquivo de configuração do Cloud Build, digite cloudbuild.yaml depois do /.

    9. Clique em Criar para salvar o gatilho de compilação.

  3. O processo foi concluído. De agora em diante, sempre que você enviar para seu repositório, um build e uma implantação do serviço serão chamados automaticamente.

Sempre que enviar um novo código para seu repositório, você acionará automaticamente uma versão e implantará seu serviço do Cloud Run.

Para mais informações sobre como criar gatilhos do Cloud Build, consulte Como criar e gerenciar gatilhos de build.

Como usar permissões mínimas do IAM

Quando um contêiner é implantado em um serviço do Cloud Run, ele é executado com a identidade da conta de serviço do ambiente de execução deste serviço do Cloud Run. Como o Cloud Build pode implantar novos contêineres automaticamente, o Cloud Build precisa ser capaz de atuar como a conta de serviço do ambiente de execução do serviço do Cloud Run.

Para conceder acesso limitado ao Cloud Build para implantar em um serviço do Cloud Run, siga estas etapas:

Console

  1. Acesse a página Contas de serviço do console do Google Cloud:

    Acesse as Contas de serviço

  2. Clique no endereço de e-mail da conta de serviço do ambiente de execução do serviço do Cloud Run (por padrão, é PROJECT_NUMBER-compute@developer.gserviceaccount.com).

  3. Clique na guia Permissões.

  4. Clique em CONCEDER ACESSO.

  5. Insira a conta de serviço do Cloud Build (PROJECT_NUMBER@cloudbuild.gserviceaccount.com)

  6. Na lista suspensa Selecionar um papel, selecione o papel Contas de serviço > Usuário da conta de serviço.

  7. Clique em Salvar.

gcloud

Use o comando gcloud iam service-accounts add-iam-policy-binding, em que PROJECT_NUMBER é o ID numérico do projeto:

gcloud iam service-accounts add-iam-policy-binding \
  PROJECT_NUMBER-compute@developer.gserviceaccount.com \
  --member="serviceAccount:PROJECT_NUMBER@cloudbuild.gserviceaccount.com" \
  --role="roles/iam.serviceAccountUser"

Substitua PROJECT_NUMBER pelo ID numérico do projeto.

Se estiver usando o Cloud Run com uma identidade de serviço personalizada, substitua PROJECT_NUMBER-compute@developer.gserviceaccount.com pelo endereço da conta de serviço.

Consulte Permissões de implantação para mais informações.

Exemplos de código

Veja alguns repositórios de amostra, cada um com um aplicativo de amostra e um arquivo de configuração de build para implantar o aplicativo no Cloud Run:

  • deploy-prebuilt: um exemplo de código que mostra como implantar uma imagem pré-criada no Cloud Run.
  • run-example-builddeploy: um exemplo de código que mostra como criar e implantar uma imagem no Cloud Run.

A seguir