Configurar contas de serviço especificadas pelo usuário

Para seguir o princípio do menor privilégio no Cloud Build, configure o Cloud Build para usar uma conta de serviço com privilégios suficientes para executar um build. Esta página documenta como configurar uma conta de serviço.

Se você não especificar uma conta de serviço, o Cloud Build poderá selecionar automaticamente uma conta de serviço para executar builds em seu nome. Essa conta de serviço pode ter permissões desnecessárias para seu caso de uso, como acesso a repositórios de origem do Cloud e a qualquer bucket do Cloud Storage no seu projeto.

Para melhorar a postura de segurança dos seus projetos e reduzir o possível impacto de configurações incorretas ou usuários maliciosos, recomendamos seguir o princípio do privilégio mínimo. Ao adotar esse princípio, você pode atribuir a cada conta de serviço as permissões e papéis associados à tarefa que ela executa. Por exemplo, é possível usar uma conta de serviço para criar e enviar imagens para o Artifact Registry, conforme mostrado no Google Cloud Blog.

Antes de começar

Conceder permissões do IAM

Para permitir que o build acesse os serviços aos quais ele precisa se conectar, é necessário conceder algumas funções e permissões:

  1. Abra a página "Configurações" do Cloud Build:

    Abrir a página "Configurações do Cloud Build"

    Você vai encontrar a guia Permissões da conta de serviço:

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

  2. Na lista suspensa, selecione a conta de serviço cujos papéis você quer mudar.

  3. Defina o status do papel que você quer adicionar a Ativar.

  4. Se o papel necessário para o pipeline de build não estiver listado aqui, conceda outros papéis na página de configurações do IAM.

Confira mais informações sobre os papéis geralmente necessários para um build em Como configurar o acesso aos recursos do Cloud Build e na lista completa de papéis e permissões do IAM do Cloud Build.

Configurar registros de build

Quando você especifica sua própria conta de serviço para builds, é preciso armazenar seus registros de build no Cloud Logging ou em um bucket do Cloud Storage criado pelo usuário. Não é possível armazenar seus registros no bucket de registros padrão.

Executar um build usando um arquivo de configuração

Para executar manualmente um build usando um arquivo de configuração:

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

  2. Adicione o campo serviceAccount e a configuração de geração de registros preferida.

    • Se você estiver armazenando os registros de build no Cloud Logging, adicione um campo logging e defina o valor do campo como CLOUD_LOGGING_ONLY.

    • Se você estiver armazenando os registros do build em um bucket do Cloud Storage criado pelo usuário:

      • Adicione um campo logging e defina o valor dele como GCS_ONLY.
      • Adicione um campo de logsBucket e defina o valor dele como o local do bucket do Cloud Storage.

    O exemplo a seguir configura o Cloud Build para executar builds usando uma conta de serviço especificada pelo usuário e configura os registros de build para serem armazenados em um bucket do Cloud Storage criado pelo usuário:

    YAML 

    steps:
- name: 'bash'
  args: ['echo', 'Hello world!']
logsBucket: 'LOGS_BUCKET_LOCATION'
serviceAccount: 'projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT'
options:
  logging: GCS_ONLY

    JSON 

    {
  "steps": [
  {
    "name": "bash",
    "args": [
      "echo",
      "Hello world!"
    ]
  }
  ],
  "logsBucket": "LOGS_BUCKET_LOCATION",
  "serviceAccount": "projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT",
  "options": {
    "logging": "GCS_ONLY"
  }
}

    Substitua os valores de marcador no arquivo de configuração do build pelo seguinte:

    • LOGS_BUCKET_LOCATION é o bucket do Cloud Storage para armazenar registros do build. Por exemplo, gs://mylogsbucket.
    • PROJECT_ID é o ID do projeto do Google Cloud em que você está executando o build.
    • SERVICE_ACCOUNT é o endereço de e-mail ou o ID exclusivo da conta de serviço que você quer especificar para builds. Por exemplo, o endereço de e-mail de uma conta de serviço é parecido com este: service-account-name@project-id.iam.gserviceaccount.com.

  3. Inicie o build usando o arquivo de configuração do build:

    gcloud builds submit --config CONFIG_FILE_PATH SOURCE_DIRECTORY

    Substitua os valores dos marcadores nos comandos acima pelo seguinte:

    • CONFIG_FILE_PATH é o caminho para o arquivo de configuração do build;
    • SOURCE_DIRECTORY é o caminho ou o URL do código-fonte.

    Se você não especificar CONFIG_FILE_PATH e SOURCE_DIRECTORY no comando gcloud builds submit, o Cloud Build presumirá que o arquivo de configuração do build e o código-fonte estão no diretório de trabalho atual.

Executar builds usando gatilhos

