5.3. サブネットの構築 (webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet)

作業の目的 [why]

サブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"を構築します。

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

完了条件 [after]

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

完了条件1

VPC"handson-cli-instance-stateless-loadaverage-vpc"にサブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"が存在する。

完了条件2

サブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"のCIDRは"10.0.1.0/24"である。

完了条件3

サブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"のAZは"ap-northeast-1c"である。

事前条件 [before]

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

事前条件1

VPC"handson-cli-instance-stateless-loadaverage-vpc"が存在する。

事前条件2

VPC"handson-cli-instance-stateless-loadaverage-vpc"にサブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"が存在しない。

事前条件3

AZ"ap-northeast-1c"が存在する。

事前条件4

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

作業対象 [what]

  • VPC

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

リソース1: VPCのタグ名

  • サブネットを構築するVPCのタグ名称です。

  • 今回は"handson-cli-instance-stateless-loadaverage-vpc"とします。

リソース2: サブネットのタグ名

  • 構築するサブネットのタグ名称です。

  • 今回は"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"とします。

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

  • 構築するサブネットのIPアドレスのレンジです。

  • 今回は"10.0.1.0/24"とします。

リソース4: サブネット配置AZ名

  • 構築するサブネットを配置するAZ名です。

  • 今回は"ap-northeast-1c"とします。

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

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

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

コマンド:

ls -d ${HOME}/environment/tmp-handson-cli-instance-stateless-loadaverage

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

${HOME}/environment/tmp-handson-cli-instance-stateless-loadaverage

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

コマンド:

mkdir -p ${HOME}/environment/tmp-handson-cli-instance-stateless-loadaverage

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. VPCのタグ名の指定

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

変数の設定:

EC2_VPC_TAG_NAME='handson-cli-instance-stateless-loadaverage-vpc'

0.2. サブネットのタグ名の指定

サブネットのタグ名を指定します。

変数の設定:

EC2_SUBNET_TAG_NAME='webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet'

0.3. アドレスレンジの指定

サブネットのIPアドレスのレンジをCIDR形式を指定します。

変数の設定:

EC2_SUBNET_CIDR='10.0.1.0/24'

0.4. サブネット配置AZ名の指定

サブネットを配置するAZ名を指定します。

変数の設定:

EC2_AZ_NAME="ap-northeast-1c"

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

変数の設定:

DIR_TMP="${HOME}/environment/tmp-handson-cli-instance-stateless-loadaverage"

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-instance-stateless-loadaverage/2020-01-13-ec2-subnet-create.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. EC2_VPC_TAG_NAME:"handson-cli-instance-stateless-loadaverage-vpc"
         EC2_VPC_TAG_NAME="${EC2_VPC_TAG_NAME}"
  # 0.2. EC2_SUBNET_TAG_NAME:"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"
         EC2_SUBNET_TAG_NAME="${EC2_SUBNET_TAG_NAME}"
  # 0.3. EC2_SUBNET_CIDR:"10.0.1.0/24"
         EC2_SUBNET_CIDR="${EC2_SUBNET_CIDR}"
  # 0.4. EC2_AZ_NAME:"ap-northeast-1c"
         EC2_AZ_NAME="${EC2_AZ_NAME}"
  # 0.5. DIR_TMP:"${HOME}/environment/tmp-handson-cli-instance-stateless-loadaverage"
         DIR_TMP="${DIR_TMP}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

1.1. 処理対象の状態確認

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

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

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

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

コマンド:

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

結果(例):

handson-cli-instance-stateless-loadaverage-vpc

VPC IDを取得します。

コマンド:

EC2_VPC_ID=$( \
  aws ec2 describe-vpcs \
    --filters Name=tag:Name,Values=${EC2_VPC_TAG_NAME}  \
    --query 'Vpcs[].VpcId' \
    --output text \
) \
  && echo ${EC2_VPC_ID}

結果(例):

vpc-xxxxxxxxxxxxxxxxx

事前条件2: VPC"handson-cli-instance-stateless-loadaverage-vpc"にサブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"が存在しない。

「VPC"handson-cli-instance-stateless-loadaverage-vpc"にサブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"が存在しない。」ことを確認します。

コマンド:

aws ec2 describe-subnets \
  --filters Name=vpc-id,Values=${EC2_VPC_ID} \
            Name=tag:Name,Values=${EC2_SUBNET_TAG_NAME}  \
  --query 'Subnets[].Tags[?Key == `Name`].Value' \
  --output text

結果(例):

(出力なし)

事前条件3: AZ"ap-northeast-1c"が存在する。

「AZ"ap-northeast-1c"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-availability-zones \
  --filters Name=region-name,Values=${AWS_DEFAULT_REGION} \
            Name=zone-name,Values=${EC2_AZ_NAME} \
  --query 'AvailabilityZones[].ZoneName' \
  --output text

結果(例):

ap-northeast-1c

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

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

コマンド:

ls -d ${DIR_TMP}

結果(例):

${HOME}/environment/tmp-handson-cli-instance-stateless-loadaverage

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

一時ファイル名の指定

一時ファイル名を指定します。

変数の設定:

FILE_TMP_EC2_SUBNET="${DIR_TMP}/$(date +%Y-%m-%d)-subnet-${EC2_SUBNET_TAG_NAME}-${AWS_DEFAULT_REGION}.json" \
  && echo ${FILE_TMP_EC2_SUBNET}

