blob: a7fd97c1dfa2f7201798dfb8d288ff194664464d [file] [log] [blame]
Charles Chanb6ab6802019-09-20 15:44:35 -07001Quick Start
2***********
3
4Trellis in a Box
5----------------
Zack Williamsd63d35b2020-06-23 14:12:46 -07006`Trellis in a Box (TiaB)
7<https://github.com/opennetworkinglab/routing/tree/master/trellis>`_ is a
8software emulated environment that allows people to run Trellis without
9hardware switches.
Charles Chanb6ab6802019-09-20 15:44:35 -070010
Zack Williamsd63d35b2020-06-23 14:12:46 -070011TiaB comes with a few Mininet scripts that emulate various network topologies
12from a **simple 2x2 leaf-spine** to a **full multi-stage** fabric.
13
14The configurations corresponding to each topology are also packaged together
15such that you can start the environment right away.
16
17Currently TiaB only emulates the data plane, meaning that you will have to run
18ONOS separately.
19
Charles Chanb6ab6802019-09-20 15:44:35 -070020We plan to integrate the control plane (ONOS) in the future.
21
Charles Chanb6ab6802019-09-20 15:44:35 -070022Trellis with Stratum
23--------------------
Charles Chanb6ab6802019-09-20 15:44:35 -070024
Zack Williamsd63d35b2020-06-23 14:12:46 -070025There is another tutorial of `How to Use Trellis with Stratum Switches
26<https://github.com/stratum/stratum/tree/master/tools/mininet/examples/trellis>`_.
27
28This is also a software emulated environment similar to TiaB. But unlike TiaB,
29this tutorial uses ``stratum-bmv2`` to emulate the data plane switches instead
30of ``ovs``.
31
32This tutorial focuses more on Trellis and Stratum integration and therefore
33only demonstrates a **simple 2x2 leaf-spine** topology.