本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
AppSpec 檔案範例
本主題提供 L AWS ambda 和 EC2 /內部部署的範例檔 AppSpec 案。
AppSpec Amazon ECS 部署的檔案範例
以下是使用 YAML 撰寫用來部署 Amazon ECS 服務的 AppSpec 檔案範例。
version: 0.0 Resources: - TargetService: Type: AWS::ECS::Service Properties: TaskDefinition: "arn:aws:ecs:us-east-1:111222333444:task-definition/my-task-definition-family-name:1" LoadBalancerInfo: ContainerName: "SampleApplicationName" ContainerPort: 80 # Optional properties PlatformVersion: "LATEST" NetworkConfiguration: AwsvpcConfiguration: Subnets: ["subnet-1234abcd","subnet-5678abcd"] SecurityGroups: ["sg-12345678"] AssignPublicIp: "ENABLED" CapacityProviderStrategy: - Base: 1 CapacityProvider: "FARGATE_SPOT" Weight: 2 - Base: 0 CapacityProvider: "FARGATE" Weight: 1 Hooks: - BeforeInstall: "LambdaFunctionToValidateBeforeInstall" - AfterInstall: "LambdaFunctionToValidateAfterInstall" - AfterAllowTestTraffic: "LambdaFunctionToValidateAfterTestTrafficStarts" - BeforeAllowTraffic: "LambdaFunctionToValidateBeforeAllowingProductionTraffic" - AfterAllowTraffic: "LambdaFunctionToValidateAfterAllowingProductionTraffic"
這裡提供前述以 JSON 撰寫的範例版本。
{ "version": 0.0, "Resources": [ { "TargetService": { "Type": "AWS::ECS::Service", "Properties": { "TaskDefinition": "arn:aws:ecs:us-east-1:111222333444:task-definition/my-task-definition-family-name:1", "LoadBalancerInfo": { "ContainerName": "SampleApplicationName", "ContainerPort": 80 }, "PlatformVersion": "LATEST", "NetworkConfiguration": { "AwsvpcConfiguration": { "Subnets": [ "subnet-1234abcd", "subnet-5678abcd" ], "SecurityGroups": [ "sg-12345678" ], "AssignPublicIp": "ENABLED" } }, "CapacityProviderStrategy": [ { "Base" : 1, "CapacityProvider" : "FARGATE_SPOT", "Weight" : 2 }, { "Base" : 0, "CapacityProvider" : "FARGATE", "Weight" : 1 } ] } } } ], "Hooks": [ { "BeforeInstall": "LambdaFunctionToValidateBeforeInstall" }, { "AfterInstall": "LambdaFunctionToValidateAfterInstall" }, { "AfterAllowTestTraffic": "LambdaFunctionToValidateAfterTestTrafficStarts" }, { "BeforeAllowTraffic": "LambdaFunctionToValidateBeforeAllowingProductionTraffic" }, { "AfterAllowTraffic": "LambdaFunctionToValidateAfterAllowingProductionTraffic" } ] }
這是部署期間的一系列事件。
-
在替換任務集上安裝更新的 Amazon ECS 應用程式之前,名為的 Lambda 函數
LambdaFunctionToValidateBeforeInstall
會執行。 -
在替換任務集上安裝更新的 Amazon ECS 應用程式之後,但在接收任何流量之前,稱為的 Lambda 函數會
LambdaFunctionToValidateAfterInstall
執行。 -
取代任務集上的 Amazon ECS 應用程式開始接收來自測試接聽程式的流量之後,稱為 Lambda 函數即會
LambdaFunctionToValidateAfterTestTrafficStarts
執行。此函數可能執行驗證測試,判斷是否繼續部署。如果您未指定測試部署群組中的測試接聽程式,便會忽略此勾點。 -
AfterAllowTestTraffic
勾點中的任何驗證測試完成後,在將生產流量提供給更新的 Amazon ECS 應用程式之前,稱為的 Lambda 函數會LambdaFunctionToValidateBeforeAllowingProductionTraffic
執行。 -
在替換任務集上將生產流量提供給更新的 Amazon ECS 應用程式之後,稱為的 Lambda 函數便
LambdaFunctionToValidateAfterAllowingProductionTraffic
會執行。
在任何掛接期間執行的 Lambda 函數都可以執行驗證測試或收集流量指標。
AppSpec AWS Lambda 部署的檔案範例
以下是使用 YAML 撰寫的 AppSpec 檔案範例,用來部署 Lambda 函數版本。
version: 0.0 Resources: - myLambdaFunction: Type: AWS::Lambda::Function Properties: Name: "myLambdaFunction" Alias: "myLambdaFunctionAlias" CurrentVersion: "1" TargetVersion: "2" Hooks: - BeforeAllowTraffic: "LambdaFunctionToValidateBeforeTrafficShift" - AfterAllowTraffic: "LambdaFunctionToValidateAfterTrafficShift"
這裡提供前述以 JSON 撰寫的範例版本。
{ "version": 0.0, "Resources": [{ "myLambdaFunction": { "Type": "AWS::Lambda::Function", "Properties": { "Name": "myLambdaFunction", "Alias": "myLambdaFunctionAlias", "CurrentVersion": "1", "TargetVersion": "2" } } }], "Hooks": [{ "BeforeAllowTraffic": "LambdaFunctionToValidateBeforeTrafficShift" }, { "AfterAllowTraffic": "LambdaFunctionToValidateAfterTrafficShift" } ] }
這是部署期間的一系列事件。
-
在將流量從呼叫的 Lambda 函數的第 1 版轉移
myLambdaFunction
到第 2 版之前,請執行名為的 Lambda 函數LambdaFunctionToValidateBeforeTrafficShift
,以驗證部署是否準備好開始流量轉移。 -
如果
LambdaFunctionToValidateBeforeTrafficShift
傳回結束代碼 0 (成功),請開始轉移流量到第 2 版的myLambdaFunction
。此部署的部署組態決定了流量轉移速率。 -
將流量從呼叫的 Lambda 函數第 1 版轉移
myLambdaFunction
到第 2 版之後,請執行名為的 Lambda 函數,LambdaFunctionToValidateAfterTrafficShift
以驗證部署是否已順利完成。
AppSpec EC2/內部部署的檔案範例
以下是用於就地部署到 Amazon Linux、Ubuntu 伺服器或 RHEL 執行個體的 AppSpec 檔案範例。
注意
對 Windows 伺服器執行個體的部署不支援該runas
元素。如果您要部署到 Windows 伺服器執行個體,請勿將其包含在您的 AppSpec 檔案中。
version: 0.0 os: linux files: - source: Config/config.txt destination: /webapps/Config - source: source destination: /webapps/myApp hooks: BeforeInstall: - location: Scripts/UnzipResourceBundle.sh - location: Scripts/UnzipDataBundle.sh AfterInstall: - location: Scripts/RunResourceTests.sh timeout: 180 ApplicationStart: - location: Scripts/RunFunctionalTests.sh timeout: 3600 ValidateService: - location: Scripts/MonitorService.sh timeout: 3600 runas: codedeployuser
如果是 Windows 伺服器執行個體,請變更os: linux
為os: windows
。而且,您必須有完整的 destination
路徑 (例如,c:\temp\webapps\Config
和 c:\temp\webapps\myApp
)。請勿包含 runas
元素。
這是部署期間的一系列事件。
-
執行位於
Scripts/UnzipResourceBundle.sh
的指令碼。 -
如果之前的指令碼傳回 0 結束代碼 (成功),請執行位於
Scripts/UnzipDataBundle.sh
的指令碼。 -
從
Config/config.txt
的路徑複製檔案到/webapps/Config/config.txt
路徑。 -
以遞迴方式複製
source
目錄中的所有檔案到/webapps/myApp
目錄。 -
以 180 秒 (3分鐘) 的逾時時間於
Scripts/RunResourceTests.sh
執行指令碼。 -
以 3600 秒 (1 小時) 的逾時時間於
Scripts/RunFunctionalTests.sh
執行指令碼。 -
以使用者
codedeploy
身分於 3600 秒 (1小時) 的逾時時間執行位於Scripts/MonitorService.sh
的指令碼。