AWS環境情報 テンプレート(書き方とサンプル例)

2022年03月05日(土)

こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
AWS環境情報のテンプレートと例文をご紹介します。

AWS環境情報 テンプレート

マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し!

AWS環境情報とは?

AWSを代表するクラウドサービスでは、サーバー(インスタンス)や、それに付随するサービスが高度に絡み合って提供されます。その結果、担当者ですら設定内容を忘れてしまい、何のための設定なのか分からなくなる場合があります。

その結果として無駄な支払いが発生したり、思わぬセキュリティホールにつながったりします。そこでAWS環境情報として、必要な情報をまとめておく必要があります。

AWS環境情報の目的

AWS環境情報は、社内の関係部署の人たちがAWSの設定状態に関する情報共有に利用します。クラウドサービスは高度に自動化される傾向があり、その結果どうやって動いているのか、どのサービスとどのサービスが関連付いているのか分からなくなるでしょう。そうした混乱を防ぐのが目的になります。

本番環境のインスタンスなのか、開発環境なのか分かるようにしたり、グループの意味を理解する、逆にもう使わなくなった余計な情報を破棄すると言った運用フローで活躍します。

AWS環境情報の書き方

AWS環境情報として、AWSのサービス別にまとめるのではなく利用しているシステム別にまとめるのが良いでしょう。そうすることで関連し合うAWSの各種サービスが明確になり、設定変更の及ぼす影響範囲が明確になります。

システム名称

自社で構築しているシステムの名称です。アプリケーションサーバー、プロキシサーバー、APIサーバーなどになります。

利用サービス

メインで利用しているAWSのサービス名を記述します。

用途

利用目的を明記します。本番環境下での役割や、開発用途など利用目的が分かるようにします。

URL

リソースにアクセスするためのURLを記述します。

利用開始日

利用開始日を記述します。

利用終了日

利用終了日が決まっている場合には、それを記述します。そうすることで、一時的に利用したインスタンスなどが放置されないようにします。

リージョン

サービスを利用しているリージョンを明記します。

関連サービス

S3やCloudfront、Lambdaなど関連付けて利用しているサービスがあれば、列挙します。

セキュリティ情報

利用制限などセキュリティに関する設定を明記します。オープンになっていてセキュリティホールになるのを防止したり、監査で実際に設定されているのか確認するのも用います。

IAM

リソースにアクセスできるアカウントの情報です。

要件

自動的にスケーリングする場合など、システム要件があれば記述しておきます。

ログ

アクセスログの保存先など、監査や監視に利用できる情報を記述します。

バックアップ

バックアップ取得の有無、その場所を明記します。

その他設定

タグやアーキテクチャにおける立ち位置などを記述します。

 

マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し!

AWS環境情報のサンプル例

##システム名称

顧客向け管理画面システム

##利用サービス

  • AWS

##用途

顧客向けに管理画面、およびその機能を提供するシステムです。

##利用開始日

2022年02月01日

##利用終了日

特にありません。

##リージョン

東京リージョン

##関連サービス

  • RDS
    • サービスDBを利用しています
  • Cloudfront
    • CDNを利用しています

##セキュリティ情報

CloudWatchにてログを収集、監視しています。

##IAM

グループXXXを利用しています。

##要件

  • 負荷が高まった場合、自動スケーリング(最大5台)します。
  • 全インスタンスのタグは「customer_admin」です。

##ログ

CloudWatch経由でS3バケット「customer_logs」に保存しています。

##バックアップ

システムのバックアップはありません。コードはGitにて管理しています。

##その他設定

サーバーのデプロイは customers_deploy にて自動アクション設定済みです。デプロイ内容はそちらを確認してください。

おすすめの情報共有ツール

マニュアル作成・ナレッジ共有ツール 「NotePM」 は、社内の知りたいことが簡単に確認できるツールです。「社内のほしい情報を探すのが大変」「ナレッジ共有が上手くいっていない」とお悩みの方は、NotePMの無料トライアル をお試しください。

NotePMサービス紹介資料はこちら >