3.2. Lightsailインスタンスの作成 (handson-cli-lightsail-instance)¶
作業の目的 [why]¶
Lightsailインスタンス"handson-cli-lightsail-instance"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
Lightsailインスタンス"handson-cli-lightsail-instance"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
Lightsailインスタンス"handson-cli-lightsail-instance"が存在しない。
- 事前条件2
Lightsailインスタンスの数が上限値"20"に達していない。
- 事前条件3
Lightsailブループリント"Amazon Linux"が存在する。
- 事前条件4
Lightsailバンドル"Nano"が存在する。
- 事前条件5
AZ"ap-northeast-1a"が存在する。
- 事前条件6
ユーザデータ"${HOME}/environment/conf-handson-cli-lightsail/handson-cli-lightsail-user_data.bash"が存在する。
- 事前条件7
Lightsailキーペア"handson-cli-lightsail-key_pair"が存在する。
- 事前条件8
SSH秘密鍵"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"が存在する。
作業対象 [what]¶
Lightsailサービス
標準時間(合計)¶
8分
パラメータ設定¶
- パラメータ設定の標準時間
2分
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: Lightsailインスタンス名
作成するLightsailインスタンスの名称です。
今回は"handson-cli-lightsail-instance"とします。
リソース2: Lightsailブループリント名
作成するLightsailブループリントの名称です。
今回は"Amazon Linux"とします。
リソース3: Lightsailバンドル名
作成するLightsailバンドルの名称です。
今回は"Nano"とします。
リソース4: サブネット配置AZ名
作成するインスタンスを配置するAZ名です。
今回は"ap-northeast-1a"とします。
リソース5: ユーザデータファイル名
作成するインスタンスが利用するユーザデータのファイル名です。
今回は"handson-cli-lightsail-user_data"とします。
リソース6: Lightsailキーペア名
作成するLightsailキーペアの名称です。
今回は"handson-cli-lightsail-key_pair"とします。
リソース7: SSH秘密鍵ファイル名
作成するキーペアのSSH秘密鍵のファイル名です。
今回は"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. Lightsailインスタンス名の指定¶
Lightsailインスタンス名を指定します。
変数の設定:
LIGHTSAIL_INSTANCE_NAME="handson-cli-lightsail-instance"
0.5. ユーザデータファイル名の指定¶
変数の設定:
DIR_USER_DATA="${HOME}/environment/conf-handson-cli-lightsail"
ユーザデータの名称を指定します。
変数の設定:
USER_DATA_NAME='handson-cli-lightsail-user_data'
変数の設定:
FILE_USER_DATA="${DIR_USER_DATA}/${USER_DATA_NAME}.bash" \ && echo ${FILE_USER_DATA}
結果(例):
${HOME}/environment/conf-handson-cli-lightsail/handson-cli-lightsail-user_data.bash
0.6. Lightsailキーペア名の指定¶
キーペア名を指定します。
変数の設定:
LIGHTSAIL_KEY_PAIR_NAME="handson-cli-lightsail-key_pair"
0.7. SSH秘密鍵ファイル名の指定¶
変数の設定:
DIR_SSH="${HOME}/.ssh"
AWS IDを取得します。
コマンド:
AWS_ID=$( \ aws sts get-caller-identity \ --query 'Account' \ --output text \ ) \ && echo ${AWS_ID}
結果(例):
XXXXXXXXXXXX
SSH秘密鍵ファイル名を指定します。
変数の設定:
FILE_SSH_KEY_SECRET="${DIR_SSH}/${LIGHTSAIL_KEY_PAIR_NAME}-${AWS_ID}-${AWS_DEFAULT_REGION}-lightsail.pem" \ && echo ${FILE_SSH_KEY_SECRET}
結果(例):
${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-lightsail" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-lightsail-instance-create-expand-user_data-key_pair.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-lightsail/2020-02-10-lightsail-instance-create-expand-user_data-key_pair.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. LIGHTSAIL_INSTANCE_NAME:"handson-cli-lightsail-instance" LIGHTSAIL_INSTANCE_NAME="${LIGHTSAIL_INSTANCE_NAME}" # 0.2. LIGHTSAIL_BLUEPRINT_NAME:"Amazon Linux" LIGHTSAIL_BLUEPRINT_NAME="${LIGHTSAIL_BLUEPRINT_NAME}" # 0.3. LIGHTSAIL_BUNDLE_NAME:"Nano" LIGHTSAIL_BUNDLE_NAME="${LIGHTSAIL_BUNDLE_NAME}" # 0.4. EC2_AZ_NAME:"ap-northeast-1a" EC2_AZ_NAME="${EC2_AZ_NAME}" # 0.6. LIGHTSAIL_KEY_PAIR_NAME:"handson-cli-lightsail-key_pair" LIGHTSAIL_KEY_PAIR_NAME="${LIGHTSAIL_KEY_PAIR_NAME}" # 0.7. FILE_SSH_KEY_SECRET:"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem" FILE_SSH_KEY_SECRET="${FILE_SSH_KEY_SECRET}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
- タスク標準時間
6分
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: Lightsailインスタンス"handson-cli-lightsail-instance"が存在しない。
「Lightsailインスタンス"handson-cli-lightsail-instance"が存在しない。」ことを確認します。
コマンド:
aws lightsail get-instances \ --query "instances[?name == \`${LIGHTSAIL_INSTANCE_NAME}\`].name" \ --output text
結果(例):
(出力なし)
事前条件2: Lightsailインスタンスの数が上限値"20"に達していない。
「Lightsailインスタンスの数が上限値"20"に達していない。」ことを確認します。
コマンド:
COUNT_LIGHTSAIL_INSTANCES=$( \ aws lightsail get-instances \ --query 'length(instances[])' ) \ && echo ${COUNT_LIGHTSAIL_INSTANCES}
結果(例):
0
事前条件3: Lightsailブループリント"Amazon Linux"が存在する。
「Lightsailブループリント"Amazon Linux"が存在する。」ことを確認します。
コマンド:
aws lightsail get-blueprints \ --query "blueprints[?name == \`${LIGHTSAIL_BLUEPRINT_NAME}\`].name" \ --output text
結果(例):
Amazon Linux
コマンド:
LIGHTSAIL_BLUEPRINT_PLATFORM=$( \ aws lightsail get-blueprints \ --query "blueprints[?name == \`${LIGHTSAIL_BLUEPRINT_NAME}\`].platform" \ --output text \ ) \ && echo ${LIGHTSAIL_BLUEPRINT_PLATFORM}
結果(例):
LINUX_UNIX
事前条件4: Lightsailバンドル"Nano"が存在する。
「Lightsailバンドル"Nano"が存在する。」ことを確認します。
コマンド:
aws lightsail get-bundles \ --query "bundles[?name == \`${LIGHTSAIL_BUNDLE_NAME}\` \ && contains( supportedPlatforms, \`${LIGHTSAIL_BLUEPRINT_PLATFORM}\` ) \ ].name" \ --output text
結果(例):
Nano
事前条件5: AZ"ap-northeast-1a"が存在する。
「AZ"ap-northeast-1a"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-availability-zones \ --filters Name=region-name,Values=${AWS_DEFAULT_REGION} \ Name=zone-name,Values=${EC2_AZ_NAME} \ --query 'AvailabilityZones[].ZoneName' \ --output text
結果(例):
ap-northeast-1a
事前条件6: ユーザデータ"${HOME}/environment/conf-handson-cli-lightsail/handson-cli-lightsail-user_data.bash"が存在する。
「ユーザデータ"${HOME}/environment/conf-handson-cli-lightsail/handson-cli-lightsail-user_data.bash"が存在する。」ことを確認します。
コマンド:
ls ${FILE_USER_DATA}
結果(例):
${HOME}/environment/conf-handson-cli-lightsail/handson-cli-lightsail-user_data.bash
事前条件7: Lightsailキーペア"handson-cli-lightsail-key_pair"が存在する。
「Lightsailキーペア"handson-cli-lightsail-key_pair"が存在する。」ことを確認します。
コマンド:
aws lightsail get-key-pairs \ --query "keyPairs[?name == \`${LIGHTSAIL_KEY_PAIR_NAME}\`].name" \ --output text
結果(例):
handson-cli-lightsail-key_pair
事前条件8: SSH秘密鍵"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"が存在する。
「SSH秘密鍵"${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem"が存在する。」ことを確認します。
コマンド:
ls ${FILE_SSH_KEY_SECRET}
結果(例):
${HOME}/.ssh/handson-cli-lightsail-key_pair-XXXXXXXXXXXX-ap-northeast-1-lightsail.pem
1.2. 主処理に必要な情報の取得¶
LightsailブループリントIDの取得
コマンド:
LIGHTSAIL_BLUEPRINT_ID=$( \ aws lightsail get-blueprints \ --query "blueprints[?name == \`${LIGHTSAIL_BLUEPRINT_NAME}\`].blueprintId" \ --output text \ ) \ && echo ${LIGHTSAIL_BLUEPRINT_ID}
結果(例):
amazon_linux
LightsailバンドルIDの取得
コマンド:
LIGHTSAIL_BUNDLE_ID=$( \ aws lightsail get-bundles \ --query "bundles[?name == \`${LIGHTSAIL_BUNDLE_NAME}\` \ && contains( supportedPlatforms, \`${LIGHTSAIL_BLUEPRINT_PLATFORM}\` ) \ ].bundleId" \ --output text \ ) \ && echo ${LIGHTSAIL_BUNDLE_ID}
結果(例):
nano_2_0
Lightsailインスタンス名の配列化
変数の設定:
ARRAY_LIGHTSAIL_INSTANCE_NAMES="${LIGHTSAIL_INSTANCE_NAME}" \ && echo ${ARRAY_LIGHTSAIL_INSTANCE_NAMES}
結果(例):
handson-cli-lightsail-instance
2. 主処理¶
Lightsailインスタンスの作成¶
変数の確認:
cat << ETX # ARRAY_LIGHTSAIL_INSTANCE_NAMES:"handson-cli-lightsail-instance" ARRAY_LIGHTSAIL_INSTANCE_NAMES="${ARRAY_LIGHTSAIL_INSTANCE_NAMES}" # EC2_AZ_NAME:"ap-northeast-1a" EC2_AZ_NAME="${EC2_AZ_NAME}" # LIGHTSAIL_BLUEPRINT_ID:"amazon_linux" LIGHTSAIL_BLUEPRINT_ID="${LIGHTSAIL_BLUEPRINT_ID}" # LIGHTSAIL_BUNDLE_ID:"nano_2_0" LIGHTSAIL_BUNDLE_ID="${LIGHTSAIL_BUNDLE_ID}" # FILE_USER_DATA:"${HOME}/environment/conf-handson-cli-lightsail/handson-cli-lightsail-user_data.bash" FILE_USER_DATA="${FILE_USER_DATA}" # LIGHTSAIL_KEY_PAIR_NAME:"handson-cli-lightsail-key_pair" LIGHTSAIL_KEY_PAIR_NAME="${LIGHTSAIL_KEY_PAIR_NAME}" ETX
コマンド:
aws lightsail create-instances \ --instance-names ${ARRAY_LIGHTSAIL_INSTANCE_NAMES} \ --availability-zone ${EC2_AZ_NAME} \ --blueprint-id ${LIGHTSAIL_BLUEPRINT_ID} \ --bundle-id ${LIGHTSAIL_BUNDLE_ID} \ --user-data file://${FILE_USER_DATA} \ --key-pair-name ${LIGHTSAIL_KEY_PAIR_NAME}
結果(例):
{ "operations": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "resourceName": "handson-cli-lightsail-instance", "resourceType": "Instance", "createdAt": 1234567890.123, "location": { "availabilityZone": "ap-northeast-1a", "regionName": "ap-northeast-1" }, "isTerminal": false, "operationType": "CreateInstance", "status": "Started", "statusChangedAt": 1234567890.123 } ] }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: Lightsailインスタンス"handson-cli-lightsail-instance"が存在する。
「Lightsailインスタンス"handson-cli-lightsail-instance"が存在する。」ことを確認します。
コマンド:
aws lightsail get-instances \ --query "instances[?name == \`${LIGHTSAIL_INSTANCE_NAME}\`].name" \ --output text
結果(例):
handson-cli-lightsail-instance