テンプレート記述の基本と実行ヘルパースクリプトの作成

本連載では、以下のイメージの構成のようなマイクロサービスアーキテクチャにおける、基盤自動化環境の構築を実践していきます。

前回は、テンプレートのコード補完／文法チェック等を実行する検証プラグインのインストール方法や、統合開発環境「IntelliJ IDEA」の設定方法を概説しました。続く今回は、CloudFormationの簡単なサンプルを作成し、テンプレート記述の基本を解説した上で、実行するためのヘルパースクリプトや実行エラーの確認方法などについて説明します。

なお、実際のソースコードはGitHub上にコミットしています。以降のソースコードでは本質的でない記述を一部省略しているので、実行コードを作成する場合は、必要に応じて適宜GitHub上のソースコードも参照してください。

CloudFormationテンプレート記述の基本

連載第21回で説明した通り、テンプレートファイルではResources要素が必須となります。加えて、Template VersionやDescritpion、Parameters、Outputsなどが一般的によく使用される要素です。ここでは、シンプルにVPCを構築するテンプレート(test-cfn.yml)を作成してみましょう。

AWSTemplateFormatVersion: '2010-09-09'                                    #(A)

Description: Sample CloudFormation template with YAML - VPC               #(B)

Parameters:                                                               #(C)
  VPCName:                                                                #(D)
    Description: Target VPC Stack Name                                    #(E)
    Type: String
    MinLength: 1
    MaxLength: 255
    AllowedPattern: ^[a-zA-Z][-a-zA-Z0-9]*$
    Default: mynavi-sample-cloudformation-vpc
  VPCCiderBlock:
    Description: CiderBlock paramater for VPC
    Type: String
    MinLength: 9
    MaxLength: 18
    AllowedPattern: (\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/(\d{1,2})
    Default: 172.0.0.0/16

Resources:                                                                #(F)
  VPC:                                                                    #(G)
    Type: AWS::EC2::VPC                                                   #(H)
    Properties:                                                           #(I)
      CidrBlock: !Sub ${VPCCiderBlock}                                    #(J)
      InstanceTenancy: default
      EnableDnsSupport: true
      EnableDnsHostnames: true
      Tags:
        - Key: Name
          Value: !Sub ${VPCName}

Outputs:                                                                  #(K)
  VPCID:                                                                  #(L)
    Description: VPC ID                                                   #(M)
    Value: !Ref VPC
    Export:
      Name: !Sub ${AWS::StackName}-VPCID

テンプレートの記述の基本となるポイントは下表の通りです。

以下に、Parameter要素で記載する「Parameters」の主なプロパティをまとめました。

テンプレート作成後、AWS CLIを使ってコマンド実行します。スタックを作成するには、aws cloudformation create-stackコマンドを実行するのが基本ですが、このコマンドでは、一度Stackを作成すると、アップデートなどを行う際も、いったんaws cloudformation delete-stackコマンドなどでスタックを削除してから再実行する必要があります。ChangeSetを同時に作成し、初回作成後もテンプレートを更新した場合もそのまま使用可能なaws cloudformation deployコマンドを使用して、スタックを作成しましょう。

コマンド実行の引数として、テンプレートのファイルパスや、入力パラメータなど毎回長いコマンドを実行するのも大変なため、実行のヘルパースクリプトを以下の通り作成します。

#!/usr/bin/env bash

stack_name="mynavi-sample-test"
template_path="test-cfn.yml"

#aws cloudformation create-stack --stack-name ${stack_name} --template-body file://${template_path} --capabilities CAPABILITY_IAM
# It is better cloudformation deploy option because command can execute even if stack existing(no need to delete existing stack).
aws cloudformation deploy --stack-name ${stack_name} --template-file ${template_path} --capabilities CAPABILITY_IAM

引数は、作成時のスタック名とテンプレートファイルのパスです。今回は関係ありませんが、IAMロールを作成する際に必要なcapabilitiesオプションを指定して実行しています。

上記はターミナルなどからも実行できますが、ここでは、テンプレート作成エディタで使っているIntelliJ IDEA上から作成したスクリプトを実行します。

コマンドが正常実行されると、下記の通り、AWSコンソール上のCloudFormationサービスからもスタックが作成されたことを確認できます。

一方、テンプレートに記述誤りがあり、CloudFormation実行中に誤ってエラーが発生した場合はどうなるのでしょうか？ 単純な記法誤りなどは、前回のイメージにもあった通り、IntelliJ IDEAでコーディングしている段階でエラー検出されます。エラーが検出されている中で強引に実行しても、以下のように、スクリプト実行時にエラーで終了してしまいます。

しかし、記法上問題なくても論理的にありえないエラーの場合などは実行中にエラーが発生します。以下は、VPC上のCIDRを論理的にありえないアドレス(172.256.0.0/16)になるように入力パラメータを変更して実行した場合の例です。

#!/usr/bin/env bash

stack_name="mynavi-sample-test"
template_path="test-cfn.yml"
parameters="VPCCiderBlock=172.256.0.0/16"

#aws cloudformation create-stack --stack-name ${stack_name} --template-body file://${template_path} --capabilities CAPABILITY_IAM
# It is better cloudformation deploy option because command can execute even if stack existing(no need to delete existing stack).

if [ "$parameters" == "" ]; then
    aws cloudformation deploy --stack-name ${stack_name} --template-file ${template_path} --capabilities CAPABILITY_IAM
else
    aws cloudformation deploy --stack-name ${stack_name} --template-file ${template_path} --parameter-overrides ${parameters} --capabilities CAPABILITY_IAM
fi

この場合、コマンド実行中にエラーとなり、それまでの処理はロールバックされます。AWSコンソール上で、CloudFormationサービスの対象のスタックで、イベントタブからエラーとなった原因を確認できます。

上記は単純な論理的エラーの例ですが、作成対象のリソースによっては、IAM権限不足や設定誤りなど、テンプレートの初回作成時は実行エラーになるケースがしばしば発生します。

都度ロールバックやテンプレートの修正、再実行の繰り返しになるため、上記のように記法誤りの早期検出や、ヘルパースクリプトの作成など繰り返し再実行がしやすい環境を用意して、テンプレートの実装を進めていくことを推奨します。

また、ある程度実装が進んだ段階になると、本番と同等相当のパラメータを使って、複数で構成されるテンプレートの挙動をまとめて確認し、結果を証跡として残したいといったニーズが出てくるかと思います。 そこで次回は、AWSから提供されている、マルチリージョンでテンプレートのテスト実行が複数同時に可能なオープンソースツール「taskcat」を使って、作成したテンプレートをテストする環境を構築し、結果を出力する方法の解説を進めていきます。