AppSpec ファイルの例 - AWS CodeDeploy

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

AppSpec ファイルの例

このトピックでは、AppSpec ファイルの例を説明します。AWSLambda および EC2/オンプレミスデプロイです。

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

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 アプリケーションが置き換えタスクセットにインストールされた後、かつトラフィックを受信する前に、LambdaFunctionToValidateAfterInstallを実行します。

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

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

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

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

のAppSpec ファイルの例AWSLambda デプロイメント

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. と呼ばれるLambda 関数のバージョン1からトラフィックをシフトする前にmyLambdaFunctionをバージョン 2 Lambda するには、LambdaFunctionToValidateBeforeTrafficShiftで、デプロイメントがトラフィックのシフトを開始する準備ができていることを検証します。

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

  3. と呼ばれるLambda 関数のバージョン1からのトラフィックのシフトの後myLambdaFunctionがバージョン 2 にLambda したら、LambdaFunctionToValidateAfterTrafficShiftデプロイが正常に完了したことを確認する。

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

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: 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 時間) のタイムアウトで実行します。