Elastic Beanstalk カスタムプラットフォーム (廃止)

カスタムプラットフォームは、いくつかの点でカスタムイメージより高度なカスタマイズです。カスタムプラットフォームでは、ゼロから新しいプラットフォーム全体を開発し、プラットフォームインスタンスで Elastic Beanstalk が実行するオペレーティングシステム、その他のソフトウェア、およびスクリプトをカスタマイズできます。この柔軟性により、Elastic Beanstalk がマネージドプラットフォームを提供していない、言語やその他のインフラストラクチャソフトウェアを使用するアプリケーション用のプラットフォームを構築できます。既存の Elastic Beanstalk プラットフォームで使用する Amazon マシンイメージ (AMI) を変更するカスタムイメージと比べた場合、Elastic Beanstalk は依然としてプラットフォームスクリプトを提供してプラットフォームのソフトウェアスタックを制御します。さらに、カスタムプラットフォームでは、自動のスクリプト化された方法を使用してカスタマイズを作成して維持します。一方、カスタムイメージでは、実行中のインスタンスで変更を手動で行います。

カスタムプラットフォームを作成するには、サポートされているオペレーティングシステムである Ubuntu、RHEL、または Amazon Linux (正確なバージョン番号については「Platform.yaml ファイルの形式。」の flavor エントリを参照) のいずれかから Amazon マシンイメージ (AMI) を作成し、それをカスタマイズします。Packer を使用して独自の Elastic Beanstalk プラットフォームを作成します。これは、Amazon Elastic Compute Cloud (Amazon EC2) で使用する AMI を含む多くのプラットフォームのマシンイメージを作成するためのオープンソースツールです。Elastic Beanstalk プラットフォームは、アプリケーションをサポートする一連のソフトウェアを実行するよう設定された AMI と、カスタム設定オプションやデフォルトの設定オプションの設定を含むことができるメタデータで構成されます。

Elastic Beanstalk は Packer を個別の組み込みプラットフォームとして管理するため、Packer の設定とバージョンについて心配する必要はありません。

Packer テンプレートと、AMI を構築するにテンプレートが呼び出すスクリプトおよびファイルを Elastic Beanstalk に提供して、プラットフォームを作成します。これらのコンポーネントは、テンプレートとメタデータを指定するプラットフォーム定義ファイルにより、プラットフォーム定義ファイルと呼ばれる ZIP アーカイブにパッケージ化されます。

カスタムプラットフォームの作成時に、Packer を実行する Elastic IP を使用しないで単一インスタンス環境を起動します。こうすることで Packer は別のインスタンスを起動してイメージを作成します。この環境は、複数のプラットフォームや各プラットフォームの複数のバージョンで再利用できます。

アカウントのユーザーは、環境の作成中にプラットフォーム ARN を指定してカスタムプラットフォームを使用できます。ARN は、カスタムプラットフォームの作成に使用した eb platform create コマンドによって返されます。

カスタムプラットフォームを構築するたびに、Elastic Beanstalk は新しいプラットフォームのバージョンを作成します。ユーザーは、プラットフォームを名前で指定して最新バージョンのプラットフォームのみを取得したり、バージョン番号を指定して特定のバージョンを取得したりできます。

たとえば、最新バージョンのカスタムプラットフォーム (バージョン 3.0 など) を、ARN MyCustomPlatformARN を使用してデプロイする場合、EB CLI のコマンドラインは次のようになります。

eb create -p MyCustomPlatformARN

バージョン 2.1 をデプロイする場合、EB CLI のコマンドラインは次のようになります。

eb create -p MyCustomPlatformARN --version 2.1

カスタムプラットフォームバージョンの作成時にタグを適用できます。また、既存のカスタムプラットフォームバージョンのタグを編集できます。詳細については、「custom プラットフォームバージョンのタグ付け」を参照してください。

カスタムプラットフォームの作成

カスタムプラットフォームを作成するには、アプリケーションの root に platform.yaml ファイルを含める必要があります。このファイルは、カスタムプラットフォームの作成に使用されるビルダーのタイプを定義します。このファイルの形式は、「Platform.yaml ファイルの形式。」で説明しています。カスタムプラットフォームを最初から作成することも、サンプルカスタムプラットフォームのいずれかを開始点として使用することもできます。

サンプル カスタム プラットフォームの使用

独自のカスタムプラットフォームを作成する別の方法として、プラットフォーム定義アーカイブサンプルの 1 つを使用してカスタムプラットフォームをブートストラップできます。ソース AMI とリージョンを設定するだけで、サンプルを使用できます。

サンプルプラットフォーム定義アーカイブ NodePlatform_Ubuntu.zip をダウンロードします。このファイルには、プラットフォーム定義ファイル、Packer テンプレート、イメージの作成中に Packer が実行するスクリプト、およびプラットフォームの作成中に Packer がビルダーインスタンスにコピーするスクリプトと設定ファイルが含まれています。

