Mermaidでネットワーク構成図を書くには|接続・区画・注記の表現

Mermaidを使うと、機器や接続をテキストで記述し、図として表せます。ネットワーク構成図では、ノード、矢印、グループを組み合わせて論理的なつながりを説明できます。

この記事では、架空の端末・中継・アプリの小さな構成を使い、書き方と変更時の確認を紹介します。実ネットワークを自動検出する方法ではなく、把握した構成を記述するための例です。

機器のIDと表示名を分ける

Mermaidのflowchartは、ノードと接続で構成します。ノードには、記述内で参照するIDと、図に表示する名前を別々に設定できます。Mermaid「Flowcharts Syntax」

たとえばclient["利用端末"]では、clientが参照用ID、括弧内が表示名です。日本語などの文字列は引用符で囲み、IDは短く、役割が分かる形にすると更新しやすくなります。

以下は記法の説明例です。実在する機器名、アドレス、認証情報は含めていません。

矢印とラベルで接続を記述する

次のコードでは、左から右への配置をLRで指定し、端末から中継、アプリへ矢印をつなぎます。矢印上のラベルは、この例で表したい通信の意味を示します。

flowchart LR
  client["利用端末"]
  gateway["中継"]
  app["アプリ"]
  client -->|HTTPS| gateway
  gateway -->|HTTPS| app

Mermaidに対応した表示環境で、このテキストを図として描画できます。ここではコードを確認・転記できるよう、本文中ではテキストとして掲載しています。

矢印が何を意味するかは、図の説明に明記してください。上の例は通信要求の向きを示す概念図であり、物理ケーブルの本数や応答パケットの全経路を表すものではありません。

subgraphで論理的な区画をまとめる

関連するノードをまとめたいときは、subgraphを使えます。次の例では中継とアプリを一つの区画に入れています。

flowchart LR
  client["利用端末"]
  subgraph service["サービス区画"]
    gateway["中継"]
    app["アプリ"]
    gateway -->|HTTPS| app
  end
  client -->|HTTPS| gateway

subgraphの枠は、記述したグループを表します。実際のネットワーク分離やアクセス制御が実装されていることを証明するものではありません。区画名がVLAN、サブネット、管理範囲のどれなのかも補足します。

変更は接続一つずつ確かめる

仮に、アプリから別の保存先へ接続を追加するなら、ノードの追加と接続の追加を区別して確認します。名前を変えただけなのか、実際に経路が変わったのかを読み取れるようにしてください。

変更 見直すポイント
表示名の変更 IDの参照先が変わっていないか
接続の追加・削除 元と先、向き、ラベルが意図どおりか
区画の変更 境界を越える通信の説明が必要か
図の分割 別図への参照と確認日が対応しているか

大きな一枚へすべて詰め込まず、目的ごとに分けることも検討します。文字が読めるか、線が交差して意味を誤らないかは、コードだけでなく描画結果でも確認します。

図の記法と実際の構成を照合する

記法が正しくても、図が現行の構成に合っているとは限りません。元となる設定・台帳・確認日を対応付け、描画環境のMermaidの版も記録しておくと、後から差を追いやすくなります。版や表示環境により配置・見え方が変わる場合もあります。

何を図へ含めるかはネットワーク構成図の書き方、検出結果から作る場合の限界は構成図の自動作成を参照してください。構成把握や運用資料の相談先はインフラ・クラウド技術支援です。

記事一覧へ戻る

ITの困りごとを、
まずはご相談ください。

何から手をつけるか決まっていない段階でも構いません。ご相談内容に応じて、担当者からご連絡します。

まずは相談する

採用へのご応募は採用エントリーからお願いします。