AWS ParallelCluster AMI をカスタマイズする方法カスタム AWS ParallelCluster AMI の構築 AWS ParallelCluster AMI の変更

カスタム AWS ParallelCluster AMI の構築

AWS ParallelCluster コマンドラインインターフェイス (CLI) または API を使用する場合、 AWS ParallelCluster イメージとクラスターを作成または更新したときに作成された AWS リソースに対してのみ料金が発生します。詳細については、「AWS ParallelCluster で使用されるサービス AWS」を参照してください。

AWS ParallelCluster UI はサーバーレスアーキテクチャ上に構築されており、ほとんどの場合、 AWS 無料利用枠カテゴリ内で使用できます。詳細については、「AWS ParallelCluster UI コスト」を参照してください。

重要

カスタム AMI を構築した場合は、新しい AWS ParallelCluster のリリースごとに、カスタム AMI を作成したときの手順を繰り返す必要があります。

この先をお読みになる前に、まず「カスタムブートストラップアクション」のセクションを確認することをお勧めします。希望する変更がスクリプト化され、今後の AWS ParallelCluster リリースでサポートされるかどうかを確認してください。

一般的にカスタム AMI の構築は理想的ではありませんが、用のカスタム AMI の構築 AWS ParallelCluster が必要な特定のシナリオがあります。このチュートリアルでは、これらのシナリオに対応するカスタム AMI を構築する方法について説明します。

前提条件

AWS ParallelCluster がインストールされます。
AWS CLI がインストールされ、設定されています。
EC2 キーペアがある。
pcluster CLI を実行してイメージをビルドするのに必要なアクセス許可を持つ IAM ロールがある。

AWS ParallelCluster AMI をカスタマイズする方法

カスタム AWS ParallelCluster AMI を構築するには 2 つの方法があります。これら 2 つの方法の 1 つは、 AWS ParallelCluster CLI を使用して新しい AMI を構築することです。もう一つの方法では、手動で変更を加えて AWS アカウントで使用できる新しい AMI を構築する必要があります。

カスタム AWS ParallelCluster AMI の構築

カスタマイズされた AMI とソフトウェアがある場合は、その AWS ParallelCluster 上にで必要な変更を適用できます。 AWS ParallelCluster は EC2 Image Builder サービスを利用してカスタマイズされた AMIs。詳細については、「Image Builder User Guide」を参照してください。

キーポイント:

このプロセスには約 1 時間かかります。この時間は、ビルド時に追加で Build/Components をインストールする場合には変動します。
AMI には主なコンポーネントのバージョンがタグ付けされています。これらには、カーネル、スケジューラー、EFA ドライバーが含まれます。コンポーネントバージョンのサブセットも AMI の説明にレポートされます。
AWS ParallelCluster 3.0.0 以降では、新しい CLI コマンドセットを使用してイメージのライフサイクルを管理できます。これには build-image、list-images、describe-image、および delete-image があります。
この方法は繰り返し実行可能です。再実行して AMI を最新の状態に保ち (OS の更新など)、既存のクラスターを更新するときに使用できます。

注記

AWS 中国パーティションでこの方法を使用すると、ネットワークエラーが発生する可能性があります。例えば、OS リポジトリからパッケージをダウンロードするときに、 pcluster build-image コマンド GitHub でこれらのエラーが表示されることがあります。このような場合には、次の代替方法のいずれかを使用することをお勧めします。

このコマンドをバイパスする「AWS ParallelCluster AMI の変更」アプローチに従ってください。
イメージを別のパーティションおよびリージョン (us-east-1 など) でビルドし、保存/復元して中国リージョンに移動します。詳細については、「Amazon EC2 ユーザーガイド」のS3 を使用して AMI を保存および復元する」を参照してください。 Amazon EC2

ステップ:

