機能
構成図の生成と更新、Server での監視と共有、CLI とライブラリ、Editor について。
構成図の生成と更新
Shumoku Server は、構成図を管理し、監視データと一緒にブラウザーで見るためのアプリです。まず YAML を取り込むか、NetBox やネットワーク探索から機器・接続の情報を取得します。
Shumoku がネットワークの階層を考慮して機器とリンクを自動配置し、ポート名や拠点ごとのまとまりを図にします。ベンダーや機器に応じたアイコンも利用できます。構成を変更したときは、更新した YAML を取り込むか、外部ソースから構成情報を取得し直して図に反映します。
監視ツールを接続せず、構成図の閲覧・共有だけに使うこともできます。NetBox がない環境でも、YAML から始められます。
Server での監視と調査
図の機器やリンクを監視対象に対応付けると、Server は監視ツールから取得した使用率やアラートを図に表示します。
構成図はブラウザーで拡大・移動して閲覧できます。リンクの使用率は色で表されます。この表示がウェザーマップです。使用率が高い線を見つけたら、両端の機器名とポート名を確認し、どの接続かを特定できます。アラートは対象の機器に表示されるため、接続先も同じ図でたどれます。
複数の構成図とメトリクス表示を組み合わせたダッシュボードも作れます。拠点ごとの図や、チームが継続して見る値を一つの画面に並べられます。
構成図の共有
Server で構成図やダッシュボードの閲覧専用リンクを作成できます。リンクを受け取った人はログインせずに同じ図を開き、機器名やポート、接続先を確認できます。調査や引き継ぎで、どの接続について話しているかを共有できます。
リンクを知っている人が閲覧できるため、共有先は図に含まれる構成情報を見せられる相手に限定してください。
CLI とライブラリでの図の生成
ドキュメント用の図を生成したり、自作ツールに構成図を組み込んだりする場合は、CLI とライブラリを利用できます。Server の導入なしで、共通の構成モデルと描画機能を使えます。
CLI は構成定義の YAML から SVG・PNG・HTML を生成します。HTML では図を拡大・移動して閲覧できます。生成コマンドを CI に組み込めば、構成定義の変更に合わせてドキュメント用の図を更新できます。
ライブラリでは、構成モデルと図の生成処理を自作ツールに組み込めます。利用するレンダラーに応じてブラウザーや Node.js で実行でき、PNG の生成は Node.js 向けです。
$ shumoku render network.yaml -o diagram.svg
$ shumoku render network.yaml -f html -o diagram.html
$ shumoku render network.yaml -f png -o diagram.pngEditor Beta
Editor は、ブラウザーで機器を配置し、ポート間をケーブルで結んで物理構成を設計するツールです。現在は Beta です。配線を検討しながら、必要な部材の一覧や PoE の電力計算を確認できます。
プロジェクトはブラウザー内に保存され、ファイルとして書き出せます。Shumoku の描画エンジンを使う独立したアプリとして提供しています。