summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFerruh Yigit <ferruh.yigit@intel.com>2016-08-04 10:04:24 +0100
committerFerruh Yigit <ferruh.yigit@intel.com>2017-05-16 11:56:13 +0100
commit8753e014c0b9b2ea0cb03e177272f334126cd791 (patch)
treef04ee22d42c01485a326e935a14db984f2ba35c5
parent9dc9811aa94f6a4edf0c348a17a73cac63be9e6b (diff)
downloadspp-8753e014c0b9b2ea0cb03e177272f334126cd791.zip
spp-8753e014c0b9b2ea0cb03e177272f334126cd791.tar.gz
spp-8753e014c0b9b2ea0cb03e177272f334126cd791.tar.xz
doc: add initial README file
To document what SPP is. Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
-rw-r--r--README21
1 files changed, 21 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..27e3b35
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+Soft Patch Panel
+================
+
+The goal of SPP is to easily interconnect DPDK applications together,
+and assign resources dynamically to these applications to build a
+pipeline.
+
+The first version of SPP provides for the management of DPDK ports, and
+assigning ports to different DPDK applications.
+
+The framework is composed of a primary DPDK application that is
+responsible for resource management. This primary application doesn't
+interact with any traffic, and is used to manage creation and freeing of
+resources only.
+
+A Python based management interface is provided to control the primary
+DPDK application to create resources, which are then to be used by
+secondary applications. This management application provides a socket
+based interface for the primary and secondary DPDK applications to
+interface to the manager. The management application will use OVSDB to
+maintain all created and assigned ports.