Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
karimra committed Nov 20, 2020
1 parent db246bd commit 695dc12
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/cmd/graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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
Expand Down
Binary file removed docs/images/html_topo.png
Binary file not shown.

0 comments on commit 695dc12

Please sign in to comment.