View a markdown version of this page

コンテナイメージのカスタマイズ - AWS での分散負荷テストソリューション

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

コンテナイメージのカスタマイズ

テスターイメージのロード

このソリューションでは、AWS が管理するパブリック Amazon Elastic Container Registry (Amazon ECR) イメージリポジトリを使用して、設定したテストの実行に使用するイメージを保存します。コンテナイメージを再構築して、独自の AWS アカウントの ECR イメージリポジトリにプッシュできます。

ニーズに合わせてデフォルトのコンテナイメージを編集できます。カスタマイズされたイメージを構築する前に、これらの環境変数を設定します。

#!/bin/bash export REGION=aws-region-code # the AWS region to launch the solution (e.g. us-east-1) export BUCKET_PREFIX=my-bucket-name # prefix of the bucket name without the region code export BUCKET_NAME=$BUCKET_PREFIX-$REGION # full bucket name where the code will reside export SOLUTION_NAME=my-solution-name export VERSION=my-version # version number for the customized code export PUBLIC_ECR_REGISTRY=public.ecr.aws/awssolutions/distributed-load-testing-on-aws-load-tester # replace with the container registry and image if you want to use a different container image export PUBLIC_ECR_TAG=v3.1.0 # replace with the container image tag if you want to use a different container image

カスタマイズされたコンテナイメージは、AWS アカウントのプライベートイメージリポジトリまたはパブリックイメージリポジトリでホストできます。イメージリソースは、コードベースの deployment/ecr/distributed-load-testing-on-aws-load-tester ディレクトリにあります。

その後、イメージを構築してホストの送信先にプッシュできます。

カスタムイメージを作成したら、カスタマイズしたソリューションを構築する前に、次の環境変数を宣言します。

#!/bin/bash export PUBLIC_ECR_REGISTRY=YOUR_ECR_REGISTRY_URI # e.g. YOUR_ACCOUNT_ID.dkr.ecr.us-east-1.amazonaws.com/YOUR_IMAGE_NAME export PUBLIC_ECR_TAG=YOUR_ECR_TAG # e.g. latest, v3.4.0

Dockerfile はロードテストイメージを定義します。Amazon Linux ベースイメージ上に構築され、ロードテストの実行に必要な言語ランタイム、システムパッケージ、テストツールをインストールし、フレームワークバージョンのメタデータファイルとload-test.shエントリポイントスクリプトを追加し、非ルートユーザーとして実行されます。Dockerfile を表示するには、GitHub リポジトリの Dockerfile を参照してください。

load-test.sh エントリポイントスクリプトは、タスクが開始するたびにコンテナ内で実行されます。テスト設定とコンテナメタデータを読み取ります。次に、Amazon S3 からテスト定義をダウンロードし、実行用に選択したテストフレームワークをプロビジョニングします。スクリプトは開始シグナルを待機し、テスト内のすべてのタスクが同時に開始されるようにします。次に、メトリクスとログを生成しながら、設定された期間テストを実行します。テストが完了すると、スクリプトは結果を収集し、その結果を生成したコンテナの詳細で強化します。結果、ログ、その他のアーティファクトを Amazon S3 にアップロードします。このスクリプトは終了シグナルも処理するため、完了する前にテストをキャンセルすると、部分的な結果とログが保持されます。スクリプト全体を表示するには、GitHub リポジトリの load-test.sh を参照してください。

ウェブコンソールイメージ (ALB + ECS Fargate テンプレートのみ)

ALB + ECS Fargate テンプレートは、ECS Fargate のコンテナとしてウェブコンソールを実行します。デフォルトでは、ソリューションは AWS が管理するパブリック Amazon ECR リポジトリからウェブコンソールイメージをプルします。

パブリックコンテナレジストリへのアクセスが制限されている環境 (インターネットアクセスのない VPC や ECR パブリックアクセスポリシーが設定されているアカウントなど) では、パブリックイメージをプライベート Amazon ECR リポジトリにミラーリングし、ウェブコンソールイメージ URI CloudFormation パラメータでプライベートイメージ URI を指定する必要があります。次の手順を使用して、ウェブコンソールイメージをカスタマイズすることもできます。

パブリックイメージをプライベート ECR リポジトリにミラーリングする

