6.1. CloudFormationテンプレートの作成 (handson-cli-bastion-vpc-cfn)

作業の目的 [why]

CloudFormationスタック"handson-cli-bastion-vpc-cfn"を作成します。

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

完了条件 [after]

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

完了条件1
CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"が存在する。
完了条件2
CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"がYAMLとして正常である。
完了条件3
CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"がCloudFormationテンプレートとして正常である。

事前条件 [before]

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

事前条件1
リソースファイル用ディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn/resources"が存在する。
事前条件2
テンプレートファイル用ディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn"が存在する。
事前条件3
CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"が存在しない。

作業対象 [what]

  • CloudFormationサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

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

CloudFormationテンプレートを配置したディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn/resources"です。

リソース2: テンプレートファイル用ディレクトリ

  • 今回は"${HOME}/tmp/handson-cli-bastion-vpc-cfn"をCloudFormationテンプレート用ディレクトリとします。

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

コマンド:

ls -d ${HOME}/tmp/handson-cli-bastion-vpc-cfn

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

${HOME}/tmp/handson-cli-bastion-vpc-cfn

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

コマンド:

mkdir -p ${HOME}/tmp/handson-cli-bastion-vpc-cfn

リソース3: CloudFormationテンプレート名

  • 作成するCloudFormationテンプレートの名称です。
  • 今回は"handson-cli-bastion-vpc-cfn"とします。

リソース4: CloudFormationテンプレートの説明

  • 作成するCloudFormationテンプレートの説明です。
  • 今回は"vpc template for handson-cli-bastion"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. テンプレートファイルディレクトリの指定

変数の設定:

DIR_CFN_TEMPLATE="${HOME}/tmp/handson-cli-bastion-vpc-cfn"

0.2. CloudFormationテンプレート名の指定

CloudFormationテンプレート名を指定します。

変数の設定:

CFN_TEMPLATE_NAME='handson-cli-bastion-vpc-cfn'

0.3. CloudFormationテンプレートの説明

CloudFormationテンプレートの説明を指定します。

変数の設定:

CFN_TEMPLATE_DESC='vpc template for handson-cli-bastion'

0.4. リソースファイルディレクトリの指定

変数の設定:

DIR_CFN_RESOURCE="${HOME}/tmp/handson-cli-bastion-vpc-cfn/resources"

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-cloudformation-template-create.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. DIR_CFN_TEMPLATE:"${HOME}/tmp/handson-cli-bastion-vpc-cfn"
         DIR_CFN_TEMPLATE="${DIR_CFN_TEMPLATE}"
  # 0.2. CFN_TEMPLATE_NAME:"handson-cli-bastion-vpc-cfn"
         CFN_TEMPLATE_NAME="${CFN_TEMPLATE_NAME}"
  # 0.3. CFN_TEMPLATE_DESC:"vpc template for handson-cli-bastion"
         CFN_TEMPLATE_DESC="${CFN_TEMPLATE_DESC}"
  # 0.4. DIR_CFN_RESOURCE:"${HOME}/tmp/handson-cli-bastion-vpc-cfn/resources"
         DIR_CFN_RESOURCE="${DIR_CFN_RESOURCE}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

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

テンプレートファイル名の指定

変数の設定:

FILE_CFN_TEMPLATE="${DIR_CFN_TEMPLATE}/${CFN_TEMPLATE_NAME}.template" \
  && echo ${FILE_CFN_TEMPLATE}

結果(例):

${HOME}/tmp/handson-cli-bastion-vpc-cfn/handson-cli-bastion-vpc-cfn.template

1.2. 処理対象の状態確認

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

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

事前条件1: リソースファイル用ディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn/resources"が存在する。

「リソースファイル用ディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn/resources"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_CFN_RESOURCE}

結果(例):

${HOME}/tmp/handson-cli-bastion-vpc-cfn/resources

事前条件2: テンプレートファイル用ディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn"が存在する。

「テンプレートファイル用ディレクトリ"${HOME}/tmp/handson-cli-bastion-vpc-cfn"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_CFN_TEMPLATE}

結果(例):

${HOME}/tmp/handson-cli-bastion-vpc-cfn

事前条件3: CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"が存在しない。

「CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_CFN_TEMPLATE}

結果(例):

ls: ${HOME}/tmp/handson-cli-bastion-vpc-cfn/handson-cli-bastion-vpc-cfn.template No such file or directory

2. 主処理

2.1. CloudFormationテンプレート共通部分の作成

コマンド:

cat << EOF > ${FILE_CFN_TEMPLATE}
AWSTemplateFormatVersion: '2010-09-09'

Description:
  "${CFN_TEMPLATE_DESC}"

EOF

cat ${FILE_CFN_TEMPLATE}

2.2. Resourcesの追加

コマンド:

echo 'Resources:' >> ${FILE_CFN_TEMPLATE}

for i in $( ls ${DIR_CFN_RESOURCE}/*.txt ); do \
  cat $i | sed '/^$/d' >> ${FILE_CFN_TEMPLATE}; \
  echo '' >> ${FILE_CFN_TEMPLATE} \
; done

cat ${FILE_CFN_TEMPLATE}

3. 後処理

完了条件の確認

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

完了条件1: CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"が存在する。

「CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"が存在する。」ことを確認します。

コマンド:

ls ${FILE_CFN_TEMPLATE}

結果(例):

${HOME}/tmp/handson-cli-bastion-vpc-cfn/handson-cli-bastion-vpc-cfn.template

完了条件2: CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"がYAMLとして正常である。

「CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"が存在する。」ことを確認します。

YAMLファイルを作成したら、フォーマットが壊れてないか必ず確認します。

コマンド:

yamllint ${FILE_CFN_TEMPLATE}

エラーが出力されなければOKです。

完了条件3: CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"がCloudFormationテンプレートとして正常である。

「CloudFormationテンプレート"handson-cli-bastion-vpc-cfn"がYAMLとして正常である。」ことを確認します。

コマンド:

aws cloudformation validate-template \
  --template-body file://${FILE_CFN_TEMPLATE}

結果(例):

{
  "Description": "vpc template for handson-cli-bastion",
  "Parameters": []
}

完了