Merge pull request #506 from denis-tingaikin/move-features-to-separat…

…e-suite feat: Move features to separate suite
networkservicemesh · Mar 12, 2021 · 448af6c · 448af6c
2 parents 8b8ace0 + b42349b
commit 448af6c
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 9 deletions.
diff --git a/examples/basic/README.md b/examples/basic/README.md
@@ -1,6 +1,6 @@
 # Basic examples
 
-Basis example contains setup and tear down logic with default NSM infrastructure.
+Contain basic setup for NSM that includes `nsmgr`, `forwarder-vpp`, `registry-k8s`. This setup can be used to check mechanisms combination or some kind of NSM [features](../features).
 
 ## Requires
 
@@ -17,17 +17,14 @@ Basis example contains setup and tear down logic with default NSM infrastructure
 - [Kernel to VXLAN to Memif Connection](../use-cases/Kernel2Vxlan2Memif)
 - [Memif to VXLAN to Kernel Connection](../use-cases/Memif2Vxlan2Kernel)
 
-**Featues**
-- [Open Policy Agent](../features/opa)
-
 ## Run
 
-Create ns for deployments:
+1. Create ns for deployments:
 ```bash
 kubectl create ns nsm-system
 ```
 
-Register `nsm-system` namespace in spire:
+2. Register `nsm-system` namespace in spire:
 
 ```bash
 kubectl exec -n spire spire-server-0 -- \
@@ -38,7 +35,7 @@ kubectl exec -n spire spire-server-0 -- \
 -selector k8s:sa:default
 ```
 
-Register `registry-k8s-sa` in spire:
+3. Register `registry-k8s-sa` in spire:
 
 ```bash
 kubectl exec -n spire spire-server-0 -- \
@@ -48,14 +45,17 @@ kubectl exec -n spire spire-server-0 -- \
 -selector k8s:ns:nsm-system \
 -selector k8s:sa:registry-k8s-sa
 ```
-Apply NSM resources for basic tests:
+
+4. Apply NSM resources for basic tests:
 
 ```bash
 kubectl apply -k .
 ```
 
 ## Cleanup
 
+To free resouces follow the next command:
+
 ```bash
 kubectl delete ns nsm-system
 ```
diff --git a/examples/features/README.md b/examples/features/README.md
@@ -0,0 +1,16 @@
+# Feature examples
+
+This document contain links for feature examples of NSM. 
+
+## Requires
+
+To run any feature example follow steps for [Basic NSM setup](../basic)
+
+## Includes
+
+- [Simple OPA example](./opa)
+- Heal
+- Refresh
+- Timeout
+- Admission webhook
+- DNS
diff --git a/examples/features/opa/README.md b/examples/features/opa/README.md
@@ -1,6 +1,5 @@
 # Feature OPA
 
-
 Let's consider a current simplified version of NSM authorization.
 
 ![NSM Authorize Scheme](./scheme.png "NSM Authorize Scheme")