1. VPNゲートウェイの作成 (handson-cli-vgw)¶
作業の目的 [why]¶
VPNゲートウェイ"handson-cli-vgw"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- VPNゲートウェイ"handson-cli-vgw"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- 一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。
- 事前条件2
- VPNゲートウェイ"handson-cli-vgw"が存在しない。
作業対象 [what]¶
- EC2サービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 一時ファイル用ディレクトリ
- 今回は"${HOME}/tmp"を一時ファイル用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d ${HOME}/tmp
結果(例:存在する場合):
${HOME}/tmp
ディレクトリが存在しない場合は作成します。
コマンド:
mkdir -p ${HOME}/tmp
リソース2: VPNゲートウェイのタグ名
- 作成するVPNゲートウェイのタグ名称です。
- 今回は"handson-cli-vgw"とします。
リソース3: VPNコネクションタイプ
- 作成するVPNゲートウェイのコネクションタイプです。
- 今回は"ipsec.1"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-vpn_gateway-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-ec2-vpn_gateway-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"us-west-2" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_TMP:"${HOME}/tmp" DIR_TMP="${DIR_TMP}" # 0.2. VPC_VGW_TAG_NAME:"handson-cli-vgw" VPC_VGW_TAG_NAME="${VPC_VGW_TAG_NAME}" # 0.3. VPC_VGW_TYPE:"ipsec.1" VPC_VGW_TYPE="${VPC_VGW_TYPE}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: 一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。
「一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_TMP}
結果(例):
${HOME}/tmp
事前条件2: VPNゲートウェイ"handson-cli-vgw"が存在しない。
「VPNゲートウェイ"handson-cli-vgw"が存在しない。」ことを確認します。
コマンド:
aws ec2 describe-vpn-gateways \ --filters Name=tag:Name,Values=${VPC_VGW_TAG_NAME} \ --query "VpnGateways[].Tags[].Value" \ --output text
結果(例):
(出力なし)
1.2. 主処理に必要な情報の取得¶
ファイル名の指定
変数の設定:
FILE_OUTPUT="${DIR_TMP}/$(date +%Y-%m-%d)-vpc-${VPC_VGW_TAG_NAME}-${AWS_DEFAULT_REGION}.json" \ && echo ${FILE_OUTPUT}
結果(例):
${HOME}/tmp/2019-04-30-vpc-handson-cli-vgw-us-west-2.json
2. 主処理¶
VPNゲートウェイの作成¶
変数の確認:
cat << ETX # FILE_OUTPUT:"${HOME}/tmp/2019-04-30-vgw-handson-cli-vgw-us-west-2.json" FILE_OUTPUT="${FILE_OUTPUT}" # VPC_VGW_TYPE:"ipsec.1" VPC_VGW_TYPE="${VPC_VGW_TYPE}" ETX
コマンド:
aws ec2 create-vpn-gateway \ --type ${VPC_VGW_TYPE} \ > ${FILE_OUTPUT} cat ${FILE_OUTPUT}
結果(例):
{ "VpnGateway": { "State": "available", "Type": "ipsec.1", "VpcAttachments": [], "VpnGatewayId": "vgw-xxxxxxxxxxxxxxxxx", "AmazonSideAsn": 64512 } }
3. 後処理¶
3.1. 状態確認に必要な情報の取得¶
VGW IDの取得
コマンド:
VPC_VGW_ID=$( \ cat ${FILE_OUTPUT} \ | jp.py "VpnGateway.VpnGatewayId" \ | sed 's/\"//g' \ ) \ && echo ${VPC_VGW_ID}
結果(例):
vgw-xxxxxxxxxxxxxxxxx
タグ情報の設定
変数の設定:
EC2_RESOURCE_ID=${VPC_VGW_ID} \ && echo ${EC2_RESOURCE_ID}
結果(例):
vgw-xxxxxxxxxxxxxxxxx
変数の設定:
EC2_TAG_KEY='Name'
変数の設定:
EC2_TAG_VALUE=${VPC_VGW_TAG_NAME} \ && echo ${EC2_TAG_VALUE}
結果(例):
handson-cli-vgw
変数の確認:
cat << ETX # EC2_RESOURCE_ID:"vgw-xxxxxxxxxxxxxxxxx" EC2_RESOURCE_ID="${EC2_RESOURCE_ID}" # EC2_TAG_KEY:"Name" EC2_TAG_KEY="${EC2_TAG_KEY}" # EC2_TAG_VALUE:"handson-cli-vgw" 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_OUTPUT}
結果:
(出力なし)
3.2. 完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: VPNゲートウェイ"handson-cli-vgw"が存在する。
「VPNゲートウェイ"handson-cli-vgw"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-vpn-gateways \ --filters Name=tag:Name,Values=${VPC_VGW_TAG_NAME} \ --query "VpnGateways[].Tags[].Value" \ --output text
結果(例):
handson-cli-vgw