ウェブコンソールイメージをプライベート ECR リポジトリにミラーリングするには。

  1. パブリック ECR レジストリへの認証を行います。

    $ aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
  2. パブリックウェブコンソールイメージをプルします。

    $ docker pull public.ecr.aws/aws-solutions/distributed-load-testing-on-aws-web-console:<version>
  3. アカウントにプライベート ECR リポジトリを作成します (まだ存在しない場合)。

    $ aws ecr create-repository --repository-name <your-repo-name> --region <region> 2>/dev/null || true
  4. プライベート ECR レジストリに対して認証します。

    $ aws ecr get-login-password --region <region> | docker login --username AWS --password-stdin <account-id>.dkr.ecr.<region>.amazonaws.com
  5. イメージをタグ付けして、プライベートリポジトリにプッシュします。

    $ docker tag public.ecr.aws/aws-solutions/distributed-load-testing-on-aws-web-console:<version> \ <account-id>.dkr.ecr.<region>.amazonaws.com/<your-repo-name>:<version> $ docker push <account-id>.dkr.ecr.<region>.amazonaws.com/<your-repo-name>:<version>
  6. ALB + ECS Fargate スタックを起動するときは、[ウェブコンソールイメージ URI] パラメータにプライベートイメージ URI を入力します。

    <account-id>.dkr.ecr.<region>.amazonaws.com/<your-repo-name>:<version>

ウェブコンソールイメージをカスタマイズする

ウェブコンソールイメージをカスタマイズすることもできます。イメージリソースは、GitHub リポジトリの deployment/ecr/distributed-load-testing-on-aws-web-console ディレクトリにあります。コンテナファイルを編集し、ローカルイメージを構築し、プライベート ECR リポジトリにプッシュして、ウェブコンソールイメージ URI パラメータで結果のイメージ URI を指定できます。

ウェブコンソールコンテナイメージは Nginx ベースイメージ上に構築され、AWS CLI をインストールします。Dockerfile は、Nginx 設定とエントリポイントスクリプトにコピーします。Dockerfile は HTTP ポートを公開し、コンテナの起動時に実行するエントリポイントスクリプトを設定します。コンテナが起動すると、entrypoint.sh は AWS CLI を使用して Amazon S3 からウェブコンソールアセットをダウンロードします。それらを Nginx ドキュメントルートに抽出し、フォアグラウンドで Nginx を開始します。nginx.conf は単一ページアプリケーション (SPA) を提供し、一致しないパスをアプリケーションのエントリポイントにルーティングします。また、Application Load Balancer のヘルスチェックエンドポイントを追加し、gzip 圧縮を有効にし、静的アセットの存続期間の長いキャッシュを設定して (エントリポイントとランタイム設定のキャッシュを無効にして)、一般的なセキュリティレスポンスヘッダーを追加します。

詳細については、「Amazon ECR ユーザーガイド」の「Amazon ECR プライベートリポジトリへの Docker イメージのプッシュ」を参照してください。

ロードテスターイメージ URI

3 つのデプロイテンプレート (Amazon CloudFront + S3、Application Load Balancer (ALB) + ECS on AWS Fargate、ヘッドレス) はすべて、デプロイ時に Amazon Elastic Container Registry (Amazon ECR) パブリックレジストリ (public.ecr.aws) からロードテスターコンテナイメージをプルします。

パブリックコンテナレジストリへのアクセスが制限されている環境では、ロードテスターイメージをプライベート Amazon ECR リポジトリにミラーリングし、ロードテスターイメージ URI (LoadTesterImageUri) AWS CloudFormation パラメータにプライベートイメージ URI を指定します。一般的な例としては、インターネットアクセスのない VPC、ECR パブリックアクセスポリシーを持つアカウント、ECS タスクがパブリック ECR レジストリにアクセスできない AWS GovCloud (米国) リージョンなどがあります。AWS GovCloud (米国) デプロイでは、デプロイリージョンのプライベートリポジトリへのミラーリングが必須であり、それ以外の場所ではオプションです。

ロードテスターイメージをプライベート ECR リポジトリにミラーリングする

注記

LoadTesterImageUri を指定すると、コンテナイメージの自動更新 (UseStableTagging) パラメータはロードテスターイメージを管理しなくなります。セキュリティパッチを取得するには、更新されたイメージタグを再ミラーリングする必要があります。

