事前作業2.1. IGWの作成

作業の目的 [why]

IGW"igw-handson-2017-11-20"を作成します。

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

完了条件 [after]

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

完了条件1
IGW"igw-handson-2017-11-20"が存在する。

事前条件 [before]

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

事前条件1
tmpファイル用ディレクトリが存在する。
事前条件2
IGW"igw-handson-2017-11-20"が存在しない。

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

課題

(未検証)

作業対象 [what]

  • EC2サービス

標準時間

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.11.117

コマンド:

aws --version

結果(例):

aws-cli/1.11.189 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.7.47

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

コマンド:

sudo -H pip install -U awscli

開始条件

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

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

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

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

    ls ${HOME}/tmp

  • 存在しない場合は作成します。

    mkdir -p ${HOME}/tmp

リソース2: IGWタグ名

  • 作成するIGWのタグ名称です。
  • 今回は"igw-handson-2017-11-20"とします。

作業開始 [when]

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

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

タスクの実施

0. パラメータの指定

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

変数の確認:

cat << ETX

  0.a. AWS_DEFAULT_PROFILE: actual: ${AWS_DEFAULT_PROFILE}
                            expect: <EC2のフル権限を許可されたプロファイル>
  0.b. AWS_DEFAULT_REGION:  actual: ${AWS_DEFAULT_REGION}
                            expect: ap-northeast-1

  0.1. DIR_TMP:             actual: ${DIR_TMP}
                            expect: ${HOME}/tmp
  0.2. VPC_IGW_TAG_NAME:    actual: ${VPC_IGW_TAG_NAME}
                            expect: igw-handson-2017-11-20

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. tmpファイルディレクトリの指定

変数の設定:

DIR_TMP="${HOME}/tmp"

0.2. IGWのタグ名の指定

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

変数の設定:

VPC_IGW_TAG_NAME='igw-handson-2017-11-20'

再確認

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

変数の確認:

cat << ETX

  0.a. AWS_DEFAULT_PROFILE: actual: ${AWS_DEFAULT_PROFILE}
                            expect: <EC2のフル権限を許可されたプロファイル>
  0.b. AWS_DEFAULT_REGION:  actual: ${AWS_DEFAULT_REGION}
                            expect: ap-northeast-1

  0.1. DIR_TMP:             actual: ${DIR_TMP}
                            expect: ${HOME}/tmp
  0.2. VPC_IGW_TAG_NAME:    actual: ${VPC_IGW_TAG_NAME}
                            expect: igw-handson-2017-11-20

ETX

1. 前処理

1.1. 処理対象の状態確認

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

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

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

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

コマンド:

ls -d ${DIR_TMP}

結果(例):

${HOME}/tmp

事前条件2: IGW"igw-handson-2017-11-20"が存在しない。

「IGW"igw-handson-2017-11-20"が存在しない。」ことを確認します。

変数の設定:

EC2_TAG_KEY='Name'

コマンド:

aws ec2 describe-internet-gateways \
  --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_IGW_TAG_NAME}  \
  --query "InternetGateways[].Tags[].Value"

結果(例):

[]

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

ファイル名の指定

変数の設定:

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

結果(例):

${HOME}/tmp/2017-11-20-igw-igw-handson-2017-11-20.json

2. 主処理

IGWの作成

変数の確認:

cat << ETX

  FILE_OUTPUT: actial: ${FILE_OUTPUT}
               expect: ${HOME}/tmp/2017-11-20-igw-igw-handson-2017-11-20.json

ETX

コマンド:

aws ec2 create-internet-gateway \
  > ${FILE_OUTPUT}

cat ${FILE_OUTPUT}

結果(例):

{
  "InternetGateway": {
    "Tags": [],
    "InternetGatewayId": "igw-xxxxxxxx",
    "Attachments": []
  }
}

3. 後処理

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

IGW IDの取得

コマンド:

VPC_IGW_ID=$( \
  cat ${FILE_OUTPUT} \
    | jp.py "InternetGateway.InternetGatewayId" \
    | sed 's/\"//g' \
) \
  && echo ${VPC_IGW_ID}

結果(例):

igw-xxxxxxxx

タグ情報の設定

変数の設定:

EC2_TAG_KEY='Name'

変数の設定:

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

結果(例):

igw-handson-2017-11-20

変数の設定:

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

結果(例):

igw-xxxxxxxx

タグの追加

変数の確認:

cat << ETX

  EC2_TAG_KEY:     actual: ${EC2_TAG_KEY}
                   expect: Name
  EC2_TAG_VALUE:   actual: ${EC2_TAG_VALUE}
                   expect: igw-handson-2017-11-20
  EC2_RESOURCE_ID: actual: ${EC2_RESOURCE_ID}
                   expect: igw-xxxxxxxx

ETX

コマンド:

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

結果(例):

(出力なし)

コマンド:

rm ${FILE_OUTPUT}

一時ファイルの削除

結果:

(出力なし)

3.2. 完了条件の確認

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

完了条件1: IGW"igw-handson-2017-11-20"が存在する。

「IGW"igw-handson-2017-11-20"が存在する。」ことを確認します。

コマンド:

aws ec2 describe-internet-gateways \
  --filters Name=tag:${EC2_TAG_KEY},Values=${VPC_IGW_TAG_NAME}  \
  --query "InternetGateways[].Tags[].Value"

結果(例):

[
  "igw-handson-2017-11-20"
]

完了