From 7c1776fd773e4d05f4a50af48b6c5de7b690c439 Mon Sep 17 00:00:00 2001 From: Denis Tingaikin Date: Sat, 27 Mar 2021 03:06:17 +0700 Subject: [PATCH] Add requires sections for use-cases Signed-off-by: Denis Tingaikin --- README.md | 11 ++++++++--- examples/use-cases/Kernel2Kernel/README.md | 4 ++++ examples/use-cases/Kernel2Memif/README.md | 4 ++++ examples/use-cases/Kernel2Vxlan2Kernel/README.md | 4 ++++ examples/use-cases/Kernel2Vxlan2Memif/README.md | 4 ++++ examples/use-cases/Memif2Kernel/README.md | 4 ++++ examples/use-cases/Memif2Memif/README.md | 4 ++++ examples/use-cases/Memif2Vxlan2Kernel/README.md | 4 ++++ examples/use-cases/Memif2Vxlan2Memif/README.md | 4 ++++ examples/use-cases/SriovKernel2Noop/README.md | 4 ++++ examples/use-cases/Vfio2Noop/README.md | 4 ++++ 11 files changed, 48 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index acc478962775..d97e426bcd6f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,11 @@ This repository provides kubernetes yaml deployments and markdown examples for N ## Contents -- [Applications](./apps) -- [Basic examples](./examples/basic) -- [SR-IOV examples](./examples/sriov) +* [Applications](./apps) +* Examples + * [Basic examples](./examples/basic) + * [Features examples](./examples/features) + * [OPA examples](./examples/features/opa) + * [IPv6 examples](./examples/features/ipv6) + * [SRIOV examples](./examples/sriov) + * [Memory examples](./examples/memory) diff --git a/examples/use-cases/Kernel2Kernel/README.md b/examples/use-cases/Kernel2Kernel/README.md index 10fb21455bc4..f1fdf521e1a2 100644 --- a/examples/use-cases/Kernel2Kernel/README.md +++ b/examples/use-cases/Kernel2Kernel/README.md @@ -5,6 +5,10 @@ This example shows that NSC and NSE on the one node can find each other. NSC and NSE are using the `kernel` mechanism to connect to its local forwarder. +## Requires + +Make sure that you have completed steps from [basic](../../basic) or [memory](../../memory) setup. + ## Run Create test namespace: diff --git a/examples/use-cases/Kernel2Memif/README.md b/examples/use-cases/Kernel2Memif/README.md index cd9afa6a5c18..a977e06d945a 100644 --- a/examples/use-cases/Kernel2Memif/README.md +++ b/examples/use-cases/Kernel2Memif/README.md @@ -6,6 +6,10 @@ This example shows that NSC and NSE on the one node can find each other. NSC is using the `kernel` mechanism to connect to its local forwarder. NSE is using the `memif` mechanism to connect to its local forwarder. +## Requires + +Make sure that you have completed steps from [basic](../../basic) or [memory](../../memory) setup. + ## Run Create test namespace: diff --git a/examples/use-cases/Kernel2Vxlan2Kernel/README.md b/examples/use-cases/Kernel2Vxlan2Kernel/README.md index aec714e8c0c8..29c2c7013287 100644 --- a/examples/use-cases/Kernel2Vxlan2Kernel/README.md +++ b/examples/use-cases/Kernel2Vxlan2Kernel/README.md @@ -5,6 +5,10 @@ This example shows that NSC and NSE on the different nodes could find and work w NSC and NSE are using the `kernel` mechanism to connect to its local forwarder. Forwarders are using the `vxlan` mechanism to connect with each other. +## Requires + +Make sure that you have completed steps from [basic](../../basic) or [memory](../../memory) setup. + ## Run Create test namespace: diff --git a/examples/use-cases/Kernel2Vxlan2Memif/README.md b/examples/use-cases/Kernel2Vxlan2Memif/README.md index 067e939d96fe..becb9267653c 100644 --- a/examples/use-cases/Kernel2Vxlan2Memif/README.md +++ b/examples/use-cases/Kernel2Vxlan2Memif/README.md @@ -6,6 +6,10 @@ NSC is using the `kernel` mechanism to connect to its local forwarder. NSE is using the `memif` mechanism to connect to its local forwarder. Forwarders are using the `vxlan` mechanism to connect with each other. +## Requires + +Make sure that you have completed steps from [basic](../../basic) or [memory](../../memory) setup. + ## Run Create test namespace: diff --git a/examples/use-cases/Memif2Kernel/README.md b/examples/use-cases/Memif2Kernel/README.md index a122201fc433..7e3483da9aad 100644 --- a/examples/use-cases/Memif2Kernel/README.md +++ b/examples/use-cases/Memif2Kernel/README.md @@ -5,6 +5,10 @@ This example shows that NSC and NSE on the one node can find each other. NSC is using the `memif` mechanism to connect to its local forwarder. NSE is using the `kernel` mechanism to connect to its local forwarder. +## Requires + +Make sure that you have completed steps from [basic](../../basic) or [memory](../../memory) setup. + ## Run Create test namespace: diff --git a/examples/use-cases/Memif2Memif/README.md b/examples/use-cases/Memif2Memif/README.md index 3c5762524622..0eb3fb34fb66 100644 --- a/examples/use-cases/Memif2Memif/README.md +++ b/examples/use-cases/Memif2Memif/README.md @@ -5,6 +5,10 @@ This example shows that NSC and NSE on the one node can find each other. NSC and NSE are using the `memif` mechanism to connect to its local forwarder. +## Requires + +Make sure that you have completed steps from [basic](../../basic) or [memory](../../memory) setup. + ## Run Create test namespace: diff --git a/examples/use-cases/Memif2Vxlan2Kernel/README.md b/examples/use-cases/Memif2Vxlan2Kernel/README.md index 23ec405bc6c6..2c339d23f195 100644 --- a/examples/use-cases/Memif2Vxlan2Kernel/README.md +++ b/examples/use-cases/Memif2Vxlan2Kernel/README.md @@ -7,6 +7,10 @@ NSC is using the `memif` mechanism to connect to its local forwarder. NSE is using the `kernel` mechanism to connect to its local forwarder. Forwarders are using the `vxlan` mechanism to connect with each other. +## Requires + +Make sure that you have completed steps from [basic](../../basic) or [memory](../../memory) setup. + ## Run Create test namespace: diff --git a/examples/use-cases/Memif2Vxlan2Memif/README.md b/examples/use-cases/Memif2Vxlan2Memif/README.md index a0abe233e73e..205ee6a29094 100644 --- a/examples/use-cases/Memif2Vxlan2Memif/README.md +++ b/examples/use-cases/Memif2Vxlan2Memif/README.md @@ -5,6 +5,10 @@ This example shows that NSC and NSE on the different nodes could find and work w NSC and NSE are using the `memif` mechanism to connect to its local forwarder. Forwarders are using the `vxlan` mechanism to connect with each other. +## Requires + +Make sure that you have completed steps from [basic](../../basic) or [memory](../../memory) setup. + ## Run Create test namespace: diff --git a/examples/use-cases/SriovKernel2Noop/README.md b/examples/use-cases/SriovKernel2Noop/README.md index 2924469f36c0..c4851f5fb9d1 100644 --- a/examples/use-cases/SriovKernel2Noop/README.md +++ b/examples/use-cases/SriovKernel2Noop/README.md @@ -2,6 +2,10 @@ This example shows that NSC and NSE can work with each other over the SR-IOV kernel connection. +## Requires + +Make sure that you have completed steps from [sriov](../../sriov) setup. + ## Run Create test namespace: diff --git a/examples/use-cases/Vfio2Noop/README.md b/examples/use-cases/Vfio2Noop/README.md index 5e52569688a0..753482137b0a 100644 --- a/examples/use-cases/Vfio2Noop/README.md +++ b/examples/use-cases/Vfio2Noop/README.md @@ -2,6 +2,10 @@ This example shows that NSC and NSE can work with each other over the VFIO connection. +## Requires + +Make sure that you have completed steps from [sriov](../../sriov) setup. + ## Run Create test namespace: