AWSエンジニアのワンポイントアップ〜構成図を描いてみよう〜
こんにちは(U・ω・U)
プロパゲートのしゅんです。
AWSエンジニアのワンポイントアップでは、今まで座学や経験で培ってきたスキルをワンポイントアップさせるおすすめのスキルアップ方を提案するコーナーです。今回は第1回目で「構成図を描いてみよう」をテーマにお届けします!
AWS構成図を描くことの重要性
構成図を描くのはシステムを構築する上で必ずしも必要な作業ではないので後回しにしがち、もしくは書かないケースもあるのですが、構成図は自己理解を深めるためにも有効ですしチームメンバーやお客様と認識を合わせる上でも有効です。例えば業務においては以下ようなシーンで役立てることができます。
- 新加入メンバーへのオンボーディング
- トラブルシューティングでの活用
- プレゼンテーションでの活用
- 運用への引き継ぎ
また趣味のAWS構築などにおいてもAWS構成図を書くようにしておくことで、ポートフォリオとしてアピールに使うこともできます。ぜひこれを機にAWSの構成図を描く習慣を身につけましょう!
AWSの構成図作成ツール紹介
構成図の材料としてよく使われるのはAWSアーキテクチャアイコンセンターにあるシンプルアイコンです。
Microsoft PowerPointが使える場合にはこちらのシンプルアイコン(ツールキット)を使ってみるのが手軽に始められるポイントになるでしょう。もしMicrosoft PowerPointがない場合にはサードパーティツールの活用を検討しましょう。無料のものだとdraw.io、Lucidchartといったツールがあります。
ガイドラインはしっかり確認しましょう
AWSシンプルアイコンのスライドP10(執筆現在のページです。最新情報をご確認ください。)に使用する際のガイドラインが書かれています。使用する前に必ずチェックしましょう。それぞれ推奨事項と禁止事項がありますが、特に禁止事項は必ず守りましょう。例えば以下のようなことが書かれています。
- 承認されていないAWSアイコンでグループを作成しない
- サービスアイコンをトリミングしない
- 文書のどこかで完全なサービス名を最初に言及せずに短縮形を使用しない
- Elastic Beanstalk と Elastic Load Balancing の ELB など、異なるサービスに対して短縮形を重複して使用しない
- 単語の途中で改行しない
推奨事項と禁止事項をそれぞれ守ることで一貫性があり、理解しやすいAWSアーキテクチャ図を作成することができます。
1枚に収めなくても大丈夫
システムの構成を書き上げようとした際、多くのサービスを使っていると1枚のAWS構成図に纏め切るのが難しいケースがあります。その場合は無理せず、複数に分けてみましょう。よくあるケースだとネットワークの構成図と各コンポーネントの関係図は分けて描くことがあります。その他にもCI/CDパイプラインといった複雑な構成は別で描くなどもお勧めです。ちなみに構成図とは少し違うのですが、計算の手順やデータのフローを表現するフローチャート図や処理の流れや概要を表現するシーケンス図についてはMermaidもご検討ください。ある記法に従ってテキストで記述したものから図を生成してくれます。NotionやVSCode上でも表現することができますのでお試しを。
自動構成図作成
既に大規模な環境を運用されている方はAWS構成図を描き起こそうにもどこから手をつければ良いか分からない、もしくは全てのAWSリソースを把握しきれないといったケースもあるかと思います。その場合は「AWS でのワークロード検出」と呼ばれるソリューションを活用してみるのを検討してみてください。以前はAWS Perspectiveという名称で提供されていました。
このソリューションはアカウント上のAWSリソースを自動で検出して構成図を描き出しくれます。アカウント上にAWSより提供されているCloudformationを用いて必要なリソースを構築するだけです。詳しい手順については以下のブログを参照ください。
ただこのソリューション、1 時間あたり約 0.58USD、1 か月あたり 425.19 USD とかなり高額なんですよね。。大規模環境を1から精査する人件費を考えると費用対効果に見合う気もしますが、個人での検証の場合は注意したほうが良さそうです。
複雑な構成図を参考にしてみよう
AWS構成図に決まった描き方はなく目的に応じて相手に伝わりやすいように書けると良いのですが、最初のうちは感覚を掴みづらいと思います。そんなときに参考にしたいのがAWSアーキテクチャーセンターです。AWSアーキテクチャーセンターでは様々なアーキテクチャーのサンプルが構成図とともに紹介されています。AWSのアーキテクチャーを学ぶ上でも参考になりますし、いろんな構成図を無料で見ることができるので大変おすすめです。
最後に
今回はAWS構成図を描くをテーマに様々な情報をご紹介させていただきました。ついつい後回しにしてしまいがちなドキュメント作業ですが、丁寧にやると必ず役に立ちます。また近年は生成AIの勢いがすごいですが、この手の分野はまだ完全ではありません。人に理解してもらいやすい、伝わりやすい構成図はなかなか生成AIでは追いつけない分野だと思いますのでぜひやってみましょうー!
それではまた次回の「AWSエンジニアのワンポイントアップ」をお楽しみにー!