AWS ParallelCluster クライアント AWS アカウントがユーザーに代わって AWS API オペレーションを呼び出すことができるように認証情報を設定します。必要なアクセス権限のリストについては、「AWS Identity and Access Management の権限 AWS ParallelCluster」を参照してください。
基本的なビルドイメージ設定ファイルを作成します。これを行うには、イメージの構築に使用する InstanceType と、ParentImage を指定します。これらは AMI を作成するための開始点として使用されます。オプションのビルドパラメータの詳細については、「Image Configuration」を参照してください。
```
Build:
 InstanceType: <BUILD_INSTANCE_TYPE>
 ParentImage: <BASE_AMI_ID>
```
CLI コマンドを使用してpcluster build-image、ベースとして指定した AWS ParallelCluster AMI から AMI を構築します。
```
$ pcluster build-image --image-id IMAGE_ID --image-configuration IMAGE_CONFIG.yaml --region REGION
    {
 "image": {
   "imageId": "IMAGE_ID",
   "imageBuildStatus": "BUILD_IN_PROGRESS",
   "cloudformationStackStatus": "CREATE_IN_PROGRESS",
   "cloudformationStackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/IMAGE_ID/abcd1234-ef56-gh78-ij90-1234abcd5678",
   "region": "us-east-1",
   "version": "3.7.0"
 }
}
```
警告
pcluster build-image はデフォルトの VPC を使用します。 AWS Control Tower または AWS Landing Zone を使用してデフォルトの VPC を削除する場合は、イメージ設定ファイルでサブネット ID を指定する必要があります。詳細については、「SubnetId」を参照してください。

その他のパラメータのリストについては、「pcluster build-image」コマンドリファレンスページを参照してください。上記のコマンドの結果は次のとおりです。
- CloudFormation スタックはイメージ設定に基づいて作成されます。このスタックには、ビルドに必要なすべての EC2 Image Builder リソースが含まれています。
- 作成されたリソースには、カスタム Image Builder AWS ParallelCluster コンポーネントを追加できる公式の Image Builder コンポーネントが含まれます。カスタムコンポーネントの作成方法については、「公共部門のお客様用ワークショップ向け HPC」の「Custom AMIs examples」を参照してください。
- EC2 Image Builder はビルドインスタンスを起動し、 AWS ParallelCluster クックブックを適用して AWS ParallelCluster ソフトウェアスタックをインストールし、必要な設定タスクを実行します。 AWS ParallelCluster クックブックは、の構築とブートストラップに使用されます AWS ParallelCluster。
- インスタンスが停止され、そこから新しい AMI が作成されます。
- 新たに作成した AMI から別のインスタンスが起動します。テストフェーズでは、EC2 Image Builder は Image Builder コンポーネントで定義されたテストを実行します。
- ビルドが成功すると、スタックは削除されます。ビルドに失敗した場合、スタックはインスペクション可能な状態で保持されます。

次のコマンドを実行すると、ビルドプロセスのステータスをモニタリングできます。ビルドが完了したら、ビルドを実行してレスポンスで指定された AMI ID を取得できます。


$ pcluster describe-image --image-id IMAGE_ID --region REGION
    
# BEFORE COMPLETE
{
 "imageConfiguration": {
   "url": "https://parallelcluster-1234abcd5678efgh-v1-do-not-delete.s3.amazonaws.com/parallelcluster/3.7.0/images/IMAGE_ID-abcd1234efgh5678/configs/image-config.yaml?...",
 },
 "imageId": "IMAGE_ID",
 "imagebuilderImageStatus": "BUILDING",
 "imageBuildStatus": "BUILD_IN_PROGRESS",
 "cloudformationStackStatus": "CREATE_IN_PROGRESS",
 "cloudformationStackArn": "arn:aws:cloudformation:us-east-1:123456789012:stack/IMAGE_ID/abcd1234-ef56-gh78-ij90-1234abcd5678",
 "region": "us-east-1",
 "version": "3.7.0",
 "cloudformationStackTags": [
   {
     "value": "3.7.0",
     "key": "parallelcluster:version"
   },
   {
     "value": "IMAGE_ID",
     "key": "parallelcluster:image_name"
   },
   ...
 ],
 "imageBuildLogsArn": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-IMAGE_ID",
 "cloudformationStackCreationTime": "2022-04-05T21:36:26.176Z"
}

