#はじめに
今回はCloudFormationでの環境構築について書いていきます。
CloudFormationはソースコードを記載することで自動でインフラの環境構築を行えるすばらしいサービスです。
CloudFormationの特徴
①ソースコードの通りにインフラの環境構築を行う
②ソースコードを共有することで共有先でも同じ環境を用意できる
といった特徴があり、
特に①は開発を行っていく上でヒューマンエラーがなくなる点で優れています。システムを構築する上では人間が行う操作はどうしてもエラー原因のもとを作ってしまうことが多く、これをできる限り少なくすることが、エラーの少ないシステムを作り上げる上では重要な要素となっています。
(例：システム作成時の手順操作が一つ抜けたor誤った等)
しかし、ソースコードで環境構築を行うということで苦手意識を持つ方が多いと思います。
そこで今回は環境構築のイメージがしやすいように
①AWSコンソール操作画面時
②ソースコード
を並行してみながら環境構築するところを記事していきます。
この形式であれば、テンプレートに苦手意識があった方でも作成時のイメージがしやすくなるかと思うのでぜひ一読いただければと思います。
CloudFormation始めて触ってみる方やテンプレートを見てもよくわからなかった方の参考になれば幸いです。
#環境
・AWSサービス(2021/1/26時点)
※各種設定画面は都度アップデートされていますので画像と異なる場合があります。
・エディタ…VisualStudioCode
※エディタは任意のもので作成してもいいですが、VisualStudioCodeにはCloudformationのソースを書く上で非常に便利な拡張機能があるのでそちらを使うと非常に効率よくコードを書けます。)
下記環境の構築の際に参考になる記事を用意しました。
https://nopipi.hatenablog.com/entry/2019/04/27/155616
参照元：のぴぴのメモ
なお、今回はソースコードは画像で貼っていますので手元で確認しながら記事を見たい方はこちらの自分のGithubに置いていますのでこちらからダウンロードしてみてください。
#目次
1.初期項目について
2.VPC作成
3.EC2作成
4.今回のソースコード
5.まとめ
#目標構成図
構成図は前回記事の構成図を再現していきます。
なお、CloudFormationのスタック(作成予定の目標環境)を区別するためVPC、EC2それぞれのサービスでテンプレートを用意します。
#1.初期項目について
構成図の環境構築を行う前にまずCloudFormationで使われる初期項目について見ていきましょう。
| 項目 | 設定内容 | 必須/任意 |
|---|---|---|
| AWSTemplateFormatVersion | Cloudfromationのテンプレート形式バージョンを指定する。 [2010-09-09]はそのまま使用。 | 必須 |
| Description | 英訳の通り説明文になります。このテンプレートの説明を記載します。 | 任意 |
| Metadata | リソースに付与する情報を記載する。(例：認証情報やユーザー情報) | 任意 |
| Parameters | Cloudformationの操作画面内で作成するAWSリソースのパラメータを任意に設定したい場合に記載する項目。(例：VPCの名前を都度任意に設定したい場合等) | 任意 |
| Mappings | 取得したいリソースの参照先を表す際に記載する項目。主にリージョンを超えての参照を行う際に使われる。(例：作業場所が東京リージョンで使用したいAWSのリソースが北米リージョンにある場合など) | 任意 |
| Conditions | テンプレートに記載のリソースを作成する条件を記載する項目。(例：スタックを追加するときに条件が合わなかった場合にそのリソースのみ環境構築を行わない場合等) | 任意 |
| Resources | メインとなる作成するAWSリソースを記載する項目。 | 必須 |
| Outputs | 他スタックと連携する際に必要な指定した値を出力する項目。 | 任意 |
#2.VPC作成
それではまずVPCサービスの構成を作成していきます。
・VPC
・インターネットゲートウェイ
・サブネット
・ElasticIP
・セキュリティグループ
・ルートテーブル
が対象です。
ここから先はResources内に記載する内容です。
###VPC
・左側：実際の操作画面
・右側：テンプレート
VPCの設定になります。
この後のリソース作成でも重要となってくるのが「myVPCID」の部分。
・myVPCID
→ここはVPCの論理IDとなります。
論理IDはそのテンプレート内で一意にしか持てないIDを指し、任意の名称を設定することが出来ます。
(自分は最初、論理IDは決まった値しかないと思い込んでしまい、複数のリソースを作成する際に迷ったことがありました。)
| 項目 | 設定内容 |
|---|---|
| Type | AWSのリソースの種類を指定します。VPCを指定するので「AWS::EC2::VPC」となります。 |
| Properties | 値を設定する項目一覧になります。properties以下に値入力が必要となる項目を設定します。 |
| CidrBlock | VPCのCIDRを設定します。 |
| EnableDnsSupport | VPC に対して DNS 解決がサポートされているかどうかを示します。作成時の画面では設定する場所はありませんがデフォルトで有効になっています。 |
| Tags(Key,Value) | →タグを設定 ※KeyにNameと設定することでValueの値がVPCの名前になります。他のAWSリソースも同様に設定しています。 |
###インターネットゲートウェイ
インターネットゲートウェイの作成とアタッチまで行っています。
ここで注目すべき点は黄枠と線で示した「!Ref [論理ID]」の部分です。
!Refを使うことでテンプレート内の指定した論理IDを参照することが出来ます。これでインターネットゲートウェイのVPCを設定する項目で関連付け(アタッチ)を行うことが出来ます。
(※以降の黄色枠、先は論理IDの参照を示します。)
| 項目 | 設定内容 |
|---|---|
| IGWID | インターネットゲートウェイの論理ID(任意) |
| Type | インターネットゲートウェイを指定するので「AWS::EC2::InternetGateway」 |
| AttachGatewayID | インターネットゲートウェイのアタッチ論理ID(任意) |
| Type | インターネットゲートウェイのアタッチを行うので「AWS::EC2::InternetGateway」 |
| VpcId | Vpcの論理IDを指定します。 |
| InternetGatewayId | インタネットゲートウェイの論理IDを指定します。 |
| (この後に記載するテーブルの共通する項目は省略していきます。) | |
| ###サブネット | |
| ■パブリックサブネット | |
 |
