1.1. EC2インスタンスの作成 (PublicIP/KeyPair: handson-cli-tmp)¶
作業の目的 [why]¶
EC2インスタンス名"handson-cli-tmp"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- ステータスが"running"のEC2インスタンス"handson-cli-tmp"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- ステータスが"running"のEC2インスタンス"handson-cli-tmp"が存在しない。
- 事前条件2
- AMI"amzn-ami-hvm-2018.03.0.20180622-x86_64-gp2"が存在する。
- 事前条件3
- VPC"handson-cli-vpc"が存在する。
- 事前条件4
- VPC"handson-cli-vpc"にサブネット"app-alpha-handson-cli-subnet"が存在する。
- 事前条件5
- VPC"handson-cli-vpc"にセキュリティグループ"webapp-handson-cli-sg"が存在する。
- 事前条件6
- キーペア"handson-cli-keypair"が存在する。
作業対象 [what]¶
- EC2サービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: EC2インスタンスのタグ名
- 作成するEC2インスタンスのタグ名称です。
- 今回は"handson-cli-tmp"とします。
リソース2: 起動時に利用するAMIイメージ名
- 作成するEC2インスタンスの起動時に利用するAMIイメージ名です。
- 今回は"amzn-ami-hvm-2018.03.0.20180622-x86_64-gp2"とします。
リソース3: VPCのタグ名
- EC2インスタンスが利用するVPCのタグ名称です。
- 今回は"handson-cli-vpc"とします。
リソース4: サブネットのタグ名
- 作成するEC2インスタンスが利用するサブネットのタグ名称です。
- 今回は"app-alpha-handson-cli-subnet"とします。
リソース5: セキュリティグループのタグ名
- 作成するEC2インスタンスが利用するセキュリティグループの名称です。
- 今回は"webapp-handson-cli-sg"とします。
リソース6: EC2インスタンスのインスタンスタイプ
- 作成するEC2インスタンスのインスタンスタイプです。
- 今回は"t2.micro"とします。
リソース7: キーペア名
- 作成するインスタンスが利用するキーペア名です。
- 今回は"handson-cli-keypair"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. 起動時に利用するAMIイメージ名¶
作成するEC2インスタンスの起動時に利用するAMIイメージ名を指定します。
変数の設定:
EC2_IMAGE_NAME="amzn-ami-hvm-2018.03.0.20180622-x86_64-gp2"
0.4. サブネットのタグ名¶
作成するEC2インスタンスが利用するサブネットのタグ名称を指定します。
変数の設定:
VPC_SUBNET_TAG_NAME="app-alpha-handson-cli-subnet"
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-instance_keypair-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-ec2-instance_keypair-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. EC2_INSTANCE_TAG_NAME:"handson-cli-tmp" EC2_INSTANCE_TAG_NAME="${EC2_INSTANCE_TAG_NAME}" # 0.2. EC2_IMAGE_NAME:"amzn-ami-hvm-2018.03.0.20180622-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_SUBNET_TAG_NAME:"app-alpha-handson-cli-subnet" VPC_SUBNET_TAG_NAME="${VPC_SUBNET_TAG_NAME}" # 0.5. VPC_SG_NAME:"webapp-handson-cli-sg" VPC_SG_NAME="${VPC_SG_NAME}" # 0.6. EC2_INSTANCE_TYPE:"t2.micro" EC2_INSTANCE_TYPE="${EC2_INSTANCE_TYPE}" # 0.7. EC2_KEY_PAIR_NAME:"handson-cli-keypair" EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: ステータスが"running"のEC2インスタンス"handson-cli-tmp"が存在しない。
「ステータスが"running"のEC2インスタンス"handson-cli-tmp"が存在しない。」ことを確認します。
コマンド:
aws ec2 describe-instances \ --filters Name=tag:Name,Values=${EC2_INSTANCE_TAG_NAME} \ Name=instance-state-name,Values=running \ --query Reservations[].Instances[].Tags[].Value \ --output text
結果(例):
(出力なし)
事前条件2: AMI"amzn-ami-hvm-2018.03.0.20180622-x86_64-gp2"が存在する。
「AMI"amzn-ami-hvm-2018.03.0.20180622-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.20180622-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"にサブネット"app-alpha-handson-cli-subnet"が存在する。
「VPC"handson-cli-vpc"にサブネット"app-alpha-handson-cli-subnet"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME} \ --query 'Subnets[].Tags[?Key == `Name`].Value' \ --output text
結果(例):
app-alpha-handson-cli-subnet
事前条件5: VPC"handson-cli-vpc"にセキュリティグループ"webapp-handson-cli-sg"が存在する。
「VPC"handson-cli-vpc"にセキュリティグループ"webapp-handson-cli-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
結果(例):
webapp-handson-cli-sg
事前条件6: キーペア"handson-cli-keypair"が存在する。
「キーペア"handson-cli-keypair"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-key-pairs \ --query "KeyPairs[?KeyName == \`${EC2_KEY_PAIR_NAME}\`].KeyName" \ --output text
結果(例):
handson-cli-keypair
1.2. 主処理に必要な情報の取得¶
イメージIDの取得
イメージ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の取得
サブネットIDを取得します。
コマンド:
VPC_SUBNET_ID=$( \ aws ec2 describe-subnets \ --filters Name=vpc-id,Values=${VPC_ID} \ Name=tag:Name,Values=${VPC_SUBNET_TAG_NAME} \ --query "Subnets[].SubnetId" \ --output text \ ) \ && echo ${VPC_SUBNET_ID}
結果(例):
subnet-xxxxxxxxxxxxxxxxx
セキュリティグループIDの取得
セキュリティグループ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
セキュリティグループの配列化
変数の設定:
ARRAY_VPC_SG_IDS="${VPC_SG_ID}" \ && echo ${ARRAY_VPC_SG_IDS}
結果(例):
sg-xxxxxxxxxxxxxxxxx
タグ設定文字列の生成
変数の設定:
EC2_TAG_KEY='Name'
変数の設定:
STRING_TAG_CONF="ResourceType=instance,Tags=[{Key=${EC2_TAG_KEY},Value=${EC2_INSTANCE_TAG_NAME}}]" \ && echo ${STRING_TAG_CONF}
結果(例):
ResourceType=instance,Tags=[{Key=Name,Value=handson-cli-tmp}]
2. 主処理¶
EC2インスタンスの作成¶
変数の確認:
cat << ETX # 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}" # STRING_TAG_CONF:"ResourceType=instance,Tags=[{Key=Name,Value=handson-cli-tmp}]" STRING_TAG_CONF="${STRING_TAG_CONF}" # VPC_SUBNET_ID:"subnet-xxxxxxxxxxxxxxxxx" VPC_SUBNET_ID="${VPC_SUBNET_ID}" # EC2_KEY_PAIR_NAME:"handson-cli-keypair" EC2_KEY_PAIR_NAME="${EC2_KEY_PAIR_NAME}" ETX
コマンド:
aws ec2 run-instances \ --image-id ${EC2_IMAGE_ID} \ --instance-type ${EC2_INSTANCE_TYPE} \ --security-group-ids ${ARRAY_VPC_SG_IDS} \ --tag-specifications ${STRING_TAG_CONF} \ --subnet-id ${VPC_SUBNET_ID} \ --key-name ${EC2_KEY_PAIR_NAME} \ --associate-public-ip-address
結果(例):
{ "Groups": [], "Instances": [ { "AmiLaunchIndex": 0, "ImageId": "ami-xxxxxxxxxxxxxxxxx", "InstanceId": "i-xxxxxxxxxxxxxxxxx", "InstanceType": "t2.micro", "KeyName": "handson-cli-keypair ", "LaunchTime": "2019-04-30T01:23:45.000Z", "Monitoring": { "State": "disabled" }, "Placement": { "AvailabilityZone": "ap-northeast-1<AZ名>", "GroupName": "", "Tenancy": "default" }, "PrivateDnsName": "ip-<Privateアドレス>.ap-northeast-1 .compute.internal", "PrivateIpAddress": "<Privateアドレス>", "ProductCodes": [], "PublicDnsName": "", "State": { "Code": 0, "Name": "pending" }, "StateTransitionReason": "", "SubnetId": "subnet-xxxxxxxxxxxxxxxxx", "VpcId": "vpc-xxxxxxxxxxxxxxxxx", "Architecture": "x86_64", "BlockDeviceMappings": [], "ClientToken": "", "EbsOptimized": false, "Hypervisor": "xen", "NetworkInterfaces": [ { "Attachment": { "AttachTime": "2019-04-30T01:23:45.000Z", "AttachmentId": "eni-attach-xxxxxxxxxxxxxxxxx", "DeleteOnTermination": true, "DeviceIndex": 0, "Status": "attaching" }, "Description": "", "Groups": [ { "GroupName": "webapp-handson-cli-sg", "GroupId": "sg-xxxxxxxxxxxxxxxxx" } ], "Ipv6Addresses": [], "MacAddress": "xx:xx:xx:xx:xx:xx", "NetworkInterfaceId": "eni-attach-xxxxxxxxxxxxxxxxx", "OwnerId": " XXXXXXXXXXXX ", "PrivateIpAddress": "<Privateアドレス>", "PrivateIpAddresses": [ { "Primary": true, "PrivateIpAddress": "<Privateアドレス>" } ], "SourceDestCheck": true, "Status": "in-use", "SubnetId": "subnet-xxxxxxxxxxxxxxxxx", "VpcId": "vpc-xxxxxxxxxxxxxxxxx" } ], "RootDeviceName": "/dev/xvda", "RootDeviceType": "ebs", "SecurityGroups": [ { "GroupName": "webapp-handson-cli-sg", "GroupId": "sg-xxxxxxxxxxxxxxxxx" } ], "SourceDestCheck": true, "StateReason": { "Code": "pending", "Message": "pending" }, "Tags": [ { "Key": "Name", "Value": "handson-cli-tmp" } ], "VirtualizationType": "hvm", "CpuOptions": { "CoreCount": 1, "ThreadsPerCore": 1 } } ], "OwnerId": " XXXXXXXXXXXX ", "ReservationId": "r-xxxxxxxxxxxxxxxxx" }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: ステータスが"running"のEC2インスタンス"handson-cli-tmp"が存在する。
「ステータスが"running"のEC2インスタンス"handson-cli-tmp"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-instances \ --filters Name=tag:Name,Values=${EC2_INSTANCE_TAG_NAME} \ Name=instance-state-name,Values=running \ --query Reservations[].Instances[].Tags[].Value \ --output text
結果(例):
handson-cli-tmp
表示されるまで数十秒程度かかります。