# AFTER COMPLETE
{
 "imageConfiguration": {
   "url": "https://parallelcluster-1234abcd5678efgh-v1-do-not-delete.s3.us-east-1.amazonaws.com/parallelcluster/3.7.0/images/IMAGE_ID-abcd1234efgh5678/configs/image-config.yaml?Signature=..."
 },
 "imageId": "IMAGE_ID",
 "imageBuildStatus": "BUILD_COMPLETE",
 "region": "us-east-1",
 "ec2AmiInfo": {
     "amiName": "IMAGE_ID 2022-04-05T21-39-24.020Z",
     "amiId": "ami-1234stuv5678wxyz",
     "description": "AWS ParallelCluster AMI for alinux2, kernel-4.14.238-182.422.amzn2.x86_64, lustre-2.10.8-5.amzn2.x86_64, efa-1.13.0-1.amzn2.x86_64, dcv-2021.1.10598-1.el7.x86_64, slurm-20-11-8-1",
     "state": "AVAILABLE",
     "tags": [
      {
        "value": "2021.3.11591-1.el7.x86_64",
        "key": "parallelcluster:dcv_version"
      },
      ...
     ],
   "architecture": "x86_64"
 },
 "version": "3.7.0"      
}

クラスターを作成するには、クラスター設定内の CustomAmi フィールドに AMI ID を入力します。

AMI 作成プロセスのトラブルシューティングとモニタリング

イメージの作成は約 1 時間で完了します。pcluster describe-image コマンドまたはログ検索コマンドを実行してプロセスをモニタリングできます。


$ pcluster describe-image --image-id IMAGE_ID --region REGION

build-image コマンドは、イメージの構築に必要なすべての EC2 リソースを含む CloudFormation スタックを作成し、EC2 Image Builder プロセスを起動します。

build-image コマンドを実行した後、を使用して CloudFormation スタックイベントを取得できますpcluster get-image-stack-events。--query パラメータで結果をフィルタリングして、最新のイベントを表示できます。詳細については、「 AWS Command Line Interface ユーザーガイド」の AWS CLI 「出力のフィルタリング」を参照してください。


$ pcluster get-image-stack-events --image-id IMAGE_ID --region REGION --query "events[0]"
{
 "eventId": "ParallelClusterImage-CREATE_IN_PROGRESS-2022-04-05T21:39:24.725Z",
 "physicalResourceId": "arn:aws:imagebuilder:us-east-1:123456789012:image/parallelclusterimage-IMAGE_ID/3.7.0/1",
 "resourceStatus": "CREATE_IN_PROGRESS",
 "resourceStatusReason": "Resource creation Initiated",
 "resourceProperties": "{\"InfrastructureConfigurationArn\":\"arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/parallelclusterimage-abcd1234-ef56-gh78-ij90-1234abcd5678\",\"ImageRecipeArn\":\"arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/parallelclusterimage-IMAGE_ID/3.7.0\",\"DistributionConfigurationArn\":\"arn:aws:imagebuilder:us-east-1:123456789012:distribution-configuration/parallelclusterimage-abcd1234-ef56-gh78-ij90-1234abcd5678\",\"Tags\":{\"parallelcluster:image_name\":\"IMAGE_ID\",\"parallelcluster:image_id\":\"IMAGE_ID\"}}",
 "stackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/IMAGE_ID/abcd1234-ef56-gh78-ij90-1234abcd5678",
 "stackName": "IMAGE_ID",
 "logicalResourceId": "ParallelClusterImage",
 "resourceType": "AWS::ImageBuilder::Image",
 "timestamp": "2022-04-05T21:39:24.725Z"
}

約 15 分後、Image Builder の作成に関連するログイベントエントリにスタックイベントが表示されます。pcluster list-image-log-streams コマンドや pcluster get-image-log-events コマンドを使用して、イメージログストリームの一覧表示および Image Builder のステップのモニタリングができるようになりました。


$ pcluster list-image-log-streams --image-id IMAGE_ID --region REGION \
    --query 'logStreams[*].logStreamName'

 "3.7.0/1"
]

