起動テンプレートのサポート - AWS Batch
起動テンプレートの Amazon EC2 ユーザーデータ

起動テンプレートのサポート

AWS Batch にコンピューティング環境で Amazon EC2 起動テンプレートを使用するためのサポートが追加されました。起動テンプレートサポートでは、カスタム AMI を作成する必要なく、AWS Batch コンピューティングリソースのデフォルト設定を変更できます。

コンピューティング環境に関連付ける前に、起動テンプレートを作成する必要があります。起動テンプレートは、Amazon EC2 コンソールで作成するか、あるいは AWS CLI または AWS SDK を使用できます。たとえば、次の JSON ファイルは、デフォルトの AWS Batch コンピューティングリソース AMI の Docker データボリュームのサイズを変更する起動テンプレートを示し、また暗号化するように設定されています。 

{
    "LaunchTemplateName": "increase-container-volume-encrypt",
    "LaunchTemplateData": {
        "BlockDeviceMappings": [
            {
                "DeviceName": "/dev/xvdcz",
                "Ebs": {
                    "Encrypted": true,
                    "VolumeSize": 100,
                    "VolumeType": "gp2"
                }
            }
        ]
    }
}

上記の起動テンプレートは、JSON ファイルを lt-data.json という名前のファイルに保存して、次の AWS CLI コマンドを実行することで作成できます。 

aws ec2 --region <region> create-launch-template --cli-input-json file://lt-data.json

起動テンプレートの詳細については、『Linux インスタンス用 Amazon EC2 ユーザーガイド』の「起動テンプレートからのインスタンスの起動」を参照してください。

起動テンプレートを使用してコンピューティング環境を作成する場合、次の既存のコンピューティング環境パラメータを起動テンプレートに移動できます。

注記

上記のパラメータ (Amazon EC2 タグ付き以外) が起動テンプレートおよびコンピューティング環境の両方で指定されている場合、コンピューティング環境パラメータが優先されます。Amazon EC2 タグは、起動テンプレートとコンピューティング環境設定間でマージされます。タグキーの対立がある場合、コンピューティング環境設定の値が優先されます。

  • Amazon EC2 キーペア

  • Amazon EC2 AMI ID

  • セキュリティグループ ID

  • Amazon EC2 タグ

以下の起動テンプレートパラメータは、AWS Batch で無視されます。

  • インスタンスタイプ (コンピューティング環境作成時にインスタンスタイプを指定)

  • インスタンスロール (コンピューティング環境作成時にインスタンスロールを指定)

  • ネットワークインターフェイスサブネット (コンピューティング環境の作成時に、サブネットを指定)

  • インスタンスマーケットオプション (AWS Batch でスポットインスタンスの設定を制御する必要があります)

  • API 終了の無効化 (AWS Batch でインスタンスのライフサイクルを制御する必要があります)

AWS Batch では、新しい起動テンプレートバージョンを使用したコンピューティング環境の更新をサポートしていません。起動テンプレートを更新する場合、新規のテンプレートで新しいコンピューティング環境を作成して、変更を有効化します。

起動テンプレートの Amazon EC2 ユーザーデータ

インスタンスの起動時に、cloud-init で実行された起動テンプレートに Amazon EC2 ユーザーデータを指定できます。ユーザーデータは一般的な設定シナリオを実行できますが、これらに限定されるものではありません。

起動テンプレートの Amazon EC2 ユーザーデータは、MIME マルチパートアーカイブ 形式にする必要があります。これは、ユーザーデータがコンピューティングリソースを設定するために必要な他の AWS Batch ユーザーデータにマージされるためです。複数のユーザーデータブロックと単一の MIME マルチパートファイルを組み合わせることができます。たとえば、Amazon ECS コンテナエージェントの設定情報を書き込むユーザーデータシェルスクリプトを使用して、Docker デーモンを設定するクラウドブートフックを組み合わせることができます。

AWS CloudFormation を使用している場合、AWS::CloudFormation::Init 型を cfn-init ヘルパースクリプトで使用し、一般的な設定シナリオを実行できます。