ロードテスターイメージをプライベート ECR リポジトリにミラーリングするには、次の手順を実行します。次のコマンドでは、<version> をイメージタグ (v4.0.0 など)、<region> をデプロイリージョン (us-gov-west-1 など)、<profile> を AWS コマンドラインインターフェイス (AWS CLI) プロファイル名、<account-id> を 12 桁の AWS アカウント ID に置き換えます。

  1. インターネットアクセスが可能なマシンから、パブリック ECR レジストリに対して認証を行います。

    aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
  2. パブリックロードテスターイメージをプルします。

    docker pull public.ecr.aws/aws-solutions/distributed-load-testing-on-aws-load-tester:<version>
  3. アカウントにプライベート ECR リポジトリを作成します (まだ存在しない場合)。

    aws ecr create-repository --repository-name dlt-load-tester --region <region> --profile <profile> 2>/dev/null || true
  4. プライベート ECR レジストリに対して認証します。

    aws ecr get-login-password --region <region> --profile <profile> | docker login --username AWS --password-stdin <account-id>.dkr.ecr.<region>.amazonaws.com
  5. イメージをタグ付けして、プライベートリポジトリにプッシュします。

    docker tag public.ecr.aws/aws-solutions/distributed-load-testing-on-aws-load-tester:<version> \ <account-id>.dkr.ecr.<region>.amazonaws.com/dlt-load-tester:<version> docker push <account-id>.dkr.ecr.<region>.amazonaws.com/dlt-load-tester:<version>
  6. スタックを起動するときに、Load Tester Image URI パラメータにプライベートイメージ URI を入力します。

    <account-id>.dkr.ecr.<region>.amazonaws.com/dlt-load-tester:<version>

AWS GovCloud (米国) でのデプロイ例

次の例は、AWS GovCloud (米国) の各スタックバリアントで必須のパラメータを示しています。

ヘッドレススタックの場合、LoadTesterImageUri のみが必須です。

aws cloudformation create-stack \ --stack-name dlt-govcloud \ --template-url https://solutions-reference-us-gov.s3.us-gov-west-1.amazonaws.com/distributed-load-testing-on-aws/latest/distributed-load-testing-on-aws-headless.template \ --parameters \ ParameterKey=AdminName,ParameterValue=admin \ ParameterKey=AdminEmail,ParameterValue=admin@example.com \ ParameterKey=LoadTesterImageUri,ParameterValue=<account-id>.dkr.ecr.us-gov-west-1.amazonaws.com/dlt-load-tester:<version> \ --capabilities CAPABILITY_IAM \ --region us-gov-west-1

AWS Fargate スタックの Application Load Balancer (ALB) + ECS の場合は、LoadTesterImageUri と WebConsoleImageUri の両方を指定します。AWS GovCloud (米国) の ECS タスクはパブリック ECR レジストリ (public.ecr.aws) にアクセスできないため、両方のコンテナイメージをミラーリングする必要があります。

aws cloudformation create-stack \ --stack-name dlt-govcloud \ --template-url https://solutions-reference-us-gov.s3.us-gov-west-1.amazonaws.com/distributed-load-testing-on-aws/latest/distributed-load-testing-on-aws-alb-ecs.template \ --parameters \ ParameterKey=AdminName,ParameterValue=admin \ ParameterKey=AdminEmail,ParameterValue=admin@example.com \ ParameterKey=ConsoleDomainName,ParameterValue=dlt.example.gov \ ParameterKey=ACMCertificateArn,ParameterValue=arn:aws-us-gov:acm:us-gov-west-1:123456789012:certificate/abcd1234-ef56-gh78-ij90-klmnopqrstuv \ ParameterKey=LoadTesterImageUri,ParameterValue=<account-id>.dkr.ecr.us-gov-west-1.amazonaws.com/dlt-load-tester:<version> \ ParameterKey=WebConsoleImageUri,ParameterValue=<account-id>.dkr.ecr.us-gov-west-1.amazonaws.com/dlt-web-console:<version> \ --capabilities CAPABILITY_IAM \ --region us-gov-west-1

ウェブコンソールイメージをミラーリングする手順については、「ウェブコンソールイメージ」を参照してください。