1.5.1. サブネットの作成 (app-alpha-handson-cli-instance-stateful-ssh-subnet)

作業の目的 [why]

サブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"を作成します。

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

完了条件 [after]

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

完了条件1

VPC"handson-cli-instance-stateful-ssh-vpc"にサブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"が存在する。

完了条件2

サブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"のCIDRは"10.0.0.0/24"である。

完了条件3

サブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"のAZは"ap-northeast-1a"である。

事前条件 [before]

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

事前条件1

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

事前条件2

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

事前条件3

VPC"handson-cli-instance-stateful-ssh-vpc"にサブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"が存在しない。

事前条件4

VPC"handson-cli-instance-stateful-ssh-vpc"にCIDR"10.0.0.0/24"を利用しているサブネットが存在しない。

事前条件5

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

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

作業対象 [what]

  • VPC

標準時間(合計)

8分

パラメータ設定

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

2分

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

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

リソース1: VPCのタグ名

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

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

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

  • 作成するサブネットのタグ名称です。

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

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

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

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

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

  • 作成するサブネットを配置するAZ名です。

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

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

  • 今回は"${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_SUBNET_TAG_NAME='app-alpha-handson-cli-instance-stateful-ssh-subnet'

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

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

変数の設定:

VPC_SUBNET_CIDR='10.0.0.0/24'

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

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

変数の設定:

EC2_AZ_NAME="ap-northeast-1a"

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

変数の設定:

DIR_TMP="${HOME}/tmp"

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-instance-stateful-ssh/2019-09-16-ec2-subnet-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_TAG_NAME:"handson-cli-instance-stateful-ssh-vpc"
         VPC_TAG_NAME="${VPC_TAG_NAME}"
  # 0.3. VPC_SUBNET_TAG_NAME:"app-alpha-handson-cli-instance-stateful-ssh-subnet"
         VPC_SUBNET_TAG_NAME="${VPC_SUBNET_TAG_NAME}"
  # 0.4. VPC_SUBNET_CIDR:"10.0.0.0/24"
         VPC_SUBNET_CIDR="${VPC_SUBNET_CIDR}"
  # 0.5. EC2_AZ_NAME:"ap-northeast-1a"
         EC2_AZ_NAME="${EC2_AZ_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間

6分

1. 前処理

1.1. 処理対象の状態確認

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

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

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

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

コマンド:

ls -d ${DIR_TMP}

結果(例):

${HOME}/tmp

事前条件2: 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

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

事前条件3: VPC"handson-cli-instance-stateful-ssh-vpc"にサブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"が存在しない。

「VPC"handson-cli-instance-stateful-ssh-vpc"にサブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"が存在しない。」ことを確認します。

コマンド:

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

結果(例):

(出力なし)

事前条件4: VPC"handson-cli-instance-stateful-ssh-vpc"にCIDR"10.0.0.0/24"を利用しているサブネットが存在しない。

「VPC"handson-cli-instance-stateful-ssh-vpc"にCIDR"10.0.0.0/24"を利用しているサブネットが存在しない。」ことを確認します。

コマンド:

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

結果(例):

(出力なし)

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

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

コマンド:

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-1a

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

ファイル名の指定

変数の設定:

FILE_OUTPUT="${DIR_TMP}/$(date +%Y-%m-%d)-subnet-${VPC_SUBNET_TAG_NAME}-${EC2_AZ_NAME}.json" \
  && echo ${FILE_OUTPUT}

結果(例):

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

2. 主処理

サブネットの作成

変数の確認:

cat << ETX

  # VPC_ID:"vpc-xxxxxxxxxxxxxxxxx"
    VPC_ID="${VPC_ID}"
  # VPC_SUBNET_CIDR:"10.0.0.0/24"
    VPC_SUBNET_CIDR="${VPC_SUBNET_CIDR}"
  # EC2_AZ_NAME:"ap-northeast-1a"
    EC2_AZ_NAME="${EC2_AZ_NAME}"
  # FILE_OUTPUT:"${HOME}/tmp/2019-09-16-subnet-app-alpha-handson-cli-instance-stateful-ssh-subnet-ap-northeast-1.json"
    FILE_OUTPUT="${FILE_OUTPUT}"

ETX

コマンド:

aws ec2 create-subnet \
  --vpc-id ${VPC_ID} \
  --cidr-block ${VPC_SUBNET_CIDR} \
  --availability-zone ${EC2_AZ_NAME} \
  > ${FILE_OUTPUT}

cat ${FILE_OUTPUT}

結果(例):

{
  "Subnet": {
    "VpcId": "vpc-xxxxxxxx",
    "CidrBlock": "10.0.0.0/24",
    "State": "pending",
    "AvailabilityZone": "ap-northeast-1a",
    "AvailabilityZoneId": "apnet-azx",
    "OwnerId": "XXXXXXXXXXXX",
    "SubnetId": "subnet-xxxxxxxx",
    "AvailableIpAddressCount": 251
    "MapPublicIpOnLaunch": false,
    "DefaultForAz": false,
    "Ipv6CidrBlockAssociationSet": [],
    "AssignIpv6AddressOnCreation": false,
    "SubnetArn": "arn:aws:ec2:ap-northeast-1:XXXXXXXXXXXX:subnet/subnet-xxxxxxxxxxxxxxxxx"

3. 後処理

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

サブネットIDの取得

コマンド:

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

結果(例):

subnet-xxxxxxxxxxxxxxxxx

タグ情報の設定

変数の設定:

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

結果(例):

subnet-xxxxxxxxxxxxxxxxx

変数の設定:

EC2_TAG_KEY='Name'

変数の設定:

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

結果(例):

app-alpha-handson-cli-instance-stateful-ssh-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:"app-alpha-handson-cli-instance-stateful-ssh-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}"

結果(例):

(出力なし)

一時ファイルの削除

コマンド:

rm ${FILE_OUTPUT}

結果:

(出力なし)

3.2. 完了条件の確認

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

完了条件1: VPC"handson-cli-instance-stateful-ssh-vpc"にサブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"が存在する。

「VPC"handson-cli-instance-stateful-ssh-vpc"にサブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"が存在する。」ことを確認します。

コマンド:

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

結果(例):

app-alpha-handson-cli-instance-stateful-ssh-subnet

完了条件2: サブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"のCIDRは"10.0.0.0/24"である。

「サブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"のCIDRは"10.0.0.0/24"である。」ことを確認します。

コマンド:

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

結果(例):

10.0.0.0/24

完了条件3: サブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"のAZは"ap-northeast-1a"である。

「サブネット"app-alpha-handson-cli-instance-stateful-ssh-subnet"のAZは"ap-northeast-1a"である。」ことを確認します。

コマンド:

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

結果(例):

ap-northeast-1a

完了