summaryrefslogtreecommitdiffstats
path: root/nsh/asciidoc
diff options
context:
space:
mode:
authorMaros Marsalek <mmarsale@cisco.com>2016-09-21 13:51:57 +0200
committerMaros Marsalek <mmarsale@cisco.com>2016-09-26 11:02:04 +0200
commit4ff0bbc3c16342bdf974299a9e444cba74096268 (patch)
tree3f14538973dfce99bee9d8c425f0ab96713c1cbf /nsh/asciidoc
parentac064ead56cd720fea45bc6873eb2ff821be6c8b (diff)
HONEYCOMB-209 Configure maven site
To produce site for Honeycomb + javadoc asciidoc To build the site: mvn clean install site:attach-descriptor site mvn site:stage -DstagingDirectory=/home/mmarsale/tmp/stage Change-Id: I4246bb09ba02b74a2a9c84ee73f8dba02384fffa Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'nsh/asciidoc')
-rw-r--r--nsh/asciidoc/Readme.adoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/nsh/asciidoc/Readme.adoc b/nsh/asciidoc/Readme.adoc
new file mode 100644
index 000000000..1ae29484a
--- /dev/null
+++ b/nsh/asciidoc/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