|-- builder                 Contains files used by Packer to create the custom platform
|-- custom_platform.json    Packer template
|-- platform.yaml           Platform definition file
|-- ReadMe.txt              Briefly describes the sample

プラットフォーム定義ファイル platform.yaml は、Elastic Beanstalk に Packer テンプレート (custom_platform.json) の名前を指定します。

version: "1.0"

provisioner:
  type: packer
  template: custom_platform.json
  flavor: ubuntu1604

Packer テンプレートは、HVM インスタンスタイプのプラットフォームイメージのベースとして Ubuntu AMI を使用して、プラットフォーム用の AMI を構築する方法を Packer に伝えます。provisioners セクションでは、アーカイブ内の builder フォルダのすべてのファイルをインスタンスにコピーし、インスタンスで builder.sh スクリプトを実行するよう Packer に伝えます。スクリプトが完了すると、Packer は変更したインスタンスからイメージを作成します。

Elastic Beanstalk は、Packer の AMI にタグを付けるために使用できる 3 つの環境変数を作成します。

サンプル custom_platform.json ファイルは、これらの変数を使用して、スクリプトで使用する次の値を定義します。

この custom_platform.json ファイルには、値を指定する必要がある 2 つのプロパティとして source_ami と region があります。AMI とリージョンの適切な値を選択する方法の詳細については、eb-custom-platforms-samples GitHub リポジトリの「Updating Packer template」(Packer テンプレートの更新) を参照してください。

{
  "variables": {
    "platform_name": "{{env `AWS_EB_PLATFORM_NAME`}}",
    "platform_version": "{{env `AWS_EB_PLATFORM_VERSION`}}",
    "platform_arn": "{{env `AWS_EB_PLATFORM_ARN`}}"
  },
  "builders": [
    {
      ...
      "region": "",
      "source_ami": "",
      ...
    }
  ],
  "provisioners": [
    {...},
    {
      "type": "shell",
      "execute_command": "chmod +x {{ .Path }}; {{ .Vars }} sudo {{ .Path }}",
      "scripts": [
        "builder/builder.sh"
      ]
    }
  ]
}

プラットフォーム定義アーカイブに含めるスクリプトとその他のファイルは、インスタンスに対して行う変更によって大きく異なります。サンプルプラットフォームには以下のスクリプトが含まれます。

EB CLI を使用して、サンプルプラットフォーム定義ファイルで最初のカスタムプラットフォームを作成します。

オペレーションが完了すると、Elastic Beanstalk 環境の起動に使用できるプラットフォームが用意されます。

コンソールから環境を作成するときに、カスタムプラットフォームを使用できます。「新しい環境の作成ウィザード」を参照してください。

プラットフォーム定義アーカイブのコンテンツ

プラットフォーム定義アーカイブは、アプリケーションソースバンドルのプラットフォームに相当します。プラットフォーム定義アーカイブは、プラットフォーム定義アーカイブ、Packer テンプレート、およびプラットフォームを作成するために Packer テンプレートによって使用されるスクリプトとファイルを含む ZIP ファイルです。

プラットフォーム定義ファイルは YAML 形式のファイルで、platform.yaml という名前でプラットフォーム定義アーカイブの root になければなりません。プラットフォーム定義ファイルでサポートされる必須キーおよびオプションのキーのリストについては、カスタムプラットフォームの作成 を参照してください。

特定の方法で Packer テンプレートに名前を付けるせんが、ファイル名はプラットフォーム定義アーカイブで指定された provisioner テンプレートに一致する必要があります。Packer テンプレートを作成する手順については、公式の Packer ドキュメントを参照してください。

プラットフォーム定義アーカイブのその他のファイルには、AMI を作成する前にインスタンスをカスタマイズするためにテンプレートによって使用されるスクリプトとファイルがあります。

カスタムプラットフォームフック

Elastic Beanstalk は、カスタムプラットフォームで標準化されたディレクトリ構造をフックに使用します。これらはライフサイクルイベント中、および管理オペレーション (環境のインスタンスが起動された、ユーザーがデプロイを開始した、またはユーザーがアプリケーションサーバーの再起動機能を使用した) に応じて実行されるスクリプトです。

フックをトリガーするスクリプトを /opt/elasticbeanstalk/hooks/ フォルダのサブフォルダの 1 つに配置します。

フックは次のフォルダーに整理されます。

appdeploy、configdeploy、および restartappserver フォルダには pre、enact、および post サブフォルダがあります。オペレーションの各段階で、pre フォルダのすべてのスクリプトがアルファベット順に実行され、次に enact フォルダ、post フォルダの順に実行されます。

インスタンスを起動すると、Elastic Beanstalk は preinit、appdeploy、postinit の順序で実行します。実行中のインスタンスへのそれ以降のデプロイで、Elastic Beanstalk は appdeploy フックを実行します。ユーザーがインスタンスソフトウェアの設定を更新すると、configdeploy フックが実行されます。restartappserver フックは、ユーザーがアプリケーションサーバーの再起動を開始するときのみ実行されます。