Para executar um build com gatilhos do Cloud Build usando sua própria conta de serviço, configure a opção de registro de sua preferência e selecione a conta de serviço de preferência ao criar o gatilho.

  1. No arquivo de configuração de build:

    • Se você estiver armazenando os registros de build no Cloud Logging, adicione um campo logging e defina o valor do campo como CLOUD_LOGGING_ONLY.

    • Se você estiver armazenando os registros do build em um bucket do Cloud Storage criado pelo usuário:

      • Adicione um campo logging e defina o valor dele como GCS_ONLY.
      • Adicione um campo de logsBucket e defina o valor dele como o local do bucket do Cloud Storage.

    O exemplo a seguir configura os registros de build para serem armazenados em um bucket do Cloud Storage criado pelo usuário:

    YAML 

    steps:
- name: 'bash'
  args: ['echo', 'Hello world!']
logsBucket: 'LOGS_BUCKET_LOCATION'
options:
  logging: GCS_ONLY

    JSON 

    {
  "steps": [
  {
    "name": "bash",
    "args": [
      "echo",
      "Hello world!"
    ]
  }
  ],
  "logsBucket": "LOGS_BUCKET_LOCATION",
  "options": {
    "logging": "GCS_ONLY"
  }
}

    Substitua LOGS_BUCKET_LOCATION pelo bucket do Cloud Storage para armazenar logs de build. Por exemplo, gs://mylogsbucket.

  2. Especifique uma conta de serviço para usar com o gatilho de compilação:

    Console

    Para executar builds usando a página "Trigger" no console do Google Cloud, a conta de serviço especificada pelo usuário precisa estar no mesmo projeto que o gatilho do build. Para usar gatilhos com contas de serviço entre projetos, crie o gatilho de build usando a ferramenta gcloud.

    1. Crie ou edite o gatilho de compilação.

    2. No campo Conta de serviço especifique sua conta de serviço. Se você não especificar uma conta de serviço, o Cloud Build vai usar a conta de serviço padrão.

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

    gcloud

    Ao criar um gatilho de compilação, especifique sua conta de serviço usando a sinalização --service-account. No exemplo a seguir, o comando gcloud cria um gatilho de build que extrai código de um repositório Git:

    gcloud builds triggers create github \
   --name=TRIGGER_NAME \
   --repo-name=REPO_NAME \
   --repo-owner=REPO_OWNER \
   --branch-pattern=BRANCH_PATTERN
   --build-config=BUILD_CONFIG_FILE
   --service-account=SERVICE_ACCOUNT
   --project=BUILD_PROJECT

    Substitua os valores de marcador no arquivo de configuração do build pelo seguinte:

    • TRIGGER_NAME é o nome do gatilho de compilação.
    • REPO_NAME é o nome do repositório;
    • REPO_OWNER é o nome de usuário do proprietário do repositório.
    • BRANCH_PATTERN é o nome da ramificação no seu repositório para invocar o build.
    • TAG_PATTERN é o nome da tag no repositório para invocar o build.
    • BUILD_CONFIG_FILE é o caminho para seu arquivo de configuração da compilação.
    • SERVICE_ACCOUNT é sua conta de serviço no formato /projects/PROJECT_ID/serviceAccounts/ACCOUNT_ID_OR_EMAIL.
    • BUILD_PROJECT é o projeto em que você está iniciando builds.

Configuração entre projetos

Se a conta de serviço especificada pelo usuário estiver em um projeto diferente do em que você está iniciando os builds, conceda o acesso necessário:

  • No projeto que tem a conta de serviço especificada pelo usuário, verifique se a restrição de política da organização iam.disableCrossProjectServiceAccountUsage não foi aplicada. Essa restrição é aplicada por padrão. Para desativar essa restrição da política da organização, execute o comando abaixo, em que SERVICE_ACCOUNT_PROJECT_ID é o projeto que contém a conta de serviço especificada pelo usuário:

    gcloud resource-manager org-policies disable-enforce \
   iam.disableCrossProjectServiceAccountUsage \
   --project=SERVICE_ACCOUNT_PROJECT_ID

  • No projeto que tem a conta de serviço especificada pelo usuário, conceda o papel roles/iam.serviceAccountTokenCreator ao agente de serviço do Cloud Build do projeto em que você está executando builds:

    gcloud projects add-iam-policy-binding SERVICE_ACCOUNT_PROJECT_ID \
    --member="serviceAccount:BUILD_SERVICE_AGENT" \
    --role="roles/iam.serviceAccountTokenCreator"

    Substitua os valores de marcador no comando pelo seguinte:

    • SERVICE_ACCOUNT_PROJECT_ID: o ID do projeto que contém a conta de serviço especificada pelo usuário.
    • BUILD_SERVICE_AGENT: o ID de e-mail do agente de serviço do formulário service-BUILD_PROJECT_NUMBER@gcp-sa-cloudbuild.iam.gserviceaccount.com, em que BUILD_PROJECT_NUMBER é o número do projeto em que você está executando os builds. Você pode encontrar o número do projeto na página de configurações do projeto.

Limitações:

  • Seu projeto do Google Cloud precisa estar em uma Google Cloud organização.

  • É necessário iniciar builds na linha de comando usando gcloud builds submit ou gcloud builds triggers create. Para usar a página "Gatilhos" no console do Google Cloud, a conta de serviço especificada pelo usuário e o gatilho de build precisam estar no mesmo projeto.

A seguir