summaryrefslogtreecommitdiffstats
path: root/nsh
diff options
context:
space:
mode:
authorHongjun Ni <hongjun.ni@intel.com>2016-09-08 23:37:16 +0800
committerMaros Marsalek <mmarsale@cisco.com>2016-09-14 07:45:04 +0000
commit1f2e93383b693c51d5a0db6ca9cf2015a6cd721e (patch)
tree1eea609e2ec7f4a497e95e3a64f99b0a7ee8d3b9 /nsh
parentd984b324a3cf491df150bd9bcb7f90da8dc845c7 (diff)
HONEYCOMB-46: Add NSH_SFC Readme doc
Change-Id: Id1f8f17d025ebba07db0d138f881384306046487 Signed-off-by: Hongjun Ni <hongjun.ni@intel.com> (cherry picked from commit 2d6efba64a5050cb8349c874b5e4d7dadacb28e0)
Diffstat (limited to 'nsh')
-rw-r--r--nsh/Readme.adoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/nsh/Readme.adoc b/nsh/Readme.adoc
new file mode 100644
index 000000000..1ae29484a
--- /dev/null
+++ b/nsh/Readme.adoc
@@ -0,0 +1,14 @@
+= nsh
+
+This is a Honeycomb plugin providing mapping code between HC and NSH_SFC Plugin APIs.
+
+== Usage
+
+Refer to nsh_postman_collection.json for sample requests. All capabilities of NSH_SFC are demo-ed there.
+
+In order to make HC NSH plugin work, need to start vpp and load nsh_sfc plugin first.
+
+Please follow the right order to support NSH_SFC feature:
+(1). Creates vxlan-gpe interface.
+(2). Creates nsh-entry.
+(3). Creates nsh-map. \ No newline at end of file