$ pcluster get-image-log-events --image-id IMAGE_ID --region REGION \
--log-stream-name 3.7.0/1 --limit 3
{
 "nextToken": "f/36295977202298886557255241372854078762600452615936671762",
 "prevToken": "b/36295977196879805474012299949460899222346900769983430672",
 "events": [
   {
     "message": "ExecuteBash: FINISHED EXECUTION",
     "timestamp": "2022-04-05T22:13:26.633Z"
   },
   {
     "message": "Document arn:aws:imagebuilder:us-east-1:123456789012:component/parallelclusterimage-test-abcd1234-ef56-gh78-ij90-1234abcd5678/3.7.0/1",
     "timestamp": "2022-04-05T22:13:26.741Z"
   },
   {
     "message": "TOE has completed execution successfully",
     "timestamp": "2022-04-05T22:13:26.819Z"
   }
 ]
}

BUILD_COMPLETE のステータスが表示されるまで、describe-image コマンドで確認を続けます。


$ pcluster describe-image --image-id IMAGE_ID --region REGION
{
 "imageConfiguration": {
   "url": "https://parallelcluster-1234abcd5678efgh-v1-do-not-delete.s3.us-east-1.amazonaws.com/parallelcluster/3.7.0/images/IMAGE_ID-abcd1234efgh5678/configs/image-config.yaml?Signature=..."
 },
 "imageId": "IMAGE_ID",
 "imageBuildStatus": "BUILD_COMPLETE",
 "region": "us-east-1",
 "ec2AmiInfo": {
     "amiName": "IMAGE_ID 2022-04-05T21-39-24.020Z",
     "amiId": "ami-1234stuv5678wxyz",
     "description": "AWS ParallelCluster AMI for alinux2, kernel-4.14.238-182.422.amzn2.x86_64, lustre-2.10.8-5.amzn2.x86_64, efa-1.13.0-1.amzn2.x86_64, dcv-2021.1.10598-1.el7.x86_64, slurm-20-11-8-1",
     "state": "AVAILABLE",
     "tags": [
      {
        "value": "2021.3.11591-1.el7.x86_64",
        "key": "parallelcluster:dcv_version"
      },
      ...
     ],
   "architecture": "x86_64"
 },
 "version": "3.7.0"      
}

カスタム AMI 作成の問題をトラブルシューティングする必要がある場合は、次の手順で説明されているようにイメージログのアーカイブを作成します。

--output パラメータに応じて、ログを Amazon S3 バケットまたはローカルファイルにアーカイブすることが可能です。


$ pcluster export-image-logs --image-id IMAGE_ID --region REGION \
--bucket BUCKET_NAME --bucket-prefix BUCKET_FOLDER
{
 "url": "https://BUCKET_NAME.s3.us-east-1.amazonaws.com/BUCKET-FOLDER/IMAGE_ID-logs-202209071136.tar.gz?AWSAccessKeyId=..."
}

$ pcluster export-image-logs --image-id IMAGE_ID \
--region REGION --bucket BUCKET_NAME --bucket-prefix BUCKET_FOLDER --output-file /tmp/archive.tar.gz
{
 "path": "/tmp/archive.tar.gz"
}

アーカイブには、Image Builder プロセスと AWS CloudFormation スタックイベントに関連する CloudWatch ログストリームが含まれています。このコマンドの実行には数分かかることがあります。

カスタム AMI の管理

AWS ParallelCluster 3.0.0 以降、イメージのライフサイクルを構築、モニタリング、管理するための新しいコマンドセットが CLI に追加されました。コマンドの詳細については、「pcluster commands」を参照してください。

AWS ParallelCluster AMI の変更

この方法は、公式 AWS ParallelCluster AMI にカスタマイズを追加して変更することで構成されます。基本 AWS ParallelCluster AMIs は新しいリリースで更新されます。これらの AMIs には、インストールおよび設定時にが機能 AWS ParallelCluster するために必要なすべてのコンポーネントがあります。これらのいずれかをベースとして開始できます。

キーポイント:

この方法は、build-image コマンドよりも高速です。ただし、これは手動のプロセスであり、自動的に繰り返すことはできません。
この方法では、CLI で利用できるログ検索やイメージライフサイクル管理コマンドにはアクセスできません。

ステップ:

New EC2 console

