Stack-Refactoring

Beurteilen Sie Ihre aktuelle Infrastruktur — Überprüfen Sie Ihre vorhandenen CloudFormation Stacks und Ressourcen, um Möglichkeiten für das Stack-Refactoring zu identifizieren.

Planen Sie Ihr Refactoring — Definieren Sie, wie Ressourcen organisiert werden sollen. Berücksichtigen Sie Ihre Abhängigkeiten, Benennungskonventionen und betrieblichen Beschränkungen. Diese können sich später auf die CloudFormation Validierung auswirken.

Ermitteln Sie die Ziel-Stacks — Entscheiden Sie, in welche Stacks Sie Ressourcen umstrukturieren möchten. Sie können Ressourcen zwischen mindestens 2 Stapel und maximal 5 Stapeln verschieben. Ressourcen können zwischen verschachtelten Stapeln verschoben werden.

Aktualisieren Sie Ihre Vorlagen — Passen Sie Ihre CloudFormation Vorlagen an die geplante Änderung an, z. B. das Verschieben von Ressourcendefinitionen zwischen Vorlagen. IDs Während dieses Vorgangs können Sie Logical umbenennen.

Den Stack-Refactor erstellen — Geben Sie eine Liste der Stack-Namen und Vorlagen an, die Sie umgestalten möchten.

Überprüfen Sie die Auswirkungen des Refactorings und lösen Sie etwaige Konflikte — CloudFormation validiert die von Ihnen bereitgestellten Vorlagen und prüft stapelübergreifende Abhängigkeiten, Ressourcentypen mit Problemen bei der Tag-Aktualisierung und Konflikte mit logischen IDs von Ressourcen.

Wenn die Validierung erfolgreich ist, CloudFormation wird eine Vorschau der Refactor-Aktionen generiert, die während der Ausführung ausgeführt werden.

Wenn die Validierung fehlschlägt, beheben Sie die identifizierten Probleme und versuchen Sie es erneut. Geben Sie bei Konflikten eine Zuordnung der logischen Ressourcen-ID an, aus der Quelle und Ziel der widersprüchlichen Ressourcen hervorgehen.

Refactor ausführen — Nachdem Sie sich vergewissert haben, dass die Änderungen Ihren Refactoring-Zielen entsprechen, schließen Sie den Stack-Refactor ab.

Überwachen — Verfolgen Sie den Ausführungsstatus, um sicherzustellen, dass der Vorgang erfolgreich abgeschlossen wird.

Verwenden Sie den Befehl get-template, um die CloudFormation Vorlagen für die Stacks abzurufen, die Sie umgestalten möchten.

aws cloudformation get-template --stack-name Stack1

Wenn Sie über die Vorlagen verfügen, verwenden Sie die integrierte Entwicklungsumgebung (IDE) Ihrer Wahl, um sie so zu aktualisieren, dass sie die gewünschte Struktur und Ressourcenorganisation verwenden.

Verwenden Sie den create-stack-refactorBefehl und geben Sie die Stack-Namen und die aktualisierten Vorlagen für die Stacks an, die umgestaltet werden sollen. Fügen Sie die --enable-stack-creation Option hinzu, mit der neue Stapel erstellt werden können CloudFormation , falls diese noch nicht existieren.

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

Der Befehl gibt a zurückStackRefactorId, das Sie in späteren Schritten verwenden werden.

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

Wenn bei der Vorlagenüberprüfung Konflikte festgestellt werden (was Sie im nächsten Schritt bestätigen können), verwenden Sie den create-stack-refactorBefehl mit der --resource-mappings Option.

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

Im Folgenden sehen Sie ein Beispiel für eine resource-mapping.json-Datei.

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

Verwenden Sie den describe-stack-refactorBefehl, um sicherzustellen, dass dies der Fall Status istCREATE_COMPLETE. Dadurch wird bestätigt, dass die Validierung abgeschlossen ist.

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

Beispielausgabe:

{
    "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"
}

Verwenden Sie den list-stack-refactor-actionsBefehl, um eine Vorschau der spezifischen Aktionen anzuzeigen, die ausgeführt werden.

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

Beispielausgabe:

{
    "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"
                }
            }
        }
    ]
}

Nachdem Sie Ihre Änderungen überprüft und bestätigt haben, verwenden Sie den execute-stack-refactorBefehl, um den Stack-Refactoring-Vorgang abzuschließen.

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

Verwenden Sie den describe-stack-refactorBefehl, um den Ausführungsstatus zu überwachen.

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

Beispielausgabe:

{
    "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"
}