From 160ba2a4f7586e48ff1e53caed871b0010660c73 Mon Sep 17 00:00:00 2001 From: Marek Gradzki Date: Tue, 21 Aug 2018 14:27:35 +0200 Subject: examples: convert ncclient Readme to adoc Change-Id: Ida137d00b51a480e4f27950cc9bbc609f4782efd Signed-off-by: Marek Gradzki --- examples/ncclient/Readme.adoc | 87 +++++++++++++++++++++++++++++++++++++++++++ examples/ncclient/Readme.txt | 59 ----------------------------- 2 files changed, 87 insertions(+), 59 deletions(-) create mode 100644 examples/ncclient/Readme.adoc delete mode 100644 examples/ncclient/Readme.txt 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 +---- + +=== 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. diff --git a/examples/ncclient/Readme.txt b/examples/ncclient/Readme.txt deleted file mode 100644 index 7f8e66d32..000000000 --- a/examples/ncclient/Readme.txt +++ /dev/null @@ -1,59 +0,0 @@ -Building ----------- - -1) Custom ODL Oxygen build: -git clone https://git.opendaylight.org/gerrit/netconf -cd netconf -git checkout -b honeycomb release/oxygen - -# copy-config support: -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 - -mvn clean install -pl netconf/netconf-util,netconf/netconf-netty-util,netconf/mdsal-netconf-connector - -2) Custom HC2VPP build - -git clone https://gerrit.fd.io/r/hc2vpp -cd hc2vpp - -a) checkout desired branch - -e.g. git checkout -b stable1804 origin/stable/1804 - -or use master branch. - -b) build vpp-integration module from hc2vpp project: - -mvn clean install -pl vpp-integration/minimal-distribution - -c) (optional) build honeycomb package -./packaging/deb/xenial/debuild.sh - -4) Build ncclient -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: -./acl/test_acl.sh -./acl/test_acl_updates.sh - -NAT: -./acl/test_nat.sh -./acl/test_nat_updates.sh - -Suggestions: -Remember that HC by default persists config and restores it after restart. -You can disable this behaviour using config/honeycomb.json. -- cgit 1.2.3-korg