Features
Generating and updating diagrams, monitoring and sharing in Server, the CLI and library, and the Editor.
Generate and update diagrams
Shumoku Server manages topologies and shows them in the browser together with monitoring data. Start by importing YAML, or fetch devices and links from NetBox or network discovery.
Shumoku lays out devices and links automatically with the network hierarchy in mind, and draws port names and per-site groups. Icons for vendors and device types are available. When the network changes, import the updated YAML or fetch from the external source again to update the diagram.
You can also use it only to view and share diagrams, without connecting a monitoring tool. Without NetBox, start from YAML.
Monitor and investigate in Server
Map devices and links on the diagram to monitored objects, and Server shows the utilization and alerts from your monitoring tool on the diagram.
Zoom and pan diagrams in the browser. Link utilization is shown by color: this view is the weathermap. When you find a busy line, read the device and port names at both ends to identify the link. Alerts appear on the affected device, so you can follow its connections on the same diagram.
You can also build dashboards that combine several diagrams and metric panels, placing per-site diagrams and the values your team watches on one screen.
Share diagrams
Server creates view-only links to topologies and dashboards. Recipients open the same diagram without signing in and can check device names, ports and connections. During an investigation or handover, everyone knows which link is being discussed.
Anyone with the link can view it, so share it only with people who may see the configuration shown in the diagram.
Generate diagrams with the CLI and library
To generate diagrams for documentation or embed them in your own tools, use the CLI and library. They share the same configuration model and renderer without deploying Server.
The CLI generates SVG, PNG and HTML from YAML definitions. In HTML you can zoom and pan the diagram. Add the command to CI to keep documentation diagrams in step with changes to the definition.
The library brings the configuration model and diagram generation into your own tools. Depending on the renderer it runs in the browser or Node.js; PNG output is for 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
The Editor is a browser tool for designing physical layouts: place devices and connect ports with cables. It is currently in beta. While planning the cabling you can check the bill of materials and PoE power budget.
Projects are saved in the browser and can be exported as files. It is a standalone app built on the Shumoku rendering engine.