1. プライベート仮想インタフェースの承認 (vif-handson-cli-vyos)

作業の目的 [why]

プライベート仮想インタフェース"vif-handson-cli-vyos"の承認をします。

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

完了条件 [after]

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

完了条件1
仮想インタフェース"vif-handson-cli-vyos"のステータスが"後ステータス"である。

事前条件 [before]

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

事前条件1
仮想インタフェース"vif-handson-cli-vyos"が存在する。
事前条件2
VPNゲートウェイ"vgw-handson-cli-vyos"が存在する。
事前条件3
仮想インタフェース"vif-handson-cli-vyos"のステータスが"confirming"である。

作業対象 [what]

  • DirectConnect仮想インタフェース

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: 仮想インタフェース

  • 承認する仮想インタフェースの名称です。
  • 今回は"vif-handson-cli-vyos"とします。

リソース2: VPNゲートウェイ名

  • 承認する仮想インタフェースに割り当てるVPNゲートウェイの名称です。
  • 今回は"vgw-handson-cli-vyos"とします。

パラメータの指定

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

0.1. 仮想インタフェース名の指定

仮想インタフェース名を指定します。

変数の設定:

DX_VIRTUAL_INTERFACE_NAME='vif-handson-cli-vyos'

0.2. VPNゲートウェイ名の指定

VPNゲートウェイ名を指定します。

変数の設定:

VPC_VGW_TAG_NAME='vgw-handson-cli-vyos'

パラメータの保存

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

変数の設定:

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

結果(例):

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

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. DX_VIRTUAL_INTERFACE_NAME:"vif-handson-cli-vyos"
         DX_VIRTUAL_INTERFACE_NAME="${DX_VIRTUAL_INTERFACE_NAME}"
  # 0.2. VPC_VGW_TAG_NAME:"vgw-handson-cli-vyos"
         VPC_VGW_TAG_NAME="${VPC_VGW_TAG_NAME}"

EOF
cat ${FILE_PARAMETER}

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

タスクの実施

課題

(未検証)

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: 仮想インタフェース"vif-handson-cli-vyos"が存在する。

「仮想インタフェース"vif-handson-cli-vyos"が存在する。」ことを確認します。

コマンド:

aws directconnect describe-virtual-interfaces \
  --query "virtualInterfaces[?virtualInterfaceName == \`${DX_VIRTUAL_INTERFACE_NAME}\`].virtualInterfaceName" \
  --output text

結果(例):

vif-handson-cli-vyos

事前条件2: VPNゲートウェイ"vgw-handson-cli-vyos"が存在する。

「VPNゲートウェイ"vgw-handson-cli-vyos"が存在する。」ことを確認します。

コマンド:

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

結果(例):

vgw-handson-cli-vyos

事前条件3: 仮想インタフェース"vif-handson-cli-vyos"のステータスが"confirming"である。

「仮想インタフェース"vif-handson-cli-vyos"のステータスが"confirming"である。」ことを確認します。

コマンド:

aws directconnect describe-virtual-interfaces \
  --query "virtualInterfaces[?virtualInterfaceName == \`${DX_VIRTUAL_INTERFACE_NAME}\`].virtualInterfaceState" \
  --output text

結果(例):

confirming

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

仮想インタフェースIDの取得

コマンド:

DX_VIRTUAL_INTERFACE_ID=$( \
  aws directconnect describe-virtual-interfaces \
    --query "virtualInterfaces[?virtualInterfaceName == \`${DX_VIRTUAL_INTERFACE_NAME}\`].virtualInterfaceId" \
    --output text \
) \
  && echo ${DX_VIRTUAL_INTERFACE_ID}

結果(例):

dxvif-xxxxxxxx

VPNゲートウェイ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. 主処理

仮想インタフェースの承認

変数の確認:

# DX_VIRTUAL_INTERFACE_ID:"dxvif-xxxxxxxx"
  DX_VIRTUAL_INTERFACE_ID:"${DX_VIRTUAL_INTERFACE_ID}"
# VPC_VGW_ID:"vgw-xxxxxxxxxxxxxxxxx"
  VPC_VGW_ID:"${VPC_VGW_ID}"

コマンド:

aws directconnect confirm-private-virtual-interface \
  --virtual-interface-id ${DX_VIRTUAL_INTERFACE_ID} \
  --virtual-gateway-id ${VPC_VGW_ID}

結果(例):

{
  "virtualInterfaceState": "pending"
}

3. 後処理

完了条件の確認

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

完了条件1: 仮想インタフェース"vif-handson-cli-vyos"のステータスが"後ステータス"である。

「仮想インタフェース"vif-handson-cli-vyos"のステータスが"後ステータス"である。」ことを確認します。

コマンド:

aws directconnect describe-virtual-interfaces \
  --query "virtualInterfaces[?virtualInterfaceName == \`${DX_VIRTUAL_INTERFACE_NAME}\`].virtualInterfaceState" \
  --output text

結果(例):

後ステータス

完了