はじめに
AWSのCloudFormerというβ版のサービスを使ってみたので作成手順を備忘録として記載します
経緯
現所属の社内システムにがAWS環境にあり、新しいサービスを導入しようとしたが、分かりやすい環境構成図がなく全容が見えませんでした
なので、現状を調査するのにいちいちAWS管理コンソールから紐づいているものを確認するのが億劫だな〜と思い、実環境から環境構成図を逆起こししてくれるようなものはないか社内TOPの技術屋さんに聞いてみたところβ版ではあるがCloudFormerというツールがあること教えてもらったので使用してみました
CloudFormerとは
CloudFormerは、アカウントに既に存在するAWSリソースから環境の起動や設定値などを抜き出して、CloudFormationテンプレートを作成するツールです
テンプレート自体は、JSON形式のテキストファイルなのでそのまま使用して全く同じ環境を作成したり、追記や修正することも可能です
CloudFormerはEC2インスタンスが起動するので起動している間は課金されます
主なメリット
- 既存環境を可視化しやすい
- 既存環境のリソース一覧がみれる
- 既存の環境をコード化できる（Infrastructure as Code）
- 既存環境と同じ環境を自分の開発環境用に構築できる
#####テンプレートとは
どのAWSリソースをどのような設定で起動するかコードで記述したもの(JSON形式またはYAML形式)
#####スタックとは
テンプレートから生成されるAWSリソースの集合のこと
スタックを消すと、紐づくリソースも全て消える
CloudFormer作成手順
※2020年1月時点のGUIのため変わっている可能性があります
- CloudFormerのスタックを作成する
- CloudFormationサービスの[スタックの作成]ボタンを押下し、[新しいリソースを使用（標準）]を選択する
- [サンプルテンプレートの使用]を選択し、テンプレートを[CloudFormer]を選択し、[次へ]ボタンを押下する
- [スタックの詳細を指定]でスタックの名前とPasswordを記載して[次へ]ボタンを押下する
（※Usernameはなくても作成可能）
- [スタックオプションの設定]では特に何も指定せず[次へ]ボタンを押下する
- [レビュー]で内容を確認し、[AWS CloudFormationによってIAMリソースが作成される場合があることを承認します。]のチェックボックスにチェックを入れて[スタックの作成]ボタンを押下する
- CloudFormationサービスのページでスタックのステータスが「CREATE_IN_PROGRESS」から「CREATE_COMPLETE」になるまで待つ(※5分くらい)
- スタックのステータスが「CREATE_COMPLETE」になればスタック作成完了
- CloudFormerのスタックを起動する
- 作成したスタックを選択し、出力タブに表示されている値のURLをクリックする
- CloudFormerツールが起動される
CloudFormerのスタックを作成した時に指定したユーザ名とパスワードを入力するとアクセスできる
- CloudFormerを使用してテンプレートを作成する
- 作成したいリーソスのあるリージョンを選択し[Create Template]ボタンを押下する
- Introページは特に入力しないまま[Continue]ボタンを押下する
- 以降のページではテンプレートに追加したいリソースを選択して[Continue]ボタンを押下していく
※セキュリティの関係上キャプチャは割愛
1. [DNS] では Route 53 レコードを追加できる
1. [VPC] では Amazon VPC を追加できる
1. [VPC Network] では Amazon VPC のサブネット、ゲートウェイ、DHCP 設定、VPN 接続を追加できる
1. [VPC Security] では ネットワーク ACL とルートテーブルを追加できる
1. [Network] では、Elastic Load Balancing ロードバランサー、Elastic IP アドレス、CloudFront ディストリビューション、Amazon EC2 ネットワークインターフェイスを追加できる
1. [Managed Services]では Auto Scalingグループ、Elastic Beanstalk アプリケーション、OpsWorks スタックを追加できる
1. [Managed Config]では Auto Scaling起動設定、Elastic Beanstalk 環境設定、OpsWorks 環境設定を追加できる
1. [Compute] では Auto Scaling グループと Amazon EC2 インスタンスを追加できる
1. [Storage] では Amazon EBS ボリューム、Amazon RDS インスタンス、DynamoDB テーブル、Amazon S3 バケットを追加できる
1. [Storage Config] では Amazon RDS サブネットグループ、ElastiCache パラメータグループ、Amazon RDS パラメータグループを追加できる
1. [App Services] では ElastiCache クラスター、Amazon SQS キュー、Amazon SimpleDB ドメイン、Amazon SNS トピックを追加できる
1. [Security] では セキュリティグループを追加できる
[Security] に進んだ時点で自動的に選択されるため、必要なグループが選択されていることの確認だけでOK
1. [Operational] ページでは Auto Scaling ポリシーと CloudWatch アラームを追加できる
1. [Summary (概要)] ページでは次のことができる
- テンプレートに追加したリソースを確認
- リソースに割り当てられている自動的に生成された論理名の変更
- サイトの IP アドレスや URL など、必要な情報を提供する出力内容を指定できる-
[AWS CloudFormation Template]に生成されたテンプレートが表示される
[S3 Bucket]を選択し[Save Template]ボタンを押下してテンプレートをバケットに保存する
-
[Launch Stack]を選択すると、指定したAmazonS3バケットにテンプレートが保存された後すぐにスタックが起動する
[Create Template]を選択した場合は指定したAmazonS3バケットにテンプレートが保存されるだけ
-
ここまででテンプレート作成完了！！
- CloudFomerのスタックを削除する
- テンプレートの作成は完了したのでCloudFormerのスタックは必要ないので削除する
CloudFormationで対象スタックを選択し、[削除]ボタンを押下する
※無駄に残しておくと不要な課金されるので不要になったらすぐ削除する
まとめ
β版なので本番環境などには適用することは難しいでしょうが、環境調査用としては十分でした
CloudFormerを使用しなければ管理コンソールから紐付けをひとつずつ辿っていかなければならなかったので
既存環境と同じ環境を作成したいけど設定値がわからない時やテンプレート化しておきたい環境があった場合にとても便利なツールだと思いました
私の場合はJSON形式ファイルのテンプレートの値から環境を調査するのも面倒臭かったので、テンプレートをCloudFormationデザイナーに貼り付けて図として現状を把握し、その図と設定値を元に環境構成図をアップデートしました
今回CloudFormerを使用してリソースを一覧化できたこっとによって、defaultの使用していないサブネットや既に使用していないサービスがあることもわかったので今後はこの情報を元に環境を綺麗にしていきます
私はJSON形式のままテンプレートを使用しましたが、CloudFormationデザイナーを使用してJSONをYAMLに変換して使用することもできるようです