4.1. EIPの取得 (handson-cli-ec2-address)¶
作業の目的 [why]¶
EIP"handson-cli-ec2-address"を取得します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- EIPタグ名"handson-cli-ec2-address"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- 一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。
- 事前条件2
- EIPタグ名"handson-cli-ec2-address"が存在しない。
- 事前条件3
- 取得済みのEIPの数が上限値"5"に達していない。
作業対象 [what]¶
- EC2サービス
標準時間(合計)¶
8分
パラメータ設定¶
パラメータ設定の標準時間: | 2分 |
---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 一時ファイル用ディレクトリ
- 今回は"${HOME}/tmp"を一時ファイル用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d ${HOME}/tmp
結果(例:存在する場合):
${HOME}/tmp
ディレクトリが存在しない場合は作成します。
コマンド:
mkdir -p ${HOME}/tmp
リソース2: EIPタグ名
- 取得するEIPのタグ名です。
- 今回は"handson-cli-ec2-address"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-ec2" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-eip-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-ec2/2019-08-05-ec2-eip-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_TMP:"${HOME}/tmp" DIR_TMP="${DIR_TMP}" # 0.2. EC2_EIP_TAG_NAME:"handson-cli-ec2-address" EC2_EIP_TAG_NAME="${EC2_EIP_TAG_NAME}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
タスク標準時間: | 6分 |
---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: 一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。
「一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_TMP}
結果(例):
${HOME}/tmp
事前条件2: EIPタグ名"handson-cli-ec2-address"が存在しない。
「EIPタグ名"handson-cli-ec2-address"が存在しない。」ことを確認します。
コマンド:
aws ec2 describe-addresses \ --filters Name=tag:Name,Values=${EC2_EIP_TAG_NAME} \ --query "Addresses[].Tags[].Value" \ --output text
結果(例):
(出力なし)
事前条件3: 取得済みのEIPの数が上限値"5"に達していない。
「取得済みのEIPの数が上限値"5"に達していない。」ことを確認します。
コマンド:
COUNT_EC2_EIP_ADDRESSES=$( \ aws ec2 describe-addresses \ --query 'length(Addresses[])' ) \ && echo ${COUNT_EC2_EIP_ADDRESSES}
結果(例):
0
1.2. 主処理に必要な情報の取得¶
一時ファイル名の指定
一時ファイル名を指定します。
変数の設定:
FILE_EIP="${DIR_TMP}/$(date +%Y-%m-%d)-eip-${EC2_EIP_TAG_NAME}-${AWS_DEFAULT_REGION}.json" \ && echo ${FILE_EIP}
結果(例):
${HOME}/tmp/2019-08-05-eip-handson-cli-ec2-address-ap-northeast-1.json
2. 主処理¶
EIPの取得¶
コマンド:
aws ec2 allocate-address \ > ${FILE_EIP} cat ${FILE_EIP}
結果(例):
{ "PublicIp": "xxx.xxx.xxx.xxx", "Domain": "vpc", "AllocationId": "eipalloc-xxxxxxxx" }
3. 後処理¶
3.1. 状態確認に必要な情報の取得¶
EIPアロケーションIDの取得
コマンド:
EC2_EIP_ALLOCATION_ID=$( \ cat ${FILE_EIP} \ | jp.py "AllocationId" \ | sed 's/\"//g' \ ) \ && echo ${EC2_EIP_ALLOCATION_ID}
結果(例):
eipalloc-xxxxxxxx
タグ情報の設定
変数の設定:
EC2_RESOURCE_ID=${EC2_EIP_ALLOCATION_ID} \ && echo ${EC2_RESOURCE_ID}
結果(例):
eipalloc-xxxxxxxx
変数の設定:
EC2_TAG_KEY='Name'
変数の設定:
EC2_TAG_VALUE=${EC2_EIP_TAG_NAME} \ && echo ${EC2_TAG_VALUE}
結果(例):
handson-cli-ec2-address
変数の確認:
cat << ETX # EC2_RESOURCE_ID:"eipalloc-xxxxxxxx" EC2_RESOURCE_ID="${EC2_RESOURCE_ID}" # EC2_TAG_KEY:"Name" EC2_TAG_KEY="${EC2_TAG_KEY}" # EC2_TAG_VALUE:"handson-cli-ec2-address" EC2_TAG_VALUE="${EC2_TAG_VALUE}" ETX
コマンド:
aws ec2 create-tags \ --resources ${EC2_RESOURCE_ID} \ --tags "Key=${EC2_TAG_KEY},Value=${EC2_TAG_VALUE}"
結果(例):
(出力なし)
一時ファイルの削除
コマンド:
rm ${FILE_EIP}
結果:
(出力なし)
3.2. 完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: EIPタグ名"handson-cli-ec2-address"が存在する。
「EIPタグ名"handson-cli-ec2-address"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-addresses \ --filters Name=tag:Name,Values=${EC2_EIP_TAG_NAME} \ --query "Addresses[].Tags[].Value" \ --output text
結果(例):
handson-cli-ec2-address