3.1. 起動設定の作成 (ユーザデータ)

作業の目的 [why]

AutoScaling起動設定"handson-lc-2017-10-09"を作成します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1
AutoScaling起動設定"handson-lc-2017-10-09"が存在する。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1
設定ファイル用ディレクトリが存在する。
事前条件2
AutoScaling起動設定"handson-lc-2017-10-09"が存在しない。
事前条件3
VPC"vpc-handson-2017-10-09"が存在する。
事前条件4
セキュリティグループ"webserver-handson-2017-10-09"が存在する。
事前条件5
AMI"amzn-ami-hvm-2017.09.0.20170930-x86_64-gp2"が存在する。
事前条件6
ユーザデータファイル"${HOME}/tmp/conf-vpc/2017-10-09-handson-lc-2017-10-09-userdata.bash"が存在する。

前提と異なることが判明した場合、直ちに処理を中止します。

課題

(未検証)

作業対象 [what]

  • AutoScalingサービス

標準時間

8分

前提条件

作業権限条件 [who]

本作業は、以下の作業権限を有する人が行います。

作業権限条件: AutoScalingへの権限

AutoScalingに対してフル権限があること。

作業環境条件 [where]

本作業は、以下の作業環境で行います。

作業環境条件1: OSとバージョン

Amazon Linuxの以下のバージョンで動作確認済

コマンド:

cat /etc/issue | head -1

結果(例):

Amazon Linux AMI release 2016.09

作業環境条件2: シェルとバージョン

bashの以下のバージョンで動作確認済

コマンド:

bash --version -v | head -1

結果(例):

GNU bash, バージョン 4.2.46(1)-release (x86_64-redhat-linux-gnu)

作業環境条件3: AWS CLIのバージョン

以下のバージョンで動作確認済

  • AWS CLI 1.11.117

コマンド:

aws --version

結果(例):

aws-cli/1.11.166 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.7.24

バージョンが古い場合は最新版に更新しましょう。

コマンド:

sudo -H pip install -U awscli

開始条件

作業に必要なモノ・情報 [resource]

作業開始には、以下が全て揃っていることが必要です。

リソース1: 設定ファイル用ディレクトリ

  • 今回は"${HOME}/tmp/conf-vpc"を設定ファイル用ディレクトリとします。

    ls ${HOME}/tmp/conf-vpc

  • 存在しない場合は作成します。

    mkdir -p ${HOME}/tmp/conf-vpc

リソース2: AutoScaling起動設定名

  • 作成するAutoScaling起動設定の名称です。
  • 今回は"handson-lc-2017-10-09"とします。

リソース3: AMI名

  • 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するAMIの名称です。
  • 今回は"amzn-ami-hvm-2017.09.0.20170930-x86_64-gp2"とします。

リソース4: VPCのタグ名

  • セキュリティグループの属するVPCのタグ名称です。
  • 今回は"vpc-handson-2017-10-09"とします。

リソース5: セキュリティグループ名

  • 作成するAutoScaling起動設定で起動するEC2インスタンスに設定するセキュリティグループの名称です。
  • 今回は"webserver-handson-2017-10-09"とします。

リソース6: インスタンスタイプ

  • 作成するAutoScaling起動設定で起動するEC2インスタンスのインスタンスタイプです。
  • 今回は"t2.micro"とします。

リソース7: ユーザデータファイル名

  • 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するユーザデータのファイル名です。
  • 今回は"${HOME}/tmp/conf-vpc/2017-10-09-handson-lc-2017-10-09-userdata.bash"とします。

作業開始 [when]

以下を全て満たしているとき、作業を開始します。

  • 開始の指示があった場合。

タスクの実施

0. パラメータの指定

まず変数の確認をします。

変数の確認:

cat << ETX

  0.a. AWS_DEFAULT_PROFILE:   actual: ${AWS_DEFAULT_PROFILE}
                              expect: <IAMのフル権限を許可されたプロファイル>
  0.b. AWS_DEFAULT_REGION:    actual: ${AWS_DEFAULT_REGION}
                              expect: ap-northeast-1

  0.1. DIR_CONF:              actual: ${DIR_CONF}
                              expect: ${HOME}/tmp/conf-vpc
  0.2. AS_LAUNCH_CONFIG_NAME: actual: ${AS_LAUNCH_CONFIG_NAME}
                              expect: handson-lc-2017-10-09
  0.3. VPC_TAG_NAME:          actual: ${VPC_TAG_NAME}
                              expect: vpc-handson-2017-10-09
  0.4. VPC_SG_NAME:           actual: ${VPC_SG_NAME}
                              expect: webserver-handson-2017-10-09
  0.5. EC2_IMAGE_NAME:        actual: ${EC2_IMAGE_NAME}
                              expect: amzn-ami-hvm-2017.09.0.20170930-x86_64-gp2
  0.6. EC2_INSTANCE_TYPE:     actual: ${EC2_INSTANCE_TYPE}
                              expect: t2.micro
  0.7. FILE_EC2_USERDATA:     actual: ${FILE_EC2_USERDATA}
                              expect: ${HOME}/tmp/conf-vpc/2017-10-09-handson-lc-2017-10-09-userdata.bash

