2. VPNゲートウェイのアタッチ (handson-cli-bastion-vpc: handson-cli-bastion-vgw)

作業の目的 [why]

VPNゲートウェイ"handson-cli-bastion-vgw"をVPC"handson-cli-bastion-vpc"にアタッチします。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1
VPC"handson-cli-bastion-vpc"にVGW"handson-cli-bastion-vgw"がアタッチされている。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1
VPC"handson-cli-bastion-vpc"が存在する。
事前条件2
VGW"handson-cli-bastion-vgw"が存在する。
事前条件3
VPC"handson-cli-bastion-vpc"にVGW"handson-cli-bastion-vgw"がアタッチされていない。

作業対象 [what]

  • EC2サービス

標準時間(合計)

8分

パラメータ設定

パラメータ設定の標準時間:2分

作業に必要なモノ・情報 [resource]

作業開始には、以下が全て揃っていることが必要です。

リソース1: VPCタグ名

  • VGWをアタッチするVPCのタグ名称です。
  • 今回は"handson-cli-bastion-vpc"とします。

リソース2: VGWタグ名

  • VPCにアタッチするVGWのタグ名称です。
  • 今回は"handson-cli-bastion-vgw"とします。

パラメータの指定

作業に必要なパラメータを変数に格納をします。

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. VPCタグ名の指定

VPCタグ名を指定します。

変数の設定:

VPC_TAG_NAME='handson-cli-bastion-vpc'

0.2. VGWタグ名の指定

VGWタグ名を指定します。

変数の設定:

VPC_VGW_TAG_NAME='handson-cli-bastion-vgw'

パラメータの保存

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ec2-vpn_gateway_attach-update.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-ec2-vpn_gateway_attach-update.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. VPC_TAG_NAME:"handson-cli-bastion-vpc"
         VPC_TAG_NAME="${VPC_TAG_NAME}"
  # 0.2. VPC_VGW_TAG_NAME:"handson-cli-bastion-vgw"
         VPC_VGW_TAG_NAME="${VPC_VGW_TAG_NAME}"

EOF

cat ${FILE_PARAMETER}

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: VPC"handson-cli-bastion-vpc"が存在する。

「VPC"handson-cli-bastion-vpc"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-vpcs \
  --filters Name=tag:Name,Values=${VPC_TAG_NAME}  \
  --query 'Vpcs[].Tags[?Key == `Name`].Value' \
  --output text

結果(例):

handson-cli-bastion-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

事前条件2: VGW"handson-cli-bastion-vgw"が存在する。

「VGW"handson-cli-bastion-vgw"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-vpn-gateways \
  --filters Name=tag:Name,Values=${VPC_VGW_TAG_NAME}  \
  --query "VpnGateways[].Tags[].Value" \
  --output text

結果(例):

handson-cli-bastion-vgw

事前条件3: VPC"handson-cli-bastion-vpc"にVGW"handson-cli-bastion-vgw"がアタッチされていない。

「VPC"handson-cli-bastion-vpc"にVGW"handson-cli-bastion-vgw"がアタッチされていない。」ことを確認します。

コマンド:

aws ec2 describe-vpn-gateways \
  --filters Name=tag:Name,Values=${VPC_VGW_TAG_NAME}  \
  --query "VpnGateways[].VpcAttachments[?VpcId == \`${VPC_ID}\`].VpcId" \
  --output text

結果(例):

(出力なし)

1.2. 主処理に必要な情報の取得

VGW IDの取得

コマンド:

VPC_VGW_ID=$( \
  aws ec2 describe-vpn-gateways \
    --filters Name=tag:Name,Values=${VPC_VGW_TAG_NAME} \
    --query "VpnGateways[].VpnGatewayId" \
    --output text \
) \
  && echo ${VPC_VGW_ID}

結果(例):

vgw-xxxxxxxxxxxxxxxxx

2. 主処理

VPNゲートウェイのアタッチ

変数の確認:

cat << ETX

  # VPC_VGW_ID:"vgw-xxxxxxxxxxxxxxxxx"
    VPC_VGW_ID="${VPC_VGW_ID}"
  # VPC_ID:"vpc-xxxxxxxxxxxxxxxxx"
    VPC_ID="${VPC_ID}"

ETX

コマンド:

aws ec2 attach-vpn-gateway \
  --vpn-gateway-id ${VPC_VGW_ID} \
  --vpc-id ${VPC_ID}

結果(例):

{
  "VpcAttachment": {
    "State": "attaching",
    "VpcId": "vpc-xxxxxxxxxxxxxxxxx"
  }
}

3. 後処理

完了条件の確認

主処理は、以下を満たしたときに成功したものとします。

完了条件1: VPC"handson-cli-bastion-vpc"にVGW"handson-cli-bastion-vgw"がアタッチされている。

「VPC"handson-cli-bastion-vpc"にVGW"handson-cli-bastion-vgw"がアタッチされている。」ことを確認します。

コマンド:

aws ec2 describe-vpn-gateways \
  --filters Name=tag:Name,Values=${VPC_VGW_TAG_NAME}  \
  --query "VpnGateways[].VpcAttachments[?VpcId == \`${VPC_ID}\`].VpcId" \
  --output text

結果(例):

vpc-xxxxxxxxxxxxxxxxx

完了