Hc2vpp 1.17.07 release notes update

Change-Id: I355e73553345ce75a60946d5db2c96253a2d1040
Signed-off-by: Marek Gradzki <[email protected]>

diff --git a/release-notes/pom.xml b/release-notes/pom.xml
index 51a0bc3..3f66050 100644 (file)
--- a/release-notes/pom.xml
+++ b/release-notes/pom.xml
@@ -108,7 +108,7 @@
                 <project-version>${project.version}</project-version>
                 <project-public-version>17.07</project-public-version>
                 <project-version-in-jira>10701</project-version-in-jira>
-                <project-branch>master</project-branch>
+                <project-branch>stable/1707</project-branch>
                 <project-vpp-version>17.07</project-vpp-version>
                 <project-vpp-snapshot-version>17.07</project-vpp-snapshot-version>
                 <project-snat-version>17.07</project-snat-version>

diff --git a/release-notes/src/main/asciidoc/devel_guide/devel_guide.adoc b/release-notes/src/main/asciidoc/devel_guide/devel_guide.adoc
index 0b68373..09a6a6a 100644 (file)
--- a/release-notes/src/main/asciidoc/devel_guide/devel_guide.adoc
+++ b/release-notes/src/main/asciidoc/devel_guide/devel_guide.adoc
@@ -7,6 +7,6 @@ Hc2vpp plugin development guide.
 * for general tutorials on building Honeycomb agents, see https://docs.fd.io/honeycomb/{project-version}/release-notes-aggregator/release_notes.html#_tutorials[Honeycomb tutorials]
 
 === Samples
-* {project-git-web}/samples?h={project-branch}[Interface management sample from Honeycomb]
+* {project-git-web}/samples?h={project-branch}[Interface management sample from Hc2vpp]
 ** Generic(non-VPP) plugin with a custom distribution containing lots of useful information about Honeycomb and its plugins.
 

diff --git a/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc b/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc
index c55e85c..a8dffc7 100644 (file)
--- a/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc
+++ b/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc
@@ -614,9 +614,9 @@ Netconf testing guide including Notifications, can be found in Honeycomb/Running
 
 NOTE: Netconf and Restconf are equivalent interfaces to Honeycomb, being capable of providing the same APIs. The only difference is with notifications. Only NETCONF is capable of emitting the notifications.
 
-== Full working sample
+== Full working sample (outdated)
 
-Full working sample on github: https://github.com/marosmars/honeycomb-samples/tree/vpp-plugin
+Full working sample (hc2vpp 1.16.09) on github: https://github.com/marosmars/honeycomb-samples/tree/vpp-plugin
 
 [NOTE]
 ====

diff --git a/release-notes/src/main/asciidoc/install_guide/install_from_available_archives.adoc b/release-notes/src/main/asciidoc/install_guide/install_from_available_archives.adoc
index 6060c30..6e2bd95 100644 (file)
--- a/release-notes/src/main/asciidoc/install_guide/install_from_available_archives.adoc
+++ b/release-notes/src/main/asciidoc/install_guide/install_from_available_archives.adoc
@@ -7,8 +7,8 @@ Hc2vpp provides zip and tar.gz archives that can be downloaded and extracted to
 == Downloading archives
 In https://nexus.fd.io/#nexus-search;quick~vpp-integration-distribution[fdio's nexus] look for vpp-integration-distribution artifact with version {project-version} and download either zip or tar.gz. After extracting the archive, a folder vpp-integration-distribution-{project-version} will be created.
 
-== Running extracted distribution[edit]
+== Running extracted distribution
 In the new folder, locate honeycomb executable shell script and run it.
 
-Note: sudo privileges are necessary with default configuration.
+NOTE: sudo privileges are necessary with default configuration.
 

diff --git a/release-notes/src/main/asciidoc/install_guide/install_from_available_binary_packages.adoc b/release-notes/src/main/asciidoc/install_guide/install_from_available_binary_packages.adoc
index c9e6294..2c2901c 100644 (file)
--- a/release-notes/src/main/asciidoc/install_guide/install_from_available_binary_packages.adoc
+++ b/release-notes/src/main/asciidoc/install_guide/install_from_available_binary_packages.adoc
@@ -20,30 +20,8 @@ Create a file /etc/yum.repos.d/honeycomb-release.repo with contents:
 == Ubuntu
 === Ubuntu 14.04 - Honeycomb Release DEB
 
