Initial check-in

Adding readme.rst and empty directory
structure for the project

Change-Id: I483caca5b14481b970a0716bd74c11ef5b3f2158
Signed-off-by: Ritu Sood <ritu.sood@intel.com>

10 files changed, 184 insertions, 0 deletions

diff --git a/.gitreview b/.gitreview
new file mode 100644
index 0000000..8c769db
--- /dev/null
+++ b/.gitreview
@@ -0,0 +1,4 @@
+[gerrit]
+host=gerrit.opnfv.org
+port=29418
+project=ovn4nfv-k8s-plugin
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..b7156e4
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,15 @@
+This file is a summary of the licensing of files in this distribution.
+
+All the files are licensed under the Apache License, Version 2.0:
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at:
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
diff --git a/Readme.rst b/Readme.rst
new file mode 100644
index 0000000..b7da2c1
--- /dev/null
+++ b/Readme.rst
@@ -0,0 +1,165 @@
+=================
+OVN4NFVK8s Plugin
+=================
+
+**Kubernetes Background**
+
+Kubernetes (Simply K8S) is one of the popular container orchestrators. K8S is supported by GCE, AZURE and AWS and will be supported by Akraino Edge stack that enable edge clouds. K8S is also being enhanced to support VM workload types too.  This helps cloud-regions that need to support VMs while moving some workloads to containers. For security reason, cloud-regions may continue to support VM types for security reasons and hence there is need for VIM that support both VMs and containers. Since same K8S instance can orchestrate both VM and container workload types, same compute nodes can be leveraged for both VMs and containers. Telco and CSPs are seeing similar need to deploy networking applications as containers.
+
+There are few differences between containers for Enterprise applications and networking applications.
+Networking applications are of three types -  Management applications, Control plane applications and  data plane applications. Management and control plane applications are similar to Enterprise applications, but data plane applications different in following aspects:
+
+    - Multiple virtual network interfaces
+    - Multiple IP addresses
+    - SRIOV networking support
+    - Programmable virtual switch (for service function chaining, to tap the traffic for visibility etc..)
+
+Since, both VMs and container workloads are used for networking applications, there would be need for
+
+    - Sharing the networks across VMs and containers.
+    - Sharing the volumes across VMs and containers.
+
+**OVN Background**
+
+OVN, the Open Virtual Network, is a system to support virtual network abstraction. OVN complements the existing capabilities of OVS to add native support for virtual network abstractions, such as virtual L2 and L3 overlays and security groups. Services such as DHCP are also desirable features. Just like OVS, OVN’s design goal is to have a production quality implementation that can operate at significant scale.
+An OVN deployment consists of several components:
+
+    - A Cloud Management System (CMS), which is OVN’s ultimate client (via its users and administrators). OVN integration requires installing a CMS-specific plugin and related software (see below). OVN initially targets Open‐ Stack as CMS.
+    - An OVN Database physical or virtual node (or, eventually, cluster) installed in a central location.
+    - One or more (usually many) hypervisors. Hypervisors must run Open vSwitch. Any hypervisor platform supported by Open vSwitch is acceptable.
+    - Zero or more gateways. A gateway extends a tunnel-based logical network into a physical network by bidirectionally forwarding packets between tunnels and a physical Ethernet port. This allows non-virtualized machines to participate in logical networks. A gateway may be a physical host, a virtual machine, or an ASIC-based hardware switch that supports the vtep(5) schema. Hypervisors and gateways are together called transport node or chassis.
+
+**NFV Requirements**
+NFV workloads can be,
+
+    →  Management plane workloads
+
+    → Control plane work loads
+
+    → User plane (data plane workloads)
+
+    → User plane workloads normally have
+
+        → Multiple interfaces, Multiple subnets, Multiple virtual networks
+
+    → NFV workloads typically have its own management network.
+
+    → Some data plane workloads require SR-IOV NIC support for data interfaces and virtual NIC for other interfaces (for performance reasons)
+
+    → Need for multiple CNIs.
+
+    → NFV workloads require dynamic creation of virtual networks. Dynamic configuration of subnets.
+
+**New Proposal**
+
+A New plugin addressing the below requirements,
+
+- For networking workloads as well typical application  workloads
+- Multi-interface support
+- Multi-IP address support
+- Dynamic creation of virtual networks
+- Co-existing with SRIOV and other CNIs.
+- Route management across virtual networks and external networks
+
+**Functionality**
+
+**K8S-OVN4NFV Plugin development**
+
+Some code and ideas are being taken from ovn-kubernetes [1] plugin work that was done as part of OVN project.  Due to good number of changes, it is a new plugin with its own code  base.  This Plugin assumes that the first interface in a Pod is provided by some other Plugin/CNI like Flannel or even OVN-Kubernetes and this plugin is only responsible to add multiple interfaces based on the Pod annotations. This plugin is currently tested to work with Multus as CNI and Flannel as first interface.
+
+Its functionality is divided into to following:
+
+- Initialization:
+
+    - Register itself as watcher to K8S API Server to receive POD events and service events.
+    - Creates a distributed router
+    - Create gateway
+    - Creates a logical switch to connect distributed router with Gateway.
+    - Creates a subnet between distributed router & Gateway.
+    - Assigns first two IP addresses of the subnet to router and Gateway.
+    - Created router port and gateway port as part of assigning IP address and MAC addresses.
+
+- Watcher:
+
+    - Upon POD bring up event
+        - Checks the annotations specific to OVN.
+        - For each network on which POD is going to be brought up
+        - Validates whether the logical switch is already present. If not, it is considered as error.
+        - If IP address and MAC addresses are not static, it asks OVN to assign IP and MAC address.
+        - Collects all IP addresses/MAC addresses assigned. Puts them as annotations (dynamic information) for that POD.
+
+    - Upon POD deletion event
+        - Returns the IP address and MAC address back to OVN pool.
+
+- OVN CNI
+
+    This is present in every minion node. CNI is expected to be called once for all OVN networks either Kubelet directly or via Multus.
+
+    - Add:
+
+        - Wait for annotations to be filled up by the watcher. From annotations, it knows set  of IP Address, MAC address and Routes to be added.
+
+        - Using network APIs for each element in the set:
+
+         - Creates veth pair.
+
+         - Assigns the IP address and MAC address to one end of veth pair. Other end veth pair is assigned to br-int.
+
+         - Creates routes based on the route list provided in annotations.
+
+    - If isDefaultRoute is set in annotations, it creates default route using this veth.
+
+    - Delete
+
+        - Removes veth pair.
+
+        - Removes routes.
+
+
+
+**Figure**
+
+       +-----------------+
+       |                 |
+       |                 |   Program OVN Switch
+       |ovn4nfvk8s Plugin|                      +------------------+
+       |                 +--------------------->|                  |
+       |                 |                      | OVN Switch       |
+       |                 |                      |                  |
+       |                 |                      +------------------+
+       +-+ -----+---+----+
+         ^          |
+         |          |
+         +On Event  |Annotate Pod
+         |          |
+         |          v
+        ++------ -------+        +------------------+           +-----------+
+        |               |        |                  |           | Pod       |
+        |Kube API       +-------->  Kube Schedular  +---------->|           |
+        |               |        |                  |           +--------+--+
+        |               |        +--------+---------+                    |
+        +---------------+                 |                              |
+                                          |                              |
+                                          |                              |Assign IP & MAC
+                                 +--------v-----------+                  |
+                                 |                    |                  |
+                                 | ovn4nfvk8s-cni     +                  |
+                                 |                    +------------------+
+                                 +--------------------+
+
+
+   Complete Architecture can be found in ovn-kubernetes documenatation at github
+
+
+**References**
+
+[1] https://wiki.opnfv.org/display/OV/K8S+OVN+NFV+Plugin
+[2] https://github.com/openvswitch/ovn-kubernetes
+[3] https://github.com/intel/multus-cni
+[4] https://github.com/Huawei-PaaS/CNI-Genie
+
+**Authors/Contributors**
+
+Addepalli, Srinivasa R <srinivasa.r.addepalli@intel.com>
+Sood, Ritu <ritu.sood@intel.com>
+
diff --git a/cmd/ovn4nfvk8s-cni/.gitkeep b/cmd/ovn4nfvk8s-cni/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/cmd/ovn4nfvk8s-cni/.gitkeep
diff --git a/cmd/ovn4nfvk8s/.gitkeep b/cmd/ovn4nfvk8s/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/cmd/ovn4nfvk8s/.gitkeep
diff --git a/internal/pkg/config/.gitkeep b/internal/pkg/config/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/internal/pkg/config/.gitkeep
diff --git a/internal/pkg/factory/.gitkeep b/internal/pkg/factory/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/internal/pkg/factory/.gitkeep
diff --git a/internal/pkg/kube/.gitkeep b/internal/pkg/kube/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/internal/pkg/kube/.gitkeep
diff --git a/internal/pkg/ovn/.gitkeep b/internal/pkg/ovn/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/internal/pkg/ovn/.gitkeep
diff --git a/internal/pkg/util/.gitkeep b/internal/pkg/util/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/internal/pkg/util/.gitkeep