4.1. サブネットの作成 (subnet-public-alpha)

作業の目的 [why]

サブネット"subnet-public-alpha"を作成します。

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

完了条件 [after]

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

完了条件1
VPC"vpc-handson-cli"にサブネット"subnet-public-alpha"が存在する。
完了条件2
サブネット"subnet-public-alpha"のCIDRは"10.192.0.0/24"である。
完了条件3
サブネット"subnet-public-alpha"のAZは"ap-northeast-1a"である。

事前条件 [before]

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

事前条件1
一時ファイル用ディレクトリが存在する。
事前条件2
VPC"vpc-handson-cli"が存在する。
事前条件3
VPC"vpc-handson-cli"にサブネット"subnet-public-alpha"が存在しない。
事前条件4
VPC"vpc-handson-cli"にCIDR"10.192.0.0/24"を利用しているサブネットが存在しない。
事前条件5
AZ"ap-northeast-1a"が存在する。

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

作業対象 [what]

  • VPC

標準時間

8分

前提条件

作業権限条件 [who]

本作業は、以下の作業権限を有する人が行います。

作業権限条件: EC2への権限

EC2に対してフル権限があること。

作業環境条件 [where]

本作業は、以下の作業環境で行います。

作業環境条件1: OSとバージョン

Amazon Linuxの以下のバージョンで動作確認済

コマンド:

cat /etc/issue | head -1

結果(例):

Amazon Linux AMI release 2016.09

作業環境条件2: シェルとバージョン

bashの以下のバージョンで動作確認済

コマンド:

bash --version -v | head -1

結果(例):

GNU bash, バージョン 4.2.46(1)-release (x86_64-redhat-linux-gnu)

作業環境条件3: AWS CLIのバージョン

以下のバージョンで動作確認済

  • AWS CLI 1.14.23

コマンド:

aws --version

結果(例):

aws-cli/1.14.28 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.8.32

バージョンが古い場合は最新版に更新しましょう。

コマンド:

sudo -H pip install -U awscli

開始条件

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

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

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

  • 今回は"${HOME}/tmp"を作業用ディレクトリとします。
  • ディレクトリの存在を確認します。

コマンド:

ls -d ${HOME}/tmp

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

${HOME}/tmp
  • ディレクトリが存在しない場合は作成します。

コマンド:

mkdir -p ${HOME}/tmp

リソース2: VPCのタグ名

  • サブネットを作成するVPCのタグ名称です。
  • 今回は"vpc-handson-cli"とします。

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

  • 作成するサブネットのタグ名称です。
  • 今回は"subnet-public-alpha"とします。

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

  • 作成するサブネットのIPアドレスのレンジです。
  • 今回は"10.192.0.0/24"とします。

リソース5: AZ

  • 作成するサブネットを配置するAZです。
  • 今回は"ap-northeast-1a"とします。

作業開始 [when]

以下を全て満たしているとき、作業を開始します。

  • 開始の指示があった場合。

タスクの実施

0. パラメータの指定

まず変数の確認をします。

変数の確認:

cat << ETX

  # 0.a. AWS_DEFAULT_PROFILE:"<EC2のフル権限を許可されたプロファイル>"
         AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}"
  # 0.b. 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:"vpc-handson-cli"
         VPC_TAG_NAME="${VPC_TAG_NAME}"
  # 0.3. VPC_SUBNET_TAG_NAME:"subnet-public-alpha"
         VPC_SUBNET_TAG_NAME="${VPC_SUBNET_TAG_NAME}"
  # 0.4. VPC_SUBNET_CIDR:"10.192.0.0/24"
         VPC_SUBNET_CIDR="${VPC_SUBNET_CIDR}"
  # 0.5. VPC_SUBNET_AZ:"ap-northeast-1a"
         VPC_SUBNET_AZ="${VPC_SUBNET_AZ}"

ETX

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

0.a. プロファイルの指定

プロファイルの一覧を確認します。

コマンド:

cat ~/.aws/credentials \
 | grep '\[' \
 | sed 's/\[//g' | sed 's/\]//g'

結果(例):

iamFull-prjz-mbpr13
<EC2のフル権限を許可されたプロファイル>

変数の設定:

export AWS_DEFAULT_PROFILE='<EC2のフル権限を許可されたプロファイル>'

0.b. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

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

変数の設定:

DIR_TMP="${HOME}/tmp"

0.2. VPCのタグ名の指定

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

変数の設定:

VPC_TAG_NAME='vpc-handson-cli'

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

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

変数の設定:

VPC_SUBNET_TAG_NAME='subnet-public-alpha'

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

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

変数の設定:

VPC_SUBNET_CIDR='10.192.0.0/24'

0.5. AZの指定

サブネットを配置するAZです。

変数の設定:

VPC_SUBNET_AZ="${AWS_DEFAULT_REGION}a" \
  && echo ${VPC_SUBNET_AZ}

結果(例):

ap-northeast-1a

再確認

