1.1. VPCの作成 (handson-cli-instance-stateful-ssh-vpc)

作業の目的 [why]

VPC"handson-cli-instance-stateful-ssh-vpc"を作成します。

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

完了条件 [after]

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

完了条件1

VPC"handson-cli-instance-stateful-ssh-vpc"が存在する。

完了条件2

VPC"handson-cli-instance-stateful-ssh-vpc"のCIDRが"10.0.0.0/16"である。

事前条件 [before]

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

事前条件1

VPC"handson-cli-instance-stateful-ssh-vpc"が存在しない。

事前条件2

VPCの数が上限値"5"に達していない。

事前条件3

一時ファイル用ディレクトリが存在する。

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

作業対象 [what]

  • EC2サービス

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

リソース1: VPCタグ名

  • 作成するVPCのタグ名称です。

  • 今回は"handson-cli-instance-stateful-ssh-vpc"とします。

リソース2: アドレスレンジ

  • 作成するVPCのIPアドレスのレンジです。

  • 今回は"10.0.0.0/16"とします。

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

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

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

コマンド:

ls -d ${HOME}/tmp

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

${HOME}/tmp

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

コマンド:

mkdir -p ${HOME}/tmp

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. VPCのタグ名の指定

VPCのタグ名を指定します。

変数の設定:

VPC_TAG_NAME='handson-cli-instance-stateful-ssh-vpc'

0.2. VPCのアドレスレンジ指定

VPCのアドレスレンジをCIDRで指定します。

変数の設定:

VPC_CIDR='10.0.0.0/16'

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

変数の設定:

DIR_TMP="${HOME}/tmp"

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-instance-stateful-ssh/2019-09-16-ec2-vpc-create.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-instance-stateful-ssh-vpc"
         VPC_TAG_NAME="${VPC_TAG_NAME}"
  # 0.2. VPC_CIDR:"10.0.0.0/16"
         VPC_CIDR="${VPC_CIDR}"
  # 0.3. DIR_TMP:"${HOME}/tmp"
         DIR_TMP="${DIR_TMP}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: VPC"handson-cli-instance-stateful-ssh-vpc"が存在しない。

「VPC"handson-cli-instance-stateful-ssh-vpc"が存在しない。」ことを確認します。

コマンド:

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

結果(例):

(出力なし)

事前条件2: VPCの数が上限値"5"に達していない。

「VPCの数が上限値"5"に達していない。」ことを確認します。

コマンド:

COUNT_VPCS=$( \
  aws ec2 describe-vpcs \
    --query 'length(Vpcs[])'
  ) \
  && echo ${COUNT_VPCS}

結果(例):

1

事前条件3: 一時ファイル用ディレクトリが存在する。

「一時ファイル用ディレクトリが存在する。」ことを確認します。

コマンド:

ls -d ${DIR_TMP}

結果(例):

${HOME}/tmp

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

ファイル名の指定

変数の設定:

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

結果(例):

${HOME}/tmp/2019-09-16-vpc-handson-cli-instance-stateful-ssh-vpc-ap-northeast-1.json

2. 主処理

VPCの作成

変数の確認:

cat << ETX

  # VPC_CIDR:"10.0.0.0/16"
    VPC_CIDR="${VPC_CIDR}"
  # FILE_OUTPUT:"${HOME}/tmp/2019-09-16-vpc-handson-cli-instance-stateful-ssh-vpc-ap-northeast-1.json"
    FILE_OUTPUT="${FILE_OUTPUT}"

ETX

コマンド:

aws ec2 create-vpc \
  --cidr-block ${VPC_CIDR} \
  > ${FILE_OUTPUT}

cat ${FILE_OUTPUT}

結果(例):

{
  "Vpc": {
    "VpcId": "vpc-xxxxxxxxxxxxxxxxx",
    "InstanceTenancy": "default",
    "Tags": [],
    "CidrBlockAssociationSet": [
        {
            "AssociationId": "vpc-cidr-assoc-xxxxxxxx",
            "CidrBlock": "10.0.0.0/16",
            "CidrBlockState": {
                "State": "associated"
            }
        }
    ],
    "Ipv6CidrBlockAssociationSet": [],
    "State": "pending",
    "DhcpOptionsId": "dopt-xxxxxxxx",
    "CidrBlock": "vpc-xxxxxxxxxxxxxxxxx",
    "IsDefault": false
  }
}

3. 後処理

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

VPC IDの取得

コマンド:

VPC_ID=$( \
  cat ${FILE_OUTPUT} \
    | jp.py "Vpc.VpcId" \
    | sed 's/\"//g' \
) \
  && echo ${VPC_ID}

結果(例):

vpc-xxxxxxxxxxxxxxxxx

タグ情報の設定

変数の設定:

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

結果(例):

vpc-xxxxxxxxxxxxxxxxx

変数の設定:

EC2_TAG_KEY='Name'

変数の設定:

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

結果(例):

handson-cli-instance-stateful-ssh-vpc

変数の確認:

cat << ETX

  # EC2_RESOURCE_ID:"vpc-xxxxxxxxxxxxxxxxx"
    EC2_RESOURCE_ID="${EC2_RESOURCE_ID}"
  # EC2_TAG_KEY:"Name"
    EC2_TAG_KEY="${EC2_TAG_KEY}"
  # EC2_TAG_VALUE:"handson-cli-instance-stateful-ssh-vpc"
    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-instance-stateful-ssh-vpc"が存在する。

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

コマンド:

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

結果(例):

handson-cli-instance-stateful-ssh-vpc

完了条件2: VPC"handson-cli-instance-stateful-ssh-vpc"のCIDRが"10.0.0.0/16"である。

「VPC"handson-cli-instance-stateful-ssh-vpc"のCIDRが"10.0.0.0/16"である。」ことを確認します。

コマンド:

aws ec2 describe-vpcs \
  --filters Name=tag:Name,Values=${VPC_TAG_NAME} \
  --query "Vpcs[].CidrBlock" \
  --output text

結果(例):

10.0.0.0/16

完了