Conceitos e terminologia do Git Sync do AWS CloudFormation - AWS CloudFormation
Visão geral do Git SyncArquivo de implantação da pilhaArquivo de modelo do CloudFormationRepositório de definição de modelo

Conceitos e terminologia do Git Sync do AWS CloudFormation

Esta seção apresenta conceitos e termos fundamentais do Git Sync.

Visão geral do Git Sync

A breve visão geral apresentada a seguir explica como funciona o Git Sync e como usá-lo. Para obter um tutorial completo, consulte Demonstração do Git Sync do AWS CloudFormation.

  • Use CodeConnections para conectar um provedor do Git ao CloudFormation. Neste guia, a conexão é criada por meio do console do Connections. Como alternativa, é possível criar a conexão com a AWS CLI. O Git Sync oferece suporte ao GitHub, ao GitHub Enterprise, ao GitLab e ao Bitbucket.

  • Forneça um modelo do CloudFormation que defina a pilha e adicione-o ao seu repositório. Este arquivo de modelo é monitorado. O CloudFormation atualiza a pilha automaticamente quando as alterações são confirmadas para ela.

  • No console do CloudFormation, crie uma nova pilha e escolha Sincronizar pelo Git para configurar a pilha com suporte ao Git Sync. Você especificará o repositório e a ramificação que deseja que o CloudFormation monitore, bem como especificará o modelo do CloudFormation que define a pilha em seu repositório.

  • Durante a configuração, é possível fornecer o próprio arquivo de implantação da pilha do seu repositório ou fazer com que o Git Sync gere um arquivo para você. O arquivo de implantação da pilha contém parâmetros e valores que configuram os recursos na pilha. Este arquivo de implantação da pilha é monitorado. O CloudFormation atualiza a pilha automaticamente quando as alterações são confirmadas para ela.

  • O Git Sync cria uma solicitação pull em seu repositório para sincronizar a pilha com o arquivo de modelo do CloudFormation e o arquivo de implantação da pilha. Se o Git Sync gerar o arquivo de implantação da pilha para você, ele será enviado ao seu repositório pelo Git Sync.

  • Mescle a solicitação pull com seu repositório para que o CloudFormation provisione a pilha, configure-a com seus parâmetros de implantação e comece a monitorar as alterações no repositório.

  • Como o CloudFormation está monitorando o repositório, as alterações que você confirma para o arquivo de modelo e para o arquivo de implantação da pilha são detectadas e a pilha é atualizada automaticamente.

  • No console do CloudFormation, será possível visualizar informações sobre o status da configuração do Git Sync para a pilha e um histórico de confirmações aplicadas à pilha. Além disso, o console fornece ferramentas para a reconfiguração do Git Sync e para a solução de problemas.

Arquivo de implantação da pilha

Um arquivo de implantação da pilha corresponde a um arquivo formatado em JavaScript Object Notation (JSON) ou em YAML padrão que contém os parâmetros e os valores que gerenciam a pilha do CloudFormation. Ele é monitorado quanto a alterações. Quando alterações no arquivo são confirmadas no repositório, a pilha associada é atualizada automaticamente.

O arquivo de implantação da pilha contém um par chave/valor e dois dicionários:

  • template-file-path

    Este é o caminho completo do repositório para o arquivo de modelo do CloudFormation. O arquivo de modelo declara os recursos para a pilha do CloudFormation associada a este arquivo de implantação.

  • parameters

    O dicionário de parâmetros contém pares chave/valor que configuram os recursos na pilha. Um arquivo de implantação da pilha pode ter, no máximo, 50 parâmetros.

  • tags

    O dicionário de etiquetas contém pares chave/valor opcionais que você pode usar para identificar e categorizar os recursos na pilha. Um arquivo de implantação da pilha pode ter, no máximo, 50 etiquetas.

É possível fornecer o próprio arquivo de implantação da pilha ou fazer com que o Git Sync crie um arquivo para você e envie automaticamente uma solicitação pull para o seu repositório. Você pode gerenciar os parâmetros e as etiquetas ao editar o arquivo de implantação da pilha e ao confirmar as alterações no repositório.

Veja a seguir um exemplo de um arquivo de implantação da pilha do Git Sync:

template-file-path: ./fargate-srvc/my-stack-template.yaml

parameters: 
    image: public.ecr.aws/lts/nginx:latest
    task_size: x-small
    max_capacity: 5
    port: 8080
    env: production
tags:
    cost-center: '123456'
    org: 'AWS'

Arquivo de modelo do CloudFormation

Um arquivo de modelo contém uma declaração dos recursos da AWS que compõem uma pilha do CloudFormation. O modelo é armazenado como um arquivo formatado em JavaScript Object Notation (JSON) ou em YAML padrão. É possível criar e editar modelos com o Template Designer do CloudFormation ou em qualquer editor de textos. Com o Git Sync, o arquivo de modelo é armazenado no repositório Git e referenciado pelo arquivo de implantação da pilha. É possível gerenciar a pilha ao editar o arquivo de modelo e ao confirmar as alterações para o repositório.

Para obter mais informações sobre os modelos, incluindo exemplos e uma demonstração do Template Designer do AWS CloudFormation, consulte Trabalhar com modelos do AWS CloudFormation.

Repositório de definição de modelo

O repositório de definição de modelo corresponde ao repositório Git vinculado ao CloudFormation por meio do Git Sync. O repositório é monitorado quanto a alterações para o modelo do CloudFormation e para o arquivo de implantação da pilha. Quando você confirma as alterações para o arquivo, a pilha associada é atualizada automaticamente.

Importante

Ao configurar o repositório de definição de modelo no console do Git Sync, selecione o repositório e a ramificação adequados da conexão do Git. O Git Sync monitora somente o repositório e a ramificação configurados em busca de alterações para o modelo do CloudFormation e para o arquivo de implantação da pilha.

O Git Sync oferece suporte aos repositórios GitHub, GitHub Enterprise, GitLab e Bitbucket.