MIME マルチパートファイルには次のコンポーネントが含まれます。

  • コンテンツの種類およびパート境界の宣言: Content-Type: multipart/mixed; boundary="==BOUNDARY=="

  • MIME バージョンの宣言: MIME-Version: 1.0

  • 次のコンポーネントを含む 1 つ以上のユーザーデータブロック:

    • ユーザーデータブロックの始まりを示す開始境界:--==BOUNDARY==

    • ブロックのコンテンツタイプの宣言: Content-Type: text/cloud-config; charset="us-ascii"。コンテンツの種類の詳細については、「Cloud-Init のドキュメント」を参照してください。

    • ユーザーデータのコンテンツ、たとえば、シェル・コマンドまたは cloud-init ディレクティブのリスト

  • MIME マルチパートファイルの終わりを示す、終了境界: --==BOUNDARY==--

以下に、独自のファイルを作成するために使用できる MIME マルチパートファイルの例をいくつか示します。

注記

Amazon EC2 コンソールの起動テンプレートにユーザーデータを追加するには、プレーンテキストにユーザーデータを貼り付けるか、またはファイルからアップロードできます。AWS CLI あるいは AWS SDK を使用する場合、まず最初にユーザーデータを base64 エンコード化し、次に、下記の JSON に示すように、CreateLaunchTemplate の呼び出し時にこの文字列を UserData パラメータの値として送信します。 

{
    "LaunchTemplateName": "base64-user-data",
    "LaunchTemplateData": {
        "UserData": "ewogICAgIkxhdW5jaFRlbXBsYXRlTmFtZSI6ICJpbmNyZWFzZS1jb250YWluZXItdm9sdW..."
    }
}

例: 既存の Amazon EFS ファイルシステムのマウント

このサンプル MIME マルチパートファイルは、コンピューティングリソースを設定して amazon-efs-utils パッケージをインストールし、既存の Amazon EFS ファイルシステムを /mnt/efs にマウントします。 

MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="==MYBOUNDARY=="

--==MYBOUNDARY==
Content-Type: text/cloud-config; charset="us-ascii"

packages:
- amazon-efs-utils

runcmd:
- file_system_id_01=fs-abcdef123
- efs_directory=/mnt/efs

- mkdir -p ${efs_directory}
- echo "${file_system_id_01}:/ ${efs_directory} efs tls,_netdev" >> /etc/fstab
- mount -a -t efs defaults

--==MYBOUNDARY==--

例: デフォルトの Amazon ECS コンテナエージェント設定の上書き

このサンプル MIME マルチパートファイルは、コンピューティングリソースのデフォルトの Docker イメージクリーンアップ設定を上書きします。

MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="==MYBOUNDARY=="

--==MYBOUNDARY==
Content-Type: text/x-shellscript; charset="us-ascii"

#!/bin/bash
echo ECS_IMAGE_CLEANUP_INTERVAL=60m >> /etc/ecs/ecs.config
echo ECS_IMAGE_MINIMUM_CLEANUP_AGE=60m >> /etc/ecs/ecs.config

--==MYBOUNDARY==--

例: 既存の Amazon FSx for Lustre ファイルシステムのマウント

このサンプル MIME マルチパートファイルは、コンピューティングリソースを設定して Extras Library から lustre2.10 パッケージをインストールし、既存の Amazon FSx for Lustre ファイルシステムを /scratch にマウントします。この例は Amazon Linux 2 用です。他の Linux ディストリビューションのインストール手順については、Amazon FSx for Lustre ユーザーガイドの「Lustre クライアントのインストール」を参照してください。 

MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="==MYBOUNDARY=="

--==MYBOUNDARY==
Content-Type: text/cloud-config; charset="us-ascii"

runcmd:
- file_system_id_01=fs-0abcdef1234567890
- region=us-east-2
- fsx_directory=/scratch
- amazon-linux-extras install -y lustre2.10
- mkdir -p ${fsx_directory}
- mount -t lustre ${file_system_id_01}.fsx.${region}.amazonaws.com@tcp:fsx ${fsx_directory}

--==MYBOUNDARY==--

コンテナプロパティの volumes および mountPoints メンバーでは、マウントポイントをコンテナにマッピングする必要があります。 

{
    "volumes": [
        {
            "host": {
                "sourcePath": "/scratch"
            },
            "name": "Scratch"
        }
    ],
    "mountPoints": [
        {
            "containerPath": "/scratch",
            "sourceVolume": "Scratch"
        }
    ],
}