【入門】Shumokuで簡単ネットワーク図作成！YAMLからSVGへ

Shumokuとは？ ネットワーク図をコードで管理しよう

ネットワーク図を作成する際、Visioのようなツールを使っていませんか？ Shumokuは、YAMLファイルでネットワーク構成を定義するだけで、美しいSVGダイアグラムを自動生成してくれる、まさに「ネットワーク図をコードで管理する」ためのモダンなツールです。Gitと連携すれば、構成の変更履歴を追跡したり、CI/CDパイプラインに組み込んだりすることも可能になるかもしれません。ネットワークエンジニアの皆さんにとって、作業効率を大幅に向上させる可能性を秘めています。

【ここにShumokuで生成されたネットワーク図のイメージ写真】

なぜShumokuが注目されているのか？

従来のネットワーク図作成ツールでは、手作業での修正やバージョン管理が煩雑になりがちでした。Shumokuは、YAMLというシンプルで人間が読みやすい形式で構成を記述するため、コードレビューのように図の変更を確認・承認できます。また、Gitなどのバージョン管理システムとの親和性も高く、インフラ構成管理の手法として注目されています。

Shumokuの主な機能とメリット

Shumokuには、ネットワーク図作成を強力にサポートする機能が満載です。具体的にどのようなことができるのか、見ていきましょう。

YAMLで定義：シンプルで管理しやすい

ネットワーク構成をYAML形式で記述します。インデントなどで構造が分かりやすく、Gitでの管理や差分確認が容易です。手書きの図とは異なり、コードとしての変更管理が可能です。

900+ ベンダーアイコン：主要機器を網羅

YAMAHA、Aruba、Juniper、AWSといった主要なネットワーク機器ベンダーのアイコンを900種類以上サポートしています。これにより、実際の環境に近い、視認性の高い図を作成できます。

【ここに様々なベンダーアイコンが並んだ様子のスクリーンショット】

自動レイアウト：配置の手間を削減

ELK.js というライブラリを利用した階層的な自動レイアウト機能があります。これにより、ノードの配置を手動で行う手間が省け、効率的に図を作成できます。もちろん、必要に応じて調整することも可能かもしれません。

SVGエクスポート：高品質なベクター形式

生成されたダイアグラムは、高品質なSVG（Scalable Vector Graphics）形式でエクスポートされます。これにより、拡大・縮小しても画質が劣化せず、ドキュメントやプレゼンテーション資料にも綺麗に利用できます。

TypeScript対応：型安全性と補完機能

ShumokuはTypeScriptで書かれており、完全な型定義が提供されています。これにより、IDE（統合開発環境）でのコード補完機能が強力に働き、入力ミスを防ぎやすくなります。開発体験が向上するでしょう。

NetBox連携：既存資産の活用

IPアドレス管理ツールとして有名なNetBoxとの連携機能も用意されています。NetBoxに登録されている情報を元に、自動でネットワークダイアグラムを生成できるため、既存の資産管理情報を有効活用できます。

Shumokuの始め方

「面白そう！」「使ってみたい！」と思った方は、まずは以下の方法でShumokuを試してみてはいかがでしょうか。

Playgroundで試してみる

Webブラウザ上でShumokuの機能を気軽に試せる「Playground」が用意されています。インストール不要で、すぐにYAMLを書いてダイアグラムが生成される様子を確認できます。

【ここにPlaygroundの画面イメージ写真】

ローカル環境にインストールする

Node.jsとnpm（またはyarn）がインストールされていれば、以下のコマンドでShumokuをインストールできます。ローカル環境で本格的に使いたい場合や、CI/CDに組み込みたい場合に必要になります。

ドキュメントを読む

より詳細な情報や、高度な使い方については、公式ドキュメントを参照するのがおすすめです。YAMLの記法やオプションについて詳しく解説されています。

さあ、あなたも「ネットワーク図をコードで管理する」新しい時代を体験してみませんか？