Merge pull request #637 from denis-tingaikin/add-requires-sections-fo…

…r-use-cases

fix: Add requires sections for use-cases

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)

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:

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:

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:

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:

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:

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:

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:

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:

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:

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: