Refactorisation de piles

1. Évaluez votre infrastructure actuelle : passez en revue vos CloudFormation stacks et ressources existants afin d'identifier les opportunités de refactoring des stack.

2. Planifiez votre refactorisation : définissez comment les ressources doivent être organisées. Tenez compte de vos dépendances, de vos conventions de dénomination et de vos limites opérationnelles. Cela peut affecter la CloudFormation validation ultérieure.

3. Déterminez les piles de destination : décidez dans quelles piles vous allez refactoriser les ressources. Vous pouvez déplacer des ressources entre au moins 2 piles (à l'aide de la console) et un maximum de 5 piles (à l' AWS CLI aide de). Les ressources peuvent être déplacées entre des piles imbriquées.

4. Mettez à jour vos modèles : modifiez vos CloudFormation modèles pour refléter le changement prévu, par exemple en déplaçant les définitions de ressources entre les modèles. Vous pouvez renommer la logique IDs au cours de ce processus.

5. Créez le refactorisateur de pile : fournissez une liste des noms de pile et des modèles que vous souhaitez refactoriser.

6. Vérifiez l'impact de la refactorisation et résolvez les éventuels conflits : CloudFormation valide les modèles que vous fournissez et vérifie les dépendances entre les piles, les types de ressources présentant des problèmes de mise à jour des balises et les conflits d'ID logique des ressources.

   Si la validation réussit, CloudFormation un aperçu des actions de refactorisation qui se produiront pendant l'exécution sera généré.

   Si la validation échoue, résolvez les problèmes identifiés et réessayez. En cas de conflit, fournissez un mappage d’ID logique de ressource indiquant la source et la destination des ressources en conflit.

7. Exécutez la refactorisation : après avoir vérifié que les modifications correspondent à vos objectifs de refactorisation, terminez la refactorisation de la pile.

8. Surveiller — Suivez l’état d’exécution pour vous assurer que l’opération se termine correctement.

Pour refactoriser des piles

1. Connectez-vous à la CloudFormation console AWS Management Console et ouvrez-la à l'adresse https://console.aws.amazon.com/cloudformation.

2. Dans la barre de navigation en haut de l'écran, choisissez l' Région AWS emplacement de vos piles.

3. Dans le volet de navigation de gauche, choisissez Stack refactors.

4. Sur la page Stack refactor, choisissez Start stack refactor.

5. Dans Description, fournissez une description pour vous aider à identifier votre refactorisateur de pile. Ensuite, choisissez Suivant.

6. Pour la pile 1, procédez comme suit :

   1. Choisissez Mettre à jour le modèle pour une pile existante ou Créer une nouvelle pile.

      Si vous avez choisi Mettre à jour le modèle pour une pile existante, sélectionnez une pile existante dans la liste. Ou choisissez Enter a stack ARN pour saisir l'ARN d'une pile existante.

      Si vous avez choisi Créer une nouvelle pile, saisissez le nom de la nouvelle pile dans Nom de la pile.

   2. Sous Remplacer le modèle existant par un modèle refactorisé, choisissez l'URL Amazon S3 ou Téléversez un fichier modèle pour télécharger le modèle souhaité pour la pile 1.

   3. Choisissez Suivant.

7. Pour la pile 2, procédez comme suit :

   1. Choisissez Mettre à jour le modèle pour une pile existante ou Créer une nouvelle pile.

      Si vous avez choisi Mettre à jour le modèle pour une pile existante, sélectionnez une pile existante dans la liste. Ou choisissez Enter a stack ARN pour saisir l'ARN d'une pile existante.

      Si vous avez choisi Créer une nouvelle pile, saisissez le nom de la nouvelle pile dans Nom de la pile.

   2. Sous Remplacer le modèle existant par un modèle refactorisé, choisissez l'URL Amazon S3 ou Charger le fichier modèle pour télécharger le modèle souhaité pour la pile 2.

   3. Choisissez Suivant.

8. Sur la page Spécifier les identifiants de ressources logiques renommés, assurez-vous de savoir CloudFormation comment refactoriser les piles en mappant toutes les ressources affichées à leur logique correcte. IDs Dans le cadre du refactor de pile, si la logique d'une ressource a IDs été modifiée, vous devez spécifier comment elle a été renommée en fournissant le nom de la pile source, l'ID logique d'origine, le nom de la pile de destination et l'ID logique renommé. Dans certains cas, la CloudFormation console peut détecter automatiquement le mappage des ressources, et vous pouvez simplement vérifier que le mappage des ressources prérempli est correct avant de continuer.

9. Choisissez Suivant.

10. Sur la page Révision et exécution, passez en revue toutes les sélections effectuées lors des étapes précédentes et vérifiez que tout est correctement configuré.

11. Lorsque vous êtes prêt à refactoriser les piles, choisissez Execute stack refactor.

Pour refactoriser des piles

1. Utilisez la create-stack-refactorcommande et fournissez les noms des piles et les modèles mis à jour pour les piles à refactoriser. Incluez l'--enable-stack-creationoption permettant CloudFormation de créer de nouvelles piles si elles n'existent pas déjà.

   aws cloudformation create-stack-refactor \
     --stack-definitions \
       StackName=Stack1,TemplateBody@=file://template1-updated.yaml \
       StackName=Stack2,TemplateBody@=file://template2-updated.yaml \
     --enable-stack-creation

   La commande renvoie un StackRefactorId que vous utiliserez ultérieurement.

   {
       "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841"
   }

   Si des conflits sont détectés lors de la validation du modèle (ce que vous pourrez confirmer à l'étape suivante), utilisez la create-stack-refactorcommande avec l'--resource-mappingsoption.

   aws cloudformation create-stack-refactor \
     --stack-definitions \
       StackName=Stack1,TemplateBody@=file://template1-updated.yaml \
       StackName=Stack2,TemplateBody@=file://template2-updated.yaml \
     --enable-stack-creation \ 
     --resource-mappings file://resource-mapping.json

   Voici un exemple de fichier resource-mapping.json.

   [
       {
           "Source": {
               "StackName": "Stack1",
               "LogicalResourceId": "MySNSTopic"
           },
           "Destination": {
               "StackName": "Stack2",
               "LogicalResourceId": "MyLambdaSNSTopic"
           }
       }
   ]

2. Utilisez la describe-stack-refactorcommande pour vous assurer que Status c'est le casCREATE_COMPLETE. Cela permet de vérifier que la validation est terminée.

   aws cloudformation describe-stack-refactor \
     --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841

   Exemple de sortie :

   {
       "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841",
       "StackIds": [
           "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
           "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b"
       ],
       "ExecutionStatus": "AVAILABLE",
       "Status": "CREATE_COMPLETE"
   }

3. Utilisez la list-stack-refactor-actionscommande pour prévisualiser les actions spécifiques qui seront effectuées.

   aws cloudformation list-stack-refactor-actions \
     --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841

   Exemple de sortie :

   {
       "StackRefactorActions": [
           {
               "Action": "MOVE",
               "Entity": "RESOURCE",
               "PhysicalResourceId": "MyTestLambdaRole",
               "Description": "No configuration changes detected.",
               "Detection": "AUTO",
               "TagResources": [],
               "UntagResources": [],
               "ResourceMapping": {
                   "Source": {
                       "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
                       "LogicalResourceId": "MyLambdaRole"
                   },
                   "Destination": {
                       "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b",
                       "LogicalResourceId": "MyLambdaRole"
                   }
               }
           },
           {
               "Action": "MOVE",
               "Entity": "RESOURCE",
               "PhysicalResourceId": "MyTestFunction",
               "Description": "Resource configuration changes will be validated during refactor execution.",
               "Detection": "AUTO",
               "TagResources": [
                   {
                       "Key": "aws:cloudformation:stack-name",
                       "Value": "Stack2"
                   },
                   {
                       "Key": "aws:cloudformation:logical-id",
                       "Value": "MyFunction"
                   },
                   {
                       "Key": "aws:cloudformation:stack-id",
                       "Value": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b"
                   }
               ],
               "UntagResources": [
                   "aws:cloudformation:stack-name",
                   "aws:cloudformation:logical-id",
                   "aws:cloudformation:stack-id"
               ],
               "ResourceMapping": {
                   "Source": {
                       "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
                       "LogicalResourceId": "MyFunction"
                   },
                   "Destination": {
                       "StackName": "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b",
                       "LogicalResourceId": "MyFunction"
                   }
               }
           }
       ]
   }

4. Après avoir examiné et confirmé vos modifications, utilisez la execute-stack-refactorcommande pour terminer l'opération de refactorisation de la pile.

   aws cloudformation execute-stack-refactor \
     --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841

5. Utilisez la describe-stack-refactorcommande pour surveiller l'état d'exécution.

   aws cloudformation describe-stack-refactor \
     --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841

   Exemple de sortie :

   {
       "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841",
       "StackIds": [
           "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack1/3e6a1ff0-94b1-11f0-aa6f-0a88d2e03acf",
           "arn:aws:cloudformation:us-east-1:123456789012:stack/Stack2/5da91650-94b1-11f0-81cf-0a23500e151b"
       ],
       "ExecutionStatus": "SUCCEEDED",
       "Status": "COMPLETE"
   }