スクリプトでエラーが発生した場合、ゼロ以外のステータスで終了し、stderr に書き込んでオペレーションを失敗させることができます。stderr に書き込むメッセージは、オペレーションが失敗した場合に出力されるイベントに表示されます。Elastic Beanstalk は、この情報をログファイル /var/log/eb-activity.log に取り込み、オペレーションを失敗させたくない場合は 0 (ゼロ) を返します。stderr または stdout に書き込むメッセージはデプロイログに表示されますが、オペレーションが失敗しない限り、イベントストリームには表示されません。

Packer インスタンスのクリーンアップ

Packer ビルダープロセスを完了前に停止するなど特定の状況では、Packer によって起動されたインスタンスはクリーンアップされません。これらのインスタンスは Elastic Beanstalk 環境の一部ではなく、Amazon EC2 サービスを使用してのみ表示および終了できます。

Platform.yaml ファイルの形式。

platform.yaml ファイルの形式は次のとおりです。

version: "version-number"

provisioner:
   type: provisioner-type
   template: provisioner-template
   flavor: provisioner-flavor
        
metadata:
   maintainer: metadata-maintainer
   description: metadata-description
   operating_system_name: metadata-operating_system_name
   operating_system_version: metadata-operating_system_version
   programming_language_name: metadata-programming_language_name
   programming_language_version: metadata-programming_language_version
   framework_name: metadata-framework_name
   framework_version: metadata-framework_version

option_definitions:
   - namespace: option-def-namespace
     option_name: option-def-option_name
     description: option-def-description
     default_value: option-def-default_value

option_settings:
   - namespace: "option-setting-namespace"
     option_name: "option-setting-option_name"
     value: "option-setting-value"

プレースホルダーを該当する値に置き換えます。

custom プラットフォームバージョンのタグ付け

AWS Elastic Beanstalk カスタムプラットフォームバージョンにタグを適用できます。タグは、 AWS リソースに関連付けられたキーと値のペアです。Elastic Beanstalk リソースのタグ付け、ユースケース、タグのキーと値の制約、サポートされているリソースタイプの詳細については、「Elastic Beanstalk アプリケーションリソースのタグ付け」を参照してください。

カスタムプラットフォームバージョンの作成時にタグを指定できます。既存のカスタムプラットフォームバージョンでは、タグの追加や削除、既存タグの値の更新ができます。カスタムプラットフォームバージョンごとに最大 50 個のタグを追加できます。

カスタムプラットフォームバージョンの作成時にタグを追加する

EB CLI を使用してカスタムプラットフォームバージョンを作成する場合は。eb platform create の --tags オプションを使用してタグを追加します。

~/workspace/my-app$ eb platform create --tags mytag1=value1,mytag2=value2

AWS CLI または他の API ベースのクライアントで、 create-platform-version コマンドの --tagsパラメータを使用してタグを追加します。

$ aws elasticbeanstalk create-platform-version \
      --tags Key=mytag1,Value=value1 Key=mytag2,Value=value2 \
      --platform-name my-platform --platform-version 1.0.0 --platform-definition-bundle S3Bucket=amzn-s3-demo-bucket,S3Key=sample.zip

既存のカスタムプラットフォームバージョンのタグを管理する

既存の Elastic Beanstalk カスタムプラットフォームバージョンのタグを追加、更新、削除できます。

EB CLI を使用してカスタムプラットフォームバージョンを更新する場合は、 eb tags を使用してタグを追加、更新、削除、一覧表示します。

たとえば、次のコマンドでは、カスタムプラットフォームバージョンのタグを一覧表示します。

~/workspace/my-app$ eb tags --list --resource "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

次のコマンドでは、mytag1 タグを更新して mytag2 タグを削除します。

~/workspace/my-app$ eb tags --update mytag1=newvalue --delete mytag2 \
      --resource "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

オプションの完全なリストおよび詳細な例については、「eb tags」を参照してください。

AWS CLI または他の API ベースのクライアントでは、 list-tags-for-resource コマンドを使用してカスタムプラットフォームバージョンのタグを一覧表示します。

$ aws elasticbeanstalk list-tags-for-resource --resource-arn "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

カスタムプラットフォームバージョンのタグを追加、更新、または削除するには、 update-tags-for-resource コマンドを使用します。

$ aws elasticbeanstalk update-tags-for-resource \
      --tags-to-add Key=mytag1,Value=newvalue --tags-to-remove mytag2 \
      --resource-arn "arn:aws:elasticbeanstalk:us-east-2:my-account-id:platform/my-platform/1.0.0"

追加するタグと更新するタグを update-tags-for-resource の --tags-to-add パラメータで指定します。存在していないタグが追加され、既存のタグの値が更新されます。

$ aws elasticbeanstalk list-platform-versions