|
| ■プライベートサブネット | |
 |
サブネットの作成です。
基本的に項目の構成はあまり変わりませんね。
パブリック、プライベートサブネットはCIDRの範囲に気をつけながら設定してください。
| 項目 | 設定内容 |
|---|---|
| PublicSubnetID PrivateSubnetID | サブネットの論理ID(任意) |
| Type | サブネットの作成を指定するので「AWS::EC2::Subnet」 |
| AvailabilityZone | アベイラビリティゾーンを指定 |
###ElasticIP
今回のElasticIPの設定は画面側と共通する項目はありませんが、割り当てるElasticIPをどのVPC内で利用するか指定します。
| 項目 | 設定内容 |
|---|---|
| Domain | ElasticIPを利用するVPCを指定 |
ここで作成したElasticIPは後ほどEC2に割り当てる際に利用します。
###セキュリティグループ
■パブリックサブネットのセキュリティグループ
■プライベートサブネットのセキュリティグループ
セキュリティグループも基本的に操作画面に沿って設定していきます。
なお今回のアウトバウンドルールはコメントアウトしていますが、
コメントアウトした場合は現在の操作画面の設定が初期値として反映されます。
またプライベートサブネットのセキュリティグループの設定を今回は0.0.0.0/0としていますが、セキュリティを高める場合には、コメントアウト部分に記載の通りEC2に設定するElasticIPを設定すると効果的です。
| 項目 | 設定内容 |
|---|---|
| SecGroupNamePublicID SecGroupNamePrivateID |
セキュリティグループの論理ID(任意) |
| Type | セキュリティグループの作成を指定するので「AWS::EC2::SecurityGroup」 |
| GroupName | セキュリティグループの名前 |
| GroupDescription | セキュリティグループの説明文 |
| SecurityGroupIngress | セキュリティグループのインバウンド |
| IpProtocol | ポート番号(今回SSH接続で22を指定) |
| FromPort | ポート番号(今回SSH接続で22を指定) |
| CidrIp | セキュリティグループのCIDRを設定 |
| SecurityGroupEgress | セキュリティグループのアウトバウンド |
###ルートテーブル
■パブリックサブネットのルートテーブル
■プライベートサブネットのルートテーブル
参照が多くなってきて、複雑になってきました。ですが難しいことはありません。ルートテーブルを作成し、それぞれどのサブネットの論理IDに関連付けるか、またどこの画面操作をしているのか確認できればおのずと繋がって来ると思います。
■ルートテーブルの作成
| 項目 | 設定内容 |
|---|---|
| RouteTableNamePublicID RouteTableNamePrivateID |
ルートテーブルの論理ID(任意) |
| Type | ルートテーブルの作成を指定するので「AWS::EC2::RouteTable」 |
■ルートテーブルの関連付け
| 項目 | 設定内容 |
|---|---|
| SubnetId | ルートテーブルの関連付けを指定するので「AWS::EC2::SubnetRouteTableAssociation」 |
| SubnetId | 関連付けるサブネット |
| RouteTableId | 関連付けるルートテーブル |
■ルートテーブルのルートを指定
| 項目 | 設定内容 |
|---|---|
| Type | ルートテーブル内のルートを指定するので「AWS::EC2::Route」 |
| RouteTableId | ルートテーブルの論理ID(任意) |
| DestinationCidrBlock | 接続するCIDRブロックを指定 (ここでは0.0.0.0/0) |
| GatewayId | インターネットゲートウェイの論理ID(任意) |
###Outputs
OutputsではResourcesで設定した値を出力することができ、その値を別のスタックで使用することが可能になります。今回の例ではVPCスタックで作成したものをEC2のスタックで利用できるようにします。
そして今回使用するVPCの値は
①ElasticIP
→EC2に固定IPアドレスを付与します。
②サブネット
→EC2を配置するサブネットの論理IDを出力します。
②パブリック&プライベートサブネットのセキュリティグループ
→EC2に作成したセキュリティグループを設定します。
ここで注目したい点は「!GetAtt」の部分。
記載方法としては
!GetAtt [論理ID].[各種パラメータ]となっており、
対象の論理IDのAWSリソースから情報を取得します。
なお、[各種パラメータ]はそれぞれのAWSリソースで決まった値が入るので、ここはドキュメントで確認する作業が必要となります。
(例：セキュリティグループのドキュメント)
###ここまでの構成図
#3.EC2作成
次にEC2のテンプレートです。
###前準備
前準備としてキーペアはCloudformationで作成することが出来ないためキーペアは事前に作成します。
EC2メニューの「ネットワーク & セキュリティ>キーペア」でキーペアの作成を行います。
###EC2作成
パブリックサブネット側とプライベートサブネット側で設定する内容は大きく変わらないので合わせて記載します。
ここでの注目点は「!ImportValue」です。
VPCのテンプレートでOutputで出力した値をここで使用しています。
Export>Nameで指定した値を入力して値を取得し、スタック間での連携が可能となります。
| 項目 | 設定内容 |
|---|---|
| Type | EC2を指定するので「AWS::EC2::Instance」 |
| KeyName | キーペアの名前 |
| ImageId | AMIを入力 |
| InstanceType | インスタンスタイプを入力 |
| SecurityGroupIds | セキュリティグループのIdを指定 |
| SubnetId | EC2を配置するサブネットIdを指定 |
| UserData | シェルスクリプトを記載する(今回は省略) 事前にEC2にインストールしたいソフトウェアをここで記載する。 |
###ElasticIPをEC2に割り当て
EC2にElasticIPアドレスを割り当て、外部からSSH接続でキーペアを使ってアクセス可能にします。
| 項目 | 設定内容 |
|---|---|
| Type | AWS::EC2::EIPAssociation |
| AllocationId | ElasticIPをEC2と関連付けるためのIdを指定 VPCで設定したElasticIPを関連付ける |
| InstanceId | EC2の論理IDを指定 |
割り当てのEC2の画面
###Cloudformationでスタックを作成
最後にcloudformation内でテンプレートを用いて
①VPC
②EC2
の順でスタックを作成します。
①VPC
テンプレートを選択。
スタックの名前を入力。
タグを任意に入力し、必要に応じてIAMロールを設定し、
スタックを作成します。
スタックの作成が完了すると上記の用にCREATE_COMPLETEと表示され環境が構築されます。
②EC2
同様にEC2スタックを作成し、それぞれのスタックが作成されたことを確認します。これで今回の構成図は作成完了です。
###最終的な構成図
構成図の作成はここまでとなります。
構成図完成後、接続確認をしますが、こちらは前回記事の接続方法を参考にしてみてください。
#4.今回のソースコード
今回作成したソースコードについては下記リンク先のgithubあげましたので、実際のソースコードを確認したい方はぜひ参考にしてみてください。
今回のソースコードはこちら
#5.まとめ
以上が今回のCloudformationでのEC2の環境構築でした。
実際の操作画面とソースコードを比較しながらやっていきましたが、
ソースコードでの環境構築のイメージがしやすかったのではないでしょうか？
私としては実際の操作画面と比較しながら書いてみて
ソースコードを書く＝操作手順説明書を書く
に近いイメージで書くことが出来ました。
AWS Cloudformationのドキュメントを見て書いていくよりも断然理解が早く進んだのでこの学習方法も使えそうな気がします。
操作画面でポチポチ入力してインフラ環境を構築するだけでなく、ソースコード書いて自動で環境構築できるようになるとかっこいいですよね。
いつか実際の現場でCloudformation使いこなしてボタンひと押しで環境構築をサクッと終わらせてみたいですね。
今回は以上です。
長くなりましたが、ここまで読んでいただきありがとうございました。
AWSを勉強する方の参考になれば幸いです。
#AWSの学習体験
当記事は動画学習サービスのAWSCloudTechの講座を参考に作成しました。
これからもっと普及するクラウドサービスの一角であるAWSを学びたい方におすすめです。
現在、無料講座を開放しているようなので気になった方はぜひ体験してみてください。
