Added top-level README.md

nathanbycroft · Jun 30, 2024 · df6e87e · df6e87e
1 parent f24ddaa
commit df6e87e
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 114 deletions.
diff --git a/P2MP/initial-config.j2 → OSPF/p2mp/initial-config.j2 b/P2MP/initial-config.j2 → OSPF/p2mp/initial-config.j2
diff --git a/P2MP/mesh-ping.yml → OSPF/p2mp/mesh-ping.yml b/P2MP/mesh-ping.yml → OSPF/p2mp/mesh-ping.yml
diff --git a/P2MP/ospf-p2mp.j2 → OSPF/p2mp/ospf-p2mp.j2 b/P2MP/ospf-p2mp.j2 → OSPF/p2mp/ospf-p2mp.j2
diff --git a/P2MP/topology-expanded.yml → OSPF/p2mp/topology-expanded.yml b/P2MP/topology-expanded.yml → OSPF/p2mp/topology-expanded.yml
diff --git a/P2MP/topology.yml → OSPF/p2mp/topology.yml b/P2MP/topology.yml → OSPF/p2mp/topology.yml
diff --git a/P2MP/Vagrantfile b/P2MP/Vagrantfile
diff --git a/P2MP/ansible.cfg b/P2MP/ansible.cfg
diff --git a/P2MP/hosts.yml b/P2MP/hosts.yml
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+# Netlab Examples
+
+This repository contains dozens of _netlab_ examples, many of them [explained in ipSpace.net blog posts](https://blog.ipspace.net/tag/netlab.html). You can [install *netlab*](https://netlab.tools/install/) and run them locally (even on [Apple silicon](https://blog.ipspace.net/2024/03/netlab-bgp-apple-silicon.html)),  or [explore them in a (free) GitHub codespace](https://github.com/codespaces/new/ipspace/netlab-examples) (see [BGP labs](https://bgplabs.net/4-codespaces/) for more details).
+
+The networking technologies examples include:
+
+* An interesting [Ansible](Ansible) example
+* Over a dozen [BGP](BGP) examples
+* Various [DHCP](DHCP) scenarios from the [DHCP relaying series](https://blog.ipspace.net/series/dhcp-relay.html)
+* A [DMVPN](DMVPN) and an [EIGRP](EIGRP) topology
+* VXLAN- and MPLS-based [EVPN](EVPN) examples
+* An [IS-IS](ISIS) topology
+* [IP routing](routing) examples
+* [MPLS](MPLS) examples
+* Several [OSPF](OSPF) examples
+* [VLAN](VLAN) and [VRF](VRF) examples
+* [VXLAN](VXLAN) examples
+* A [WAN](WAN) emulation example
+
+_netlab_ examples include:
+
+* A [custom configuration](config) example
+* [Multi-platform](multi-platform) examples
+* [Plugin examples](plugins)
+* A [topology](timing) used to [measure network device boot times](https://blog.ipspace.net/2023/02/virtual-device-boot-times.html)