AppSpec File 例 - AWS CodeDeploy

AppSpec File 例

このトピックでは、AWS Lambda および EC2/オンプレミス のデプロイ向けの AppSpec ファイルの例も提供します。

Amazon ECS のデプロイ向けの AppSpec File の例

Amazon ECS サービスをデプロイするために YAML で書かれた AppSpec file の例を示します。

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" Hooks: - BeforeInstall: "LambdaFunctionToValidateBeforeInstall" - AfterInstall: "LambdaFunctionToValidateAfterTraffic" - 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" } } } } } ], "Hooks": [ { "BeforeInstall": "LambdaFunctionToValidateBeforeInstall" }, { "AfterInstall": "LambdaFunctionToValidateAfterTraffic" }, { "AfterAllowTestTraffic": "LambdaFunctionToValidateAfterTestTrafficStarts" }, { "BeforeAllowTraffic": "LambdaFunctionToValidateBeforeAllowingProductionTraffic" }, { "AfterAllowTraffic": "LambdaFunctionToValidateAfterAllowingProductionTraffic" } ] }

デプロイ中のイベントのシーケンスを次に示します。

  1. 最新の Amazon ECS アプリケーションが置き換えタスクセットにインストールされる前に、LambdaFunctionToValidateBeforeInstall と呼ばれる Lambda 関数が実行されます。

  2. 最新の Amazon ECS アプリケーションが置き換えタスクセットにインストールされた後、かつ、トラフィックを受信する前に、LambdaFunctionToValidateAfterTraffic と呼ばれる Lambda 関数が実行されます。

  3. 置き換えタスクセット上の Amazon ECS アプリケーションが、テストリスナーからのトラフィックの受信を開始した後、LambdaFunctionToValidateAfterTestTrafficStarts と呼ばれる Lambda 関数が実行されます。この関数は、デプロイが続行されるかどうかを判断するために、検証テストを実行する可能性があります。デプロイグループでテストリスナーを指定しない場合、このフックは無視されます。

  4. AfterAllowTestTraffic フックの検証テストがすべて完了した後、かつ、最新の Amazon ECS アプリケーションに本稼働トラフィックが提供される前に、LambdaFunctionToValidateBeforeAllowingProductionTraffic と呼ばれる Lambda 関数が実行されます。

  5. 置き換えタスクセット上の最新の Amazon ECS アプリケーションに本稼働トラフィックが提供された後に、LambdaFunctionToValidateAfterAllowingProductionTraffic と呼ばれる Lambda 関数が実行されます。

フック中に実行される Lambda 関数は、検証テストを実行したり、トラフィックメトリクスを収集したりできます。

AWS Lambda のデプロイ向けの AppSpec File の例

Lambda 関数のバージョンをデプロイするために YAML で書かれた AppSpec file の例を示します。

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

デプロイ中のイベントのシーケンスを次に示します。

  1. myLambdaFunction という名前の Lambda 関数のバージョン 1 からのバージョン 2 にトラフィックを移行する前に、デプロイでトラフィックの移行を開始する準備が整っていることを確認する、LambdaFunctionToValidateBeforeTrafficShift という名前の Lambda 関数を実行します。

  2. LambdaFunctionToValidateBeforeTrafficShift が終了コード 0 (成功) を返した場合は、myLambdaFunction のバージョン 2 へのトラフィックの移行を開始します。このデプロイのデプロイ設定により、トラフィックが移行するレートが決まります。

  3. myLambdaFunction という名前の Lambda 関数のバージョン 1 からバージョン 2 へのトラフィックの移行が完了したら、デプロイが正常に完了したことを確認する、LambdaFunctionToValidateAfterTrafficShift という名前の Lambda 関数を実行します。

EC2/オンプレミス のデプロイ向けの AppSpec File の例

Amazon Linux、Ubuntu Server、または RHEL インスタンスへのインプレースデプロイのための AppSpec file の例を次に示します。

注記

Windows Server インスタンスへのデプロイは runas 要素をサポートしていません。Windows Server インスタンスにデプロイする場合は、AppSpec file にこの要素を含めないでください。

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 Server インスタンスの場合は、os: linuxos: windows に変更します。また、destination パスを完全に修飾する必要があります (例: c:\temp\webapps\Configc:\temp\webapps\myApp)。runas エレメントは含めないでください。

デプロイ中のイベントのシーケンスを次に示します。

  1. Scripts/UnzipResourceBundle.sh にあるスクリプトを実行します。

  2. 前のスクリプトが終了コード 0 (成功) を返した場合、Scripts/UnzipDataBundle.sh にあるスクリプトを実行します。

  3. ファイルを Config/config.txt のパスからパス /webapps/Config/config.txt にコピーします。

  4. source ディレクトリのすべてのファイルを再帰的に /webapps/myApp ディレクトリにコピーします。

  5. Scripts/RunResourceTests.sh にあるスクリプトを、180 秒 (3 分) のタイムアウトで実行します。

  6. Scripts/RunFunctionalTests.sh にあるスクリプトを、3600 秒 (1 時間) のタイムアウトで実行します。

  7. Scripts/MonitorService.sh にあるスクリプトを、ユーザー codedeploy として 3600 秒 (1 時間) のタイムアウトで実行します。