2. CloudFormation (create: 20171225-handson)¶
作業の目的 [why]¶
CloudFormationテンプレート"20171225-handson"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- CloudFormationテンプレート"20171225-handson"がYAMLとして正常である。
- 完了条件2
- CloudFormationテンプレート"20171225-handson"がCloudFormationテンプレートとして正常である。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- 設定ファイル用ディレクトリが存在する。
- 事前条件2
- CloudFormationテンプレート"20171225-handson"が存在しない。
- 事前条件3
- 作業用ディレクトリが存在する。
前提と異なることが判明した場合、直ちに処理を中止します。
課題
(未検証)
作業対象 [what]¶
- CloudFormationサービス
標準時間¶
8分
前提条件¶
作業環境条件 [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.150
コマンド:
aws --version
結果(例):
aws-cli/1.14.16 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.8.20
バージョンが古い場合は最新版に更新しましょう。
コマンド:
sudo -H pip install -U awscli
開始条件¶
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: 設定ファイル用ディレクトリ
今回は"${HOME}/tmp/conf-cfn"を設定ファイル用ディレクトリとします。
ls ${HOME}/tmp/conf-cfn
存在しない場合は作成します。
mkdir -p ${HOME}/tmp/conf-cfn
リソース2: CloudFormationテンプレート名
- 作成するCloudFormationテンプレートの名称です。
- 今回は"20171225-handson"とします。
リソース3: CloudFormationテンプレートの説明
- 作成するCloudFormationテンプレートの説明です。
- 今回は"JAWS-UG CLI handson 20171225."とします。
リソース4: 一時作業用ディレクトリ
- 今回は"${HOME}/tmp/cfn-20171225-handson"を作業用ディレクトリとします。
タスクの実施¶
0. パラメータの指定¶
まず変数の確認をします。
変数の確認:
cat << ETX # 0.a. AWS_DEFAULT_PROFILE:"<CloudFormationのvalidate-template権限が許可されているプロファイル>" AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}" # 0.1. DIR_CONF:"${HOME}/tmp/conf-cfn" DIR_CONF="${DIR_CONF}" # 0.2. CFN_TEMPLATE_NAME:"20171225-handson" CFN_TEMPLATE_NAME="${CFN_TEMPLATE_NAME}" # 0.3. CFN_TEMPLATE_DESC:"JAWS-UG CLI handson 20171225." CFN_TEMPLATE_DESC="${CFN_TEMPLATE_DESC}" # 0.4. DIR_TMP:"${HOME}/tmp/cfn-20171225-handson" DIR_TMP="${DIR_TMP}" ETX
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号について作業を行います。
0.a. プロファイルの指定¶
プロファイルの一覧を確認します。
コマンド:
cat ~/.aws/credentials \ | grep '\[' \ | sed 's/\[//g' | sed 's/\]//g'
結果(例):
iamFull-prjz-mbpr13 <CloudFormationのvalidate-template権限が許可されているプロファイル>
変数の設定:
export AWS_DEFAULT_PROFILE='<CloudFormationのvalidate-template権限が許可されているプロファイル>'
0.2. CloudFormationテンプレート名の指定¶
CloudFormationテンプレート名を指定します。
変数の設定:
CFN_TEMPLATE_NAME='20171225-handson'
0.3. CloudFormationテンプレートの説明の指定¶
CloudFormationテンプレートの説明を指定します。
変数の設定:
CFN_TEMPLATE_DESC='JAWS-UG CLI handson 20171225.'
再確認¶
設定されている変数の内容を再確認します。
変数の確認:
cat << ETX # 0.a. AWS_DEFAULT_PROFILE:"<CloudFormationのvalidate-template権限が許可されているプロファイル>" AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}" # 0.1. DIR_CONF:"${HOME}/tmp/conf-cfn" DIR_CONF="${DIR_CONF}" # 0.2. CFN_TEMPLATE_NAME:"20171225-handson" CFN_TEMPLATE_NAME="${CFN_TEMPLATE_NAME}" # 0.3. CFN_TEMPLATE_DESC:"JAWS-UG CLI handson 20171225." CFN_TEMPLATE_DESC="${CFN_TEMPLATE_DESC}" # 0.4. DIR_TMP:"${HOME}/tmp/cfn-20171225-handson" DIR_TMP="${DIR_TMP}" ETX
1. 前処理¶
1.1. 状態確認に必要な情報の取得¶
テンプレートファイル名の指定
変数の設定:
FILE_INPUT="${DIR_CONF}/${CFN_TEMPLATE_NAME}.template" \ && echo ${FILE_INPUT}
結果(例):
${HOME}/tmp/conf-cfn/20171225-handson.template
1.2. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: 設定ファイル用ディレクトリが存在する。
「設定ファイル用ディレクトリが存在する。」ことを確認します。
コマンド:
ls -d ${DIR_CONF}
結果(例):
${HOME}/tmp/conf-cfn
事前条件2: CloudFormationテンプレート"20171225-handson"が存在しない。
「CloudFormationテンプレート"20171225-handson"が存在しない。」ことを確認します。
コマンド:
ls ${FILE_INPUT}
結果(例):
ls: ${HOME}/tmp/conf-cfn/20171225-handson.template: No such file or directory
事前条件3: 作業用ディレクトリが存在する。
「作業用ディレクトリが存在する。」ことを確認します。
コマンド:
ls -d ${DIR_TMP}
結果(例):
${HOME}/tmp/cfn-20171225-handson
1.3. 主処理に必要な情報の取得¶
Resourcesセクションの作成
変数の設定:
FILE_CFN_RESOURCES="${DIR_TMP}/resources.txt" \ && echo ${FILE_CFN_RESOURCES}
結果(例):
${HOME}/tmp/cfn-20171225-handson/resources.txt
コマンド:
echo 'Resources:' > ${FILE_CFN_RESOURCES}
コマンド:
for i in $( ls ${DIR_TMP}/resources/*.txt ); do \ cat $i | sed '/^$/d' >> ${FILE_CFN_RESOURCES}; \ echo '' >> ${FILE_CFN_RESOURCES} \ ; done cat ${FILE_CFN_RESOURCES}
2. 主処理¶
2.1. CloudFormationテンプレート共通部分の作成¶
コマンド:
cat << EOF > ${FILE_INPUT} AWSTemplateFormatVersion: '2010-09-09' Description: "${CFN_TEMPLATE_DESC}" EOF cat ${FILE_INPUT}
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: CloudFormationテンプレート"20171225-handson"がYAMLとして正常である。
「CloudFormationテンプレート"20171225-handson"がYAMLとして正常である。」ことを確認します。
YAMLファイルを作成したら、フォーマットが壊れてないか必ず確認します。
コマンド:
yamllint ${FILE_INPUT}
エラーが出力されなければOKです。
完了条件2: CloudFormationテンプレート"20171225-handson"がCloudFormationテンプレートとして正常である。
「CloudFormationテンプレート"20171225-handson"がCloudFormationテンプレートとして正常である。」ことを確認します。
コマンド:
aws cloudformation validate-template \ --template-body file://${FILE_INPUT}
結果(例):
{ "Description": "JAWS-UG CLI handson 20171225.", "Parameters": [] }