2.1. EC2起動テンプレートドキュメントの作成 (handson-cli-webapp-stateless-launchtemplate)¶
作業の目的 [why]¶
EC2起動テンプレート用ドキュメント名""を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- EC2起動テンプレート用ドキュメントファイル"${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- EC起動テンプレートドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli-webapp-stateless"が存在する。
- 事前条件2
- EC2起動テンプレート用ドキュメントファイル"${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json"が存在しない。
- 事前条件3
- AMI"handson-cli-webapp-stateless-1"が存在する。
- 事前条件4
- VPC"handson-cli-vpc"が存在する。
- 事前条件5
- VPC"handson-cli-vpc"にセキュリティグループ"handson-cli-webapp-sg"が存在する。
作業対象 [what]¶
- ローカル環境
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: EC2起動テンプレートドキュメント用ディレクトリ
- 今回は"${HOME}/tmp/conf-handson-cli-webapp-stateless"をEC2起動テンプレートドキュメント用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d ${HOME}/tmp/conf-handson-cli-webapp-stateless
結果(例:存在する場合):
${HOME}/tmp/conf-handson-cli-webapp-stateless
存在しない場合は作成します。
コマンド:
mkdir -p ${HOME}/tmp/conf-handson-cli-webapp-stateless
リソース2: EC2起動テンプレートドキュメント名
- 作成するEC2起動テンプレートドキュメントのファイル名です。
- 今回は"${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json"とします。
リソース3: AMI名
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するAMIの名称です。
- 今回は"handson-cli-webapp-stateless-1"とします。
リソース4: VPCのタグ名
- セキュリティグループの属するVPCのタグ名称です。
- 今回は"handson-cli-vpc"とします。
リソース5: セキュリティグループ名
- 作成するAutoScaling起動設定で起動するEC2インスタンスに設定するセキュリティグループの名称です。
- 今回は"handson-cli-webapp-sg"とします。
リソース6: インスタンスタイプ
- 作成するAutoScaling起動設定で起動するEC2インスタンスのインスタンスタイプです。
- 今回は"t2.micro"とします。
リソース7: EBSボリュームのサイズ
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのサイズです。
- 今回は"8"とします。
リソース8: EBSボリュームのタイプ
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのタイプです。
- 今回は"gp2"とします。
リソース9: EBSボリュームデバイス名
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのデバイス名です。
- 今回は"/dev/xvda"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. EC2起動テンプレートドキュメント用ディレクトリの指定¶
変数の設定:
DIR_EC2_LAUNCH_TEMPLATE_DOC="${HOME}/tmp/conf-handson-cli-webapp-stateless" \ && echo ${DIR_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli-webapp-stateless
0.2. EC2起動テンプレートドキュメント名の指定¶
EC2起動テンプレート名を指定します。
変数の設定:
EC2_LAUNCH_TEMPLATE_NAME='handson-cli-webapp-stateless-launchtemplate'
EC2起動テンプレートドキュメント名を指定します。
変数の設定:
FILE_EC2_LAUNCH_TEMPLATE_DOC="${DIR_EC2_LAUNCH_TEMPLATE_DOC}/${EC2_LAUNCH_TEMPLATE_NAME}.json" \ && echo ${FILE_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json
0.3. AMI名の指定¶
作成する起動テンプレートで起動するEC2インスタンスが利用するAMIの名称を指定します。
変数の設定:
EC2_IMAGE_NAME='handson-cli-webapp-stateless-1'
0.5. セキュリティグループ名の指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスに設定するセキュリティグループ の名称を指定します。
変数の設定:
VPC_SG_NAME='handson-cli-webapp-sg'
0.6. インスタンスタイプの指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスのインスタンスタイプを指定しま す。
変数の設定:
EC2_INSTANCE_TYPE='t2.micro'
0.7. EBSボリュームサイズの指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのサイズを指定します。
変数の設定:
EC2_VOLUME_SIZE='8'
0.8. EBSボリュームタイプの指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのタイプを指定します。
変数の設定:
EC2_VOLUME_TYPE='gp2'
0.9. EBSボリュームデバイス名の指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するEBSボリュームのデバイス名を指定しま す。
変数の設定:
EC2_VOLUME_DEVICE_NAME='/dev/xvda'
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-webapp-stateless" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-launch_template_document-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-webapp-stateless/2019-05-19-ec2-launch_template_document-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_EC2_LAUNCH_TEMPLATE_DOC:"${HOME}/tmp/conf-handson-cli-webapp-stateless" DIR_EC2_LAUNCH_TEMPLATE_DOC="${DIR_EC2_LAUNCH_TEMPLATE_DOC}" # 0.2. FILE_EC2_LAUNCH_TEMPLATE_DOC:"${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json" FILE_EC2_LAUNCH_TEMPLATE_DOC="${FILE_EC2_LAUNCH_TEMPLATE_DOC}" # 0.3. EC2_IMAGE_NAME:"handson-cli-webapp-stateless-1" EC2_IMAGE_NAME="${EC2_IMAGE_NAME}" # 0.4. VPC_TAG_NAME:"handson-cli-vpc" VPC_TAG_NAME="${VPC_TAG_NAME}" # 0.5. VPC_SG_NAME:"handson-cli-webapp-sg" VPC_SG_NAME="${VPC_SG_NAME}" # 0.6. EC2_INSTANCE_TYPE:"t2.micro" EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}" # 0.7. EC2_VOLUME_SIZE:"8" EC2_VOLUME_SIZE="${EC2_VOLUME_SIZE}" # 0.8. EC2_VOLUME_TYPE:"gp2" EC2_VOLUME_TYPE="${EC2_VOLUME_TYPE}" # 0.9. EC2_VOLUME_DEVICE_NAME:"/dev/xvda" EC2_VOLUME_DEVICE_NAME="${EC2_VOLUME_DEVICE_NAME}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
課題
(未検証)
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: EC起動テンプレートドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli-webapp-stateless"が存在する。
「EC起動テンプレートドキュメント用ディレクトリ"${HOME}/tmp/conf-handson-cli-webapp-stateless"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli-webapp-stateless
事前条件2: EC2起動テンプレート用ドキュメントファイル"${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json"が存在しない。
「EC2起動テンプレート用ドキュメントファイル"${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json"が存在しない。」ことを確認します。
コマンド:
! ls ${FILE_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
ls: ${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json No such file or directory
事前条件3: AMI"handson-cli-webapp-stateless-1"が存在する。
「AMI"handson-cli-webapp-stateless-1"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-images \ --filter "Name=name, Values=${EC2_IMAGE_NAME}" \ --query 'Images[].Name' \ --output text
結果(例):
handson-cli-webapp-stateless-1
事前条件4: VPC"handson-cli-vpc"が存在する。
「VPC"handson-cli-vpc"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${VPC_TAG_NAME} \ --query 'Vpcs[].Tags[?Key == `Name`].Value' \ --output text
結果(例):
handson-cli-vpc
VPC IDを取得します。
コマンド:
VPC_ID=$( \ aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${VPC_TAG_NAME} \ --query 'Vpcs[].VpcId' \ --output text \ ) \ && echo ${VPC_ID}
結果(例):
vpc-xxxxxxxxxxxxxxxxx
事前条件5: VPC"handson-cli-vpc"にセキュリティグループ"handson-cli-webapp-sg"が存在する。
「VPC"handson-cli-vpc"にセキュリティグループ"handson-cli-webapp-sg"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-security-groups \ --filter Name=vpc-id,Values=${VPC_ID} \ Name=group-name,Values=${VPC_SG_NAME} \ --query 'SecurityGroups[].GroupName' \ --output text
結果(例):
handson-cli-webapp-sg
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-xxxxxxxxxxxxxxxxx
セキュリティグループIDの配列への格納
変数の設定:
ARRAY_VPC_SG_IDS="${VPC_SG_ID}" \ && echo ${ARRAY_VPC_SG_IDS}
結果(例):
sg-xxxxxxxxxxxxxxxxx
2. 主処理¶
EC2起動テンプレートドキュメントの作成¶
変数の確認:
cat << ETX # AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # FILE_EC2_LAUNCH_TEMPLATE_DOC:"${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json" FILE_EC2_LAUNCH_TEMPLATE_DOC="${FILE_EC2_LAUNCH_TEMPLATE_DOC}" # EC2_VOLUME_DEVICE_NAME:"/dev/xvda" EC2_VOLUME_DEVICE_NAME="${EC2_VOLUME_DEVICE_NAME}" # EC2_VOLUME_SIZE:"8" EC2_VOLUME_SIZE="${EC2_VOLUME_SIZE}" # EC2_VOLUME_TYPE:"gp2" EC2_VOLUME_TYPE="${EC2_VOLUME_TYPE}" # EC2_IMAGE_ID:"ami-xxxxxxxxxxxxxxxxx" EC2_IMAGE_ID="${EC2_IMAGE_ID}" # EC2_INSTANCE_TYPE:"t2.micro" EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}" # ARRAY_VPC_SG_IDS:"sg-xxxxxxxxxxxxxxxxx" ARRAY_VPC_SG_IDS="${ARRAY_VPC_SG_IDS}" ETX
コマンド:
cat << EOF > ${FILE_EC2_LAUNCH_TEMPLATE_DOC} { "EbsOptimized": false, "BlockDeviceMappings": [ { "DeviceName": "${EC2_VOLUME_DEVICE_NAME}", "Ebs": { "VolumeSize": ${EC2_VOLUME_SIZE}, "VolumeType": "${EC2_VOLUME_TYPE}" } } ], "ImageId": "${EC2_IMAGE_ID}", "InstanceType": "${EC2_INSTANCE_TYPE}", "Monitoring": { "Enabled": false }, "SecurityGroupIds": [ "${ARRAY_VPC_SG_IDS}" ] } EOF cat ${FILE_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
{ "EbsOptimized": false, "BlockDeviceMappings": [ { "DeviceName": "/dev/xvda", "Ebs": "VolumeSize": 8, "VolumeType": "gp2" } } ], "ImageId": "ami-xxxxxxxxxxxxxxxxx", "InstanceType": "t2.micro", "Monitoring": { "Enabled": false }, "SecurityGroupIds": [ "sg-xxxxxxxxxxxxxxxxx" ] }
コマンド:
jsonlint -q ${FILE_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: EC2起動テンプレート用ドキュメントファイル"${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json"が存在する。
「EC2起動テンプレート用ドキュメントファイル"${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json"が存在する。」ことを確認します。
コマンド:
ls ${FILE_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
${HOME}/tmp/conf-handson-cli-webapp-stateless/handson-cli-webapp-stateless-launchtemplate.json