チュートリアル: CodePipeline を使用した Amazon ECS 標準デプロイ - AWS CodePipeline

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

チュートリアル: CodePipeline を使用した Amazon ECS 標準デプロイ

このチュートリアルでは、CodePipeline を使用した Amazon ECS を使用して、完全なエンドツーエンドの継続的なデプロイ (CD) パイプラインを作成します。

注記

このチュートリアルは、CodePipeline の Amazon ECS 標準デプロイアクションを対象としています。CodePipeline で青/緑のデプロイアクションをコード化するために Amazon ECS を使用するチュートリアルについては、チュートリアル: Amazon ECR ソースと、ECS と CodeDeploy 間のデプロイを含むパイプラインを作成する

Prerequisites

このチュートリアルで CD パイプラインを作成する前に、いつくかのリソースを用意する必要があります。使用を開始するために必要なものは以下のとおりです。

注記

これらのすべてのリソースを、同じ AWS リージョン内に作成する必要があります。

  • Dockerfile およびアプリケーションリソースを使用するソースコントロールリポジトリ (このチュートリアルでは CodeCommit を使用します)。詳細については、「」を参照してください。CodeCommit リポジトリを作成する()AWS CodeCommitユーザーガイド

  • Dockerfile およびアプリケーションソースから作成したイメージを含む Docker イメージリポジトリ (このチュートリアルでは Amazon ECR を使用します)。詳細については、「」を参照してください。リポジトリの作成およびイメージのプッシュ()Amazon Elastic Containery

  • イメージリポジトリでホストされた Docker イメージを参照する Amazon ECS タスク定義。詳細については、「」を参照してください。タスク定義の作成()Amazon Elastic Container Service

    このチュートリアルで使用するタスク定義の例を以下に示します。使用する値nameおよびfamilyビルド仕様ファイルの次のステップで使用します。

    { "ipcMode": null, "executionRoleArn": "role_ARN", "containerDefinitions": [ { "dnsSearchDomains": null, "environmentFiles": null, "logConfiguration": { "logDriver": "awslogs", "secretOptions": null, "options": { "awslogs-group": "/ecs/hello-world", "awslogs-region": "us-west-2", "awslogs-stream-prefix": "ecs" } }, "entryPoint": null, "portMappings": [ { "hostPort": 80, "protocol": "tcp", "containerPort": 80 } ], "command": null, "linuxParameters": null, "cpu": 0, "environment": [], "resourceRequirements": null, "ulimits": null, "dnsServers": null, "mountPoints": [], "workingDirectory": null, "secrets": null, "dockerSecurityOptions": null, "memory": null, "memoryReservation": 128, "volumesFrom": [], "stopTimeout": null, "image": "image_name", "startTimeout": null, "firelensConfiguration": null, "dependsOn": null, "disableNetworking": null, "interactive": null, "healthCheck": null, "essential": true, "links": null, "hostname": null, "extraHosts": null, "pseudoTerminal": null, "user": null, "readonlyRootFilesystem": null, "dockerLabels": null, "systemControls": null, "privileged": null, "name": "hello-world" } ], "placementConstraints": [], "memory": "2048", "taskRoleArn": null, "compatibilities": [ "EC2", "FARGATE" ], "taskDefinitionArn": "ARN", "family": "hello-world", "requiresAttributes": [], "pidMode": null, "requiresCompatibilities": [ "FARGATE" ], "networkMode": "awsvpc", "cpu": "1024", "revision": 1, "status": "ACTIVE", "inferenceAccelerators": null, "proxyConfiguration": null, "volumes": [] }
  • 前に説明したタスク定義を使用するサービスを実行する Amazon ECS クラスター。詳細については、「」を参照してください。クラスターの作成およびサービスの作成()Amazon Elastic Container Service

これらの前提条件を満たした後、チュートリアルに進んで CD パイプラインを作成できます。

ステップ 1: ビルド仕様ファイルをソースリポジトリに追加する

