AppSpec ファイルの例 - AWS CodeDeploy

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AppSpec ファイルの例

このトピックでは、 AWS Lambda と EC2/オンプレミスデプロイのサンプル AppSpec ファイルについて説明します。

AppSpec Amazon ECSデプロイのファイル例

Amazon ECSサービスをデプロイYAMLするために に書き込まれた 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" } ] }

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

  1. 更新された Amazon ECSアプリケーションが代替タスクセットにインストールされる前に、 という Lambda 関数LambdaFunctionToValidateBeforeInstallが実行されます。

  2. 更新された Amazon ECSアプリケーションが代替タスクセットにインストールされた後、トラフィックを受信する前に、 という Lambda 関数LambdaFunctionToValidateAfterInstallが実行されます。

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

  4. AfterAllowTestTraffic フックでの検証テストが完了し、本番トラフィックが更新された Amazon ECSアプリケーションに配信される前に、 という Lambda 関数LambdaFunctionToValidateBeforeAllowingProductionTrafficが実行されます。

  5. 本番トラフィックが代替タスクセットで更新された Amazon ECSアプリケーションに配信されると、 という Lambda 関数LambdaFunctionToValidateAfterAllowingProductionTrafficが実行されます。

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

AppSpec AWS Lambda デプロイのファイル例

Lambda 関数バージョンをデプロイYAMLするために に書き込まれた AppSpec ファイルの例を次に示します。

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 関数を実行します。

AppSpec EC2/オンプレミスデプロイのファイル例

以下は、Amazon Linux、Ubuntu Server、またはRHELインスタンスへのインプレースデプロイ用の AppSpec ファイルの例です。

注記

Windows Server インスタンスへのデプロイでは、runas 要素をサポートしていません。Windows Server インスタンスにデプロイする場合は、 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 Server のインスタンスで、[os: linux] を [os: 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 時間) のタイムアウトで実行します。