Implantar um fluxo de trabalho de um repositório Git usando o Cloud Build

É possível usar um gatilho de build do Cloud Build para iniciar automaticamente um build e implantar um fluxo de trabalho de um repositório Git. Você pode configurar o gatilho para implantar o fluxo de trabalho em qualquer mudança no repositório de origem ou somente quando a mudança corresponder a critérios específicos.

Essa abordagem pode ajudar a gerenciar o ciclo de vida da implantação. Por exemplo, é possível implantar mudanças em um fluxo de trabalho em um ambiente de preparação, executar testes nesse ambiente e, em seguida, implementar essas mudanças de forma incremental no ambiente de produção.

Antes de começar

Estas instruções pressupõem que você tenha o papel de editor do Cloud Build (roles/cloudbuild.builds.editor) no seu Google Cloud projeto para poder criar gatilhos. Você também precisa de um fluxo de trabalho em um repositório de origem, como GitHub ou Bitbucket.

Console

  1. Ative as APIs Cloud Build e Workflows.

    Ativar as APIs

  2. Conceda o papel de administrador do Workflows (roles/workflows.admin) à conta de serviço do Cloud Build:

    1. No Google Cloud console, acesse a página IAM.

      Acessar IAM

    2. Selecione o projeto.

    3. Na linha da conta de serviço do Cloud Build (PROJECT_NUMBER@cloudbuild.gserviceaccount.com), clique em Editar principal.

    4. Clique em Adicionar outro papel.

    5. Na lista Papel, selecione o papel Administrador do Workflows.

    6. Clique em Salvar.

  3. Conceda o papel de usuário da conta de serviço (roles/iam.serviceAccountUser) na conta de serviço padrão do Compute Engine à conta de serviço do Cloud Build. Quando você tiver ativado a API Compute Engine, a conta de serviço padrão do Compute Engine é PROJECT_NUMBER-compute@developer.gserviceaccount.com.

    1. No Google Cloud console do, acesse a página Contas de serviço.

      Acessar a página "Contas de serviço"

    2. Selecione o projeto.

    3. Clique no endereço de e-mail da conta de serviço padrão do Compute Engine (PROJECT_NUMBER-compute@developer.gserviceaccount.com).

    4. Clique na guia Permissões.

    5. Clique no botão Conceder acesso.

    6. Para adicionar uma nova principal, insira o endereço de e-mail da conta de serviço (SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com).

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

    8. Clique em Salvar.

gcloud

  1. Ative as APIs Cloud Build e Workflows.

    gcloud services enable cloudbuild.googleapis.com \
      workflows.googleapis.com
    
  2. Conceda o papel de administrador do Workflows (roles/workflows.admin) à conta de serviço do Cloud Build:

    PROJECT_NUMBER=$(gcloud projects describe PROJECT_ID --format='value(projectNumber)')
    gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:$PROJECT_NUMBER@clogserviceaccount.comudbuild. \
      --role=roles/workflows.admin
    

    Substitua PROJECT_ID pelo ID do seu Google Cloud projeto.

  3. Conceda o papel de usuário da conta de serviço (roles/iam.serviceAccountUser) na conta de serviço padrão do Compute Engine à conta de serviço do Cloud Build. Quando você tiver ativado a API Compute Engine, a conta de serviço padrão do Compute Engine é PROJECT_NUMBER-compute@developer.gserviceaccount.com.

    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
    

Conectar-se ao repositório de origem

É necessário conectar o Cloud Build ao repositório de origem para que ele possa automatizar os builds em resposta a eventos que acontecem no repositório.

Conclua as etapas a seguir para se conectar ao GitHub ou ao Bitbucket:

  1. No Google Cloud console, acesse a página Gatilhos do Cloud Build:

    Acessar "Acionadores"

  2. Se necessário, selecione o projeto e clique em Abrir.

  3. Na lista Região, selecione a região em que você quer criar o gatilho.

  4. Clique em Conectar repositório.

  5. Selecione o repositório de origem em que você armazenou o código-fonte.

    Por exemplo: GitHub (app GitHub do Cloud Build)

  6. Clique em Continuar.

  7. Autentique o repositório de origem com seu nome de usuário e senha.

    Se você estiver fazendo login no GitHub, será necessário autorizar o app GitHub do Google Cloud Build a acessar sua conta do GitHub para continuar.

  8. Na lista de repositórios disponíveis, selecione o repositório desejado e clique em OK.

    Para repositórios externos, como GitHub e Bitbucket, é necessário ter permissões de proprietário para o Google Cloud projeto em que você está trabalhando.

  9. Leia a exoneração de responsabilidade e marque a caixa de seleção ao lado dela para indicar que você concorda com os termos.

  10. Clique em Conectar.

  11. Para continuar criando um gatilho de compilação para automatizar builds para o código-fonte no repositório, clique em Criar um gatilho. Caso contrário, clique em Concluído.

Criar um arquivo de configuração do Cloud Build

Um arquivo de configuração do build define os campos necessários ao usar um gatilho de compilação para iniciar um build. Crie o arquivo de configuração no diretório raiz do projeto e grave-o usando YAML ou JSON.

Por exemplo, o arquivo de configuração a seguir implanta e executa um fluxo de trabalho de teste e, em seguida, usa um script para verificar a saída. Se o teste for aprovado, o fluxo de trabalho será implantado:

steps:
# Deploy the test workflow with the commit sha
- id: 'deploy-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  args: ['workflows', 'deploy', '$_WORKFLOW_NAME-$BRANCH_NAME-$SHORT_SHA', '--source', 'gitops/workflow.yaml']