結果(例):

${HOME}/environment/tmp-handson-cli-instance-stateless-loadaverage/2020-01-13-subnet-webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet-ap-northeast-1.json

2. 主処理

サブネットの作成

変数の確認:

cat << ETX

  # EC2_VPC_ID:"vpc-xxxxxxxxxxxxxxxxx"
    EC2_VPC_ID="${EC2_VPC_ID}"
  # EC2_SUBNET_CIDR:"10.0.1.0/24"
    EC2_SUBNET_CIDR="${EC2_SUBNET_CIDR}"
  # EC2_AZ_NAME:"ap-northeast-1c"
    EC2_AZ_NAME="${EC2_AZ_NAME}"
  # FILE_TMP_EC2_SUBNET:"${HOME}/environment/tmp-handson-cli-instance-stateless-loadaverage/2020-01-13-subnet-webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet-ap-northeast-1.json"
    FILE_TMP_EC2_SUBNET="${FILE_TMP_EC2_SUBNET}"

ETX

コマンド:

aws ec2 create-subnet \
  --vpc-id ${EC2_VPC_ID} \
  --cidr-block ${EC2_SUBNET_CIDR} \
  --availability-zone ${EC2_AZ_NAME} \
  > ${FILE_TMP_EC2_SUBNET}

cat ${FILE_TMP_EC2_SUBNET}

結果(例):

{
  "Subnet": {
    "VpcId": "vpc-xxxxxxxxxxxxxxxxx",
    "CidrBlock": "10.0.1.0/24",
    "State": "pending",
    "AvailabilityZone": "ap-northeast-1c",
    "AvailabilityZoneId": "<AZ_ID>",
    "OwnerId": "XXXXXXXXXXXX",
    "SubnetId": "subnet-xxxxxxxxxxxxxxxxx",
    "AvailableIpAddressCount": 251
    "MapPublicIpOnLaunch": false,
    "DefaultForAz": false,
    "Ipv6CidrBlockAssociationSet": [],
    "AssignIpv6AddressOnCreation": false,
    "SubnetArn": "arn:aws:ec2:ap-northeast-1:XXXXXXXXXXXX:subnet/subnet-xxxxxxxxxxxxxxxxx"
  }
}

3. 後処理

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

サブネットIDの取得

コマンド:

EC2_SUBNET_ID=$( \
  cat ${FILE_TMP_EC2_SUBNET} \
    | jp.py "Subnet.SubnetId" \
    | sed 's/\"//g' \
) \
  && echo ${EC2_SUBNET_ID}

結果(例):

subnet-xxxxxxxxxxxxxxxxx

タグ情報の設定

変数の設定:

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

結果(例):

subnet-xxxxxxxxxxxxxxxxx

変数の設定:

EC2_TAG_KEY='Name'

変数の設定:

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

結果(例):

webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet

変数の確認:

cat << ETX

  # EC2_RESOURCE_ID:"subnet-xxxxxxxxxxxxxxxxx"
    EC2_RESOURCE_ID="${EC2_RESOURCE_ID}"
  # EC2_TAG_KEY:"Name"
    EC2_TAG_KEY="${EC2_TAG_KEY}"
  # EC2_TAG_VALUE:"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"
    EC2_TAG_VALUE="${EC2_TAG_VALUE}"

ETX

コマンド:

aws ec2 create-tags \
  --resources ${EC2_RESOURCE_ID} \
  --tags "Key=${EC2_TAG_KEY},Value=${EC2_TAG_VALUE}"

結果(例):

(出力なし)

3.2. 完了条件の確認

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

完了条件1: VPC"handson-cli-instance-stateless-loadaverage-vpc"にサブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"が存在する。

「VPC"handson-cli-instance-stateless-loadaverage-vpc"にサブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-subnets \
  --filters Name=vpc-id,Values=${EC2_VPC_ID} \
            Name=tag:Name,Values=${EC2_SUBNET_TAG_NAME}  \
  --query 'Subnets[].Tags[?Key == `Name`].Value' \
  --output text

結果(例):

webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet

完了条件2: サブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"のCIDRは"10.0.1.0/24"である。

「サブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"のCIDRは"10.0.1.0/24"である。」ことを確認します。

コマンド:

aws ec2 describe-subnets \
  --filters Name=vpc-id,Values=${EC2_VPC_ID} \
            Name=tag:Name,Values=${EC2_SUBNET_TAG_NAME}  \
  --query "Subnets[].CidrBlock" \
  --output text

結果(例):

10.0.1.0/24

完了条件3: サブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"のAZは"ap-northeast-1c"である。

「サブネット"webhost-charlie-handson-cli-instance-stateless-loadaverage-subnet"のAZは"ap-northeast-1c"である。」ことを確認します。

コマンド:

aws ec2 describe-subnets \
  --filters Name=vpc-id,Values=${EC2_VPC_ID} \
            Name=tag:Name,Values=${EC2_SUBNET_TAG_NAME}  \
  --query "Subnets[].AvailabilityZone" \
  --output text

結果(例):

ap-northeast-1c

3.3. 後処理に必要な作業

一時ファイルの削除

コマンド:

rm ${FILE_TMP_EC2_SUBNET}

結果:

(出力なし)

完了