Armazenar e gerenciar registros de build

Quando você executa compilações, o Cloud Build coleta e armazena seus registros de build. Esta página explica como armazenar, visualizar e excluir registros de build.

Escolher onde armazenar os registros do build

É possível configurar o Cloud Build para armazenar registros de compilação no Cloud Logging ou no Cloud Storage incluindo o campo logging no arquivo de configuração do Cloud Build. de dados. Se você não especificar um campo logging no arquivo de configuração de versão, o Cloud Build armazenará registros de versão no Logging e no Cloud Storage.

As etapas a seguir armazenam registros de criação somente no Logging:

  1. No arquivo de configuração de build, defina o valor de logging como CLOUD_LOGGING_ONLY:

    YAML 

    steps:
- name: 'gcr.io/cloud-builders/docker'
  args: ['build', '-t', 'us-east1-docker.pkg.dev/myproject/myimage', '.']
options:
  logging: CLOUD_LOGGING_ONLY

    JSON 

    {
  "steps": [
  {
    "name": "gcr.io/cloud-builders/docker",
    "args": [
      "build",
      "-t",
      "us-east1-docker.pkg.dev/myproject/myimage",
      "."
    ]
  }
  ],
  "options": {
    "logging": "CLOUD_LOGGING_ONLY"
  }
}

  2. Use o arquivo de configuração do build para iniciar um build usando a linha de comando, a API ou os acionadores.

Armazenar registros de build no bucket padrão criado pelo Google

Por padrão, o Cloud Build armazena os registros de build em um bucket do Cloud Storage criado pelo Google. É possível visualizar o armazenamento de registros de build no bucket do Cloud Storage criado pelo Google, mas não é possível fazer outras alterações nele. Se você precisar de controle total sobre seu bucket de registros, armazene os registros em um bucket do Cloud Storage criado pelo usuário.

Armazenar registros de build em um bucket criado pelo usuário

Permissões do IAM:

Para armazenar registros de build no seu próprio bucket do Cloud Storage, primeiro conceda as permissões do IAM necessárias à conta de serviço que você está usando para o build:

  • Se o bucket do Cloud Storage e o Cloud Build estiverem no mesmo projeto do Google Cloud e você estiver usando a conta de serviço legada do Cloud Build, ela terá as permissões de IAM necessárias por padrão. Você não precisa conceder permissões adicionais.

  • Em qualquer outro caso, conceda o papel de Administrador do Storage à conta de serviço que você está usando para o build:

    1. Abra a página "IAM" no projeto em que o bucket do Cloud Storage está localizado:

      Abra a página do IAM

    2. Clique em Conceder acesso.

    3. Insira o endereço de e-mail da conta de serviço.

    4. Selecione Cloud Storage > Administrador do Storage.

    5. Clique em Save.

Para especificar um bucket do Cloud Storage para armazenar registros de builds:

  1. No projeto do Google Cloud, crie um bucket do Cloud Storage sem uma política de retenção definida para armazenar os registros de build.

  2. No arquivo de configuração do build, adicione um campo logsBucket que aponte para o bucket do Cloud Storage criado para armazenar registros da build. O arquivo de configuração de build a seguir contém instruções para criar uma imagem de contêiner e armazenar os registros de build em um bucket chamado mylogsbucket:

    YAML

        steps:
    - name: 'gcr.io/cloud-builders/docker'
      args: [ 'build', '-t', 'us-east1-docker.pkg.dev/myproject/myimage', '.' ]
    logsBucket: 'gs://mylogsbucket'
    options:
      logging: GCS_ONLY

    JSON 

        {
      "steps": [
       {
         "name": "gcr.io/cloud-builders/docker",
         "args": [
           "build",
           "-t",
           "us-east1-docker.pkg.dev/myproject/myimage",
           "."
         ]
       }
       ],
       "logsBucket": "gs://mylogsbucket",
       "options": {
         "logging": "GCS_ONLY"
       }
    }

  3. Use o arquivo de configuração do build para iniciar um build usando a linha de comando, a API ou os acionadores.

Quando o build é concluído, o Cloud Build armazena os registros no bucket do Cloud Storage especificado no arquivo de configuração de build.

Armazenar registros de build em um bucket regionalizado e de propriedade do usuário

Por padrão, o Cloud Build armazena registros do build em uma região especificada pelo Google, que pode ser diferente do local em que você executa um build. A opção defaultLogsBucketBehavior permite configurar o Cloud Build para usar um bucket de registros padrão no seu projeto e na mesma região do build. Essa configuração oferece mais controle sobre o local dos dados de registro, o que pode ajudar a cumprir os requisitos de residência de dados.

Você vai incorrer em custos para armazenar registros no seu próprio projeto. Para detalhes sobre preços, consulte Preços do Cloud Storage.

Configure o Cloud Build para usar logs regionalizados de propriedade do usuário:

  1. Conceda as permissões necessárias do IAM.

    • Se você estiver usando a conta de serviço legada do Cloud Build, seu A conta de serviço legada do Cloud Build tem o IAM necessário permissões por padrão. Você não precisa conceder outras permissões.

    • Para outras contas de serviço, conceda o papel de Administrador de armazenamento à conta de serviço que você está usando para o build. Para instruções sobre como conceder uma a uma conta de serviço, consulte Como conceder papéis projeto.

  2. Na configuração de build, adicione a opção defaultLogsBucketBehavior e defina o valor dela como REGIONAL_USER_OWNED_BUCKET:

    YAML 

    steps:
- name: 'gcr.io/cloud-builders/docker'
  args: [ 'build', '-t', 'us-central1-docker.pkg.dev/myproject/myrepo/myimage', '.' ]
options:
  defaultLogsBucketBehavior: REGIONAL_USER_OWNED_BUCKET

    JSON 

    {
  "steps": [
    {
      "name": "gcr.io/cloud-builders/docker",
      "args": [
        "build",
        "-t",
        "us-central1-docker.pkg.dev/myproject/myrepo/myimage",
        "."
      ]
    }
    ],
    "options": {
      "defaultLogsBucketBehavior": "REGIONAL_USER_OWNED_BUCKET"
    }
}

  3. Use esse arquivo para iniciar um build usando a linha de comando, a API ou acionadores.

    Quando você executa o build, o Cloud Build cria o novo bucket de registros na região em que o build é executado e armazena os registros desse bucket. Os builds subsequentes no mesmo projeto e região vão utilizar o bucket atual por padrão.

Se você definir a opção defaultLogsBucketBehavior e criar builds em várias regiões, o Cloud Build vai criar vários buckets para seus logs de build.

Os registros de build regionalizados armazenados no seu próprio projeto não têm uma política de retenção. Essa configuração não pode ser alterada.

Precedência entre as configurações de registros

Se você estiver adicionando a opção defaultLogsBucketBehavior a um arquivo de configuração de build e tiver configurado anteriormente as opções logging ou logsBucket, recomendamos que você exclua essas configurações para evitar conflitos.

Especificamente, o defaultLogsBucketBehavior não vai funcionar se você tiver configurado:

  • logging: CLOUD_LOGGING_ONLY para armazenar os registros do build no Cloud Logging.
  • logging: NONE para desativar a geração de registros.

Quando você executa um build sem opções de registro definidas na configuração de build, o Cloud Build define logging: LEGACY e armazena os registros no bucket padrão do Cloud Storage criado pelo Google. Se você adicionar defaultLogsBucketBehavior: REGIONAL_USER_OWNED_BUCKET, essa opção vai substituir logging: LEGACY.

Veja os registros das versões

Permissões do IAM:

  • Se os registros do build estiverem no Logging, conceda o papel Visualizador de registros no projeto em que o build está configurado para principais que querem visualizar registros de compilação:

    1. Abra a página do IAM:

      Abrir a página do IAM

    2. Selecione o projeto e clique em Abrir.

    3. Na tabela de permissões, localize o ID de e-mail do principal e clique no ícone de lápis.

    4. Selecione o papel Logging > Visualizador de registros.

    5. Clique em Save.

  • Se os registros de build estiverem no bucket padrão do Cloud Storage criado pelo Google, conceda o papel Visualizador de projetos no projeto em que o build está configurado para principais que querem visualizá-los:

    1. Abra a página do IAM:

      Abrir a página do IAM

    2. Selecione o projeto e clique em Abrir.

    3. Na tabela de permissões, localize o ID de e-mail do principal e clique no ícone de lápis.

    4. Selecione o papel Projeto > Leitor.

    5. Clique em Save.

    Se os registros do build estiverem em um bucket do Cloud Storage criado ou de propriedade do usuário, conceda Leitor de objetos do Storage aos principais que querem conferir os registros de build:

    1. Abra a página do IAM:

      Abrir a página do IAM

    2. Selecione o projeto e clique em Abrir.

    3. Na tabela de permissões, localize o ID de e-mail do principal e clique no ícone de lápis.

    4. Selecione o papel Cloud Storage > Leitor de objetos do Storage.

    5. Clique em Salvar.

Para ver os registros do build no Cloud Build:

Console

  1. Abra a página do Cloud Build no console do Google Cloud.

    Abra a página do Cloud Build

  2. Selecione o projeto e clique em Abrir.

  3. No menu suspenso Região, selecione a região do seu build.

  4. Na página Histórico de build, clique em um build específica.

  5. Na página Detalhes do build, em Etapas, clique em Resumo do build para ver os registros de build inteiros ou clique em uma etapa do build para ver registros de build dessa etapa.

    Captura de tela dos registros de build na página "Detalhes do build"

  6. Se os registros forem armazenados no Logging, no painel Registro do build, clique no ícone para visualizar os registros no Explorador de registros.

    Captura de tela dos registros de build no Explorador de registros

gcloud

Execute o comando gcloud builds log, em que build-id é o ID da versão para que você quer receber registros de versão. O ID do build é exibido no final do processo de envio da build quando você executa gcloud builds submit ou na coluna "ID" quando você executa gcloud builds list.

gcloud builds log build-id

Para ver os registros de builds no GitHub e no GitHub Enterprise:

Se você criar um GitHub ou do GitHub Enterprise e especificou --include-logs-with-status como opção, é possível conferir os registros de build no GitHub e no GitHub Enterprise.

Para conferir os registros de build no GitHub e no GitHub Enterprise:

  1. Navegue até o repositório associado ao acionador.

  2. Navegue até sua lista de commits.

  3. Localize a linha da confirmação com os registros de build que você quer ver.

  4. Clique no ícone de resultado na linha do commit.

    Você verá uma lista de verificações associadas à confirmação.

  5. Clique em Detalhes na linha em que você quer conferir os registros de build.

    A página Resumo associada à sua confirmação será mostrada. Se você criou um gatilho usando o a sinalização --include-logs-with-status, Os registros de build exibidos na seção Detalhes da página.

Excluir registros de build

Não é possível excluir os registros de build no bucket de registros criado pelo Google.

Para excluir os registros da build em um bucket de registros criado pelo usuário:

  1. Conceda o papel Administrador de objetos do Storage ao usuário ou à conta de serviço que exclua os registros.

  2. Exclua os registros de build seguindo as instruções para excluir objetos do Cloud Storage em Como excluir objetos.

Para excluir o bucket de registros criados pelo usuário:

  1. Conceda o papel Administrador do Storage ao usuário ou à conta de serviço excluindo o bucket de registros.

  2. Exclua o bucket de registros usando as instruções para excluir um bucket em Como excluir buckets.

A seguir