1. VPCピア接続の作成 (リージョン越え: handson-cli-vpc-us-west-2-vpcpeer)¶
作業の目的 [why]¶
リージョン間("ap-northeast-1"-"us-west-2")のVPCピア接続名"handson-cli-vpc-us-west-2-vpcpeer"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- VPCピア接続名"handson-cli-vpc-us-west-2-vpcpeer"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- 一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。
- 事前条件2
- VPCピア接続名"handson-cli-vpc-us-west-2-vpcpeer"が存在しない。
- 事前条件3
- VPC"handson-cli-vpc"が存在する。
- 事前条件4
- リージョン"us-west-2"にVPCピア接続先VPC"handson-cli-vpc"が存在する。
作業対象 [what]¶
- EC2サービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 一時ファイル用ディレクトリ
- 今回は"${HOME}/tmp"を一時ファイル用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d ${HOME}/tmp
結果(例:存在する場合):
${HOME}/tmp
ディレクトリが存在しない場合は作成します。
コマンド:
mkdir -p ${HOME}/tmp
リソース2: VPCピア接続のタグ名
- 作成するVPCピア接続のタグ名称です。
- 今回は"handson-cli-vpc-us-west-2-vpcpeer"とします。
リソース3: VPCタグ名
- 作成するVPCピア接続を要求する側のVPCのタグ名称です。
- 今回は"handson-cli-vpc"とします。
リソース4: VPCピア接続先VPCタグ名
- 作成するVPCピア接続の接続先のリージョン名です。
- 今回は"us-west-2"とします。
リソース5: VPCピア接続先VPCタグ名
- 作成するVPCピア接続の接続先のVPCのタグ名称です。
- 今回は"handson-cli-vpc"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-vpc_peering_connection_region-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-ec2-vpc_peering_connection_region-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. VPC_PEERING_TAG_NAME:"handson-cli-vpc-us-west-2-vpcpeer" VPC_PEERING_TAG_NAME="${VPC_PEERING_TAG_NAME}" # 0.3. VPC_TAG_NAME:"handson-cli-vpc" VPC_TAG_NAME="${VPC_TAG_NAME}" # 0.4. VPC_REGION_PEER:"us-west-2" VPC_REGION_PEER="${VPC_REGION_PEER}" # 0.5. VPC_TAG_NAME_PEER:"handson-cli-vpc" VPC_TAG_NAME_PEER="${VPC_TAG_NAME_PEER}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
課題
(未検証)
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: 一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。
「一時ファイル用ディレクトリ"${HOME}/tmp"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_TMP}
結果(例):
${HOME}/tmp
事前条件2: VPCピア接続名"handson-cli-vpc-us-west-2-vpcpeer"が存在しない。
「VPCピア接続名"handson-cli-vpc-us-west-2-vpcpeer"が存在しない。」ことを確認します。
コマンド:
aws ec2 describe-vpc-peering-connections \ --filters Name=tag:Name,Values=${VPC_PEERING_TAG_NAME} \ --query "VpcPeeringConnections[].Tags[].Value" \ --output text
結果(例):
(出力なし)
事前条件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: リージョン"us-west-2"にVPCピア接続先VPC"handson-cli-vpc"が存在する。
「リージョン"us-west-2"にVPCピア接続先VPC"handson-cli-vpc"が存在する。」ことを確認します。
変数の設定:
export AWS_DEFAULT_REGION="us-west-2"
コマンド:
aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${VPC_TAG_NAME_PEER} \ --query "Vpcs[].Tags[].Value" \ --output text
結果(例):
handson-cli-vpc
VPC IDを取得します。
コマンド:
VPC_ID_PEER=$( \ aws ec2 describe-vpcs \ --filters Name=tag:Name,Values=${VPC_TAG_NAME_PEER} \ --query 'Vpcs[].VpcId' \ --output text \ ) \ && echo ${VPC_ID_PEER}
結果(例):
vpc-yyyyyyyyyyyyyyyyy
変数の設定:
export AWS_DEFAULT_REGION="ap-northeast-1"
1.2. 主処理に必要な情報の取得¶
ファイル名の指定
変数の設定:
FILE_OUTPUT="${DIR_TMP}/$(date +%Y-%m-%d)-vpc_peering-${VPC_PEERING_TAG_NAME}-${AWS_DEFAULT_REGION}.json" \ && echo ${FILE_OUTPUT}
結果(例):
${HOME}/tmp/2019-04-30-vpc_peering-handson-cli-vpc-us-west-2-vpcpeer-ap-northeast-1.json
2. 主処理¶
VPCピア接続の作成¶
変数の確認:
cat << ETX # FILE_OUTPUT:"${HOME}/tmp/2019-04-30-vpc_peering-handson-cli-vpc-us-west-2-vpcpeer-ap-northeast-1.json" FILE_OUTPUT="${FILE_OUTPUT}" # VPC_ID:"vpc-xxxxxxxxxxxxxxxxx" VPC_ID="${VPC_ID}" # VPC_ID_PEER:"vpc-yyyyyyyyyyyyyyyyy" VPC_ID_PEER="${VPC_ID_PEER}" # VPC_REGION_PEER:"us-west-2" VPC_REGION_PEER="${VPC_REGION_PEER}" ETX
コマンド:
aws ec2 create-vpc-peering-connection \ --vpc-id ${VPC_ID} \ --peer-vpc-id ${VPC_ID_PEER} \ --peer-region ${VPC_REGION_PEER} \ > ${FILE_OUTPUT} cat ${FILE_OUTPUT}
結果(例):
{ "VpcPeeringConnection": { "AccepterVpcInfo": { "OwnerId": "XXXXXXXXXXXX", "VpcId": "vpc-yyyyyyyyyyyyyyyyy", "Region": "us-west-2" }, "ExpirationTime": "2019-04-30T01:23:45.000Z", "RequesterVpcInfo": { "CidrBlock": "10.0.0.0/16", "CidrBlockSet": [ { "CidrBlock": "10.0.0.0/16" } ], "OwnerId": "XXXXXXXXXXXX", "PeeringOptions": { "AllowDnsResolutionFromRemoteVpc": false, "AllowEgressFromLocalClassicLinkToRemoteVpc": false, "AllowEgressFromLocalVpcToRemoteClassicLink": false }, "VpcId": "vpc-xxxxxxxxxxxxxxxxx", "Region": "ap-northeast-1" }, "Status": { "Code": "initiating-request", "Message": "Initiating Request to XXXXXXXXXXXX" }, "Tags": [], "VpcPeeringConnectionId": "pcx-xxxxxxxxxxxxxxxxx" } }
3. 後処理¶
3.1. 状態確認に必要な情報の取得¶
VPCピア接続IDの取得
コマンド:
VPC_PEERING_ID=$( \ cat ${FILE_OUTPUT} \ | jp.py "VpcPeeringConnection.VpcPeeringConnectionId" \ | sed 's/\"//g' \ ) \ && echo ${VPC_PEERING_ID}
結果(例):
pcx-xxxxxxxxxxxxxxxxx
タグ情報の設定
変数の設定:
EC2_RESOURCE_ID=${VPC_PEERING_ID} \ && echo ${EC2_RESOURCE_ID}
結果(例):
pcx-xxxxxxxxxxxxxxxxx
変数の設定:
EC2_TAG_KEY='Name'
変数の設定:
EC2_TAG_VALUE=${VPC_PEERING_TAG_NAME} \ && echo ${EC2_TAG_VALUE}
結果(例):
handson-cli-vpc-us-west-2-vpcpeer
変数の確認:
cat << ETX # EC2_RESOURCE_ID:"pcx-xxxxxxxxxxxxxxxxx" EC2_RESOURCE_ID="${EC2_RESOURCE_ID}" # EC2_TAG_KEY:"Name" EC2_TAG_KEY="${EC2_TAG_KEY}" # EC2_TAG_VALUE:"handson-cli-vpc-us-west-2-vpcpeer" 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: VPCピア接続名"handson-cli-vpc-us-west-2-vpcpeer"が存在する。
「VPCピア接続名"handson-cli-vpc-us-west-2-vpcpeer"が存在する。」ことを確認します。
コマンド:
aws ec2 describe-vpc-peering-connections \ --filters Name=tag:Name,Values=${VPC_PEERING_TAG_NAME} \ --query "VpcPeeringConnections[].Tags[].Value" \ --output text
結果(例):
handson-cli-vpc-us-west-2-vpcpeer