失敗したステージまたは失敗したアクションのステージ再試行の設定

失敗したステージまたはステージ内の失敗したアクションを再試行するには

1. AWS Management Console にサインインして、CodePipeline コンソール https://console.aws.amazon.com/codesuite/codebuild/home を開きます。

   AWS アカウントに関連付けられているすべてのパイプラインの名前が表示されます。

2. [Name] で、パイプラインの名前を選択します。

3. 失敗したアクションのあるステージを見つけ、次のいずれかを選択します。

   • ステージ内のすべてのアクションを再試行するには、[ステージの再試行] を選択します。

   • ステージ内の失敗したアクションのみを再試行するには、[失敗したアクションの再試行] を選択します。

   

   再試行したアクションがすべて正常に完了した場合、パイプラインは続行されます。

失敗したステージまたはステージ内の失敗したアクションを再試行するには - CLI

AWS CLI を使用して、すべてのアクションまたは失敗したアクションを再試行するには、次のパラメータを指定して retry-stage-execution コマンドを実行します。

--pipeline-name <value>
--stage-name <value>
--pipeline-execution-id <value>
--retry-mode ALL_ACTIONS/FAILED_ACTIONS

1. ターミナル (Linux、macOS、UNIX) またはコマンドプロンプト (Windows) で、retry-stage-execution コマンドを実行します。次の例では、MyPipeline という名前のパイプラインに対して実行しています。

   aws codepipeline retry-stage-execution --pipeline-name MyPipeline --stage-name Deploy --pipeline-execution-id b59babff-5f34-EXAMPLE --retry-mode FAILED_ACTIONS

   出力は実行 ID を返します。

   {
       "pipelineExecutionId": "b59babff-5f34-EXAMPLE"
   }

2. JSON 入力ファイルを使用してコマンドを実行することもできます。まず、パイプライン、失敗したアクションを含むステージ、そのステージでの最新のパイプラインの実行を識別する JSON ファイルを作成します。その後、retry-stage-execution コマンドに --cli-input-json パラメータを指定して実行します。JSON ファイルに必要な詳細を取得するには、get-pipeline-state コマンドを使用するのが最も簡単です。

   1. ターミナル (Linux、macOS、UNIX) またはコマンドプロンプト (Windows) で、パイプラインの get-pipeline-state コマンドを実行します。例えば、「MyFirstPipeline」という名前のパイプラインに対しては、以下のようなコマンドを入力します。

      aws codepipeline get-pipeline-state --name MyFirstPipeline

      コマンドに対する応答には、各ステージのパイプラインの状態情報が含まれます。以下の例では、応答は [Staging] ステージで 1 つ以上のアクションが失敗したことを示しています。

      {
          "updated": 1427245911.525,
          "created": 1427245911.525,
          "pipelineVersion": 1,
          "pipelineName": "MyFirstPipeline",
          "stageStates": [
              {
                  "actionStates": [...],
                  "stageName": "Source",
                  "latestExecution": {
                      "pipelineExecutionId": "9811f7cb-7cf7-SUCCESS",
                      "status": "Succeeded"
                  }
              },
              {
                  "actionStates": [...],
                  "stageName": "Staging",
                  "latestExecution": {
                      "pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE",
                      "status": "Failed"
                  }
              }
          ]
      }

   2. プレーンテキストエディタで、JSON 形式で以下の情報を記録するファイルを作成します。

      • 失敗したアクションを含むパイプラインの名前

      • 失敗したアクションを含むステージの名前

      • ステージでの最新のパイプラインの実行 ID

      • 再試行モード

      先ほどの MyFirstPipeline の例では、ファイルは以下のようになります。

      {
          "pipelineName": "MyFirstPipeline",
          "stageName": "Staging",
          "pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE",
          "retryMode": "FAILED_ACTIONS"
      }

   3. retry-failed-actions.json のような名前でファイルを保存します。

   4. retry-stage-execution コマンドを実行したときに作成したファイルを呼び出します。例:

      重要

      ファイル名の前に必ず file:// を含めてください。このコマンドでは必須です。

      aws codepipeline retry-stage-execution --cli-input-json file://retry-failed-actions.json

   5. 再試行の結果を表示するには、CodePipeline コンソールを開いてから、失敗したアクションが含まれるパイプラインを選択するか、もう一度 get-pipeline-state コマンドを使用します。詳細については、「CodePipeline でパイプラインと詳細を表示する」を参照してください。

自動的に再試行するようにステージを設定する (コンソール）

1. AWS Management Console にサインインして、CodePipeline コンソール (https://console.aws.amazon.com/codesuite/codebuild/home を開きます。

   AWS アカウントに関連付けられているすべてのパイプラインの名前とステータスが表示されます。

2. [Name] で、編集するパイプラインの名前を選択します。

3. パイプライン詳細ページで、[編集] を選択します。

4. [編集] ページで、編集するアクションに関連する [ステージを編集する] を選択します。

5. [自動ステージ設定]、[ステージ障害時の自動再試行を有効にする] の順に選択します。パイプラインに変更を保存します。

6. [自動ステージ設定] で、次のいずれかの再試行モードを選択します。

   • ステージ内のすべてのアクションを再試行するように指定するには、[失敗したステージを再試行] を選択します。

   • ステージ内の失敗したアクションのみを再試行するように指定するには、[失敗したアクションを再試行] を選択します。

   パイプラインに変更を保存します。

   

7. パイプラインの実行後に、ステージの障害が発生した場合は、自動再試行が行われます。以下の例は、自動的に再試行されたビルドステージを示しています。

   

8. 再試行の詳細を表示するには、[詳細を表示] を選択します。ウィンドウが表示されます。

   

• ターミナル (Linux、macOS、Unix) またはコマンドプロンプト (Windows) を開きます。次に AWS CLI を使用し、パイプライン構造の失敗条件を指定して update-pipeline コマンドを実行します。次の例では、S3Deploy という名前のステージの自動再試行を設定します。

  {
                  "name": "S3Deploy",
                  "actions": [
                      {
                          "name": "s3deployaction",
                          "actionTypeId": {
                              "category": "Deploy",
                              "owner": "AWS",
                              "provider": "S3",
                              "version": "1"
                          },
                          "runOrder": 1,
                          "configuration": {
                              "BucketName": "static-website-bucket",
                              "Extract": "false",
                              "ObjectKey": "SampleApp.zip"
                          },
                          "outputArtifacts": [],
                          "inputArtifacts": [
                              {
                                  "name": "SourceArtifact"
                              }
                          ],
                          "region": "us-east-1"
                      }
                  ],
                   "onFailure": {
                      "result": "RETRY",
                      "retryConfiguration": {
                          "retryMode": "ALL_ACTIONS",
                      },
              } 

• 次のスニペットに示すように、テンプレートを更新します。次の例では、Release という名前のステージの自動再試行を設定します。

  AppPipeline: 
    Type: AWS::CodePipeline::Pipeline 
    Properties: 
      RoleArn:
        Ref: CodePipelineServiceRole 
      Stages: 
        - 
          Name: Source 
          Actions: 
            - 
              Name: SourceAction
              ActionTypeId: 
                Category: Source 
                Owner: AWS 
                Version: 1 
                Provider: S3 
              OutputArtifacts: 
                - 
                  Name: SourceOutput 
              Configuration: 
                S3Bucket: 
                  Ref: SourceS3Bucket 
                S3ObjectKey: 
                  Ref: SourceS3ObjectKey 
              RunOrder: 1  
        - 
          Name: Release 
          Actions: 
            - 
              Name: ReleaseAction
              InputArtifacts: 
                - 
                  Name: SourceOutput 
              ActionTypeId: 
                Category: Deploy 
                Owner: AWS 
                Version: 1
                Provider: CodeDeploy 
              Configuration: 
                ApplicationName: 
                  Ref: ApplicationName
                DeploymentGroupName: 
                  Ref: DeploymentGroupName 
              RunOrder: 1   
         OnFailure:
             Result: RETRY
             RetryConfiguration: 
                RetryMode: ALL_ACTIONS
      ArtifactStore: 
        Type: S3 
        Location:
          Ref: ArtifactStoreS3Location 
        EncryptionKey:
          Id: arn:aws:kms:useast-1:ACCOUNT-ID:key/KEY-ID
          Type: KMS
      DisableInboundStageTransitions: 
        - 
          StageName: Release 
          Reason: "Disabling the transition until integration tests are completed"
      Tags:
        - Key: Project
          Value: ProjectA
        - Key: IsContainerBased
          Value: 'true' 
      

  障害時にステージを再試行するように設定する方法の詳細については、「AWS CloudFormation ユーザーガイド」で「StageDeclaration」の「OnFailure」を参照してください。