Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Add requires sections for use-cases #637

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions examples/use-cases/Kernel2Kernel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions examples/use-cases/Kernel2Memif/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions examples/use-cases/Kernel2Vxlan2Kernel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions examples/use-cases/Kernel2Vxlan2Memif/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions examples/use-cases/Memif2Kernel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions examples/use-cases/Memif2Memif/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions examples/use-cases/Memif2Vxlan2Kernel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions examples/use-cases/Memif2Vxlan2Memif/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions examples/use-cases/SriovKernel2Noop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions examples/use-cases/Vfio2Noop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down