From: Kuralamudhan Ramakrishnan <kuralamudhan.ramakrishnan@intel.com>
Date: Tue, 22 Sep 2020 00:49:09 +0000 (-0700)
Subject: adding documentations
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=6563111f5d1787921d7eff9c86e4c71a29d1eca5;p=ovn4nfv-k8s-plugin.git

adding documentations

Signed-off-by: Kuralamudhan Ramakrishnan <kuralamudhan.ramakrishnan@intel.com>
Change-Id: I2b4c04275c5acb69a604009ae901d741387c5f93
---

diff --git a/doc/how-to-use.md b/doc/how-to-use.md
index e69de29..3e2ab21 100644
--- a/doc/how-to-use.md
+++ b/doc/how-to-use.md
@@ -0,0 +1,421 @@
+# OVN4NFV Usage guide
+
+## Quickstart Installation Guide
+
+Please follow the ovn4nfv installation steps - [ovn4nfv installation](https://github.com/ovn4nfv/ovn4nfv-k8s-plugin#quickstart-installation-guide)
+
+## Network Testing
+
+create 2 pod and test the ping operation between them
+
+```
+# kubectl apply -f example/ovn4nfv-deployment-replica-2-noannotation.yaml
+deployment.apps/ovn4nfv-deployment-noannotation created
+# kubectl get pods  -o wide
+NAMESPACE     NAME                                              READY   STATUS    RESTARTS   AGE     IP               NODE       NOMINATED NODE   READINESS GATES
+default       ovn4nfv-deployment-noannotation-f446688bf-8g8hl   1/1     Running   0          3m26s   10.233.64.11     minion02   <none>           <none>
+default       ovn4nfv-deployment-noannotation-f446688bf-srh56   1/1     Running   0          3m26s   10.233.64.10     minion01   <none>           <none>
+# kubectl exec -it ovn4nfv-deployment-noannotation-f446688bf-8g8hl -- ping 10.233.64.10 -c 1
+PING 10.233.64.10 (10.233.64.10): 56 data bytes
+64 bytes from 10.233.64.10: seq=0 ttl=64 time=2.650 ms
+
+--- 10.233.64.10 ping statistics ---
+1 packets transmitted, 1 packets received, 0% packet loss
+round-trip min/avg/max = 2.650/2.650/2.650 ms
+```
+
+Create hostname deployment and svc and test the k8s service query
+
+```
+# kubectl apply -f example/ovn4nfv-deployment-noannotation-hostnames.yaml
+deployment.apps/hostnames created
+# kubectl get pods --all-namespaces -o wide
+NAMESPACE     NAME                                          READY   STATUS    RESTARTS   AGE     IP               NODE       NOMINATED NODE   READINESS GATES
+default       hostnames-5d97c4688-jqw77                     1/1     Running   0          12s     10.233.64.12     minion01   <none>           <none>
+default       hostnames-5d97c4688-rx7zp                     1/1     Running   0          12s     10.233.64.11     master     <none>           <none>
+default       hostnames-5d97c4688-z44sh                     1/1     Running   0          12s     10.233.64.10     minion02   <none>           <none>
+```
+
+Test the hostname svc
+
+```
+# kubectl apply -f example/ovn4nfv-deployment-hostnames-svc.yaml
+service/hostnames created
+# kubectl apply -f example/ovn4nfv-deployment-noannotation-sandbox.yaml
+deployment.apps/ovn4nfv-deployment-noannotation-sandbox created
+# kubectl get pods -o wide
+NAME                                                       READY   STATUS    RESTARTS   AGE     IP             NODE       NOMINATED NODE   READINESS GATES
+hostnames-5d97c4688-jqw77                                  1/1     Running   0          6m41s   10.233.64.12   minion01   <none>           <none>
+hostnames-5d97c4688-rx7zp                                  1/1     Running   0          6m41s   10.233.64.11   master     <none>           <none>
+hostnames-5d97c4688-z44sh                                  1/1     Running   0          6m41s   10.233.64.10   minion02   <none>           <none>
+ovn4nfv-deployment-noannotation-sandbox-5fb94db669-vdkss   1/1     Running   0          9s      10.233.64.13   minion02   <none>           <none>
+# kubectl exec -it ovn4nfv-deployment-noannotation-sandbox-5fb94db669-vdkss -- wget -qO- hostnames
+hostnames-5d97c4688-jqw77
+# kubectl exec -it ovn4nfv-deployment-noannotation-sandbox-5fb94db669-vdkss -- wget -qO- hostnames
+hostnames-5d97c4688-rx7zp
+# kubectl exec -it ovn4nfv-deployment-noannotation-sandbox-5fb94db669-vdkss -- wget -qO- hostnames
+hostnames-5d97c4688-z44sh
+```
+you should get different hostname for each query
+
+Test the reachablity
+
+```
+# kubectl exec -it ovn4nfv-deployment-noannotation-sandbox-5fb94db669-vdkss -- wget -qO- example.com
+<!doctype html>
+<html>
+<head>
+    <title>Example Domain</title>
+
+    <meta charset="utf-8" />
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style type="text/css">
+    body {
+        background-color: #f0f0f2;
+        margin: 0;
+        padding: 0;
+        font-family: -apple-system, system-ui, BlinkMacSystemFont, "Segoe UI", "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
+
+    }
+    div {
+        width: 600px;
+        margin: 5em auto;
+        padding: 2em;
+        background-color: #fdfdff;
+        border-radius: 0.5em;
+        box-shadow: 2px 3px 7px 2px rgba(0,0,0,0.02);
+    }
+    a:link, a:visited {
+        color: #38488f;
+        text-decoration: none;
+    }
+    @media (max-width: 700px) {
+        div {
+            margin: 0 auto;
+            width: auto;
+        }
+    }
+    </style>
+</head>
+
+<body>
+<div>
+    <h1>Example Domain</h1>
+    <p>This domain is for use in illustrative examples in documents. You may use this
+    domain in literature without prior coordination or asking for permission.</p>
+    <p><a href="https://www.iana.org/domains/example">More information...</a></p>
+</div>
+</body>
+</html>
+```
+
+## Test the  Multiple Network Setup and Testing
+
+Create two networks ovn-priv-net and ovn-port-net
+
+```
+# kubectl apply -f example/ovn-priv-net.yaml
+network.k8s.plugin.opnfv.org/ovn-priv-net created
+
+# kubectl apply -f example/ovn-port-net.yaml
+network.k8s.plugin.opnfv.org/ovn-port-net created
+
+# kubectl get crds
+NAME                                    CREATED AT
+networkchainings.k8s.plugin.opnfv.org   2020-09-21T19:29:50Z
+networks.k8s.plugin.opnfv.org           2020-09-21T19:29:50Z
+providernetworks.k8s.plugin.opnfv.org   2020-09-21T19:29:50
+
+# kubectl get networks
+NAME           AGE
+ovn-port-net   32s
+ovn-priv-net   39s
+```
+
+Use the network `ovn-port-net` and `ovn-priv-net` for the multiple network creation
+and test the network connectivity between the pods
+
+```
+# kubectl apply -f example/ovn4nfv-deployment-replica-2-withannotation.yaml
+deployment.apps/ovn4nfv-deployment-2-annotation created
+
+# kubectl get pods -o wide
+NAME                                               READY   STATUS    RESTARTS   AGE     IP             NODE       NOMINATED NODE   READINESS GATES
+ovn4nfv-deployment-2-annotation-65cbc6f87f-5zwkt   1/1     Running   0          3m15s   10.233.64.14   minion01   <none>           <none>
+ovn4nfv-deployment-2-annotation-65cbc6f87f-cv75p   1/1     Running   0          3m15s   10.233.64.15   minion02   <none>           <none>
+
+# kubectl exec -it ovn4nfv-deployment-2-annotation-65cbc6f87f-5zwkt -- ifconfig
+eth0      Link encap:Ethernet  HWaddr B6:66:62:E9:40:0F
+          inet addr:10.233.64.14  Bcast:10.233.127.255  Mask:255.255.192.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
+          RX packets:13 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:1026 (1.0 KiB)  TX bytes:0 (0.0 B)
+
+lo        Link encap:Local Loopback
+          inet addr:127.0.0.1  Mask:255.0.0.0
+          UP LOOPBACK RUNNING  MTU:65536  Metric:1
+          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:1000
+          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
+
+net0      Link encap:Ethernet  HWaddr B6:66:62:10:21:03
+          inet addr:172.16.33.2  Bcast:172.16.33.255  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
+          RX packets:13 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:1026 (1.0 KiB)  TX bytes:0 (0.0 B)
+
+net1      Link encap:Ethernet  HWaddr B6:66:62:10:2C:03
+          inet addr:172.16.44.2  Bcast:172.16.44.255  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
+          RX packets:52 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:10452 (10.2 KiB)  TX bytes:0 (0.0 B)
+
+# kubectl exec -it ovn4nfv-deployment-2-annotation-65cbc6f87f-cv75p -- ifconfig
+eth0      Link encap:Ethernet  HWaddr B6:66:62:E9:40:10
+          inet addr:10.233.64.15  Bcast:10.233.127.255  Mask:255.255.192.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
+          RX packets:13 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:1026 (1.0 KiB)  TX bytes:0 (0.0 B)
+
+lo        Link encap:Local Loopback
+          inet addr:127.0.0.1  Mask:255.0.0.0
+          UP LOOPBACK RUNNING  MTU:65536  Metric:1
+          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:1000
+          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
+
+net0      Link encap:Ethernet  HWaddr B6:66:62:10:21:04
+          inet addr:172.16.33.3  Bcast:172.16.33.255  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
+          RX packets:13 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:1026 (1.0 KiB)  TX bytes:0 (0.0 B)
+
+net1      Link encap:Ethernet  HWaddr B6:66:62:10:2C:04
+          inet addr:172.16.44.3  Bcast:172.16.44.255  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
+          RX packets:13 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:1026 (1.0 KiB)  TX bytes:0 (0.0 B)
+
+# kubectl exec -it ovn4nfv-deployment-2-annotation-65cbc6f87f-cv75p -- ping 172.16.44.2 -c 1
+PING 172.16.44.2 (172.16.44.2): 56 data bytes
+64 bytes from 172.16.44.2: seq=0 ttl=64 time=3.488 ms
+
+--- 172.16.44.2 ping statistics ---
+1 packets transmitted, 1 packets received, 0% packet loss
+round-trip min/avg/max = 3.488/3.488/3.488 ms
+```
+
+## VLAN and Direct Provider Network Setup and Testing
+
+In this `./example` folder, OVN4NFV-plugin daemonset yaml file, VLAN and direct Provider networking testing scenarios and required sample
+configuration file.
+
+### Quick start
+
+### Creating sandbox environment
+
+Create 2 VMs in your setup. The recommended way of creating the sandbox is through KUD. Please follow the all-in-one setup in KUD. This
+will create two VMs and provide the required sandbox.
+
+### VLAN Tagging Provider network testing
+
+The following setup have 2 VMs with one VM having Kubernetes setup with OVN4NFVk8s plugin and another VM act as provider networking to do
+testing.
+
+Run the following yaml file to test teh vlan tagging provider networking. User required to change the `providerInterfaceName` and
+`nodeLabelList` in the `ovn4nfv_vlan_pn.yml`
+
+```
+kubectl apply -f ovn4nfv_vlan_pn.yml
+```
+This create Vlan tagging interface eth0.100 in VM1 and two pods for the deployment `pnw-original-vlan-1` and `pnw-original-vlan-2` in VM.
+Test the interface details and inter network communication between `net0` interfaces
+```
+# kubectl exec -it pnw-original-vlan-1-6c67574cd7-mv57g -- ifconfig
+eth0      Link encap:Ethernet  HWaddr 0A:58:0A:F4:40:30
+          inet addr:10.244.64.48  Bcast:0.0.0.0  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1450  Metric:1
+          RX packets:11 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:462 (462.0 B)  TX bytes:0 (0.0 B)
+
+lo        Link encap:Local Loopback
+          inet addr:127.0.0.1  Mask:255.0.0.0
+          UP LOOPBACK RUNNING  MTU:65536  Metric:1
+          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:1000
+          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
+
+net0      Link encap:Ethernet  HWaddr 0A:00:00:00:00:3C
+          inet addr:172.16.33.3  Bcast:172.16.33.255  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
+          RX packets:10 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:9 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:868 (868.0 B)  TX bytes:826 (826.0 B)
+# kubectl exec -it pnw-original-vlan-2-5bd9ffbf5c-4gcgq -- ifconfig
+eth0      Link encap:Ethernet  HWaddr 0A:58:0A:F4:40:31
+          inet addr:10.244.64.49  Bcast:0.0.0.0  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1450  Metric:1
+          RX packets:11 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:462 (462.0 B)  TX bytes:0 (0.0 B)
+
+lo        Link encap:Local Loopback
+          inet addr:127.0.0.1  Mask:255.0.0.0
+          UP LOOPBACK RUNNING  MTU:65536  Metric:1
+          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:1000
+          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
+
+net0      Link encap:Ethernet  HWaddr 0A:00:00:00:00:3D
+          inet addr:172.16.33.4  Bcast:172.16.33.255  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
+          RX packets:25 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:25 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:2282 (2.2 KiB)  TX bytes:2282 (2.2 KiB)
+```
+Test the ping operation between the vlan interfaces
+```
+# kubectl exec -it pnw-original-vlan-2-5bd9ffbf5c-4gcgq -- ping -I net0 172.16.33.3 -c 2
+PING 172.16.33.3 (172.16.33.3): 56 data bytes
+64 bytes from 172.16.33.3: seq=0 ttl=64 time=0.092 ms
+64 bytes from 172.16.33.3: seq=1 ttl=64 time=0.105 ms
+
+--- 172.16.33.3 ping statistics ---
+2 packets transmitted, 2 packets received, 0% packet loss
+round-trip min/avg/max = 0.092/0.098/0.105 ms
+```
+In VM2 create a Vlan tagging for eth0 as eth0.100 and configure the IP address as
+```
+# ifconfig eth0.100
+eth0.100: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
+        inet 172.16.33.2  netmask 255.255.255.0  broadcast 172.16.33.255
+        ether 52:54:00:f4:ee:d9  txqueuelen 1000  (Ethernet)
+        RX packets 111  bytes 8092 (8.0 KB)
+        RX errors 0  dropped 0  overruns 0  frame 0
+        TX packets 149  bytes 12698 (12.6 KB)
+        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
+```
+Pinging from VM2 through eth0.100 to pod 1 in VM1 should be successfull to test the VLAN tagging
+```
+# ping -I eth0.100 172.16.33.3 -c 2
+PING 172.16.33.3 (172.16.33.3) from 172.16.33.2 eth0.100: 56(84) bytes of data.
+64 bytes from 172.16.33.3: icmp_seq=1 ttl=64 time=0.382 ms
+64 bytes from 172.16.33.3: icmp_seq=2 ttl=64 time=0.347 ms
+
+--- 172.16.33.3 ping statistics ---
+2 packets transmitted, 2 received, 0% packet loss, time 1009ms
+rtt min/avg/max/mdev = 0.347/0.364/0.382/0.025 ms
+```
+### VLAN Tagging between VMs
+![vlan tagging testing](../images/vlan-tagging.png)
+
+### Direct Provider network testing
+
+The main difference between Vlan tagging and Direct provider networking is that VLAN logical interface is created and then ports are
+attached to it. In order to validate the direct provider networking connectivity, we create VLAN tagging between VM1 & VM2 and test the
+connectivity as follow.
+
+Create VLAN tagging interface eth0.101 in VM1 and VM2. Just add `providerInterfaceName: eth0.101' in Direct provider network CR.
+```
+# kubectl apply -f ovn4nfv_direct_pn.yml
+```
+Check the inter connection between direct provider network pods as follow
+```
+# kubectl exec -it pnw-original-direct-1-85f5b45fdd-qq6xc -- ifconfig
+eth0      Link encap:Ethernet  HWaddr 0A:58:0A:F4:40:33
+          inet addr:10.244.64.51  Bcast:0.0.0.0  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1450  Metric:1
+          RX packets:6 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:252 (252.0 B)  TX bytes:0 (0.0 B)
+
+lo        Link encap:Local Loopback
+          inet addr:127.0.0.1  Mask:255.0.0.0
+          UP LOOPBACK RUNNING  MTU:65536  Metric:1
+          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:1000
+          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
+
+net0      Link encap:Ethernet  HWaddr 0A:00:00:00:00:3E
+          inet addr:172.16.34.3  Bcast:172.16.34.255  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
+          RX packets:29 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:26 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:2394 (2.3 KiB)  TX bytes:2268 (2.2 KiB)
+
+# kubectl exec -it pnw-original-direct-2-6bc54d98c4-vhxmk  -- ifconfig
+eth0      Link encap:Ethernet  HWaddr 0A:58:0A:F4:40:32
+          inet addr:10.244.64.50  Bcast:0.0.0.0  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1450  Metric:1
+          RX packets:6 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:252 (252.0 B)  TX bytes:0 (0.0 B)
+
+lo        Link encap:Local Loopback
+          inet addr:127.0.0.1  Mask:255.0.0.0
+          UP LOOPBACK RUNNING  MTU:65536  Metric:1
+          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:1000
+          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
+
+net0      Link encap:Ethernet  HWaddr 0A:00:00:00:00:3F
+          inet addr:172.16.34.4  Bcast:172.16.34.255  Mask:255.255.255.0
+          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
+          RX packets:14 errors:0 dropped:0 overruns:0 frame:0
+          TX packets:10 errors:0 dropped:0 overruns:0 carrier:0
+          collisions:0 txqueuelen:0
+          RX bytes:1092 (1.0 KiB)  TX bytes:924 (924.0 B)
+# kubectl exec -it pnw-original-direct-2-6bc54d98c4-vhxmk  -- ping -I net0 172.16.34.3 -c 2
+PING 172.16.34.3 (172.16.34.3): 56 data bytes
+64 bytes from 172.16.34.3: seq=0 ttl=64 time=0.097 ms
+64 bytes from 172.16.34.3: seq=1 ttl=64 time=0.096 ms
+
+--- 172.16.34.3 ping statistics ---
+2 packets transmitted, 2 packets received, 0% packet loss
+round-trip min/avg/max = 0.096/0.096/0.097 ms
+```
+In VM2, ping the pod1 in the VM1
+$ ping -I eth0.101 172.16.34.2 -c 2
+```
+PING 172.16.34.2 (172.16.34.2) from 172.16.34.2 eth0.101: 56(84) bytes of data.
+64 bytes from 172.16.34.2: icmp_seq=1 ttl=64 time=0.057 ms
+64 bytes from 172.16.34.2: icmp_seq=2 ttl=64 time=0.065 ms
+
+--- 172.16.34.2 ping statistics ---
+2 packets transmitted, 2 received, 0% packet loss, time 1010ms
+rtt min/avg/max/mdev = 0.057/0.061/0.065/0.004 ms
+```
+### Direct provider networking between VMs
+![Direct provider network testing](../images/direct-provider-networking.png)
+
+# Summary
+
+This is only the test scenario for development and also for verification purpose. Work in progress to make the end2end testing
+automatic.
diff --git a/example/README.md b/example/README.md
deleted file mode 100644
index 2d3ad4c..0000000
--- a/example/README.md
+++ /dev/null
@@ -1,199 +0,0 @@
-# Example Setup and Testing
-
-In this `./example` folder, OVN4NFV-plugin daemonset yaml file, VLAN and direct Provider networking testing scenarios and required sample
-configuration file.
-
-# Quick start
-
-## Creating sandbox environment
-
-Create 2 VMs in your setup. The recommended way of creating the sandbox is through KUD. Please follow the all-in-one setup in KUD. This
-will create two VMs and provide the required sandbox.
-
-## VLAN Tagging Provider network testing
-
-The following setup have 2 VMs with one VM having Kubernetes setup with OVN4NFVk8s plugin and another VM act as provider networking to do
-testing.
-
-Run the following yaml file to test teh vlan tagging provider networking. User required to change the `providerInterfaceName` and
-`nodeLabelList` in the `ovn4nfv_vlan_pn.yml`
-
-```
-kubectl apply -f ovn4nfv_vlan_pn.yml
-```
-This create Vlan tagging interface eth0.100 in VM1 and two pods for the deployment `pnw-original-vlan-1` and `pnw-original-vlan-2` in VM.
-Test the interface details and inter network communication between `net0` interfaces
-```
-# kubectl exec -it pnw-original-vlan-1-6c67574cd7-mv57g -- ifconfig
-eth0      Link encap:Ethernet  HWaddr 0A:58:0A:F4:40:30
-          inet addr:10.244.64.48  Bcast:0.0.0.0  Mask:255.255.255.0
-          UP BROADCAST RUNNING MULTICAST  MTU:1450  Metric:1
-          RX packets:11 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:0
-          RX bytes:462 (462.0 B)  TX bytes:0 (0.0 B)
-
-lo        Link encap:Local Loopback
-          inet addr:127.0.0.1  Mask:255.0.0.0
-          UP LOOPBACK RUNNING  MTU:65536  Metric:1
-          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:1000
-          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
-
-net0      Link encap:Ethernet  HWaddr 0A:00:00:00:00:3C
-          inet addr:172.16.33.3  Bcast:172.16.33.255  Mask:255.255.255.0
-          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
-          RX packets:10 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:9 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:0
-          RX bytes:868 (868.0 B)  TX bytes:826 (826.0 B)
-# kubectl exec -it pnw-original-vlan-2-5bd9ffbf5c-4gcgq -- ifconfig
-eth0      Link encap:Ethernet  HWaddr 0A:58:0A:F4:40:31
-          inet addr:10.244.64.49  Bcast:0.0.0.0  Mask:255.255.255.0
-          UP BROADCAST RUNNING MULTICAST  MTU:1450  Metric:1
-          RX packets:11 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:0
-          RX bytes:462 (462.0 B)  TX bytes:0 (0.0 B)
-
-lo        Link encap:Local Loopback
-          inet addr:127.0.0.1  Mask:255.0.0.0
-          UP LOOPBACK RUNNING  MTU:65536  Metric:1
-          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:1000
-          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
-
-net0      Link encap:Ethernet  HWaddr 0A:00:00:00:00:3D
-          inet addr:172.16.33.4  Bcast:172.16.33.255  Mask:255.255.255.0
-          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
-          RX packets:25 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:25 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:0
-          RX bytes:2282 (2.2 KiB)  TX bytes:2282 (2.2 KiB)
-```
-Test the ping operation between the vlan interfaces
-```
-# kubectl exec -it pnw-original-vlan-2-5bd9ffbf5c-4gcgq -- ping -I net0 172.16.33.3 -c 2
-PING 172.16.33.3 (172.16.33.3): 56 data bytes
-64 bytes from 172.16.33.3: seq=0 ttl=64 time=0.092 ms
-64 bytes from 172.16.33.3: seq=1 ttl=64 time=0.105 ms
-
---- 172.16.33.3 ping statistics ---
-2 packets transmitted, 2 packets received, 0% packet loss
-round-trip min/avg/max = 0.092/0.098/0.105 ms
-```
-In VM2 create a Vlan tagging for eth0 as eth0.100 and configure the IP address as
-```
-# ifconfig eth0.100
-eth0.100: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
-        inet 172.16.33.2  netmask 255.255.255.0  broadcast 172.16.33.255
-        ether 52:54:00:f4:ee:d9  txqueuelen 1000  (Ethernet)
-        RX packets 111  bytes 8092 (8.0 KB)
-        RX errors 0  dropped 0  overruns 0  frame 0
-        TX packets 149  bytes 12698 (12.6 KB)
-        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
-```
-Pinging from VM2 through eth0.100 to pod 1 in VM1 should be successfull to test the VLAN tagging
-```
-# ping -I eth0.100 172.16.33.3 -c 2
-PING 172.16.33.3 (172.16.33.3) from 172.16.33.2 eth0.100: 56(84) bytes of data.
-64 bytes from 172.16.33.3: icmp_seq=1 ttl=64 time=0.382 ms
-64 bytes from 172.16.33.3: icmp_seq=2 ttl=64 time=0.347 ms
-
---- 172.16.33.3 ping statistics ---
-2 packets transmitted, 2 received, 0% packet loss, time 1009ms
-rtt min/avg/max/mdev = 0.347/0.364/0.382/0.025 ms
-```
-## VLAN Tagging between VMs
-![vlan tagging testing](../images/vlan-tagging.png)
-
-# Direct Provider network testing
-
-The main difference between Vlan tagging and Direct provider networking is that VLAN logical interface is created and then ports are
-attached to it. In order to validate the direct provider networking connectivity, we create VLAN tagging between VM1 & VM2 and test the
-connectivity as follow.
-
-Create VLAN tagging interface eth0.101 in VM1 and VM2. Just add `providerInterfaceName: eth0.101' in Direct provider network CR.
-```
-# kubectl apply -f ovn4nfv_direct_pn.yml
-```
-Check the inter connection between direct provider network pods as follow
-```
-# kubectl exec -it pnw-original-direct-1-85f5b45fdd-qq6xc -- ifconfig
-eth0      Link encap:Ethernet  HWaddr 0A:58:0A:F4:40:33
-          inet addr:10.244.64.51  Bcast:0.0.0.0  Mask:255.255.255.0
-          UP BROADCAST RUNNING MULTICAST  MTU:1450  Metric:1
-          RX packets:6 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:0
-          RX bytes:252 (252.0 B)  TX bytes:0 (0.0 B)
-
-lo        Link encap:Local Loopback
-          inet addr:127.0.0.1  Mask:255.0.0.0
-          UP LOOPBACK RUNNING  MTU:65536  Metric:1
-          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:1000
-          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
-
-net0      Link encap:Ethernet  HWaddr 0A:00:00:00:00:3E
-          inet addr:172.16.34.3  Bcast:172.16.34.255  Mask:255.255.255.0
-          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
-          RX packets:29 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:26 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:0
-          RX bytes:2394 (2.3 KiB)  TX bytes:2268 (2.2 KiB)
-
-# kubectl exec -it pnw-original-direct-2-6bc54d98c4-vhxmk  -- ifconfig
-eth0      Link encap:Ethernet  HWaddr 0A:58:0A:F4:40:32
-          inet addr:10.244.64.50  Bcast:0.0.0.0  Mask:255.255.255.0
-          UP BROADCAST RUNNING MULTICAST  MTU:1450  Metric:1
-          RX packets:6 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:0
-          RX bytes:252 (252.0 B)  TX bytes:0 (0.0 B)
-
-lo        Link encap:Local Loopback
-          inet addr:127.0.0.1  Mask:255.0.0.0
-          UP LOOPBACK RUNNING  MTU:65536  Metric:1
-          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:1000
-          RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
-
-net0      Link encap:Ethernet  HWaddr 0A:00:00:00:00:3F
-          inet addr:172.16.34.4  Bcast:172.16.34.255  Mask:255.255.255.0
-          UP BROADCAST RUNNING MULTICAST  MTU:1400  Metric:1
-          RX packets:14 errors:0 dropped:0 overruns:0 frame:0
-          TX packets:10 errors:0 dropped:0 overruns:0 carrier:0
-          collisions:0 txqueuelen:0
-          RX bytes:1092 (1.0 KiB)  TX bytes:924 (924.0 B)
-# kubectl exec -it pnw-original-direct-2-6bc54d98c4-vhxmk  -- ping -I net0 172.16.34.3 -c 2
-PING 172.16.34.3 (172.16.34.3): 56 data bytes
-64 bytes from 172.16.34.3: seq=0 ttl=64 time=0.097 ms
-64 bytes from 172.16.34.3: seq=1 ttl=64 time=0.096 ms
-
---- 172.16.34.3 ping statistics ---
-2 packets transmitted, 2 packets received, 0% packet loss
-round-trip min/avg/max = 0.096/0.096/0.097 ms
-```
-In VM2, ping the pod1 in the VM1
-$ ping -I eth0.101 172.16.34.2 -c 2
-```
-PING 172.16.34.2 (172.16.34.2) from 172.16.34.2 eth0.101: 56(84) bytes of data.
-64 bytes from 172.16.34.2: icmp_seq=1 ttl=64 time=0.057 ms
-64 bytes from 172.16.34.2: icmp_seq=2 ttl=64 time=0.065 ms
-
---- 172.16.34.2 ping statistics ---
-2 packets transmitted, 2 received, 0% packet loss, time 1010ms
-rtt min/avg/max/mdev = 0.057/0.061/0.065/0.004 ms
-```
-## Direct provider networking between VMs
-![Direct provider network testing](../images/direct-provider-networking.png)
-
-# Summary
-
-This is only the test scenario for development and also for verification purpose. Work in progress to make the end2end testing
-automatic.
diff --git a/example/ovn-port-net.yaml b/example/ovn-port-net.yaml
new file mode 100644
index 0000000..3c73f35
--- /dev/null
+++ b/example/ovn-port-net.yaml
@@ -0,0 +1,10 @@
+apiVersion: k8s.plugin.opnfv.org/v1alpha1
+kind: Network
+metadata:
+  name: ovn-port-net
+spec:
+  cniType : ovn4nfv
+  ipv4Subnets:
+  - subnet: 172.16.33.0/24
+    name: subnet1
+    gateway: 172.16.33.1/24
diff --git a/example/ovn-priv-net.yaml b/example/ovn-priv-net.yaml
new file mode 100644
index 0000000..aa5fe1e
--- /dev/null
+++ b/example/ovn-priv-net.yaml
@@ -0,0 +1,10 @@
+apiVersion: k8s.plugin.opnfv.org/v1alpha1
+kind: Network
+metadata:
+  name: ovn-priv-net
+spec:
+  cniType : ovn4nfv
+  ipv4Subnets:
+  - subnet: 172.16.44.0/24
+    name: subnet1
+    gateway: 172.16.44.1/24
diff --git a/example/ovn4nfv-deployment-hostnames-svc.yaml b/example/ovn4nfv-deployment-hostnames-svc.yaml
new file mode 100644
index 0000000..4ff4c59
--- /dev/null
+++ b/example/ovn4nfv-deployment-hostnames-svc.yaml
@@ -0,0 +1,14 @@
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    app: hostnames
+  name: hostnames
+spec:
+  selector:
+    app: hostnames
+  ports:
+  - name: default
+    protocol: TCP
+    port: 80
+    targetPort: 9376
diff --git a/example/ovn4nfv-deployment-noannotation-hostnames.yaml b/example/ovn4nfv-deployment-noannotation-hostnames.yaml
new file mode 100644
index 0000000..c513df9
--- /dev/null
+++ b/example/ovn4nfv-deployment-noannotation-hostnames.yaml
@@ -0,0 +1,22 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    app: hostnames
+  name: hostnames
+spec:
+  selector:
+    matchLabels:
+      app: hostnames
+  replicas: 3
+  template:
+    metadata:
+      labels:
+        app: hostnames
+    spec:
+      containers:
+      - name: hostnames
+        image: rkamudhan/serve-hostname-amd64:1.2
+        securityContext:
+          capabilities:
+            add: ["NET_ADMIN"]
diff --git a/example/ovn4nfv-deployment-noannotation-sandbox.yaml b/example/ovn4nfv-deployment-noannotation-sandbox.yaml
new file mode 100644
index 0000000..1a620ae
--- /dev/null
+++ b/example/ovn4nfv-deployment-noannotation-sandbox.yaml
@@ -0,0 +1,22 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: ovn4nfv-deployment-noannotation-sandbox
+  labels:
+    app: ovn4nfv-noannotation-sandbox
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: ovn4nfv-noannotation-sandbox
+  template:
+    metadata:
+      labels:
+        app: ovn4nfv-noannotation-sandbox
+    spec:
+      containers:
+      - name: ovn4nfv-deployment-noannotation-sandbox
+        image: "busybox"
+        command: ["top"]
+        stdin: true
+        tty: true
diff --git a/example/ovn4nfv-deployment-replica-2-noannotation.yaml b/example/ovn4nfv-deployment-replica-2-noannotation.yaml
new file mode 100644
index 0000000..e792cf2
--- /dev/null
+++ b/example/ovn4nfv-deployment-replica-2-noannotation.yaml
@@ -0,0 +1,22 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: ovn4nfv-deployment-noannotation
+  labels:
+    app: ovn4nfv-noannotation
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app: ovn4nfv-noannotation
+  template:
+    metadata:
+      labels:
+        app: ovn4nfv-noannotation
+    spec:
+      containers:
+      - name: ovn4nfv-deployment-noannotation
+        image: "busybox"
+        command: ["top"]
+        stdin: true
+        tty: true
diff --git a/example/ovn4nfv-deployment-replica-2-withannotation.yaml b/example/ovn4nfv-deployment-replica-2-withannotation.yaml
new file mode 100644
index 0000000..fc88349
--- /dev/null
+++ b/example/ovn4nfv-deployment-replica-2-withannotation.yaml
@@ -0,0 +1,25 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: ovn4nfv-deployment-2-annotation
+  labels:
+    app: ovn4nfv-2-annotation
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app: ovn4nfv-2-annotation
+  template:
+    metadata:
+      labels:
+        app: ovn4nfv-2-annotation
+      annotations:
+        k8s.plugin.opnfv.org/nfn-network: '{ "type": "ovn4nfv", "interface": [{ "name": "ovn-port-net", "interface": "net0" , "defaultGateway": "false"},
+                      { "name": "ovn-priv-net", "interface": "net1" , "defaultGateway": "false"}]}'
+    spec:
+      containers:
+      - name: ovn4nfv-deployment-2-annotation
+        image: "busybox"
+        command: ["top"]
+        stdin: true
+        tty: true