Difference between revisions of "Honeycomb/Releases/1609"
(→Install guide) |
(→Footprint) |
||
Line 78: | Line 78: | ||
The footprint varies depending on: | 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'' | |
− | + | * Amount of data stored by Honeycomb. | |
== User Guide == | == User Guide == |
Revision as of 10:58, 9 September 2016
Contents
Honeycomb 1609 release
First release of Honeycomb (VPP management agent)
Release plan
Honeycomb/Release_Plans/Release_Plan_16.09
Features
16.09 release of Honeycomb comes with these features:
- Generic, model-driven agent framework providing northbound interfaces
- NETCONF
- RESTCONF
- V3po plugin for VPP management with following capabilities:
- Interface management
- Bridge-domain management
- ARP termination table management
- VXLAN tunnel management
- VHOST-user interface managmenet
- TAP interface management
- VLAN management
- Low-level classifier API access
- ACL management
- L2 permit/deny
- L3 permit/deny
- Vxlan GPE tunnel management
- GRE management
- NSH plugin for VPP's NSH plugin with following capabilities
- NSH plugin support
- LISP plugin for VPP with following capabilities
- LISP managment
- Distribution available as zip, tar.gz, DEB and RPM packages
For further information refer to:
- Release plan
- JIRA backlog
- Provided RESTCONF collections with sample requests for all available APIs
Backlog
YANG models
List of YANG models implemented by Honeycomb:
- V3PO plugin yang models
- LISP plugin yang models
- NSH plugin yang models
- Context(mapping metadata) YANG models
Install guide
Installing binaries:
// TODO Update repository from snapshot master to release
Manual build
How to setup and build Honeycomb locally
Distribution notes
Honeycomb is packaged as a static set of jars, that are loaded by Honeycomb Main class, where pre-configured plugins are then started.
Footprint
Minimal footprint for Honeycomb infrastructure (without any plugins) at rest around 100Mb. For the VPP Honeycomb distribution, minimal footprint was observed at around 150Mb.
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
- Amount of data stored by Honeycomb.
User Guide
Configuration files
Honeycomb's configuration files present within its distribution:
POSTMAN collections
POSTMAN (google chrome REST client app) collections containing sample requests for all Honeycomb features. Useful when looking in depth for what Honeycomb supports.
Running Honeycomb
How to start and use Honeycomb
Devel guide
Tutorials:
Samples:
- Interface sample is part of the Honeycomb codebase - Generic(non-VPP) plugin with a custom distribution containing lots of useful information about Honeycomb and its plugins.