About
Shumoku について
Shumoku とは
Shumoku（しゅもく）は、ネットワーク構成図を YAML/JSON で記述し、SVG/HTML/PNG として出力するためのオープンソースライブラリです。
ネットワークエンジニアが、ドキュメント内でネットワーク図を簡単に作成・管理できることを目指しています。
特徴
- テキストベース — YAML でネットワークを定義。Git でバージョン管理、差分確認が容易
- 自動レイアウト — ネットワーク図に特化した独自の階層レイアウトエンジン
- ベンダーアイコン — Yamaha, Aruba, AWS, Juniper など 900 以上のアイコン
- インタラクティブ — HTML 出力でパン/ズーム、ツールチップ、階層ナビゲーション
- システム連携 — NetBox や独自 API からの自動生成
名前の由来
shumoku という名前は、茶室の喚鐘（かんしょう）に由来します。喚鐘を鳴らす道具が撞木（しゅもく）、その撞木を掛けておく金具が撞木釘。撞木釘が撞木を静かに支えるように、shumoku はネットワーク運用の始まりを支える基点でありたい、という意味を込めています。詳しくは名前とロゴの由来をご覧ください。
ライセンス
GNU Affero General Public License v3.0 (AGPL-3.0)