ETX

変数が入っていない、適切でない場合は、それぞれの手順番号について作業を行います。

0.a. プロファイルの指定

プロファイルの一覧を確認します。

コマンド:

cat ~/.aws/credentials \
 | grep '\[' \
 | sed 's/\[//g' | sed 's/\]//g'

結果(例):

iamFull-prjz-mbpr13
<IAMのフル権限を許可されたプロファイル>

変数の設定:

export AWS_DEFAULT_PROFILE='<IAMのフル権限を許可されたプロファイル>'

0.b. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. 設定ファイルディレクトリの指定

変数の設定:

DIR_CONF="${HOME}/tmp/conf-vpc"

0.2. AutoScaling起動設定名の指定

AutoScaling起動設定名を指定します。

変数の設定:

AS_LAUNCH_CONFIG_NAME='handson-lc-2017-10-09'

0.3. AMI名の指定

作成するAutoScaling起動設定で起動するEC2インスタンスが利用するAMIの名称を指定します。

変数の設定:

EC2_IMAGE_NAME='amzn-ami-hvm-2017.09.0.20170930-x86_64-gp2'

0.4. VPCのタグ名の指定

セキュリティグループの属するVPCのタグ名称を指定します。

変数の設定:

VPC_TAG_NAME='vpc-handson-2017-10-09'

0.5. セキュリティグループ名の指定

作成するAutoScaling起動設定で起動するEC2インスタンスに設定するセキュリティグループの名称を指定します。

変数の設定:

VPC_SG_NAME='webserver-handson-2017-10-09'

0.6. インスタンスタイプの指定

作成するAutoScaling起動設定で起動するEC2インスタンスのインスタンスタイプを指定します。

変数の設定:

EC2_INSTANCE_TYPE='t2.micro'

0.7. ユーザデータファイル名の指定

作成するAutoScaling起動設定で起動するEC2インスタンスが利用するユーザデータのファイル 名を指定します。

変数の設定:

FILE_EC2_USERDATA="${DIR_CONF}/$(date +%Y-%m-%d)-${AS_LAUNCH_CONFIG_NAME}-userdata.bash" \
  && echo ${FILE_EC2_USERDATA}

結果(例):

${HOME}/tmp/conf-vpc/2017-10-09-handson-lc-2017-10-09-userdata.bash

再確認

設定されている変数の内容を再確認します。

変数の確認:

cat << ETX

  0.a. AWS_DEFAULT_PROFILE:   actual: ${AWS_DEFAULT_PROFILE}
                              expect: <IAMのフル権限を許可されたプロファイル>
  0.b. AWS_DEFAULT_REGION:    actual: ${AWS_DEFAULT_REGION}
                              expect: ap-northeast-1

  0.1. DIR_CONF:              actual: ${DIR_CONF}
                              expect: ${HOME}/tmp/conf-vpc
  0.2. AS_LAUNCH_CONFIG_NAME: actual: ${AS_LAUNCH_CONFIG_NAME}
                              expect: handson-lc-2017-10-09
  0.3. VPC_TAG_NAME:          actual: ${VPC_TAG_NAME}
                              expect: vpc-handson-2017-10-09
  0.4. VPC_SG_NAME:           actual: ${VPC_SG_NAME}
                              expect: webserver-handson-2017-10-09
  0.5. EC2_IMAGE_NAME:        actual: ${EC2_IMAGE_NAME}
                              expect: amzn-ami-hvm-2017.09.0.20170930-x86_64-gp2
  0.6. EC2_INSTANCE_TYPE:     actual: ${EC2_INSTANCE_TYPE}
                              expect: t2.micro
  0.7. FILE_EC2_USERDATA:     actual: ${FILE_EC2_USERDATA}
                              expect: ${HOME}/tmp/conf-vpc/2017-10-09-handson-lc-2017-10-09-userdata.bash

ETX

1. 前処理

処理対象の状態確認

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: 設定ファイル用ディレクトリが存在する。

「設定ファイル用ディレクトリが存在する。」ことを確認します。

コマンド:

ls -d ${DIR_CONF}

結果(例):

${HOME}/tmp/conf-vpc

事前条件2: AutoScaling起動設定"handson-lc-2017-10-09"が存在しない。

「AutoScaling起動設定"handson-lc-2017-10-09"が存在しない。」ことを確認します。

コマンド:

aws autoscaling describe-launch-configurations \
  --launch-configuration-names ${AS_LAUNCH_CONFIG_NAME} \
  --query 'LaunchConfigurations[].LaunchConfigurationName'

結果(例):

(出力なし)

事前条件3: VPC"vpc-handson-2017-10-09"が存在する。