# Run the test workflow and capture the output
- id: 'run-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  entrypoint: 'bash>9;
  args: ['-c', 'gcloud workflows run $_WORKFLOW_NAME-$BRANCH_NAME-$SHORT_SHA  /workspace/testoutput.log']

# Delete the test workflow
- id: 'delete-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  args: ['workflows', 'delete', '$_WORKFLOW_NAME-$BRANCH_NAME-$SHORT_SHA', '--quiet']

# Check the test output
- id: 'check-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  entrypoint: 'bash'
  args: ['gitops/test-$BRANCH_NAME.sh']

# Deploy the workflow
- id: 'deploy-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  args: ['workflows', 'deploy', '$_WORKFLOW_NAME-$BRANCH_NAME', '--source', 'gitops/workflow.yaml']

As variáveis de substituição $BRANCH_NAME e $SHORT_SHA são preenchidas pelo Cloud Build quando um build é acionado de um repositório Git. Elas representam o nome da ramificação e os sete primeiros caracteres do ID de commit associado ao build, respectivamente.

A variável de substituição $_WORKFLOW_NAME permite reutilizar um arquivo de configuração com diferentes valores de variáveis. É possível especificar o valor dela ao criar o gatilho de compilação.

Para saber mais, consulte Criar um arquivo de configuração do build.

Criar um gatilho de compilação

É possível automatizar a implantação do fluxo de trabalho criando um gatilho de build do Cloud Build.

Para criar um gatilho de compilação para o arquivo de configuração na seção anterior:

  1. No Google Cloud console, acesse a página Gatilhos do Cloud Build:

    Acessar "Acionadores"

  2. Clique em Criar gatilho.

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

  4. Em Evento, selecione o evento para invocar o gatilho.

    Por exemplo: Enviar para uma ramificação

  5. Em Origem, selecione o repositório e o nome da ramificação ou da tag que iniciará o gatilho. É possível usar uma expressão regular para especificar uma correspondência a uma ramificação ou tag.

    Por exemplo: GoogleCloudPlatform/workflows-demos (repositório) e ^main$|^staging$ (corresponde às ramificações main e staging)

  6. Expanda a seção Mostrar filtros de arquivos incluídos e ignorados e especifique o fluxo de trabalho como um arquivo incluído para que, quando ele for alterado, um build seja invocado.

    Por exemplo: gitops/workflow.yaml

  7. Em Configuração, selecione Arquivo de configuração do Cloud Build (YAML ou JSON) como o tipo e Repositório como o local.

  8. No campo Local do arquivo de configuração do Cloud Build , especifique o local do arquivo.

    Por exemplo: gitops/cloudbuild.yaml

  9. Opcionalmente, para adicionar uma variável de substituição, clique em Adicionar variável e especifique uma combinação de chave e valor.

    Por exemplo: _WORKFLOW_NAME (variável) e workflows-gitops (valor)

  10. Para salvar o gatilho de compilação, clique em Criar.

Quando qualquer mudança for enviada para um fluxo de trabalho na ramificação especificada do repositório Git, ela acionará automaticamente o Cloud Build para implantar o fluxo de trabalho.

Para mais informações, consulte Criar e gerenciar gatilhos de build.

Testar o gatilho de compilação

É possível testar o gatilho de compilação e o arquivo de configuração das seções anteriores.

  1. Na ramificação staging do repositório Git, edite workflow.yaml e mude Hello World para Bye World:

    main:
      steps:
        - init:
            assign:
              - message: "Hello World"
        - returnResult:
            return: ${message}
  2. Confirme e envie a mudança para a ramificação staging.

    git add workflow.yaml
    git commit -m "Update workflow.yaml in staging"
    git push
    

    O gatilho de build do Cloud Build é executado e inicia um build.

  3. Para confirmar o sucesso do build, no Google Cloud console, acesse a página Histórico de builds:

    Acessar o histórico de builds

    Depois que um build é concluído, o Cloud Build fornece um status geral para o build e para cada etapa de build individual. Para mais informações, consulte Ver resultados de builds.

  4. Para confirmar se um fluxo de trabalho de preparação está implantado, no Google Cloud console, acesse a página Fluxos de trabalho:

    Acessar fluxos de trabalho

    Um fluxo de trabalho chamado workflows-gitops-staging será listado.

  5. Para implantar o fluxo de trabalho de preparação na produção, mescle a ramificação staging à ramificação main:

    git checkout main
    git merge staging
    git push
    

    Como test-main.sh espera Hello World na saída do fluxo de trabalho, o build falhará:

    RESULT_EXPECTED="result: '\"Hello World\"'"
    RESULT_ACTUAL=$(grep "result: " $FILE)
    if [[ $RESULT_EXPECTED == $RESULT_ACTUAL ]]; then
      echo "Result test passed"
    else
      echo "Result test failed. Expected: $RESULT_EXPECTED Actual: $RESULT_ACTUAL"; exit 1;
    fi
  6. Para implantar um fluxo de trabalho de produção, na ramificação staging, edite workflow.yaml novamente e mude a string de volta para Hello World.

  7. Confirme e envie a mudança para a ramificação staging e mescle a ramificação staging à ramificação main.

  8. Para confirmar se um fluxo de trabalho de produção está implantado, no Google Cloud console, acesse a página Fluxos de trabalho:

    Acessar fluxos de trabalho

    Um fluxo de trabalho chamado workflows-gitops-main será listado.

A seguir