From 88ee8a2ae842393992295126f7dbce921c561d2a Mon Sep 17 00:00:00 2001 From: Pim van Pelt Date: Sun, 4 May 2025 12:45:10 +0200 Subject: [PATCH] Add pre languages --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fabd5ff..6b5898d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # VPP Containerlab Docker image -## Example Containerlab +## User Documentation -The file `vpp.clab.yml' contains an example topology existing of two VPP instances connected each to +The file `vpp.clab.yml` contains an example topology existing of two VPP instances connected each to one Alpine linux container, in the following topology: ![learn-vpp](learn-vpp.png) @@ -19,7 +19,7 @@ SSH keys installed (if available). Otherwise, you can log in as user `root` usin VPP runs its own network namespace called `dataplane`, which is very similar to SR Linux default `network-instance`. You can join it to take a look: -``` +```bash pim@summer:~/src/vpp-containerlab$ ssh root@vpp1 root@vpp1:~# nsenter --net=/var/run/netns/dataplane root@vpp1:~# ip -br a @@ -41,7 +41,7 @@ rtt min/avg/max/mdev = 9.530/12.735/15.941/3.205 ms The two clients are running a minimalistic Alpine Linux container, which doesn't ship with SSH by default. You can enter the containers as following: -``` +```bash pim@summer:~/src/vpp-containerlab$ docker exec -it client1 sh / # ip addr show dev eth1 531235: eth1@if531234: mtu 9500 qdisc noqueue state UP @@ -65,8 +65,8 @@ traceroute to 2001:db8:8298:102::2 (2001:db8:8298:102::2), 30 hops max, 72 byte 3 2001:db8:8298:102::2 (2001:db8:8298:102::2) 31.964 ms 30.814 ms 32.000 ms ``` -From the vantage point of `client1`, hop 1 represents the `vpp1` node, which forwards to `vpp2`, -which finally forwards to `client2`. +From the vantage point of `client1`, the first hop represents the `vpp1` node, which forwards to +`vpp2`, which finally forwards to `client2`. ## Developer Documentation @@ -119,7 +119,7 @@ network cards. If DPDK at some future point is desired, mapping VFIO can be done or in Containerlab, using the `devices` feature: -``` +```yaml my-node: image: git.ipng.ch/ipng/vpp-containerlab:latest kind: fdio_vpp @@ -148,7 +148,7 @@ network links, which will show up as `eth1` and further. `eth0` is the default N the management plane in Containerlab (the one which you'll see with `containerlab inspect`). Before VPP can use these `veth` interfaces, it needs to bind them, like so: -``` +```bash docker exec -it clab-pim vppctl ```