はじめに
- 自分の中の頭の整理に記載していきます。
- 図については基本的なLAMP環境を意識して記載しますので参考程度に。。
サーバー構成図の書き方
- システムを構成するサーバー機器の構成を図示します。
- システム開発においては外部設計で作成されます。
- また、新規でサーバーを構築する場合には、この情報をもとに優先順位をつけ構築することになります。
必ず書くもの
識別情報（オブジェクトと識別子）
- １機器１オブジェクトとして表現する
- スケールする場合は別表などに機器名をまとめても良いが、初期構築の台数などは記載しておいたほうが良い
通信経路（関係線）
- in/outがわかるように矢印などを用いて記述する
- 通信プロトコルも併せて記述する
参考図：「必ず書くもの」だけで書いてみる
(最低限だとちょっと物足りなさありますよね。。）
できるだけ書くべきもの
セグメント
本番環境や開発環境などでセグメントを分けている場合
外部サービス
- システムが外部サービスに依存している場合、どのようなアクセスをしているか記述
参考図：「できるだけ書くべきもの」も含めて書いてみる
(まぁシンプルですが、必要な情報は書いてるかな？人によっては物足りなさが・・・？）
余裕があったり必要に応じて書くもの
サーバーの役割
- WEBサーバー
- DBサーバー
- 踏み台サーバー など
サーバースペック情報
- CPUスペック、個数
- メモリサイズ
- Disk容量（HDD,SSDなど）
- その他必要なスペック情報
ソフトウェア情報
- OS情報
- ミドルウェア情報
システム利用者情報
- どんな利用者がいて、どのような経路でアクセスするのか
- システム利用者、システム管理者、システム開発者など
参考図：さらに「余裕があったり必要に応じて書くもの」も含めて書いてみる
（だんだんくどくなってきた。。）
場合によっては必要かもしれないが、基本的に書かなくても良いもの
バージョン情報
- 場合によっては頻繁にバージョンアップするものもあるので、図の保守性を考えると別表で管理したほうが良い
DBスキーマ情報
- １サーバーに複数スキーマが入っている場合は必要に応じて記載
おわりに
ここまで書きましたが、サーバー構成情報は利用者間で記載情報やその粒度の認識を合わせておく必要がありますので、サーバー構築から運用までを意識して必要な情報を必要なだけ記載しておくのが良いと思います。
ちなみに今回の図は draw.io(https://www.draw.io/) で書きました。
作図は利便性と保守性の良いツールを使うのが良いですね。
Thankyou!