1. カスタマゲートウェイの作成 (cgw-handson-cli)

作業の目的 [why]

カスタマゲートウェイ"cgw-handson-cli"を作成します。

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

完了条件 [after]

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

完了条件1
カスタマゲートウェイ"cgw-handson-cli"が存在する。

事前条件 [before]

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

事前条件1
tmpファイル用ディレクトリ"${HOME}/tmp"が存在する。
事前条件2
カスタマゲートウェイ"cgw-handson-cli"が存在しない。

作業対象 [what]

  • EC2サービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: 一時ファイル用ディレクトリ

  • 今回は"${HOME}/tmp"を一時ファイル用ディレクトリとします。

ディレクトリが存在することを確認します。

コマンド:

ls -d ${HOME}/tmp

結果(例:存在する場合):

${HOME}/tmp

ディレクトリが存在しない場合は作成します。

コマンド:

mkdir -p ${HOME}/tmp

リソース2: カスタマゲートウェイのタグ名

  • 作成するカスタマゲートウェイのタグ名称です。
  • 今回は"cgw-handson-cli"とします。

リソース3: カスタマコネクションタイプ

  • 作成するカスタマゲートウェイのコネクションタイプです。
  • 今回は"ipsec.1"とします。

リソース4: AS番号

  • 作成するカスタマゲートウェイのAS番号です。
  • プライベートAS番号を使う場合は、64512–65534の範囲で指定します。
  • 今回は"65000"とします。

リソース5: IPアドレス

  • 作成するカスタマゲートウェイの外部インタフェース側のIPアドレスです。
  • 今回は"xxx.xxx.xxx.xxx"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. 一時ファイル用ディレクトリの指定

変数の設定:

DIR_TMP="${HOME}/tmp"

0.2. カスタマゲートウェイのタグ名の指定

カスタマゲートウェイのタグ名を指定します。

変数の設定:

VPC_CGW_TAG_NAME='cgw-handson-cli'

0.3. カスタマゲートウェイのタイプの指定

カスタマゲートウェイのタイプを指定します。

変数の設定:

VPC_CGW_TYPE='ipsec.1'

0.4. カスタマゲートウェイのAS番号の指定

カスタマゲートウェイのAS番号を指定します。

変数の設定:

VPC_CGW_ASN='65000'

0.5. IPアドレスの指定

カスタマゲートウェイの外部インタフェースのIPアドレスを指定します。

変数の設定:

VPC_CGW_IP='xxx.xxx.xxx.xxx'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-ec2-customer_gateway-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_CGW_TAG_NAME:"cgw-handson-cli"
         VPC_CGW_TAG_NAME="${VPC_CGW_TAG_NAME}"
  # 0.3. VPC_CGW_TYPE:"ipsec.1"
         VPC_CGW_TYPE="${VPC_CGW_TYPE}"
  # 0.4. VPC_CGW_ASN:"65000"
         VPC_CGW_ASN="${VPC_CGW_ASN}"
  # 0.5. VPC_CGW_IP:"xxx.xxx.xxx.xxx"
         VPC_CGW_IP="${VPC_CGW_IP}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

課題

(未検証)

タスク標準時間:6分

1. 前処理

1.2. 処理対象の状態確認

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

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

事前条件1: tmpファイル用ディレクトリ"${HOME}/tmp"が存在する。

「tmpファイル用ディレクトリ"${HOME}/tmp"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_TMP}

結果(例):

${HOME}/tmp

事前条件2: カスタマゲートウェイ"cgw-handson-cli"が存在しない。

「カスタマゲートウェイ"cgw-handson-cli"が存在しない。」ことを確認します。

コマンド:

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

結果(例):

(出力なし)

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

ファイル名の指定

変数の設定:

FILE_OUTPUT="${DIR_TMP}/$(date +%Y-%m-%d)-vpc-${VPC_CGW_TAG_NAME}-${AWS_DEFAULT_REGION}.json" \
  && echo ${FILE_OUTPUT}

結果(例):

${HOME}/tmp/2019-04-30-vpc-cgw-handson-cli-ap-northeast-1.json

2. 主処理

カスタマゲートウェイの作成

変数の確認:

cat << ETX

  # FILE_OUTPUT:"${HOME}/tmp/2019-04-30-vgw-cgw-handson-cli-ap-northeast-1.json"
    FILE_OUTPUT="${FILE_OUTPUT}"
  # VPC_CGW_TYPE:"ipsec.1"
    VPC_CGW_TYPE="${VPC_CGW_TYPE}"

ETX

コマンド:

aws ec2 create-customer-gateway \
  --type ${VPC_CGW_TYPE} \
  > ${FILE_OUTPUT}

cat ${FILE_OUTPUT}

結果(例):

|yet|

3. 後処理

3.1. 状態確認に必要な情報の取得

CGW IDの取得

コマンド:

VPC_CGW_ID=$( \
  cat ${FILE_OUTPUT} \
    | jp.py "CustomerGateway.CustomerGatewayId" \
    | sed 's/\"//g' \
) \
  && echo ${VPC_CGW_ID}

結果(例):

cgw-xxxxxxxxxxxxxxxxx

タグ情報の設定

変数の設定:

EC2_RESOURCE_ID=${VPC_CGW_ID} \
  && echo ${EC2_RESOURCE_ID}

結果(例):

cgw-xxxxxxxxxxxxxxxxx

変数の設定:

EC2_TAG_KEY='Name'

変数の設定:

EC2_TAG_VALUE=${VPC_CGW_TAG_NAME} \
  && echo ${EC2_TAG_VALUE}

結果(例):

cgw-handson-cli

変数の確認:

cat << ETX

  # EC2_RESOURCE_ID:"cgw-xxxxxxxxxxxxxxxxx"
    EC2_RESOURCE_ID="${EC2_RESOURCE_ID}"
  # EC2_TAG_KEY:"Name"
    EC2_TAG_KEY="${EC2_TAG_KEY}"
  # EC2_TAG_VALUE:"cgw-handson-cli"
    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}

結果:

(出力なし)

完了条件の確認

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

完了条件1: カスタマゲートウェイ"cgw-handson-cli"が存在する。

「カスタマゲートウェイ"cgw-handson-cli"が存在する。」ことを確認します。

コマンド:

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

結果(例):

cgw-handson-cli

完了