From dc75318a5ef702def8f0aaa8532ce7663e046c2d Mon Sep 17 00:00:00 2001
From: Simon Ruderich <simon@ruderich.org>
Date: Fri, 15 Nov 2024 08:38:37 +0100
Subject: [PATCH] examples: add READMEs

---
 examples/bird-ospf/README.adoc  | 29 +++++++++++++++++++++++++++++
 examples/podman-frr/README.adoc | 19 +++++++++++++++++++
 examples/podman-frr/run.sh      |  2 +-
 examples/readme/README.adoc     |  3 +++
 4 files changed, 52 insertions(+), 1 deletion(-)
 create mode 100644 examples/bird-ospf/README.adoc
 create mode 100644 examples/podman-frr/README.adoc
 create mode 100644 examples/readme/README.adoc

diff --git a/examples/bird-ospf/README.adoc b/examples/bird-ospf/README.adoc
new file mode 100644
index 0000000..cba8f6d
--- /dev/null
+++ b/examples/bird-ospf/README.adoc
@@ -0,0 +1,29 @@
+= README
+
+Lab with three nodes (routers) each running OSPF with
+https://bird.network.cz/[Bird].
+
+image::lab.png[r1 <-> r2 <-> r3]
+
+You need to install bird first and make sure that the user `bird` and the
+directory `/run/bird/` exist.
+
+To start the lab use (as root):
+
+    # linux-network-namespace-labs up lab.conf
+
+You can use the following shell function to connect to the bird running on the
+current node:
+
+    birdc() {
+        command birdc -s "/run/bird/$(ip netns identify).ctl" "$@"
+    }
+
+For example:
+
+    # ip netns exec r1 zsh
+    # birdc
+
+To stop the lab use:
+
+    # linux-network-namespace-labs down lab.conf
diff --git a/examples/podman-frr/README.adoc b/examples/podman-frr/README.adoc
new file mode 100644
index 0000000..af38be8
--- /dev/null
+++ b/examples/podman-frr/README.adoc
@@ -0,0 +1,19 @@
+= README
+
+Proof of concept lab with two nodes (routers) each running
+https://frrouting.org/[FRR] from a Podman container.
+
+You need to install Podman first.
+
+Then start the lab (as root) with:
+
+    # ./run.sh
+
+Connect to FRR in the container with:
+
+    # podman exec -it r1 sh
+    # vtysh
+
+To stop the lab use:
+
+    # linux-network-namespace-labs down lab.conf
diff --git a/examples/podman-frr/run.sh b/examples/podman-frr/run.sh
index bda1830..3076556 100755
--- a/examples/podman-frr/run.sh
+++ b/examples/podman-frr/run.sh
@@ -30,5 +30,5 @@ linux-network-namespace-labs up lab.conf
 podman_run r1
 podman_run r2
 
-# Connect to podman container with `podman exec -it r1 bash` and then run
+# Connect to podman container with `podman exec -it r1 sh` and then run
 # `vtysh` to interact with frr.
diff --git a/examples/readme/README.adoc b/examples/readme/README.adoc
new file mode 100644
index 0000000..d5bc6cb
--- /dev/null
+++ b/examples/readme/README.adoc
@@ -0,0 +1,3 @@
+= README
+
+Example from main README, see there for details.
-- 
2.45.2