-[CAUTION]
-====
-Add openjdk-8 repository. 1404 does not provide openjdk-8 by default
-
- According to http://stackoverflow.com/questions/32942023/ubuntu-openjdk-8-unable-to-locate-package
-====
-
-Pick Ubuntu version:
-
- export UBUNTU="trusty"
-
-Then run:
-
- sudo rm /etc/apt/sources.list.d/99fd.io.list
- echo "deb [trusted=yes] https://nexus.fd.io/content/repositories/fd.io.ubuntu.$UBUNTU.main/ ./" | sudo tee -a /etc/apt/sources.list.d/99fd.io.list
- sudo apt-get update
- sudo apt-get install honeycomb
-
-[CAUTION]
-====
-Uninstall previously installed java 7
-
- look for packages e.g. openjdk-7-* and uninstall them
-====
+Ubuntu 14.04 packages are no longer published.
+But you can build them link:install_manual_build.html#_building_packages[manually].
 
 === Ubuntu 16.04 - Honeycomb Release DEB
 

diff --git a/release-notes/src/main/asciidoc/install_guide/install_guide.adoc b/release-notes/src/main/asciidoc/install_guide/install_guide.adoc
index de2e02e..a921b87 100644 (file)
--- a/release-notes/src/main/asciidoc/install_guide/install_guide.adoc
+++ b/release-notes/src/main/asciidoc/install_guide/install_guide.adoc
@@ -14,10 +14,10 @@ Honeycomb is packaged as a static set of jars, that are loaded by Honeycomb Main
 
 === Footprint
 
-Minimal footprint for Honeycomb infrastructure (without any plugins) at rest below 100Mb. For Honeycomb distribution with VPP related plugins, minimal footprint was observed below 150Mb.
+Minimal footprint for Honeycomb infrastructure (without any plugins) at rest below 90Mb. For Honeycomb distribution with VPP related plugins, minimal footprint was observed below 120Mb.
 The footprint varies depending on:
 
 * VM load. Under heavier load, JVM tends to release some unused memory used during Honeycomb initialization.
 * Northbound interface configuration (4 interfaces started by default: Restconf HTTP, HTTPS, Netconf TCP, SSH). Minimal footprint can be achieved by using only a single interface.
-* JVM configuration. Even lower footprint numbers can be achieved by using aggressive JVM memory options: -client -Xms20m -Xmx32m -XX:MetaspaceSize=5m -XX:MaxMetaspaceSize=32m -XX:MaxMetaspaceExpansion=1m -Xss512k -XX:+UseSerialGC -Djava.compiler=NONE -Xverify:none -noverify
+* JVM configuration. Minimal footprint can be achieved by using aggressive JVM memory options, e.g.: -client -Xms20m -Xmx32m -XX:MetaspaceSize=5m -XX:MaxMetaspaceSize=32m -XX:MaxMetaspaceExpansion=1m -Xss512k -XX:+UseSerialGC -Djava.compiler=NONE -Xverify:none -noverify
 * Amount of data stored by Honeycomb.
\ No newline at end of file

diff --git a/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc b/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc
index 59a9f31..6e94819 100644 (file)
--- a/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc
+++ b/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc
@@ -188,7 +188,7 @@ Now hc2vpp can be run with:
 After the code has been built, you can build an RPM or DEB package for hc2vpp.
 
 ==== RPM
-Export build number variable:
+Export build number variable, e.g.:
 
  export BUILD_NUMBER=33
 
@@ -197,10 +197,14 @@ Run package building script from:
  packaging/rpm/rpmbuild.sh
 
 ==== DEB
-Export build number variable:
+Export build number variable, e.g.:
 
  export BUILD_NUMBER=33
 
 Run package building script from:
 
- packaging/deb/debuild.sh
\ No newline at end of file
+ packaging/deb/xenial/debuild.sh
+
+or
+
+ packaging/deb/trusty/debuild.sh
\ No newline at end of file

diff --git a/release-notes/src/main/asciidoc/release_notes.adoc b/release-notes/src/main/asciidoc/release_notes.adoc
index 605eda6..8e94397 100644 (file)
--- a/release-notes/src/main/asciidoc/release_notes.adoc
+++ b/release-notes/src/main/asciidoc/release_notes.adoc
@@ -11,15 +11,25 @@ Adding to the list of existing features: https://docs.fd.io/hc2vpp/1.17.04/hc2vp
 
 === New features
 
