3.1. 起動設定の作成 (lc-handson-cli)¶
作業の目的 [why]¶
AutoScaling起動設定"lc-handson-cli"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- AutoScaling起動設定"lc-handson-cli"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- AutoScaling起動設定"lc-handson-cli"が存在しない。
- 事前条件2
- AMI"amzn-ami-2017.09.f-amazon-ecs-optimized"が存在する。
- 事前条件3
- VPC"vpc-handson-cli"が存在する。
- 事前条件4
- VPC"vpc-handson-cli"にセキュリティグループ"webapp-handson-cli"が存在する。
- 事前条件5
- ユーザデータファイル"${HOME}/tmp/conf-autoscaling/ecs-cluster-handson-cli.bash"が存在する。
- 事前条件6
- IAMインスタンスプロファイル"ecsInstanceProfile"が存在する。
前提と異なることが判明した場合、直ちに処理を中止します。
作業対象 [what]¶
- AutoScalingサービス
標準時間¶
8分
前提条件¶
作業環境条件 [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.14.28
コマンド:
aws --version
結果(例):
aws-cli/1.14.31 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.8.35
バージョンが古い場合は最新版に更新しましょう。
コマンド:
sudo -H pip install -U awscli
開始条件¶
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: AutoScaling起動設定名
- 作成するAutoScaling起動設定の名称です。
- 今回は"lc-handson-cli"とします。
リソース2: AMI名
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するAMIの名称です。
- 今回は"amzn-ami-2017.09.f-amazon-ecs-optimized"とします。
リソース3: VPCのタグ名
- セキュリティグループの属するVPCのタグ名称です。
- 今回は"vpc-handson-cli"とします。
リソース4: セキュリティグループ名
- 作成するAutoScaling起動設定で起動するEC2インスタンスに設定するセキュリティグループの名称です。
- 今回は"webapp-handson-cli"とします。
リソース5: ユーザデータファイル名
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するユーザデータのファイル名です。
- 今回は"${HOME}/tmp/conf-autoscaling/ecs-cluster-handson-cli.bash"とします。
リソース6: インスタンスタイプ
- 作成するAutoScaling起動設定で起動するEC2インスタンスのインスタンスタイプです。
- 今回は"t2.micro"とします。
リソース7: EBSボリュームのデバイス名
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのデバイス名です。
- 今回は"/dev/xvdcz"とします。
リソース8: EBSボリュームのサイズ
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのサイズです。
- 今回は"22"とします。
リソース9: EBSボリュームのタイプ
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのタイプです。
- 今回は"gp2"とします。
リソース10: IAMインスタンスプロファイル名
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するIAMインスタンスプロファイルの名称です。
- 今回は"ecsInstanceProfile"とします。
タスクの実施¶
0. パラメータの指定¶
まず変数の確認をします。
変数の確認:
cat << ETX # 0.a. AWS_DEFAULT_PROFILE:"<AutoScalingのフル権限を許可されたプロファイル>" AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}" # 0.b. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. AS_LAUNCH_CONFIG_NAME:"lc-handson-cli" AS_LAUNCH_CONFIG_NAME="${AS_LAUNCH_CONFIG_NAME}" # 0.2. EC2_IMAGE_NAME:"amzn-ami-2017.09.f-amazon-ecs-optimized" EC2_IMAGE_NAME="${EC2_IMAGE_NAME}" # 0.3. VPC_TAG_NAME:"vpc-handson-cli" VPC_TAG_NAME="${VPC_TAG_NAME}" # 0.4. VPC_SG_NAME:"webapp-handson-cli" VPC_SG_NAME="${VPC_SG_NAME}" # 0.5. FILE_EC2_USERDATA:"${HOME}/tmp/conf-autoscaling/ecs-cluster-handson-cli.bash" FILE_EC2_USERDATA="${FILE_EC2_USERDATA}" # 0.6. EC2_INSTANCE_TYPE:"t2.micro" EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}" # 0.7. EC2_VOLUME_DEVICE_NAME:"/dev/xvdcz" EC2_VOLUME_DEVICE_NAME="${EC2_VOLUME_DEVICE_NAME}" # 0.8. EC2_VOLUME_SIZE:"22" EC2_VOLUME_SIZE="${EC2_VOLUME_SIZE}" # 0.9. EC2_VOLUME_TYPE:"gp2" EC2_VOLUME_TYPE="${EC2_VOLUME_TYPE}" # 0.10. IAM_INSTANCE_PROFILE_NAME:"ecsInstanceProfile" IAM_INSTANCE_PROFILE_NAME="${IAM_INSTANCE_PROFILE_NAME}" ETX
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号について作業を行います。
0.2. AMI名の指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するAMIの名称を指定します。
変数の設定:
EC2_IMAGE_NAME='amzn-ami-2017.09.f-amazon-ecs-optimized'
0.4. セキュリティグループ名の指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスに設定するセキュリティグループの名称を指定します。
変数の設定:
VPC_SG_NAME='webapp-handson-cli'
0.5. ユーザデータファイル名の指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するユーザデータのファイル名を指定します。
変数の設定:
FILE_EC2_USERDATA="${HOME}/tmp/conf-autoscaling/ecs-cluster-handson-cli.bash" \ && echo ${FILE_EC2_USERDATA}
結果(例):
${HOME}/tmp/conf-autoscaling/ecs-cluster-handson-cli.bash
0.6. インスタンスタイプの指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスのインスタンスタイプを指定します。
変数の設定:
EC2_INSTANCE_TYPE='t2.micro'
0.7. EBSボリュームデバイス名の指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのデバイス名を指定します。
変数の設定:
EC2_VOLUME_DEVICE_NAME='/dev/xvdcz'
0.8. EBSボリュームサイズの指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのサイズを指定します。
変数の設定:
EC2_VOLUME_SIZE='22'
0.9. EBSボリュームタイプの指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのタイプを指定します。
変数の設定:
EC2_VOLUME_TYPE='gp2'
0.10. IAMインスタンスプロファイルの指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するIAMインスタンスプロファイルを指定します。
変数の設定:
IAM_INSTANCE_PROFILE_NAME='ecsInstanceProfile'
再確認¶
設定されている変数の内容を再確認します。
変数の確認:
cat << ETX # 0.a. AWS_DEFAULT_PROFILE:"<AutoScalingのフル権限を許可されたプロファイル>" AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}" # 0.b. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. AS_LAUNCH_CONFIG_NAME:"lc-handson-cli" AS_LAUNCH_CONFIG_NAME="${AS_LAUNCH_CONFIG_NAME}" # 0.2. EC2_IMAGE_NAME:"amzn-ami-2017.09.f-amazon-ecs-optimized" EC2_IMAGE_NAME="${EC2_IMAGE_NAME}" # 0.3. VPC_TAG_NAME:"vpc-handson-cli" VPC_TAG_NAME="${VPC_TAG_NAME}" # 0.4. VPC_SG_NAME:"webapp-handson-cli" VPC_SG_NAME="${VPC_SG_NAME}" # 0.5. FILE_EC2_USERDATA:"${HOME}/tmp/conf-autoscaling/ecs-cluster-handson-cli.bash" FILE_EC2_USERDATA="${FILE_EC2_USERDATA}" # 0.6. EC2_INSTANCE_TYPE:"t2.micro" EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}" # 0.7. EC2_VOLUME_DEVICE_NAME:"/dev/xvdcz" EC2_VOLUME_DEVICE_NAME="${EC2_VOLUME_DEVICE_NAME}" # 0.8. EC2_VOLUME_SIZE:"22" EC2_VOLUME_SIZE="${EC2_VOLUME_SIZE}" # 0.9. EC2_VOLUME_TYPE:"gp2" EC2_VOLUME_TYPE="${EC2_VOLUME_TYPE}" # 0.10. IAM_INSTANCE_PROFILE_NAME:"ecsInstanceProfile" IAM_INSTANCE_PROFILE_NAME="${IAM_INSTANCE_PROFILE_NAME}" ETX
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: AutoScaling起動設定"lc-handson-cli"が存在しない。
「AutoScaling起動設定"lc-handson-cli"が存在しない。」ことを確認します。
コマンド:
aws autoscaling describe-launch-configurations \ --launch-configuration-names ${AS_LAUNCH_CONFIG_NAME} \ --query 'LaunchConfigurations[].LaunchConfigurationName'
結果(例):
[]
事前条件2: AMI"amzn-ami-2017.09.f-amazon-ecs-optimized"が存在する。
「AMI"amzn-ami-2017.09.f-amazon-ecs-optimized"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-images \ --filter "Name=name, Values=${EC2_IMAGE_NAME}" \ --query 'Images[].Name'
結果(例):
[ "amzn-ami-2017.09.f-amazon-ecs-optimized" ]
事前条件3: VPC"vpc-handson-cli"が存在する。
「VPC"vpc-handson-cli"が存在する。」ことを確認します。
変数の設定:
EC2_TAG_KEY='Name'
コマンド:
aws ec2 describe-vpcs \ --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_TAG_NAME} \ --query "Vpcs[].Tags[].Value"
結果(例):
[ "vpc-handson-cli" ]
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: VPC"vpc-handson-cli"にセキュリティグループ"webapp-handson-cli"が存在する。
「VPC"vpc-handson-cli"にセキュリティグループ"webapp-handson-cli"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-security-groups \ --filter Name=vpc-id,Values=${VPC_ID} \ Name=group-name,Values=${VPC_SG_NAME} \ --query 'SecurityGroups[].GroupName'
結果(例):
[ "webapp-handson-cli" ]
事前条件5: ユーザデータファイル"${HOME}/tmp/conf-autoscaling/ecs-cluster-handson-cli.bash"が存在する。
「ユーザデータファイル"${HOME}/tmp/conf-autoscaling/ecs-cluster-handson-cli.bash"が存在する。」ことを確認します。
コマンド:
ls ${FILE_EC2_USERDATA}
結果(例):
${HOME}/tmp/conf-autoscaling/ecs-cluster-handson-cli.bash
事前条件6: IAMインスタンスプロファイル"ecsInstanceProfile"が存在する。
「IAMインスタンスプロファイル"ecsInstanceProfile"が存在する。」ことを確認します。
コマンド:
aws iam list-instance-profiles \ --query "InstanceProfiles[?InstanceProfileName == \`${IAM_INSTANCE_PROFILE_NAME}\`].InstanceProfileName"
結果(例):
[ "ecsInstanceProfile" ]
1.2. 主処理に必要な情報の取得¶
イメージ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
セキュリティグループ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
セキュリティグループIDの配列への格納
変数の設定:
ARRAY_VPC_SG_IDS="${VPC_SG_ID}" \ && echo ${ARRAY_VPC_SG_IDS}
結果(例):
sg-xxxxxxxx
ブロックデバイスマッピングの文字列取得
変数の設定:
STRING_BLOCK_DEVICE_MAPPINGS="DeviceName=${EC2_VOLUME_DEVICE_NAME},Ebs={VolumeSize=${EC2_VOLUME_SIZE},VolumeType=${EC2_VOLUME_TYPE}}" \ && echo ${STRING_BLOCK_DEVICE_MAPPINGS}
結果(例):
DeviceName=/dev/xvdcz,Ebs={VolumeSize=22,VolumeType=gp2}
2. 主処理¶
起動設定の作成¶
変数の確認:
cat << ETX # AS_LAUNCH_CONFIG_NAME:"lc-handson-cli" AS_LAUNCH_CONFIG_NAME="${AS_LAUNCH_CONFIG_NAME}" # EC2_IMAGE_ID:"ami-xxxxxxxx" EC2_IMAGE_ID="${EC2_IMAGE_ID}" # ARRAY_VPC_SG_IDS:"sg-xxxxxxxx" ARRAY_VPC_SG_IDS="${ARRAY_VPC_SG_IDS}" # FILE_EC2_USERDATA:"${HOME}/tmp/conf-autoscaling/ecs-cluster-handson-cli.bash" FILE_EC2_USERDATA="${FILE_EC2_USERDATA}" # EC2_INSTANCE_TYPE:"t2.micro" EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}" # STRING_BLOCK_DEVICE_MAPPINGS:"DeviceName=/dev/xvdcz,Ebs={VolumeSize=22,VolumeType=gp2}" STRING_BLOCK_DEVICE_MAPPINGS="${STRING_BLOCK_DEVICE_MAPPINGS}" # IAM_INSTANCE_PROFILE_NAME:"ecsInstanceProfile" IAM_INSTANCE_PROFILE_NAME="${IAM_INSTANCE_PROFILE_NAME}" ETX
コマンド:
aws autoscaling create-launch-configuration \ --launch-configuration-name ${AS_LAUNCH_CONFIG_NAME} \ --image-id ${EC2_IMAGE_ID} \ --security-groups ${ARRAY_VPC_SG_IDS} \ --user-data file://${FILE_EC2_USERDATA} \ --instance-type ${EC2_INSTANCE_TYPE} \ --block-device-mappings ${STRING_BLOCK_DEVICE_MAPPINGS} \ --iam-instance-profile ${IAM_INSTANCE_PROFILE_NAME} \ --associate-public-ip-address
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: AutoScaling起動設定"lc-handson-cli"が存在する。
「AutoScaling起動設定"lc-handson-cli"が存在する。」ことを確認します。
コマンド:
aws autoscaling describe-launch-configurations \ --launch-configuration-names ${AS_LAUNCH_CONFIG_NAME} \ --query 'LaunchConfigurations[].LaunchConfigurationName'
結果(例):
[ "lc-handson-cli" ]