3.2. EBSボリュームのアタッチ (handson-cli-instance-stateful-ssh-data-volume)¶
作業の目的 [why]¶
EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"をEC2インスタンス"handson-cli-instance-stateful-ssh"にアタッチします。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"がEC2インスタンスタグ名"handson-cli-instance-stateful-ssh"にアタッチされている。
- 完了条件2
EC2インスタンスタグ名"handson-cli-instance-stateful-ssh"にアタッチされたEBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"のデバイスファイル名が"sdh"である。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
EC2インスタンスタグ名"handson-cli-instance-stateful-ssh"が存在する。
- 事前条件2
EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"が存在する。
- 事前条件3
EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"がEC2インスタンスタグ名"handson-cli-instance-stateful-ssh"にアタッチされている。
作業対象 [what]¶
EC2インスタンス
標準時間(合計)¶
8分
パラメータ設定¶
- パラメータ設定の標準時間
2分
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: EC2インスタンスタグ名
作成するEC2インスタンスのタグ名です。
今回は"handson-cli-instance-stateful-ssh"とします。
リソース2: EBSボリュームタグ名
作成するEBSボリュームのタグ名です。
今回は"handson-cli-instance-stateful-ssh-data-volume"とします。
リソース3: OSデバイスファイル名
OS上に割り当てるデバイスファイル名です。
今回は"sdh"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. EC2インスタンスタグ名の指定¶
EC2インスタンスのタグ名を指定します。
変数の設定:
EC2_INSTANCE_TAG_NAME='handson-cli-instance-stateful-ssh'
0.2. EBSボリュームタグ名の指定¶
EBSボリュームのタグ名を指定します。
変数の設定:
EC2_VOLUME_TAG_NAME='handson-cli-instance-stateful-ssh-data-volume'
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-instance-stateful-ssh" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-volume-update-expand-attach.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-instance-stateful-ssh/2019-09-16-ec2-volume-update-expand-attach.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-instance-stateful-ssh" EC2_INSTANCE_TAG_NAME="${EC2_INSTANCE_TAG_NAME}" # 0.2. EC2_VOLUME_TAG_NAME:"handson-cli-instance-stateful-ssh-data-volume" EC2_VOLUME_TAG_NAME="${EC2_VOLUME_TAG_NAME}" # 0.3. DEVICE_FILE_NAME:"sdh" DEVICE_FILE_NAME="${DEVICE_FILE_NAME}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
課題
(未検証)
- タスク標準時間
6分
1. 前処理¶
1.1. 状態確認に必要な情報の取得¶
インスタンスIDの取得
コマンド:
EC2_INSTANCE_ID=$( \ aws ec2 describe-instances \ --filters Name=tag-key,Values=Name \ Name=tag-value,Values=${EC2_INSTANCE_TAG_NAME} \ Name=instance-state-name,Values=running \ --query Reservations[].Instances[].InstanceId \ --output text \ ) \ && echo ${EC2_INSTANCE_ID}
結果(例):
i-xxxxxxxxxxxxxxxxx
EBSボリュームIDの取得
コマンド:
EC2_VOLUME_ID=$( \ aws ec2 describe-volumes \ --filters Name=tag-key,Values=Name \ Name=tag-value,Values=${EC2_VOLUME_TAG_NAME} \ --query 'Volumes[?Tags.Key == Name].VolumeId' \ --output text ) \ && echo ${EC2_VOLUME_ID}
結果(例):
vol-xxxxxxxxxxxxxxxxx
1.2. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: EC2インスタンスタグ名"handson-cli-instance-stateful-ssh"が存在する。
「EC2インスタンスタグ名"handson-cli-instance-stateful-ssh"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-instances \ --filters Name=tag-key,Values=Name \ Name=tag-value,Values=${EC2_INSTANCE_TAG_NAME} \ Name=instance-state-name,Values=running \ --query Reservations[].Instances[].Tags[].Value \ --output text
結果(例):
handson-cli-instance-stateful-ssh
事前条件2: EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"が存在する。
「EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-volumes \ --filters Name=tag-key,Values=Name \ Name=tag-value,Values=${EC2_VOLUME_TAG_NAME} \ --query 'Volumes[?Tags.Key == Name].Tags[].Value' \ --output text
結果(例):
handson-cli-instance-stateful-ssh-data-volume
事前条件3: EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"がEC2インスタンスタグ名"handson-cli-instance-stateful-ssh"にアタッチされている。
「EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"がEC2インスタンスタグ名"handson-cli-instance-stateful-ssh"にアタッチされている。」ことを確認します。
コマンド:
aws ec2 describe-instances \ --instance-ids ${EC2_INSTANCE_ID} \ --query "Reservations[].Instances[].BlockDeviceMappings[?Ebs.VolumeId == \`${EC2_VOLUME_ID}\`].Ebs.VolumeId" \ --output text
結果(例):
(出力なし)
1.3. 主処理に必要な情報の取得¶
sample
2. 主処理¶
EBSボリュームのアタッチ¶
変数の確認:
cat << ETX # DEVICE_FILE_NAME:"sdh" DEVICE_FILE_NAME="${DEVICE_FILE_NAME}" # EC2_INSTANCE_ID:"i-xxxxxxxxxxxxxxxxx" EC2_INSTANCE_ID="${EC2_INSTANCE_ID}" # EC2_VOLUME_ID:"vol-xxxxxxxxxxxxxxxxx" EC2_VOLUME_ID="${EC2_VOLUME_ID}" ETX
コマンド:
aws ec2 attach-volume \ --device ${DEVICE_FILE_NAME} \ --instance-id ${EC2_INSTANCE_ID} \ --volume-id ${EC2_VOLUME_ID}
結果(例):
{ "AttachTime": "2019-09-16T01:23:45.678Z", "Device": "sdh", "InstanceId": "i-xxxxxxxxxxxxxxxxx", "State": "attaching", "VolumeId": "vol-xxxxxxxxxxxxxxxxx" }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"がEC2インスタンスタグ名"handson-cli-instance-stateful-ssh"にアタッチされている。
「EBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"がEC2インスタンスタグ名"handson-cli-instance-stateful-ssh"にアタッチされている。」ことを確認します。
コマンド:
aws ec2 describe-instances \ --instance-ids ${EC2_INSTANCE_ID} \ --query "Reservations[].Instances[].BlockDeviceMappings[?Ebs.VolumeId == \`${EC2_VOLUME_ID}\`].Ebs.VolumeId" \ --output text
結果(例):
vol-xxxxxxxxxxxxxxxxx
完了条件2: EC2インスタンスタグ名"handson-cli-instance-stateful-ssh"にアタッチされたEBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"のデバイスファイル名が"sdh"である。
「EC2インスタンスタグ名"handson-cli-instance-stateful-ssh"にアタッチされたEBSボリュームタグ名"handson-cli-instance-stateful-ssh-data-volume"のデバイスファイル名が"sdh"である。」ことを確認します。
コマンド:
aws ec2 describe-instances \ --instance-ids ${EC2_INSTANCE_ID} \ --query "Reservations[].Instances[].BlockDeviceMappings[?Ebs.VolumeId == \`${EC2_VOLUME_ID}\`].DeviceName" \ --output text
結果(例):
sdh