diff --git a/docs/cmd/graph.md b/docs/cmd/graph.md index 6daaf5d47..de73a2796 100644 --- a/docs/cmd/graph.md +++ b/docs/cmd/graph.md @@ -4,11 +4,7 @@ The `graph` command generates graphical representaitons of the deployed topology. -Two graph styles are available, using [Graphviz](https://graphviz.org/) or using a HTML page generated by `containerlab` based on a Go html template. - -#### Graphviz - -PLACEHOLDER +Two graphing options are available; using a HTML page generated by `containerlab` based on a Go html template, or using a [dot file](https://en.wikipedia.org/wiki/DOT_(graph_description_language)) that can visualized using [Graphviz](https://graphviz.org/) #### HTML @@ -56,7 +52,13 @@ Within the template Javascript libraries such as [**d3js directed force graph** After the graph generation, it allows to freely move the nodes to a desired position then export the graph in PNG format -![default_graph](../images/html_topo.png) +![default_graph](https://gitlab.com/rdodin/pics/-/wikis/uploads/5f3ade3559a5f044d4786bfd0e278b65/image.png) + +#### Graphviz + +When `graph` command is called without the `--srv` flag, containerlab will generate a [graph description file in dot format](https://en.wikipedia.org/wiki/DOT_(graph_description_language)). + +The dot file can be used to view the graphical representation of the topology either by rendering the dot file into a PNG file or using [online dot viewer](https://dreampuf.github.io/GraphvizOnline/). ### Usage @@ -83,7 +85,7 @@ The `--template` flag allows to customize the HTML based graph by supplying a us ```bash -# generate topo1 graph using Graphviz +# generate a graph description file in dot format for topo1 topology containerlab graph --topo /path/to/topo1.yaml # start an http server on :3002 where topo1 graph will be rendered using the default template diff --git a/docs/images/html_topo.png b/docs/images/html_topo.png deleted file mode 100644 index b87db018b..000000000 Binary files a/docs/images/html_topo.png and /dev/null differ