3.1. AutoScaling起動設定の作成 (handson-cli-deploy-lc)¶
作業の目的 [why]¶
AutoScaling起動設定"handson-cli-deploy-lc"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- AutoScaling起動設定"handson-cli-deploy-lc"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- AutoScaling起動設定"handson-cli-deploy-lc"が存在しない。
- 事前条件2
- AMI"amzn-ami-hvm-2018.03.0.20180811-x86_64-gp2"が存在する。
- 事前条件3
- VPC"handson-cli-vpc"が存在する。
- 事前条件4
- VPC"handson-cli-vpc"にセキュリティグループ"handson-cli-webapp-sg"が存在する。
- 事前条件5
- EC2ユーザデータ用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。
- 事前条件6
- ユーザデータファイル"${HOME}/tmp/conf-handson-cli/handson-cli-deploy-autoscaling.bash"が存在する。
- 事前条件7
- IAMインスタンスプロファイル"handson-cli-deploy-instanceprofile"が存在する。
- 事前条件8
- EC2キーペア"handson-cli-keypair"が存在する。
- 事前条件9
- SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem"が存在する。
作業対象 [what]¶
- AutoScalingサービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
作業開始には、以下が全て揃っていることが必要です。
リソース1: AutoScaling起動設定名
- 作成するAutoScaling起動設定の名称です。
- 今回は"handson-cli-deploy-lc"とします。
リソース2: AMI名
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するAMIの名称です。
- 今回は"amzn-ami-hvm-2018.03.0.20180811-x86_64-gp2"とします。
リソース3: VPCのタグ名
- セキュリティグループの属するVPCのタグ名称です。
- 今回は"handson-cli-vpc"とします。
リソース4: セキュリティグループ名
- 作成するAutoScaling起動設定で起動するEC2インスタンスに設定するセキュリティグループの名称です。
- 今回は"handson-cli-webapp-sg"とします。
リソース5: インスタンスタイプ
- 作成するAutoScaling起動設定で起動するEC2インスタンスのインスタンスタイプです。
- 今回は"t2.micro"とします。
リソース6: EC2ユーザデータ用ディレクトリ
EC2ユーザデータを配置したディレクトリ"${HOME}/tmp/conf-handson-cli"です。
リソース7: ユーザデータファイル名
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するユーザデータのファイル名です。
- 今回は"${HOME}/tmp/conf-handson-cli/handson-cli-deploy-autoscaling.bash"とします。
リソース8: IAMインスタンスプロファイル名
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するIAMインスタンスプロファイルの名称です。
- 今回は"handson-cli-deploy-instanceprofile"とします。
リソース9: キーペア名
- 作成するAutoScaling起動設定で起動するEC2インスタンスが利用するキーペア名です。
- 今回は"handson-cli-keypair"とします。
リソース10: SSH秘密鍵ファイル名
- 作成するAutoScaling起動設定で起動するEC2インスタンスへのSSHログインに利用するSSH秘密鍵のファイル名です。
- 今回は"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. AutoScaling起動設定名の指定¶
AutoScaling起動設定名を指定します。
変数の設定:
AS_LAUNCH_CONFIG_NAME='handson-cli-deploy-lc'
0.2. AMI名の指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するAMIの名称を指定します。
変数の設定:
EC2_IMAGE_NAME='amzn-ami-hvm-2018.03.0.20180811-x86_64-gp2'
0.4. セキュリティグループ名の指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスに設定するセキュリティグループの名称を指定します。
変数の設定:
VPC_SG_NAME='handson-cli-webapp-sg'
0.5. インスタンスタイプの指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスのインスタンスタイプを指定します。
変数の設定:
EC2_INSTANCE_TYPE='t2.micro'
0.8. IAMインスタンスプロファイルの指定¶
作成するAutoScaling起動設定で起動するEC2インスタンスが利用するIAMインスタンスプロファイルを指定します。
変数の設定:
IAM_INSTANCE_PROFILE_NAME='handson-cli-deploy-instanceprofile'
0.10. SSH秘密鍵ファイル名の指定¶
SSH秘密鍵ファイル名を指定します。
AWS IDを取得します。
コマンド:
AWS_ID=$( \ aws sts get-caller-identity \ --query 'Account' \ --output text \ ) \ && echo ${AWS_ID}
結果(例):
XXXXXXXXXXXX
変数の設定:
FILE_SSH_KEY="${HOME}/.ssh/${EC2_KEY_PAIR_NAME}-${AWS_ID}-${AWS_DEFAULT_REGION}-ec2.pem" \ && echo ${FILE_SSH_KEY}
結果(例):
${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-autoscaling-launch_configuration-create-expand-iam_instance_profile-user_data-key_name-instance_monitoring-associate_public_ip_address.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-autoscaling-launch_configuration-create-expand-iam_instance_profile-user_data-key_name-instance_monitoring-associate_public_ip_address.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. AS_LAUNCH_CONFIG_NAME:"handson-cli-deploy-lc" AS_LAUNCH_CONFIG_NAME="${AS_LAUNCH_CONFIG_NAME}" # 0.2. EC2_IMAGE_NAME:"amzn-ami-hvm-2018.03.0.20180811-x86_64-gp2" EC2_IMAGE_NAME="${EC2_IMAGE_NAME}" # 0.3. VPC_TAG_NAME:"handson-cli-vpc" VPC_TAG_NAME="${VPC_TAG_NAME}" # 0.4. VPC_SG_NAME:"handson-cli-webapp-sg" VPC_SG_NAME="${VPC_SG_NAME}" # 0.5. EC2_INSTANCE_TYPE:"t2.micro" EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}" # 0.6. DIR_EC2_USERDATA:"${HOME}/tmp/conf-handson-cli" DIR_EC2_USERDATA="${DIR_EC2_USERDATA}" # 0.7. EC2_USERDATA_NAME:"handson-cli-deploy-autoscaling" EC2_USERDATA_NAME="${EC2_USERDATA_NAME}" # 0.8. IAM_INSTANCE_PROFILE_NAME:"handson-cli-deploy-instanceprofile" IAM_INSTANCE_PROFILE_NAME="${IAM_INSTANCE_PROFILE_NAME}" # 0.9. EC2_KEY_PAIR_NAME:"handson-cli-keypair" EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}" # 0.10. FILE_SSH_KEY:"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem" FILE_SSH_KEY="${FILE_SSH_KEY}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
課題
(未検証)
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 状態確認に必要な情報の取得¶
EC2ユーザデータファイル名の指定
変数の設定:
FILE_EC2_USERDATA="${DIR_EC2_USERDATA}/${EC2_USERDATA_NAME}.bash" \ && echo ${FILE_EC2_USERDATA}
結果(例):
${HOME}/tmp/conf-handson-cli/handson-cli-deploy-autoscaling.bash
1.2. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: AutoScaling起動設定"handson-cli-deploy-lc"が存在しない。
「AutoScaling起動設定"handson-cli-deploy-lc"が存在しない。」ことを確認します。
コマンド:
aws autoscaling describe-launch-configurations \ --launch-configuration-names ${AS_LAUNCH_CONFIG_NAME} \ --query 'LaunchConfigurations[].LaunchConfigurationName' \ --output text
結果(例):
(出力なし)
事前条件2: AMI"amzn-ami-hvm-2018.03.0.20180811-x86_64-gp2"が存在する。
「AMI"amzn-ami-hvm-2018.03.0.20180811-x86_64-gp2"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-images \ --filter "Name=name, Values=${EC2_IMAGE_NAME}" \ --query 'Images[].Name' \ --output text
結果(例):
amzn-ami-hvm-2018.03.0.20180811-x86_64-gp2
事前条件3: 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
事前条件4: 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
事前条件5: EC2ユーザデータ用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。
「EC2ユーザデータ用ディレクトリ"${HOME}/tmp/conf-handson-cli"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_EC2_USERDATA}
結果(例):
${HOME}/tmp/conf-handson-cli
事前条件6: ユーザデータファイル"${HOME}/tmp/conf-handson-cli/handson-cli-deploy-autoscaling.bash"が存在する。
「ユーザデータファイル"${HOME}/tmp/conf-handson-cli/handson-cli-deploy-autoscaling.bash"が存在する。」ことを確認します。
コマンド:
ls ${FILE_EC2_USERDATA}
結果(例):
${HOME}/tmp/conf-handson-cli/handson-cli-deploy-autoscaling.bash
事前条件7: IAMインスタンスプロファイル"handson-cli-deploy-instanceprofile"が存在する。
「IAMインスタンスプロファイル"handson-cli-deploy-instanceprofile"が存在する。」ことを確認します。
コマンド:
aws iam list-instance-profiles \ --query "InstanceProfiles[?InstanceProfileName == \`${IAM_INSTANCE_PROFILE_NAME}\`].InstanceProfileName" \ --output text
結果(例):
handson-cli-deploy-instanceprofile
事前条件8: EC2キーペア"handson-cli-keypair"が存在する。
「EC2キーペア"handson-cli-keypair"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-key-pairs \ --query "KeyPairs[?KeyName == \`${EC2_KEY_PAIR_NAME}\`].KeyName" \ --output text
結果(例):
handson-cli-keypair
事前条件9: SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem"が存在する。
「SSH秘密鍵"${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem"が存在する。」ことを確認します。
コマンド:
ls ${FILE_SSH_KEY}
結果:
${HOME}/.ssh/handson-cli-keypair-XXXXXXXXXXXX-ap-northeast-1-ec2.pem
1.3. 主処理に必要な情報の取得¶
イメージ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. 主処理¶
起動設定の作成¶
変数の確認:
cat << ETX # AS_LAUNCH_CONFIG_NAME:"handson-cli-deploy-lc" AS_LAUNCH_CONFIG_NAME="${AS_LAUNCH_CONFIG_NAME}" # EC2_IMAGE_ID:"ami-xxxxxxxxxxxxxxxxx" EC2_IMAGE_ID="${EC2_IMAGE_ID}" # ARRAY_VPC_SG_IDS:"sg-xxxxxxxxxxxxxxxxx" ARRAY_VPC_SG_IDS="${ARRAY_VPC_SG_IDS}" # EC2_INSTANCE_TYPE:"t2.micro" EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}" # IAM_INSTANCE_PROFILE_NAME:"handson-cli-deploy-instanceprofile" IAM_INSTANCE_PROFILE_NAME="${IAM_INSTANCE_PROFILE_NAME}" # FILE_EC2_USERDATA:"${HOME}/tmp/conf-handson-cli/handson-cli-deploy-autoscaling.bash" FILE_EC2_USERDATA="${FILE_EC2_USERDATA}" # EC2_KEY_PAIR_NAME:"handson-cli-keypair" EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_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} \ --instance-type ${EC2_INSTANCE_TYPE} \ --iam-instance-profile ${IAM_INSTANCE_PROFILE_NAME} \ --user-data file://${FILE_EC2_USERDATA} \ --key-name ${EC2_KEY_PAIR_NAME} \ --instance-monitoring Enabled=false \ --associate-public-ip-address
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: AutoScaling起動設定"handson-cli-deploy-lc"が存在する。
「AutoScaling起動設定"handson-cli-deploy-lc"が存在する。」ことを確認します。
コマンド:
aws autoscaling describe-launch-configurations \ --launch-configuration-names ${AS_LAUNCH_CONFIG_NAME} \ --query 'LaunchConfigurations[].LaunchConfigurationName' \ --output text
結果(例):
handson-cli-deploy-lc