Comment fonctionne Git Sync avec CloudFormation - AWS CloudFormation

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Comment fonctionne Git Sync avec CloudFormation

Cette rubrique décrit le fonctionnement de Git sync et présente les concepts clés nécessaires à son utilisation.

Comment fonctionne Git Sync

Pour utiliser Git sync, vous devez d'abord connecter un fournisseur Git à CloudFormation l'utilisation du CodeConnectionsservice. Dans les procédures décrites dans ce guide, la connexion est créée via la CodeConnections console. Vous pouvez également créer la connexion avec le AWS CLI. Vous pouvez utiliser l'un des fournisseurs Git suivants :

Ensuite, vous créez un CloudFormation modèle qui définit votre pile et vous l'ajoutez à votre référentiel. Ce fichier modèle est surveillé. CloudFormation met automatiquement à jour la pile lorsque des modifications y sont apportées.

Dans la CloudFormation console, vous créez une nouvelle pile et vous choisissez Sync from Git CloudFormation pour indiquer d'utiliser Git sync. Vous allez spécifier le dépôt et la branche que vous CloudFormation souhaitez surveiller, ainsi que le CloudFormation modèle de votre référentiel qui définit la pile.

Lors de la configuration, vous pouvez soit fournir votre propre fichier de déploiement de pile à partir de votre référentiel, soit demander à la synchronisation Git d’en générer un pour vous. Le fichier de déploiement de la pile contient des paramètres et des valeurs qui configurent les ressources de votre pile. Ce fichier de déploiement de stack est surveillé. CloudFormation met automatiquement à jour la pile lorsque des modifications y sont apportées.

Git sync crée une pull request dans votre dépôt pour synchroniser votre pile avec le fichier CloudFormation modèle et le fichier de déploiement de la pile. Si c’est la synchronisation Git qui génère le fichier de déploiement de la pile pour vous, ce fichier est envoyé à votre référentiel par la synchronisation Git.

Vous fusionnez ensuite la pull request avec votre référentiel afin que celui-ci CloudFormation approvisionne la pile, la configure avec vos paramètres de déploiement et commence à surveiller les modifications apportées à votre référentiel.

À partir de ce moment, chaque fois que vous apportez des modifications à votre fichier modèle ou à votre fichier de déploiement de pile et que vous les validez dans votre référentiel, les modifications CloudFormation seront automatiquement détectées. Si votre équipe utilise des pull requests, les membres de votre équipe peuvent ensuite examiner et approuver les modifications avant leur déploiement. Une fois la pull request acceptée, CloudFormation déploie vos modifications.

Vous pouvez surveiller l'état de votre configuration de synchronisation Git pour la pile et consulter l'historique des validations appliquées à la pile dans la CloudFormation console. La console fournit également des outils pour reconfigurer la synchronisation  Git et résoudre les problèmes.

Commentaires sur les demandes d'extraction

Vous pouvez choisir de CloudFormation créer un résumé des modifications de code dans les pull requests via le CodeConnections service en activant l'option Activer les commentaires sur les pull requests dans la console. En fournissant un résumé des modifications apportées aux pull requests, les membres de l'équipe peuvent facilement examiner et comprendre l'impact des modifications proposées avant de fusionner les pull requests. Pour de plus amples informations, veuillez consulter Permet CloudFormation de publier un résumé des modifications de la pile dans les pull requests.

Fichier de déploiement de pile

Un fichier de déploiement de pile est un fichier de notation d' JavaScript objet (JSON) ou un fichier au format YAML standard qui contient les paramètres et les valeurs qui gèrent votre CloudFormation pile. Il est surveillé pour détecter les modifications. Lorsque les modifications apportées au fichier sont validées dans le référentiel, la pile associée est automatiquement mise à jour.

Le fichier de déploiement de pile contient une paire clé-valeur et deux dictionnaires :

  • template-file-path

    Il s'agit du chemin complet du référentiel pour le fichier CloudFormation modèle. Le fichier modèle déclare les ressources pour la CloudFormation pile associée à ce fichier de déploiement.

  • parameters

    Le dictionnaire de paramètres contient des paires clé-valeur qui configurent les ressources de la pile. Un fichier de déploiement de pile peut comporter jusqu’à 50 paramètres.

  • tags

    Le dictionnaire des balises contient des paires clé-valeur facultatives que vous pouvez utiliser pour identifier et classer les ressources de la pile. Un fichier de déploiement de pile peut comporter jusqu’à 50 balises.

Vous pouvez fournir votre propre fichier de déploiement de pile, ou demander à la synchronisation Git d’en créer un pour vous et d’envoyer automatiquement une demande d’extraction à votre référentiel. Vous pouvez gérer les paramètres et les balises en modifiant le fichier de déploiement de pile et en validant les modifications dans le référentiel.

Voici un exemple de fichier de déploiement de pile avec synchronisation Git :

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'

CloudFormation fichier modèle

Un fichier modèle contient une déclaration des AWS ressources qui constituent une CloudFormation pile. Avec la synchronisation Git, le fichier modèle est stocké dans votre référentiel Git et référencé par le fichier de déploiement de la pile. Vous pouvez gérer la pile en modifiant le fichier modèle et en validant les modifications dans le référentiel.

Pour de plus amples informations, veuillez consulter Utilisation de CloudFormation modèles.

Référentiel de définition du modèle

Le référentiel de définition du modèle est le référentiel Git auquel est lié CloudFormation via Git sync. Le référentiel est surveillé pour détecter les modifications apportées au CloudFormation modèle et au fichier de déploiement de la pile. Lorsque vous validez les modifications apportées au fichier, la pile associée est automatiquement mise à jour.

Important

Lorsque vous configurez le référentiel de définition du modèle dans la console de synchronisation Git, sélectionnez le référentiel et la branche corrects à partir de la connexion Git. Git sync surveille uniquement le référentiel et la branche configurés pour détecter les modifications apportées au CloudFormation modèle et au fichier de déploiement de la pile.