ospf6-topo1: Add Markdown doc with testdescription

diff --git a/tests/topotests/ospf6-topo1/README.md b/tests/topotests/ospf6-topo1/README.md
new file mode 100644 (file)
index 0000000..864c8e9
--- /dev/null
+++ b/tests/topotests/ospf6-topo1/README.md
@@ -0,0 +1,132 @@
+# OSPFv3 (IPv6) Topology Test
+
+## Topology
+                                                         -----\
+         SW1 - Stub Net 1            SW2 - Stub Net 2          \
+         fc00:1:1:1::/64             fc00:2:2:2::/64            \
+       \___________________/      \___________________/          |
+                 |                          |                    |
+                 |                          |                    |
+                 | ::1                      | ::2                |
+       +---------+---------+      +---------+---------+          |
+       |        R1         |      |        R2         |          |
+       |      Quagga       |      |      Quagga       |          |
+       | Rtr-ID: 10.0.0.1  |      | Rtr-ID: 10.0.0.2  |          |
+       +---------+---------+      +---------+---------+          |
+                 | ::1                      | ::2                 \
+                  \______        ___________/                      OSPFv3
+                         \      /                               Area 0.0.0.0
+                          \    /                                  /
+                    ~~~~~~~~~~~~~~~~~~                           |
+                  ~~       SW5        ~~                         |
+                ~~       Switch         ~~                       |
+                  ~~  fc00:A:A:A::/64 ~~                         |
+                    ~~~~~~~~~~~~~~~~~~                           |
+                            |                 /----              |
+                            | ::3            | SW3 - Stub Net 3  | 
+                  +---------+---------+    /-+ fc00:3:3:3::/64   |
+                  |        R3         |   /  |                  /
+                  |      Quagga       +--/    \----            /
+                  | Rtr-ID: 10.0.0.3  | ::3        ___________/
+                  +---------+---------+                       \
+                            | ::3                              \
+                            |                                   \
+                    ~~~~~~~~~~~~~~~~~~                           |
+                  ~~       SW6        ~~                         |
+                ~~       Switch         ~~                       |
+                  ~~  fc00:B:B:B::/64 ~~                          \
+                    ~~~~~~~~~~~~~~~~~~                             OSPFv3
+                            |                                   Area 0.0.0.1
+                            | ::4                                 /
+                  +---------+---------+       /----              |
+                  |        R4         |      | SW4 - Stub Net 4  |
+                  |      Quagga       +------+ fc00:4:4:4::/64   |
+                  | Rtr-ID: 10.0.0.4  | ::4  |                   /
+                  +-------------------+       \----             /
+                                                          -----/
+
+## Quagga Configuration
+
+Full config as used is in r1 / r2 / r3 / r4 / r5 subdirectories
+
+Simplified `R1` config (R1 is similar)
+
+       hostname r1
+       !
+       interface r1-stubnet
+        ipv6 address fc00:1:1:1::1/64
+        ipv6 ospf6 network broadcast
+       !
+       interface r1-sw5
+        ipv6 address fc00:a:a:a::1/64
+        ipv6 ospf6 network broadcast
+       !
+       router ospf6
+        router-id 10.0.0.1
+        log-adjacency-changes detail
+        redistribute static
+        interface r1-stubnet area 0.0.0.0
+        interface r1-sw5 area 0.0.0.0
+       !
+       ipv6 route fc00:1111:1111:1111::/64 fc00:1:1:1::1234
+
+Simplified `R3` config
+
+       hostname r3
+       !
+       interface r3-stubnet
+        ipv6 address fc00:3:3:3::3/64
+        ipv6 ospf6 network broadcast
+       !
+       interface r3-sw5
+        ipv6 address fc00:a:a:a::3/64
+        ipv6 ospf6 network broadcast
+       !
+       interface r3-sw6
+        ipv6 address fc00:b:b:b::3/64
+        ipv6 ospf6 network broadcast
+       !
+       router ospf6
+        router-id 10.0.0.3
+        log-adjacency-changes detail
+        redistribute static
+        interface r3-stubnet area 0.0.0.0
+        interface r3-sw5 area 0.0.0.0
+        interface r3-sw6 area 0.0.0.1
+       !
+       ipv6 route fc00:3333:3333:3333::/64 fc00:3:3:3::1234
+
+## Tests executed
+
+### Check if Quagga is running
+
+Test is executed by running 
+
+       vtysh -c "show log" | grep "Logging configuration for"
+       
+on each quagga router. This should return the logging information for all daemons registered
+to Zebra and the list of running daemons is compared to the daemons started for this test (`zebra` and `ospf6d`)
+
+### Verify for OSPFv3 to converge
+
+OSPFv3 is expected to converge on each view within 60s total time. Convergence is verified by executing (on each node)
+
+       vtysh -c "show ipv6 ospf neigh"
+
+and checking for "Full" neighbor status in the output. An additional 15 seconds after the full converge is waited for routes to populate before the following routing table checks are executed
+
+### Verifing OSPFv3 Routing Tables
+
+Routing table is verified by running 
+
+       vtysh -c "show ipv6 route"
+
+on each node and comparing the result to the stored example config (see `show_ipv6_route.ref` in r1 / r2 / r3 / r4 directories). Link-Local addresses are masked out before the compare.
+
+### Verifying Linux Kernel Routing Table
+
+Linux Kernel IPv6 Routing table is verified on each Quagga node with
+
+       ip -6 route
+
+Tables are compared with reference routing table (see `ip_6_address.ref` in r1 / r2 / r3 / r4 directories). Link-Local addresses are translated after getting collected on each node with interface name to make them consistent