summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--examples/ncclient/Readme.adoc (renamed from examples/ncclient/Readme.txt)66
1 files changed, 47 insertions, 19 deletions
diff --git a/examples/ncclient/Readme.txt b/examples/ncclient/Readme.adoc
index 7f8e66d32..cc1d63e12 100644
--- a/examples/ncclient/Readme.txt
+++ b/examples/ncclient/Readme.adoc
@@ -1,59 +1,87 @@
-Building
-----------
+= Building
-1) Custom ODL Oxygen build:
+== Custom ODL Oxygen build:
+
+[source]
+----
git clone https://git.opendaylight.org/gerrit/netconf
cd netconf
git checkout -b honeycomb release/oxygen
+----
+
+=== <copy-config> support:
-# copy-config support:
+[source]
+----
git fetch https://git.opendaylight.org/gerrit/netconf refs/changes/06/69606/1 && git cherry-pick FETCH_HEAD
+----
-# ncclient support:
-git fetch https://git.opendaylight.org/gerrit/netconf refs/changes/81/71181/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
+----
-2) Custom HC2VPP build
+== Custom HC2VPP build
+[source]
+----
git clone https://gerrit.fd.io/r/hc2vpp
cd hc2vpp
+----
-a) checkout desired branch
+1. Checkout desired branch or use master branch, e.g.
+[source]
+----
+git checkout -b stable1804 origin/stable/1804
+----
-e.g. git checkout -b stable1804 origin/stable/1804
-
-or use master branch.
-
-b) build vpp-integration module from hc2vpp project:
+2. Build vpp-integration module from hc2vpp project:
+[source]
+----
mvn clean install -pl vpp-integration/minimal-distribution
+----
-c) (optional) build honeycomb package
+3. (optional) Build honeycomb package
+[source]
+----
./packaging/deb/xenial/debuild.sh
+----
-4) Build ncclient
+== Build ncclient
+
+[source]
+----
git clone https://github.com/ncclient/ncclient.git
cd ncclient
sudo python setup.py install
+----
+= Running examples
-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
+----
-Suggestions:
-Remember that HC by default persists config and restores it after restart.
+NOTE: Remember that HC by default persists config and restores it after restart.
You can disable this behaviour using config/honeycomb.json.