3. CloudFormation スタックの作成¶
作業の目的 [why]¶
CloudFormationスタック"handson20171225"を作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- CloudFormationスタック"handson20171225"が存在する。
- 完了条件2
- CloudFormationスタック"handson20171225"のステータスが"CREATE_COMPLETE"になっている。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- 設定ファイルが存在する。
- 事前条件2
- CloudFormationスタック"handson20171225"が存在しない。
前提と異なることが判明した場合、直ちに処理を中止します。
作業対象 [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.117
コマンド:
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スタックの名称です。
- 今回は"handson20171225"とします。
リソース3: CloudFormationテンプレートファイル名
- 利用するCloudFormationテンプレートのファイル名です。
- 今回は"${HOME}/tmp/conf-cfn/20171225-handson.template"とします。
タスクの実施¶
0. パラメータの指定¶
まず変数の確認をします。
変数の確認:
cat << ETX # 0.a. AWS_DEFAULT_PROFILE:"<CloudFormationのフル権限を許可されたプロファイル>" AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}" # 0.b. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_CONF:"${HOME}/tmp/conf-cfn" DIR_CONF="${DIR_CONF}" # 0.2. CF_STACK_NAME:"handson20171225" CF_STACK_NAME="${CF_STACK_NAME}" # 0.3. FILE_INPUT:"${HOME}/tmp/conf-cfn/20171225-handson.template" FILE_INPUT="${FILE_INPUT}" ETX
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号について作業を行います。
0.a. プロファイルの指定¶
プロファイルの一覧を確認します。
コマンド:
cat ~/.aws/credentials \ | grep '\[' \ | sed 's/\[//g' | sed 's/\]//g'
結果(例):
iamFull-prjz-mbpr13 <CloudFormationのフル権限を許可されたプロファイル>
変数の設定:
export AWS_DEFAULT_PROFILE='<CloudFormationのフル権限を許可されたプロファイル>'
0.3. テンプレートファイル名の指定¶
CloudFormationテンプレートのファイル名を指定します。
変数の設定:
FILE_INPUT="${DIR_CONF}/20171225-handson.template" \ && echo ${FILE_INPUT}
結果(例):
${HOME}/tmp/conf-cfn/20171225-handson.template
再確認¶
設定されている変数の内容を再確認します。
変数の確認:
cat << ETX # 0.a. AWS_DEFAULT_PROFILE:"<CloudFormationのフル権限を許可されたプロファイル>" AWS_DEFAULT_PROFILE="${AWS_DEFAULT_PROFILE}" # 0.b. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. DIR_CONF:"${HOME}/tmp/conf-cfn" DIR_CONF="${DIR_CONF}" # 0.2. CF_STACK_NAME:"handson20171225" CF_STACK_NAME="${CF_STACK_NAME}" # 0.3. FILE_INPUT:"${HOME}/tmp/conf-cfn/20171225-handson.template" FILE_INPUT="${FILE_INPUT}" ETX
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: 設定ファイルが存在する。
「設定ファイルが存在する。」ことを確認します。
コマンド:
ls ${FILE_INPUT}
結果(例):
${HOME}/tmp/conf-cfn/20171225-handson.template
事前条件2: CloudFormationスタック"handson20171225"が存在しない。
「CloudFormationスタック"handson20171225"が存在しない。」ことを確認します。
コマンド:
aws cloudformation list-stacks \ --query "StackSummaries[?StackName == \`${CF_STACK_NAME}\`].StackName"
結果(例):
[]
2. 主処理¶
CloudFormationスタックの作成¶
変数の確認:
cat << ETX # CF_STACK_NAME: handson20171225 CF_STACK_NAME="${CF_STACK_NAME}" # FILE_INPUT: ${HOME}/tmp/conf-cfn/20171225-handson.template FILE_INPUT="${FILE_INPUT}" ETX
コマンド:
aws cloudformation create-stack \ --stack-name "${CF_STACK_NAME}" \ --template-body file://${FILE_INPUT}
結果(例):
{ "StackId": "arn:aws:cloudformation:ap-northeast-1:XXXXXXXXXXXX:stack/handson20171225/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }
3. 後処理¶
3.1. 完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: CloudFormationスタック"handson20171225"が存在する。
「CloudFormationスタック"handson20171225"が存在する。」ことを確認します。
コマンド:
aws cloudformation list-stacks \ --query "StackSummaries[?StackName == \`${CF_STACK_NAME}\`].StackName"
結果(例):
[ "handson20171225" ]
完了条件2: CloudFormationスタック"handson20171225"のステータスが"CREATE_COMPLETE"になっている。
「CloudFormationスタック"handson20171225"のステータスが"CREATE_COMPLETE"になっている。」ことを確認します。
コマンド:
CF_STACK_STATUS=$(\ aws cloudformation list-stacks \ --query "StackSummaries[?StackName == \`${CF_STACK_NAME}\`].StackStatus" \ --output text \ ) \ && echo ${CF_STACK_STATUS}
結果(例):
CREATE_COMPLETE
3.2. 後処理に必要な作業¶
後処理に必要な作業があれば実施します。
イベントの確認
ステータスがROLLBUCKになった場合は、イベントを確認して原因を特定します。
コマンド:
aws cloudformation describe-stack-events \ --stack-name ${CF_STACK_NAME}
結果(例):
(省略)