使用する特定のに対応する AMI を見つけ AWS リージョンます。これを見つけるには、 --regionパラメータを指定して pcluster list-official-images コマンドを使用し、使用する OS AWS リージョン --osとアーキテクチャで目的の AMI をフィルタリングする特定のパラメータと --architectureパラメータを選択します。出力結果から、EC2 イメージ ID を取得します。
にサインイン AWS Management Console し、https://console.aws.amazon.com/ec2/ で Amazon EC2 コンソールを開きます。
ナビゲーションペインで、[イメージ]、[AMI] の順に選択します。取得した EC2 イメージ ID を検索し、[AMI] を選択して、[AMI からインスタンスを起動] を選択します。
下にスクロールして、使用する [インスタンスタイプ] を選択します。
使用する [キーペア]、[インスタンスの作成] を選択します。
OS ユーザーと SSH キーを使用してインスタンスにログインします。
要件に合わせてインスタンスを手動でカスタマイズします。
次のコマンドを実行して、インスタンスを AMI 作成用に準備します。
```
sudo /usr/local/sbin/ami_cleanup.sh
```
コンソールから [インスタンスの状態] および [インスタンスの停止] を選択します。

[インスタンス] に移動して、新しいインスタンスを選択し、[インスタンスの状態]、[インスタンスの停止] の順に選択します。
EC2 コンソールまたは AWS CLI create-image を使用して、インスタンスから新しい AMI を作成します。
EC2 コンソールから
1. ナビゲーションペインで、[Instances (インスタンス)] を選択します。
2. 作成および変更したインスタンスを選択します。
3. [アクション]で、[イメージ]、[イメージの作成] の順に選択します。
4. [Create Image] を選択します。
クラスター設定内の CustomAmi フィールドに新しい AMI ID を入力して、クラスターを作成します。

Old EC2 console

使用する特定のに対応する AWS ParallelCluster AMI を見つけ AWS リージョンます。これを見つけるには、 pcluster list-official-images コマンドと --regionパラメータを使用して、使用する OS AWS リージョン --osとアーキテクチャで目的の AMI をフィルタリングする特定のパラメータと --architectureパラメータを選択します。出力結果から、EC2 イメージ ID を取得できます。
にサインイン AWS Management Console し、https://console.aws.amazon.com/ec2/ で Amazon EC2 コンソールを開きます。
ナビゲーションペインで、[イメージ]、[AMI] の順に選択します。[パブリックイメージ] のフィルターを設定し、取得した EC2 イメージ ID を検索し、AMI を選択して [起動] を選択します。
インスタンスタイプを選択し、[次へ:インスタンスの詳細の設定] または [確認と作成] を選択してインスタンスを起動します。
[起動] を選択し、[キーペア]、[インスタンスの作成] を選択します。
OS ユーザーと SSH キーを使用してインスタンスにログインします。詳細については、[インスタンス] に移動し、新しいインスタンスを選択して [接続] を選択します。
要件を満たすようにインスタンスを手動でカスタマイズします。
次のコマンドを実行して、インスタンスを AMI 作成用に準備します。
```
sudo /usr/local/sbin/ami_cleanup.sh
```
EC2 コンソールから、ナビゲーションペインで [インスタンス] を選択し、新しいインスタンスを選択して[アクション]、[インスタンスの状態]、および [停止] を選択します。
EC2 コンソールまたは AWS CLI create-image を使用して、インスタンスから新しい AMI を作成します。
EC2 コンソールから
1. ナビゲーションペインで、[Instances (インスタンス)] を選択します。
2. 作成および変更したインスタンスを選択します。
3. [アクション] で、[イメージ]、[イメージの作成] の順に選択します。
4. [Create Image] を選択します。
クラスター設定内の CustomAmi フィールドに新しい AMI ID を入力して、クラスターを作成します。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

AWS ParallelCluster で最初のジョブを実行する

Active Directory の統合

カスタム AWS ParallelCluster AMI の構築

重要

前提条件

AWS ParallelCluster AMI をカスタマイズする方法

カスタム AWS ParallelCluster AMI の構築

注記

警告

AWS ParallelCluster AMI の変更

EC2 コンソールから

EC2 コンソールから