Elastic Beanstalkの.extensionsの挙動を確認する

2023-10-142024-04-27

Elastic Beanstalkにおける設定オプションについて確認します。
以下のページによりますと、Elastic Beanstalkの設定オプションは4つ存在します。

https://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/command-options.html

環境に直接適用される設定
保存済み設定
設定ファイル (.ebextensions)
デフォルト値

上の方が優先順位が高いです。

今回は.ebextensionsを使用して設定変更します。
具体的には以下のパターンの挙動を確認します。

.ebextensionsでのみ設定した項目
上位の設定オプション(保存済み設定)と競合する項目

構築する環境

Diagram of checking the behavior of .extensions in Elastic Beanstalk.

最小構成のElastic Beanstalk環境を構築します。
Elastic Beanstalkの環境はWebサーバーを選択します。
プラットフォームはPython3.8を選択します。

本構成において、.ebextensionsの挙動を確認します。

具体的には、CodeBuildでElastic Beanstalk用のソースバンドルをビルドしますが、.ebextensionsも同様に作成します。
このCodeBuildを実行するトリガーは、CloudFormationカスタムリソースを使用します。

CloudFormationテンプレートファイル

上記の構成をCloudFormationで構築します。
以下のURLにCloudFormationテンプレートを配置しています。

https://github.com/awstut-an-r/awstut-dva/tree/main/01/002

テンプレートファイルのポイント解説

本ページでは、.ebextensionsの挙動を確認することを目的としています。

具体的には、保存された設定および.ebestensionsで以下の通りに設定を試みます。

設定項目	保存された設定	.ebextensions
aws:elasticbeanstalk:environment EnvironmentType	SingleInstance	LoadBalanced
aws:autoscaling:launchconfiguration IamInstanceProfile	InstanceProfile	–
aws:autoscaling:launchconfiguration InstanceType	–	t3.nano

Elastic Beanstalkに関する基本的な事項については、以下のページをご確認ください。

CodeBuild

Resources:
  CodeBuildProject:
    Type: AWS::CodeBuild::Project
    Properties:
      Artifacts:
        Type: NO_ARTIFACTS
      Cache:
        Type: NO_CACHE
      Environment:
        ComputeType: !Ref ProjectEnvironmentComputeType
        EnvironmentVariables:
          - Name: BUCKET_NAME
            Type: PLAINTEXT
            Value: !Ref BucketName
          - Name: ENVIRONMENT_TYPE
            Type: PLAINTEXT
            Value: !Ref EnvironmentType
          - Name: INSTANCE_TYPE
            Type: PLAINTEXT
            Value: !Ref InstanceType
          - Name: SOURCE_BUNDLE_NAME
            Type: PLAINTEXT
            Value: !Ref SourceBundleName
          - Name: SOURCE_FILE_NAME
            Type: PLAINTEXT
            Value: !Ref SourceFileName
        Image: !Ref ProjectEnvironmentImage
        ImagePullCredentialsType: CODEBUILD
        Type: !Ref ProjectEnvironmentType
        PrivilegedMode: true
      LogsConfig:
        CloudWatchLogs:
          Status: DISABLED
        S3Logs:
          Status: DISABLED
      Name: !Ref Prefix
      ServiceRole: !GetAtt CodeBuildRole.Arn
      Source:
        Type: NO_SOURCE
        BuildSpec: !Sub |
          version: 0.2

          phases:
            pre_build:
              commands:
                - |
                  cat << EOF > $SOURCE_FILE_NAME
                  import datetime

                  def application(environ, start_response):
                      response = str(datetime.datetime.now())
                      start_response("200 OK", [
                          ("Content-Type", "text/html")
                      ])
                      return [bytes(response, 'utf-8')]
                  EOF
                - mkdir .ebextensions
                - |
                  cat << EOF > .ebextensions/sample.config
                  option_settings:
                    aws:elasticbeanstalk:environment:
                      EnvironmentType: $ENVIRONMENT_TYPE
                    aws:autoscaling:launchconfiguration:
                      InstanceType: $INSTANCE_TYPE
                  EOF
            build:
              commands:
                - zip $SOURCE_BUNDLE_NAME -r * .[^.]*
            post_build:
              commands:
                - aws s3 cp $SOURCE_BUNDLE_NAME s3://$BUCKET_NAME/
      Visibility: PRIVATE
Code language: YAML (yaml)

CodeBuildを使用して、Elastic Beanstalk用のソースバンドルを作成します。

BuildSpecプロパティでbuildspec.yamlの中身を記載します。

pre_buildフェーズで2つのファイルを作成します。

1つ目はElastic Beanstalk上で実行するPythonスクリプトです。
現在日時を返すシンプルな内容です。

2つ目は.ebextensions用の設定ファイルです。
今回はsample.configという名前とします。
環境タイプを「LoadBalanced」に、インスタンスタイプを「t3.nano」に設定する内容です。
後述する.ebextensionsにおいて、前者は設定し、後者は設定しません。

これらのファイルを以下のディレクトリ構造で配置します。

% tree -a
.
├── .ebextensions
│   └── sample.config
└── application.pyCode language: plaintext (plaintext)

これをZIP化してS3バケットに配置し、Elastic Beanstalk用ソースバンドルとします。

Elastic Beanstalk Configuration Template

Resources:
  ConfigurationTemplate:
    Type: AWS::ElasticBeanstalk::ConfigurationTemplate
    Properties:
      ApplicationName: !Ref Application
      OptionSettings:
        - Namespace: aws:autoscaling:launchconfiguration
          OptionName: IamInstanceProfile
          Value: !Ref InstanceProfile
        - Namespace: aws:elasticbeanstalk:environment
          OptionName: EnvironmentType
          Value: !Ref EnvironmentType
        - Namespace: aws:elasticbeanstalk:environment
          OptionName: ServiceRole
          Value: !Sub "arn:aws:iam::${AWS::AccountId}:role/service-role/aws-elasticbeanstalk-service-role"
        - Namespace: aws:ec2:vpc
          OptionName: VPCId
          Value: !Ref VPC
        - Namespace: aws:ec2:vpc
          OptionName: Subnets
          Value: !Ref PublicSubnet1
      SolutionStackName: !Ref SolutionStackName

  InstanceProfile:
    Type: AWS::IAM::InstanceProfile
    Properties:
      Path: /
      Roles:
        - !Ref InstanceRole

  InstanceRole:
    Type: AWS::IAM::Role
    DeletionPolicy: Delete
    Properties:
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Effect: Allow
            Action: sts:AssumeRole
            Principal:
              Service:
                - ec2.amazonaws.com
      ManagedPolicyArns:
        - arn:aws:iam::aws:policy/AWSElasticBeanstalkWebTier
Code language: YAML (yaml)