+* https://jira.fd.io/browse/HC2VPP-168[GPE native forward paths support]
+* https://jira.fd.io/browse/HC2VPP-147[Lisp GPE entry feature support]
+* https://jira.fd.io/browse/HC2VPP-174[BGP to VPP FIB translation for IP unicast family]
+* https://jira.fd.io/browse/HC2VPP-90[Prefix based addresses as EIDs]
+* https://jira.fd.io/browse/HC2VPP-139[Sub-interface missing features]
+* https://jira.fd.io/browse/HC2VPP-148[Interface unnumbered flag]
+* https://jira.fd.io/browse/HC2VPP-180[Documentation: mapping between HC Yang models and VPP APIs]
+
 === Removed features
 
+ACL management in terms of ietf-acl model based on vpp classifier
+
 === Modified features
 
 === Deprecated features
 
 == Backlog
 
-* https://jira.fd.io/projects/HONEYCOMB/versions/{project-version-in-jira}[JIRA]
+* https://jira.fd.io/projects/HC2VPP/versions/{project-version-in-jira}[JIRA]
 * https://jira.fd.io/jira/secure/ReleaseNote.jspa?projectId=10601&version={project-version-in-jira}[Release notes]
 
 include::install_guide/install_guide.adoc[]

diff --git a/release-notes/src/main/asciidoc/user_guide/user_guide.adoc b/release-notes/src/main/asciidoc/user_guide/user_guide.adoc
index 3b706ef..1c7390a 100644 (file)
--- a/release-notes/src/main/asciidoc/user_guide/user_guide.adoc
+++ b/release-notes/src/main/asciidoc/user_guide/user_guide.adoc
@@ -35,6 +35,8 @@ Honeycomb's configuration files present within its distribution:
 ** {project-git-web}/nat/nat-api/src/main/yang?h={project-branch}[NAT YANG models]
 * iOAM plugin
 ** {project-git-web}/ioam/api/src/main/yang?h={project-branch}[IOAM YANG models]
+* Interface role plugin
+** {project-git-web}/interface-role/api/src/main/yang?h={project-branch}[Interface role YANG models]
 * Routing plugin
 ** {project-git-web}/routing/routing-api/src/main/yang?h={project-branch}[Routing YANG models]
 * ACL plugin
@@ -56,12 +58,15 @@ Honeycomb's configuration files present within its distribution:
 ** {project-git-web}/v3po/postman_rest_collection.json?h={project-branch}[V3PO postman collection]
 * LISP plugin
 ** {project-git-web}/lisp/lisp_postman_collection.json?h={project-branch}[LISP postman collection]
+** {project-git-web}/lisp/gpe_postman_collection.json?h={project-branch}[LISP GPE postman collection]
 * NSH plugin
 ** {project-git-web}/nsh/nsh_postman_collection.json?h={project-branch}[NSH postman collection]
 * NAT plugin
 ** {project-git-web}/nat/postman_rest_collection.json?h={project-branch}[NAT postman collection]
 * iOAM plugin
 ** {project-git-web}/ioam/ioam_postman_collection.json?h={project-branch}[IOAM postman collection]
+* Interface role plugin
+** {project-git-web}/interface-role/interface_role_postman_collection.json?h={project-branch}[Interface role postman collection]
 * Routing plugin
 ** {project-git-web}/routing/routing_postman_collection.json?h={project-branch}[Routing postman collection]
 ** {project-git-web}/routing/routing_adv_postman_collection.json?h={project-branch}[Routing advertisements postman collection]

diff --git a/release-notes/src/main/asciidoc/user_guide/user_running_honeycomb.adoc b/release-notes/src/main/asciidoc/user_guide/user_running_honeycomb.adoc
index 07b82a5..a60025c 100644 (file)
--- a/release-notes/src/main/asciidoc/user_guide/user_running_honeycomb.adoc
+++ b/release-notes/src/main/asciidoc/user_guide/user_running_honeycomb.adoc
@@ -8,7 +8,7 @@ The zipped vpp-integration distribution can be started by invoking:
 [subs="+attributes"]
  sudo ./vpp-integration-distribution-{project-version}/honeycomb
 
-This will start Honeycomb with all ODL dependencies and VPP translation code. It will automatically initialize vpp-jvpp to create interface between VPP and Honeycomb.
+This will start Honeycomb with all ODL dependencies and VPP translation code. It will automatically initialize jvpp to create interface between VPP and Honeycomb.
 
 If Honeycomb was installed from the RPM or DEB packages, it can be started by (make sure you start vpp first):