diff options
Diffstat (limited to 'release-notes')
6 files changed, 26 insertions, 37 deletions
diff --git a/release-notes/pom.xml b/release-notes/pom.xml index 03a66847d..5f2b2bf4f 100644 --- a/release-notes/pom.xml +++ b/release-notes/pom.xml @@ -82,10 +82,10 @@ <!-- TODO set snapshot version to project-vpp-version after VPP is released--> <!--<project-vpp-snapshot-version>17.04</project-vpp-snapshot-version>--> <project-vpp-snapshot-version>17.04-SNAPSHOT</project-vpp-snapshot-version> - <project-snat-version>1.0</project-snat-version> + <project-snat-version>17.04</project-snat-version> <!-- TODO set snapshot version to project-snat-version after VPP is released--> - <!--<project-snat-snapshot-version>1.0</project-snat-snapshot-version>--> - <project-snat-snapshot-version>1.0-SNAPSHOT</project-snat-snapshot-version> + <!--<project-snat-snapshot-version>17.04</project-snat-snapshot-version>--> + <project-snat-snapshot-version>17.04-SNAPSHOT</project-snat-snapshot-version> <project-git-web>https://git.fd.io/cgit/hc2vpp/tree</project-git-web> <project-infra-git-web>https://git.fd.io/cgit/honeycomb/tree</project-infra-git-web> </attributes> 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 5d664ec16..0b68373af 100644 --- a/release-notes/src/main/asciidoc/devel_guide/devel_guide.adoc +++ b/release-notes/src/main/asciidoc/devel_guide/devel_guide.adoc @@ -1,13 +1,12 @@ == Devel guide -Honeycomb plugin development guide. +Hc2vpp plugin development guide. === Tutorials -!!!!! fixme link here tutorials from honeycomb !!!!! - * link:devel_plugin_vpp_tutorial.html[How to write Honeycomb plugins for VPP] +* 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 managmenet sample from Honeycomb] +* {project-git-web}/samples?h={project-branch}[Interface management sample from Honeycomb] ** 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/install_guide/install_from_available_archives.adoc b/release-notes/src/main/asciidoc/install_guide/install_from_available_archives.adoc index 5eeb4fee2..6060c309f 100644 --- 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 @@ -2,10 +2,10 @@ link:release_notes.html[< Home] -Honeycomb provides zip and tar.gz archives that can be downloaded and extracted to provide Honeycomb VPP distribution. +Hc2vpp provides zip and tar.gz archives that can be downloaded and extracted to provide Honeycomb VPP distribution. == Downloading archives -In https://nexus.fd.io/#nexus-search;quick~vpp-integration-distribution[Honeycomb'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-<version> will be created. +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] In the new folder, locate honeycomb executable shell script and run it. 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 82ab84413..59a9f3122 100644 --- a/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc +++ b/release-notes/src/main/asciidoc/install_guide/install_manual_build.adoc @@ -3,24 +3,24 @@ link:release_notes.html[< Home] == Prerequisites -Building Honeycomb project requires: +Building Hc2vpp project requires: * Java 8 * Maven (version 3.2.5 and above should be fine) * Properly set maven settings(displayed below) to access nexus.fd.io -== Obtain the honeycomb source code +== Obtain the hc2vpp source code TIP: Make sure you have https://wiki.fd.io/view/DEV/Setting_up_Gerrit[registered your ssh key with gerrit]. [subs="+attributes"] - git clone ssh://[username]@gerrit.fd.io:29418/honeycomb - cd honeycomb + git clone ssh://[username]@gerrit.fd.io:29418/hc2vpp + cd hc2vpp git checkout {project-branch} == Building the code Make sure all the prerequisites are installed. -NOTE: To make sure fresh Honeycomb build is compatible with VPP, building VPP is also required to make sure the same JVpp version is used preventing out-of-sync exceptions. In case only Honeycomb needs to be built, skip Building VPP section. +NOTE: To make sure fresh hc2vpp build is compatible with VPP, building VPP is also required to make sure the same JVpp version is used preventing out-of-sync exceptions. In case only hc2vpp needs to be built, skip Building VPP section. === Building VPP Clone VPP according to: https://gerrit.fd.io/r/#/admin/projects/vpp and checkout {project-branch} branch @@ -41,7 +41,7 @@ Start VPP: sudo start vpp -Install JVpp into local maven repository to make Honeycomb pick up the same JVpp version +Install JVpp into local maven repository to make hc2vpp pick up the same JVpp version [subs="+attributes"] cd build-vpp-native/vpp-api/java/ @@ -52,8 +52,8 @@ Install JVpp into local maven repository to make Honeycomb pick up the same JVpp Now current Vpp is up and running and prepared for integration with HC. -=== Building Honeycomb -Now Honeycomb can be built and it will use latest JVpp produced during VPP build. +=== Building hc2vpp +Now hc2vpp can be built and it will use latest JVpp produced during VPP build. ==== Setup settings.xml Put the following in your ~/.m2/settings.xml: @@ -167,8 +167,8 @@ Put the following in your ~/.m2/settings.xml: </settings> ---- -==== Building Honeycomb -cd honeycomb/ +==== Building hc2vpp +cd hc2vpp/ mvn clean install @@ -179,13 +179,13 @@ To perform quick build(no tests, no checks, no docs) run: mvn clean install -DskipTests -Dcheckstyle.skip -Dmaven.javadoc.skip=true -Djacoco.skip ===== -Now Honeycomb can be run with: +Now hc2vpp can be run with: [subs="+attributes"] sudo sh vpp-integration/minimal-distribution/target/vpp-integration-distribution-{project-version}-hc/vpp-integration-distribution-{project-version}/honeycomb === Building packages -After the code has been built, you can build an RPM or DEB package for honeycomb. +After the code has been built, you can build an RPM or DEB package for hc2vpp. ==== RPM Export build number variable: diff --git a/release-notes/src/main/asciidoc/release_notes.adoc b/release-notes/src/main/asciidoc/release_notes.adoc index 11dce0848..b173f9f5a 100644 --- a/release-notes/src/main/asciidoc/release_notes.adoc +++ b/release-notes/src/main/asciidoc/release_notes.adoc @@ -1,6 +1,7 @@ -= Honeycomb {project-version} Release notes += Hc2vpp {project-version} Release notes Release notes for honeycomb for VPP {project-version}. Based on VPP {project-vpp-snapshot-version} +and honeycomb {project-version}. == Release plan https://wiki.fd.io/view/Honeycomb/Release_Plans/Release_Plan_{project-public-version}[Release plan] @@ -9,29 +10,18 @@ https://wiki.fd.io/view/Honeycomb/Release_Plans/Release_Plan_{project-public-ver Adding to the list of existing features: https://wiki.fd.io/view/Honeycomb/Releases/1701#Features[1701 feature list]: === New features -* https://jira.fd.io/browse/HONEYCOMB-132[NAT management] -* https://jira.fd.io/browse/HONEYCOMB-257[iOAM management] -* https://jira.fd.io/browse/HONEYCOMB-58[Static routing management] -* https://jira.fd.io/browse/HONEYCOMB-303[Stateful acl's management] -* https://jira.fd.io/browse/HONEYCOMB-46[NSH management] -* https://jira.fd.io/browse/HONEYCOMB-242[Port mirroring] -* https://jira.fd.io/browse/HONEYCOMB-281[Loopback interface management] -* https://jira.fd.io/browse/HONEYCOMB-102[Ipv6 support] +* https://jira.fd.io/browse/HC2VPP-33[SLAAC] === Removed features === Modified features -* ACL management improvements: -* Previous ACL implementation that used classfier has been disabled in favor of implementation - based on acl plugin (which provides also stateful acls) === Deprecated features -* ACL management in terms of ietf-acl model based on vpp classfier == Backlog * https://jira.fd.io/projects/HONEYCOMB/versions/{project-version-in-jira}[JIRA] -* https://jira.fd.io/jira/secure/ReleaseNote.jspa?projectId=10001&version={project-version-in-jira}[Release notes] +* 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 16cf90253..7ca90f93c 100644 --- a/release-notes/src/main/asciidoc/user_guide/user_guide.adoc +++ b/release-notes/src/main/asciidoc/user_guide/user_guide.adoc @@ -56,5 +56,5 @@ Honeycomb's configuration files present within its distribution: ** {project-git-web}/ioam/ioam_postman_collection.json?h={project-branch}[IOAM postman collection] * Routing plugin ** {project-git-web}/routing/routing_postman_collection.json?h={project-branch}[Routing postman collection] -* Stateful ACL plugin -** {project-git-web}/acl/acl_postman_collection.json?h={project-branch}[Stateful ACL postman collection] +* ACL plugin +** {project-git-web}/acl/acl_postman_collection.json?h={project-branch}[ACL postman collection] |