tutorials.md

Tutorials

We published dozens of tutorials describing various netlab features. Choose one of these to get started:

• Build a simple network with two routers
• Run BGP labs in GitHub Codespaces
• Run netlab on Apple silicon (also applicable to other platforms)
• Run netlab examples in GitHub Codespaces

These instructions and tutorials cover some of the usual early hurdles:

• Building Vagrant boxes
• Building or installing containers
• Selecting Network Devices' Software Release

.. contents:: Other Tutorials
   :depth: 1
   :local:

Lab Topology Tutorials

Once you want to know more, check out these lab topology tutorials:

• netlab Custom Groups and Deployment Templates
• Simplify netlab Topologies with Link Groups
• Mix Containers and VMs in the Same Lab Topology
• Using VLAN and VRF Links

User Interface Tutorials

Want to draw graphs, create reports, or use the GUI?

• Network Topology Graphs
• Using Graphite as netlab GUI
• Using netlab Reports

(tutorials-vlan-vrf)=

VRFs and VLANs

VRFs and VLANs are particularly tricky, so we created numerous examples describing how you can use VLANs and VRFs with netlab. Here are a few basic examples:

• Simple VLAN Example
• VLAN Trunk Example
• Combining VLANs with VRFs

More complex examples:

• Creating VRF Lite Labs With netlab
• VRF Lite Topology with VLAN Trunks
• Creating MPLS/VPN Labs With netlab
• Router-on-a-Stick Example
• IRB with Anycast Gateways
• Building a Layer-2 Fabric

(tutorials-vxlan-evpn)=

VXLAN, and EVPN

These examples describe VXLAN and EVPN features:

• Simple VXLAN Bridging
• VXLAN Leaf-and-Spine Fabric
• EVPN/VXLAN Bridging Example
• IBGP Full Mesh Between Leaf Switches
• VXLAN Router-on-a-Stick Example

Looking for advanced examples? How about:

• VRF Lite over VXLAN Transport
• Building Layer-3-Only EVPN Lab
• Common Services VRF with EVPN Control Plane
• EVPN Hub-and-Spoke Layer-3 VPN

Even More Examples

More practical examples:

• Creating BGP Multipath Lab with netlab (lab topology using BGP and OSPF)
• Building Unnumbered Ethernet Lab with netlab (using unnumbered interfaces)
• Anycast Works Just Fine with MPLS/LDP (custom configuration templates)
• Optimal BGP Path Selection with BGP Additional Paths (custom deployment templates)
• Building a BGP Anycast Lab (group-wide node data, auto-generated groups)

Even more tutorials...

Configuration Module Examples

Documentation of individual configuration modules includes sample lab topology files:

• OSPF example
• IS-IS example
• Multiple BGP examples
• Segment Routing example

.. toctree::
   :caption: Tutorials
   :maxdepth: 1
   :hidden:

   example/github.md
   example/release.md
   example/link-definition.md
   example/linux.md
   example/bridge.md
   example/vlan-addressing.md
   example/selecting-vlan-mode.md