From b42349b1cce543778c5e339264be040662222462 Mon Sep 17 00:00:00 2001 From: denis-tingajkin Date: Sat, 13 Mar 2021 01:14:04 +0700 Subject: [PATCH] move features to separate suite Signed-off-by: denis-tingajkin --- examples/basic/README.md | 16 ++++++++-------- examples/features/README.md | 16 ++++++++++++++++ examples/features/opa/README.md | 1 - 3 files changed, 24 insertions(+), 9 deletions(-) create mode 100644 examples/features/README.md diff --git a/examples/basic/README.md b/examples/basic/README.md index 7278f7e83551..ed36b9a0947c 100644 --- 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,7 +45,8 @@ 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 . @@ -56,6 +54,8 @@ kubectl apply -k . ## Cleanup +To free resouces follow the next command: + ```bash kubectl delete ns nsm-system ``` \ No newline at end of file diff --git a/examples/features/README.md b/examples/features/README.md new file mode 100644 index 000000000000..50868b1daf80 --- /dev/null +++ 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 index e4cd5bde9bf4..a40d18a43e41 100644 --- 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")