「VPC"vpc-handson-2017-10-09"が存在する。」ことを確認します。

変数の設定:

EC2_TAG_KEY='Name'

コマンド:

aws ec2 describe-vpcs \
  --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_TAG_NAME}  \
  --query "Vpcs[].Tags[].Value"

結果(例):

[
  "vpc-handson-2017-10-09"
]

VPC IDを取得します。

コマンド:

VPC_ID=$( \
  aws ec2 describe-vpcs \
    --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_TAG_NAME}  \
    --query 'Vpcs[].VpcId' \
    --output text \
) \
  && echo ${VPC_ID}

結果(例):

vpc-xxxxxxxx

事前条件4: セキュリティグループ"webserver-handson-2017-10-09"が存在する。

「セキュリティグループ"webserver-handson-2017-10-09"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-security-groups \
  --filter Name=vpc-id,Values=${VPC_ID} \
    Name=group-name,Values=${VPC_SG_NAME} \
  --query 'SecurityGroups[].GroupName'

結果(例):

[
  "webserver-handson-2017-10-09"
]

セキュリティグループIDを取得します。

コマンド:

VPC_SG_ID=$( \
  aws ec2 describe-security-groups \
    --filter Name=vpc-id,Values=${VPC_ID} \
      Name=group-name,Values=${VPC_SG_NAME} \
    --query "SecurityGroups[].GroupId" \
    --output text \
) \
  && echo ${VPC_SG_ID}

結果(例):

sg-xxxxxxxx

事前条件5: AMI"amzn-ami-hvm-2017.09.0.20170930-x86_64-gp2"が存在する。

「AMI"amzn-ami-hvm-2017.09.0.20170930-x86_64-gp2"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-images \
  --filter "Name=name, Values=${EC2_IMAGE_NAME}" \
  --query 'Images[].Name'

結果(例):

[
  "amzn-ami-hvm-2017.09.0.20170930-x86_64-gp2"
]

イメージIDを取得します。

コマンド:

EC2_IMAGE_ID=$( \
  aws ec2 describe-images \
    --filters Name=name,Values="${EC2_IMAGE_NAME}" \
    --query 'Images[].ImageId' \
    --output text \
) \
  && echo ${EC2_IMAGE_ID}

結果(例):

ami-XXXXXXXX

事前条件6: ユーザデータファイル"${HOME}/tmp/conf-vpc/2017-10-09-handson-lc-2017-10-09-userdata.bash"が存在する。

「ユーザデータファイル"${HOME}/tmp/conf-vpc/2017-10-09-handson-lc-2017-10-09-userdata.bash"が存在する。」ことを確認します。

コマンド:

ls -1 ${FILE_EC2_USERDATA}

結果(例):

${HOME}/tmp/conf-vpc/2017-10-09-handson-lc-2017-10-09-userdata.bash

1.3. 主処理に必要な情報の取得

セキュリティグループIDの配列への格納

変数の設定:

ARRAY_VPC_SG_IDS="${VPC_SG_ID}" \
  && echo ${ARRAY_VPC_SG_IDS}

2. 主処理

起動設定の作成

変数の確認:

cat << ETX

  AS_LAUNCH_CONFIG_NAME actual: ${AS_LAUNCH_CONFIG_NAME}
                        expect: handson-lc-2017-10-09
  EC2_IMAGE_ID          actual: ${EC2_IMAGE_ID}
                        expect: ami-2a69be4c
  ARRAY_VPC_SG_IDS      actual: ${ARRAY_VPC_SG_IDS}
                        expect: sg-xxxxxxxx
  EC2_INSTANCE_TYPE     actual: ${EC2_INSTANCE_TYPE}
                        expect: t2.micro
  FILE_EC2_USERDATA     actual: ${FILE_EC2_USERDATA}
                        expect: ${HOME}/tmp/conf-vpc/2017-10-09-handson-lc-2017-10-09-userdata.bash

ETX

コマンド:

aws autoscaling create-launch-configuration \
  --launch-configuration-name ${AS_LAUNCH_CONFIG_NAME} \
  --image-id ${EC2_IMAGE_ID} \
  --security-groups ${ARRAY_VPC_SG_IDS} \
  --instance-type ${EC2_INSTANCE_TYPE} \
  --user-data file://${FILE_EC2_USERDATA}

結果(例):

(出力なし)

3. 後処理

完了条件の確認

主処理は、以下を満たしたときに成功したものとします。

完了条件1: AutoScaling起動設定"handson-lc-2017-10-09"が存在する。

「AutoScaling起動設定"handson-lc-2017-10-09"が存在する。」ことを確認します。

コマンド:

aws autoscaling describe-launch-configurations \
  --launch-configuration-names ${AS_LAUNCH_CONFIG_NAME} \
  --query 'LaunchConfigurations[].LaunchConfigurationName'

結果(例):

[
  "handson-lc-2017-10-09"
]

完了