6.1. EC2起動テンプレートドキュメントの作成 (handson-cli-instance-stateless-loadaverage-launchtemplate)¶
作業の目的 [why]¶
EC2起動テンプレート"handson-cli-instance-stateless-loadaverage-launchtemplate"用ドキュメントを作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
EC2起動テンプレート用ドキュメントファイル"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
EC起動テンプレートドキュメント用ディレクトリ"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage"が存在する。
- 事前条件2
EC2起動テンプレート用ドキュメントファイル"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json"が存在しない。
- 事前条件3
handson-cli-instance-stateless-loadaverage-webhost-1"が存在する。
- 事前条件4
VPC"handson-cli-instance-stateless-loadaverage-vpc"が存在する。
- 事前条件5
VPC"handson-cli-instance-stateless-loadaverage-vpc"にセキュリティグループ"webhost-handson-cli-instance-stateless-loadaverage-sg"が存在する。
作業対象 [what]¶
EC2サービス
標準時間(合計)¶
8分
パラメータ設定¶
- パラメータ設定の標準時間
2分
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: EC2起動テンプレートドキュメント用ディレクトリ
今回は"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage"をEC2起動テンプレートドキュメント用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d ${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage
結果(例:存在する場合):
${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage
存在しない場合は作成します。
コマンド:
mkdir -p ${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage
リソース2: EC2起動テンプレートドキュメント名
作成するEC2起動テンプレートドキュメントのファイル名です。
今回は"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json"とします。
リソース3: AMI名
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するAMIの名称です。
今回は"handson-cli-instance-stateless-loadaverage-webhost-1"とします。
リソース4: VPCのタグ名
セキュリティグループの属するVPCのタグ名称です。
今回は"handson-cli-instance-stateless-loadaverage-vpc"とします。
リソース5: セキュリティグループ名
作成するAutoScaling起動設定で起動するEC2インスタンスに設定するセキュリティグループの名称です。
今回は"webhost-handson-cli-instance-stateless-loadaverage-sg"とします。
リソース6: インスタンスタイプ
作成するAutoScaling起動設定で起動するEC2インスタンスのインスタンスタイプです。
今回は"t2.micro"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. EC2起動テンプレートドキュメント用ディレクトリの指定¶
変数の設定:
DIR_EC2_LAUNCH_TEMPLATE_DOC="${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage" \ && echo ${DIR_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage
0.2. EC2起動テンプレートドキュメント名の指定¶
EC2起動テンプレートドキュメント名を指定します。
変数の設定:
EC2_LAUNCH_TEMPLATE_NAME='handson-cli-instance-stateless-loadaverage-launchtemplate'
EC2起動テンプレートドキュメントファイル名を指定します。
変数の設定:
FILE_EC2_LAUNCH_TEMPLATE_DOC="${DIR_EC2_LAUNCH_TEMPLATE_DOC}/${EC2_LAUNCH_TEMPLATE_NAME}.json" \ && echo ${FILE_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json
0.3. AMI名の指定¶
AMIイメージ名を指定します。
変数の設定:
EC2_IMAGE_NAME="handson-cli-instance-stateless-loadaverage-webhost-1"
0.4. VPCのタグ名の指定¶
VPCのタグ名を指定します。
変数の設定:
EC2_VPC_TAG_NAME='handson-cli-instance-stateless-loadaverage-vpc'
0.5. セキュリティグループ名の指定¶
セキュリティグループ名を指定します。
変数の設定:
EC2_SECURITY_GROUP_NAME='webhost-handson-cli-instance-stateless-loadaverage-sg'
0.8. EC2インスタンスのタグ名の指定¶
EC2インスタンスのタグ名を指定します。
変数の設定:
EC2_INSTANCE_TAG_NAME='handson-cli-instance-stateless-loadaverage-webhost-instance'
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-instance-stateless-loadaverage" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-launch_template_document-create-expand-public_ip.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-instance-stateless-loadaverage/2020-01-13-ec2-launch_template_document-create-expand-public_ip.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}/environment/conf-handson-cli-instance-stateless-loadaverage" DIR_EC2_LAUNCH_TEMPLATE_DOC="${DIR_EC2_LAUNCH_TEMPLATE_DOC}" # 0.2. FILE_EC2_LAUNCH_TEMPLATE_DOC:"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json" FILE_EC2_LAUNCH_TEMPLATE_DOC="${FILE_EC2_LAUNCH_TEMPLATE_DOC}" # 0.3. EC2_IMAGE_NAME:"handson-cli-instance-stateless-loadaverage-webhost-1" EC2_IMAGE_NAME="${EC2_IMAGE_NAME}" # 0.4. EC2_VPC_TAG_NAME:"handson-cli-instance-stateless-loadaverage-vpc" EC2_VPC_TAG_NAME="${EC2_VPC_TAG_NAME}" # 0.5. EC2_SECURITY_GROUP_NAME:"webhost-handson-cli-instance-stateless-loadaverage-sg" EC2_SECURITY_GROUP_NAME="${EC2_SECURITY_GROUP_NAME}" # 0.6. EC2_INSTANCE_TYPE:"t2.micro" EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}" # 0.7. EC2_TAG_KEY:"Name" EC2_TAG_KEY="${EC2_TAG_KEY}" # 0.8. EC2_INSTANCE_TAG_NAME:"handson-cli-instance-stateless-loadaverage-webhost-instance" EC2_INSTANCE_TAG_NAME="${EC2_INSTANCE_TAG_NAME}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
- タスク標準時間
6分
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: EC起動テンプレートドキュメント用ディレクトリ"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage"が存在する。
「EC起動テンプレートドキュメント用ディレクトリ"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage
事前条件2: EC2起動テンプレート用ドキュメントファイル"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json"が存在しない。
「EC2起動テンプレート用ドキュメントファイル"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json"が存在しない。」ことを確認します。
コマンド:
! ls ${FILE_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
ls: ${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json No such file or directory
事前条件3: handson-cli-instance-stateless-loadaverage-webhost-1"が存在する。
「handson-cli-instance-stateless-loadaverage-webhost-1"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-images \ --filter "Name=name, Values=${EC2_IMAGE_NAME}" \ --query 'Images[].Name' \ --output text
結果(例):
handson-cli-instance-stateless-loadaverage-webhost-1
事前条件4: VPC"handson-cli-instance-stateless-loadaverage-vpc"が存在する。
「VPC"handson-cli-instance-stateless-loadaverage-vpc"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${EC2_VPC_TAG_NAME} \ --query 'Vpcs[].Tags[?Key == `Name`].Value' \ --output text
結果(例):
handson-cli-instance-stateless-loadaverage-vpc
VPC IDを取得します。
コマンド:
EC2_VPC_ID=$( \ aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${EC2_VPC_TAG_NAME} \ --query 'Vpcs[].VpcId' \ --output text \ ) \ && echo ${EC2_VPC_ID}
結果(例):
vpc-xxxxxxxxxxxxxxxxx
事前条件5: VPC"handson-cli-instance-stateless-loadaverage-vpc"にセキュリティグループ"webhost-handson-cli-instance-stateless-loadaverage-sg"が存在する。
「VPC"handson-cli-instance-stateless-loadaverage-vpc"にセキュリティグループ"webhost-handson-cli-instance-stateless-loadaverage-sg"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-security-groups \ --filter Name=vpc-id,Values=${EC2_VPC_ID} \ Name=group-name,Values=${EC2_SECURITY_GROUP_NAME} \ --query 'SecurityGroups[].GroupName' \ --output text
結果(例):
webhost-handson-cli-instance-stateless-loadaverage-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-xxxxxxxxxxxxxxxxx
セキュリティグループIDの取得
コマンド:
EC2_SECURITY_GROUP_ID=$( \ aws ec2 describe-security-groups \ --filter Name=vpc-id,Values=${EC2_VPC_ID} \ Name=group-name,Values=${EC2_SECURITY_GROUP_NAME} \ --query "SecurityGroups[].GroupId" \ --output text \ ) \ && echo ${EC2_SECURITY_GROUP_ID}
結果(例):
sg-xxxxxxxxxxxxxxxxx
セキュリティグループIDの配列への格納
変数の設定:
ARRAY_EC2_SECURITY_GROUP_IDS="${EC2_SECURITY_GROUP_ID}" \ && echo ${ARRAY_EC2_SECURITY_GROUP_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}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json" FILE_EC2_LAUNCH_TEMPLATE_DOC="${FILE_EC2_LAUNCH_TEMPLATE_DOC}" # EC2_INSTANCE_TYPE:"t2.micro" EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}" # EC2_IMAGE_ID:"ami-xxxxxxxxxxxxxxxxx" EC2_IMAGE_ID="${EC2_IMAGE_ID}" # EC2_TAG_KEY:"Name" EC2_TAG_KEY="${EC2_TAG_KEY}" # EC2_INSTANCE_TAG_NAME:"handson-cli-instance-stateless-loadaverage-webhost-instance" EC2_INSTANCE_TAG_NAME="${EC2_INSTANCE_TAG_NAME}" # ARRAY_EC2_SECURITY_GROUP_IDS:"sg-xxxxxxxxxxxxxxxxx" ARRAY_EC2_SECURITY_GROUP_IDS="${ARRAY_EC2_SECURITY_GROUP_IDS}" ETX
コマンド:
cat << EOF > ${FILE_EC2_LAUNCH_TEMPLATE_DOC} { "NetworkInterfaces": [ { "DeviceIndex": 0, "AssociatePublicIpAddress": true, "Groups": ["${ARRAY_EC2_SECURITY_GROUP_IDS}"], "DeleteOnTermination":true } ], "ImageId": "${EC2_IMAGE_ID}", "InstanceType": "${EC2_INSTANCE_TYPE}", "TagSpecifications": [ { "ResourceType": "instance", "Tags": [ { "Key": "${EC2_TAG_KEY}", "Value": "${EC2_INSTANCE_TAG_NAME}" } ] } ] } EOF cat ${FILE_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
{ "NetworkInterfaces": [ { "DeviceIndex": 0, "AssociatePublicIpAddress": true, "Groups": ["sg-xxxxxxxxxxxxxxxxx"], "DeleteOnTermination":true } ], "ImageId": "ami-xxxxxxxxxxxxxxxxx", "InstanceType": "t2.micro", "TagSpecifications": [ { "ResourceType": "instance", "Tags": [ { "Key": "Name", "Value": "handson-cli-instance-stateless-loadaverage-webhost-instance" } ] } ] }
コマンド:
jsonlint -q ${FILE_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: EC2起動テンプレート用ドキュメントファイル"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json"が存在する。
「EC2起動テンプレート用ドキュメントファイル"${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json"が存在する。」ことを確認します。
コマンド:
ls ${FILE_EC2_LAUNCH_TEMPLATE_DOC}
結果(例):
${HOME}/environment/conf-handson-cli-instance-stateless-loadaverage/handson-cli-instance-stateless-loadaverage-launchtemplate.json