このチュートリアルでは、CodeBuild を使用して Docker イメージを構築し、イメージを Amazon ECR にプッシュします。の追加buildspec.ymlファイルをソースコードリポジトリに追加して CodeBuild に処理方法を指示することを確認します。ビルド仕様の以下の例では、次のように動作します。

  • プレビルドステージ:

    • Amazon ECR にログインします。

    • リポジトリ URI を ECR イメージに設定して、ソースの Git コミット ID の最初の 7 文字を使用するイメージタグを追加します。

  • ビルドステージ:

    • Docker イメージを作成し、イメージに latest と Git コミット ID の両方をタグ付けします。

  • ポストビルドステージ:

    • 両方のタグを持った ECR リポジトリにイメージをプッシュします。

    • という名前のファイルを作成します。imagedefinitions.jsonAmazon ECS サービスのコンテナ名およびイメージとタグがあるビルドのルートにあります。CD パイプラインのデプロイステージでこの情報を使用してサービスのタスク定義の新しいリビジョンを作成し、新しいタスク定義を使用してサービスを更新します。imagedefinitions.json ファイルは ECS ジョブワーカーに必須です。

このサンプルテキストを貼り付けてbuildspec.ymlファイルを作成し、イメージとタスク定義の値を置き換えます。

version: 0.2 phases: pre_build: commands: - echo Logging in to Amazon ECR... - aws --version - aws ecr get-login-password --region $AWS_DEFAULT_REGION | docker login --username AWS --password-stdin 012345678910.dkr.ecr.us-west-2.amazonaws.com - REPOSITORY_URI=012345678910.dkr.ecr.us-west-2.amazonaws.com/hello-world - COMMIT_HASH=$(echo $CODEBUILD_RESOLVED_SOURCE_VERSION | cut -c 1-7) - IMAGE_TAG=${COMMIT_HASH:=latest} build: commands: - echo Build started on `date` - echo Building the Docker image... - docker build -t $REPOSITORY_URI:latest . - docker tag $REPOSITORY_URI:latest $REPOSITORY_URI:$IMAGE_TAG post_build: commands: - echo Build completed on `date` - echo Pushing the Docker images... - docker push $REPOSITORY_URI:latest - docker push $REPOSITORY_URI:$IMAGE_TAG - echo Writing image definitions file... - printf '[{"name":"hello-world","imageUri":"%s"}]' $REPOSITORY_URI:$IMAGE_TAG > imagedefinitions.json artifacts: files: imagedefinitions.json

ビルド仕様は、で提供されたサンプルタスク定義用に作成されました。Prerequisitesで、Amazon ECS サービスがこのチュートリアルで使用します。REPOSITORY_URI 値は image リポジトリ (イメージタグなし) に対応し、ファイルの末尾近くの hello-world 値はサービスのタスク定義のコンテナ名に対応します。

ソースリポジトリに buildspec.yml ファイルを追加するには

  1. テキストエディタを開き、上記のビルド仕様をコピーして新しいファイルに貼り付けます。

  2. をに置き換えるREPOSITORY_URI値 (012345678910.dkr.ecr.us-west-2.amazonaws.com/hello-world) を、Docker イメージの自分の Amazon ECR リポジトリ URI (イメージタグなし) に置き換えます。hello-world を、Docker イメージを参照するサービスのタスク定義のコンテナ名に置き換えます。

  3. ソースリポジトリに buildspec.yml ファイルをコミットし、プッシュします。

    1. ファイルを追加します。

      git add .
    2. 変更をコミットします。

      git commit -m "Adding build specification."
    3. コミットをプッシュします。

      git push

ステップ 2: 継続的デプロイパイプラインを作成する

CodePipeline ウィザードを使用して、パイプラインステージを作成し、ソースリポジトリを ECS サービスに接続します。

パイプラインを作成するには

  1. CodePipeline コンソールを開きます。https://console.aws.amazon.com/codepipeline/

  2. [Welcome (ようこそ)] ページで、[Create pipeline (パイプラインの作成)] を選択します。

    CodePipeline を初めて使用する場合は、ようこそ。[Get Started Now] を選択します。

  3. リポジトリの []ステップ 1: 名前ページで、パイプライン名[] にパイプラインの名前を入力し、[]。このチュートリアルでは、パイプライン名は hello-world です。

  4. リポジトリの []ステップ 2: ソースステージの追加ページで、ソースプロバイダー] で、AWS CodeCommit

    1. を使用する場合リポジトリ名[] で、パイプラインのソース場所として使用する CodeCommit リポジトリの名前を選択します。

    2. [ブランチ名] で使用するブランチを選択し、[Next (次へ)] を選択します。

  5. リポジトリの []ステップ 3: ビルドステージの追加ページで、ビルドプロバイダー選択するAWS CodeBuild[] を選択してから、[プロジェクトを作成する

    1. [Project name] では、ビルドプロジェクトに一意の名前を選択します。このチュートリアルでは、プロジェクト名は hello-world です。

    2. [環境イメージ] で、[Managed image (マネージド型イメージ)] を選択します。

    3. [オペレーティングシステム] で、[Amazon Linux 2] を選択します。

    4. [ランタイム] で、[Standard (標準)] を選択します。

    5. を使用する場合イメージ] で、aws/codebuild/amazonlinux2-x86_64-standard: 3.0

    6. [イメージバージョン] と [環境タイプ] には、既定値を使用します。

    7. [Enable this flag if you want to build Docker images or want your builds to get elevated privileges (Docker イメージを構築する場合、またはビルドで昇格された権限を取得する場合は、このフラグを有効にする)] を選択します。

    8. [CloudWatch logs] の選択を解除します。拡張する必要がある場合があります。アドバンスト

    9. [Continue to CodePipeline (CodePipeline に進む)] を選択します。

    10. [Next] を選択します。

      注記

      ウィザードは、ビルドプロジェクトの CodeBuild サービスロールを作成します。codebuildビルドプロジェクト名-サービス・ロール。このロール名を書き留めます。これには、後で Amazon ECR アクセス権限を追加します。

  6. リポジトリの []ステップ 4: デプロイステージの追加ページで、デプロイメント・プロバイダ] で、Amazon ECS

    1. を使用する場合クラスター名で、サービスが実行されている Amazon ECS クラスターを選択します。このチュートリアルでは、クラスターは default です。

    2. [サービス名] で更新するサービスを選択し、[Next (次へ)] を選択します。このチュートリアルでは、サービス名は hello-world です。

  7. リポジトリの []ステップ 5: 確認ページで、パイプライン設定を確認し、パイプラインの作成パイプラインを作成するには.

    注記

    これでパイプラインが作成され、さまざまなパイプラインステージを通して実行を試みます。ただし、ウィザードによって作成されたデフォルトの CodeBuild ロールには、buildspec.ymlファイルに格納されるため、ビルドステージは失敗します。次のセクションで、ビルドステージのアクセス権限を追加します。

ステップ 3: CodeBuild ロールへの Amazon ECR アクセス許可の追加

CodePipeline ウィザードは、CodeBuild ビルドプロジェクトの IAM ロールを作成しました。codebuildビルドプロジェクト名-サービス・ロール。このチュートリアルでは、名前はです。codebuild-hello-world-サービスロール。なぜなら、buildspec.ymlファイルが Amazon ECR API オペレーションの呼び出しを実行する場合、これらの Amazon ECR コールを行うアクセス権限を許可するポリシーがロールに必要です。以下の手順では、適切なアクセス権限をロールにアタッチします。

Amazon ECR アクセス許可を CodeBuild ロールに追加するには

  1. IAM コンソール (https://console.aws.amazon.com/iam/) を開きます。

  2. 左のナビゲーションペインで、[Roles (ロール)] を選択します。

  3. 検索ボックスに [] と入力します。codebuild[CodePipeline] ウィザードによって作成されたロールを選択します。このチュートリアルでは、ロール名は codebuild-hello-world-service-role です。

  4. [Summary (概要)] ページで、[Attach policy (ポリシーのアタッチ)] を選択します。

  5. [AmazonEC2ContainerRegistryPowerUser] ポリシーの左にあるボックスをオンにし、[Attach policy] を選択します。

ステップ 4: パイプラインのテスト

パイプラインには、エンドツーエンドの AWS ネイティブな継続的デプロイを実行するために必要なすべてが含まれているはずです。次は、コードの変更をソースリポジトリにプッシュすることで機能をテストします。

パイプラインをテストするには

  1. 設定済みソースリポジトリにコード変更を行い、変更をコミットしてプッシュします。

  2. CodePipeline コンソールを開きます。https://console.aws.amazon.com/codepipeline/

  3. リストからパイプラインを選択します。

  4. ステージを通してパイプラインの進行状況を監視します。パイプラインが終了し、Amazon ECS サービスがコード変更から作成された Docker イメージを実行することを確認します。