examples: convert ncclient Readme to adoc

Change-Id: Ida137d00b51a480e4f27950cc9bbc609f4782efd
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>

1 files changed, 87 insertions, 0 deletions

diff --git a/examples/ncclient/Readme.adoc b/examples/ncclient/Readme.adoc
new file mode 100644
index 000000000..cc1d63e12
--- /dev/null
+++ b/examples/ncclient/Readme.adoc
@@ -0,0 +1,87 @@
+= Building
+
+== Custom ODL Oxygen build:
+
+[source]
+----
+git clone https://git.opendaylight.org/gerrit/netconf
+cd netconf
+git checkout -b honeycomb release/oxygen
+----
+
+=== <copy-config> support:
+
+[source]
+----
+git fetch https://git.opendaylight.org/gerrit/netconf refs/changes/06/69606/1 && git cherry-pick FETCH_HEAD
+----
+
+=== ncclient support:
+
+[source]
+----
+git fetch https://git.opendaylight.org/gerrit/netconf refs/changes/81/71181/1 && git cherry-pick FETCH_HEAD
+mvn clean install -pl netconf/netconf-util,netconf/netconf-netty-util,netconf/mdsal-netconf-connector
+----
+
+== Custom HC2VPP build
+
+[source]
+----
+git clone https://gerrit.fd.io/r/hc2vpp
+cd hc2vpp
+----
+
+1. Checkout desired branch or use master branch, e.g.
+[source]
+----
+git checkout -b stable1804 origin/stable/1804
+----
+
+2. Build vpp-integration module from hc2vpp project:
+
+[source]
+----
+mvn clean install -pl vpp-integration/minimal-distribution
+----
+
+3. (optional) Build honeycomb package
+[source]
+----
+./packaging/deb/xenial/debuild.sh
+----
+
+== Build ncclient
+
+[source]
+----
+git clone https://github.com/ncclient/ncclient.git
+cd ncclient
+sudo python setup.py install
+----
+
+= Running examples
+
+Start vpp.
+
+Start honeycomb
+(either from hc2vpp builddir or using package built in previous steps).
+
+Then invoke:
+
+ACL:
+[source]
+----
+./acl/test_acl.sh
+./acl/test_acl_updates.sh
+----
+
+NAT:
+[source]
+----
+./acl/test_nat.sh
+./acl/test_nat_updates.sh
+----
+
+NOTE: Remember that HC by default persists config and restores it after restart.
+You can disable this behaviour using config/honeycomb.json.