AWS インフラエンジニア

【AWSエンジニア】AWS設計時の定義書作り。最低限これだけは必要な項目を紹介

お疲れ様です。satimoです。AWSの定義書作成を行っていました。

いや~定義書作り。。ほんと面白くないですよね。作りながら何回か寝そうになってしまいました。

  • 今回はAWSの定義書を作らないといけないけど、どんな項目が必要なの?
  • 書き上げようとしていくと無限に書かないといけないことが出てきて、終わらん。

そんな方向けに最低限これだけは書いといたほうが良いよ~というものをまとめました。

AWSの設計書作りで悩んでいる方は是非ご覧ください。

始めに、参考にしたサイトと本の紹介

設計書作成に悩んでいて多少時間がある方は紹介するサイトと書籍から学ぶことをお勧めします。

個人的にAWSの定義書作りの際に参考にした2つをサイトと書籍を紹介しておきます。

クラスメソッドが紹介しているAWSクラウドデザインシートテンプレート

AWSのプレミアムパートナー(日本で8社!)のクラスメソッドさんが提供しているAWS構築時に必要だとされている項目の一覧になります。

これからAWSの仕事をする人は時間を作って一度読んでみることをお勧めします。

AWS クラウドデザインシート テンプレートを公開してみた

インフラ/ネットワークエンジニアのためのネットワーク技術&設計入門

書籍の紹介になります。

書籍の内容としてはネットワーク(インフラ)構築時の設計書の下記方が記載されています。

  • ネットワーク構築の流れ
  • 物理設計
  • 論理設計
  • セキュリティ設計・負荷分散設計
  • 高可用性設計
  • 管理設計

的なことが456ページにわたって紹介されています。

設計書の作り方をこれから学習する方や作り方に悩んでいる方は一読することをお勧めします。

参考にしたサイトと書籍はこれくらいにさせていただいて、本題のAWS設計書作成時に最低限これだけは必要な項目の紹介をさせていただきます。

AWS設計時の定義書作り。最低限これだけは書いておくこと

AWSの定義書作りに必要な項目ですが、

  1. 基本構成
    1. システム概要
    2. 構成図
    3. AWSリソース(AWS上で設定したパラメータ)
    4. 権限設定(IAMの設定内容)
    5. セキュリティ(ウイルス対策の有無)
  2. 運用概要
    1. 定期処理がある場合その内容
    2. 運用手順
    3. 緊急メール連絡先
  3. 監視設定
    1. 監視項目(CloudWatchや監視ツールの設定内容)

まず、項目について書きだしましたがこちらが最低限必要な項目になります。

では各項目についてどのような内容を書いていくか見ていきたいと思います。

システム概要

システム概要の項目では、構築するシステムの名称や役割について記載していきます。

ファイルサーバやメールサーバといった内容ですね。

構成図

構成図の項目はそのままの内容になりますが、構築するAWSの構成図を記載していきます。

下のようなイメージです。

こちらの構成図は『Cacoo』というクラウドサービスを使って書いています。非常に使いやすいツールになりますの興味がある方は是非使ってみてください。

Cacooを使ってみたい方はこちら

AWSリソース(AWS上で設定したパラメータ)

AWSリソースの項目はAWS上で使ったサービスのパラメータを記載していきます。

この項目が一番書く量としては多くなりますかね。

イメージとしては下のような感じになります。

VPC

IDNameVPC CIDRテナンシー
vpc-xxxxxvpc-name0110.0.0.0/16Default
vpc-yyyyy vpc-name02172.16.0.0/16 Default

Subnet

IDNameCIDRAvailability ZoneRoute Table
subnet-xxxxxsubnet-pubric0110.0.0.0/24ap-northeast-1art-xxxxx
subnet-yyyyysubnet-pricate01 10.0.1.0/24ap-northeast-1crt-yyyyyy

各イメージとしては上記の内容になりますが、AWSのコンソール上で確認できるないようを記載していくイメージです。

権限設定(IAMの設定内容)

権限設定の項目では作成したIAMユーザの一覧を記載していきます。

ユーザ名グループ権限
AdministratorなしAdministratorAccess
satimoなしAdministratorAccess

今回はざっくり書きましたが、セキュリティに関わる項目になるので、権限については細かく書いたほうが良いです。

セキュリティ(ウイルス対策の有無)

EC2やECSなどを使う場合にはウイルス対策ソフトの検討をする必要が出てきます。

使っているウイルス対策ソフト名や除外フォルダの設定などを記載していきます。

定期処理がある場合その内容

AWS構築後に自動・手動問わず定期的に行う必要があることを記載していきます。

例えば、xxx時に再起動を実施。などですね。

イベントがあった時の運用手順

この項目では何かが起こった時の一時対応手順をまとめていきます。

例えば、バックアップ・リストア手順、構築したシステムからアラート通知が行われたときなどの対応手順などになります。

緊急メール連絡先

抜けがちな項目ですがかなり大事です。

ひとつ前に書いた、なにか起きた際に連絡する必要があるか?連絡が必要な場合誰に連絡するのか?を明確にしておくという訳です。

監視設定

CloudWatchや監視ツールの名称や、設定内容を記載していきます。

例えば、EC2が5分間起動していない場合にsatimoへメール通知させるなど、を記載するイメージです。

まとめ

今回最低限必要なAWSの設計書について記載していきました。

見る人によってはこれじゃ足りないよ~という人もいるかもしれませんが、まず形を作って肉付けしていくことでそれなりの設計書ができますので、設計書の作成に悩んでいる方はご参考にしていただければ幸いです。

-AWS, インフラエンジニア