AWSの仮想基盤構築業務において、詳細設計書を作成する機会が多々あります。今回はAWS環境の詳細設計書の作成方法を自分なりに解説したいと思います。当記事を読んで頂くと下記のことが分かります。
・AWS詳細設計書の大まかなイメージ
・AWS詳細設計書の項目
・AWS詳細設計書に記載する主なサービス
AWS詳細設計書の書き方を解説
詳細設計書はパラメータシートとも呼ばれ、構築するシステムの設定値を記載するドキュメントです。AWSの詳細設計書は、主にAWSサービスの設定値を記載します。サービス別にシートを分けたりします。本記事では、AWS詳細設計書に記載することが多いサービスや項目などをご紹介します。なお、クラウド部ではAWS詳細設計書のエクセルテンプレートを有料でご提供しております。
AWS詳細設計書のパラメータ記載方法
AWS詳細設計書ではサービス単位で、設定値をExcel等に記載します。下記はEC2のパラメータを記載した例となります。EC2構築に必要なパラメータを表形式で入力します。基本的には、パラメータ名と値が最低限必要になります。他にはデフォルト値や設定値の根拠の列を追加する場合もあります。
| パラメータ名 | 値 |
|---|---|
| インスタンスID | i-0123456789abcdef0 |
| インスタンスタイプ | t2.micro |
| AMI ID | ami-0123456789abcdef0 |
| プライベートIPアドレス | 10.0.0.123 |
| パブリックIPアドレス | 54.123.456.789 |
| キーペア名 | my-keypair |
| 状態 | running |
| 利用可能ゾーン | us-east-1a |
| サブネットID | subnet-0123456789abcdef0 |
| VPC ID | vpc-0123456789abcdef0 |
| セキュリティグループ | sg-0123456789abcdef0 (default) |
| ブロックデバイスマッピング | /dev/xvda -> vol-0123456789abcdef0 (attached, 20 GiB, gp2) |
| タグ | Name: my-ec2-instance |
| プレースメント | Affinity: default, GroupName: my-group, Tenancy: default |
| 起動時刻 | 2022-04-16T12:34:56.789Z |
| パブリックDNS名 | ec2-54-123-456-789.us-east-1.compute.amazonaws.com (if available) |
| プライベートDNS名 | ip-10-0-0-123.us-east-1.compute.internal |
| アーキテクチャ | x86_64 |
| ルートデバイスタイプ | ebs |
| ルートデバイス名 | /dev/xvda |
| ハイパーバイザー | xen |
| 仮想化タイプ | hvm |
| Elastic GPU関連付け | (適用可能な場合) |
| AMI起動インデックス | 0 |
| インスタンスライフサイクル | (スポット、スケジュール、またはなし) |
| クライアントトークン | (最大64文字のASCII文字列) |
| EBS最適化 | false |
| ENAサポート | true |
| ネットワークインターフェイス | (インスタンスに接続されたネットワークインターフェースに関する情報) |
AWS詳細設計書のサービスの書き方
AWS詳細設計書では、サービス単位でシートを作成して、パラメータを入力する記載方法が一般的です。具体的には下記のようなサービス単位でシートを作成すると見やすいと思います。
・VPC
・ルートテーブル
・サブネット
・セキュリティグループ
・IAM
・S3
・EC2
・RDS
・ALB
・CloudFront
各サービスのパラメータ入力例は下記の記事で公開しております。よろしければご参考にどうぞ。
まとめ
AWS詳細設計書は、環境構築時だけだなく、運用フェーズに移行した後も更新するドキュメントです。運用の途中からAWSのサービスが追加されることもあるので、汎用性の高いドキュメントとして作成することが求められると思います。
クラウド部のAWS詳細設計書テンプレート
クラウド部では、noteにてAWS仮想基盤詳細設計書のExcel(エクセル)テンプレートを販売しております。実際の構築時データをサンプルとして入力しております。よろしければ、下記リンクから詳細をご確認ください。