設定されている変数の内容を再確認します。

変数の確認:

cat << ETX

  # 0.a. AWS_DEFAULT_PROFILE:"<EC2のフル権限を許可されたプロファイル>"
         AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}"
  # 0.b. 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:"vpc-handson-cli"
         VPC_TAG_NAME="${VPC_TAG_NAME}"
  # 0.3. VPC_SUBNET_TAG_NAME:"subnet-public-alpha"
         VPC_SUBNET_TAG_NAME="${VPC_SUBNET_TAG_NAME}"
  # 0.4. VPC_SUBNET_CIDR:"10.192.0.0/24"
         VPC_SUBNET_CIDR="${VPC_SUBNET_CIDR}"
  # 0.5. VPC_SUBNET_AZ:"ap-northeast-1a"
         VPC_SUBNET_AZ="${VPC_SUBNET_AZ}"

ETX

1. 前処理

1.1. 処理対象の状態確認

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

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

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

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

コマンド:

ls -d ${DIR_TMP}

結果(例):

${HOME}/tmp

事前条件2: VPC"vpc-handson-cli"が存在する。

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

変数の設定:

EC2_TAG_KEY='Name'

コマンド:

aws ec2 describe-vpcs \
  --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_TAG_NAME}  \
  --query "Vpcs[].Tags[].Value"

結果(例):

[
  "vpc-handson-cli"
]

VPC IDの取得

VPC IDを取得します。

コマンド:

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

結果(例):

vpc-xxxxxxxx

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

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

変数の設定:

EC2_TAG_KEY='Name'

コマンド:

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

結果(例):

[]

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

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

コマンド:

aws ec2 describe-subnets \
  --filters Name=vpc-id,Values=${VPC_ID} \
            Name=cidrBlock,Values=${VPC_SUBNET_CIDR} \
  --query 'Subnets[].CidrBlock'

結果(例):

[]

事前条件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=${VPC_SUBNET_AZ} \
  --query 'AvailabilityZones[].ZoneName'

結果(例):

[
  "ap-northeast-1a"
]

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

ファイル名の指定

変数の設定:

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

結果(例):

${HOME}/tmp/20180121-subnet-subnet-public-alpha-ap-northeast-1.json

2. 主処理

サブネットの作成

変数の確認:

cat << ETX

  # VPC_ID:"vpc-xxxxxxxx"
    VPC_ID="${VPC_ID}"
  # VPC_SUBNET_CIDR:"10.192.0.0/24"
    VPC_SUBNET_CIDR="${VPC_SUBNET_CIDR}"
  # VPC_SUBNET_AZ:"ap-northeast-1a"
    VPC_SUBNET_AZ="${VPC_SUBNET_AZ}"
  # FILE_OUTPUT:"${HOME}/tmp/20180121-subnet-subnet-public-alpha-ap-northeast-1.json"
    FILE_OUTPUT="${FILE_OUTPUT}"

ETX

コマンド:

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

cat ${FILE_OUTPUT}

結果(例):

{
  "Subnet": {
    "VpcId": "vpc-xxxxxxxx",
    "CidrBlock": "10.192.0.0/24",
    "State": "pending",
    "AvailabilityZone": "ap-northeast-1a",
    "SubnetId": "subnet-xxxxxxxx",
    "AvailableIpAddressCount": 251
    "MapPublicIpOnLaunch": false,
    "DefaultForAz": false,
    "Ipv6CidrBlockAssociationSet": [],
    "AssignIpv6AddressOnCreation": false
  }
}

3. 後処理

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

サブネットIDの取得

コマンド:

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

結果(例):

subnet-xxxxxxxx

タグ情報の設定

変数の設定:

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

結果(例):

subnet-public-alpha

変数の設定:

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

結果(例):

subnet-xxxxxxxx

変数の設定:

EC2_TAG_KEY='Name'

変数の確認:

cat << ETX

  # EC2_TAG_KEY:"Name"
    EC2_TAG_KEY="${EC2_TAG_KEY}"
  # EC2_TAG_VALUE:"subnet-public-alpha"
    EC2_TAG_VALUE="${EC2_TAG_VALUE}"
  # EC2_RESOURCE_ID:"subnet-xxxxxxxx"
    EC2_RESOURCE_ID="${EC2_RESOURCE_ID}"

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"vpc-handson-cli"にサブネット"subnet-public-alpha"が存在する。

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

コマンド:

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

結果(例):

[
  "subnet-public-alpha"
]

完了条件2: サブネット"subnet-public-alpha"のCIDRは"10.192.0.0/24"である。

「サブネット"subnet-public-alpha"のCIDRは"10.192.0.0/24"である。」ことを確認します。

コマンド:

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

結果(例):

[
  "10.192.0.0/24"
]

完了条件3: サブネット"subnet-public-alpha"のAZは"ap-northeast-1a"である。

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

コマンド:

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

結果(例):

[
  "ap-northeast-1a"
]

完了