summaryrefslogtreecommitdiffstats
path: root/release-notes/src/main/asciidoc/install_guide/install_guide.adoc
diff options
context:
space:
mode:
authorMaros Marsalek <mmarsale@cisco.com>2016-10-14 14:09:02 +0200
committerMarek Gradzki <mgradzki@cisco.com>2016-10-21 05:41:19 +0000
commitf31e292087e56b5171dcdfc83bbd81462236977d (patch)
treee9ca15bba120278bbfb00d38497587bb45101483 /release-notes/src/main/asciidoc/install_guide/install_guide.adoc
parente0ff3ddc1c7a146c18f1ae4f15e0e4f30ed18a9f (diff)
Release notes
- migrated from wiki - updated versions to current version - notes are built with each regular build - notes root is at: target/generated-docs/release_notes.html - notes are inlined into site Change-Id: I581898988f41f77f5eafb20e9e61e08f09908b98 Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'release-notes/src/main/asciidoc/install_guide/install_guide.adoc')
-rw-r--r--release-notes/src/main/asciidoc/install_guide/install_guide.adoc23
1 files changed, 23 insertions, 0 deletions
diff --git a/release-notes/src/main/asciidoc/install_guide/install_guide.adoc b/release-notes/src/main/asciidoc/install_guide/install_guide.adoc
new file mode 100644
index 000000000..de2e02eda
--- /dev/null
+++ b/release-notes/src/main/asciidoc/install_guide/install_guide.adoc
@@ -0,0 +1,23 @@
+== Install guide
+
+Installing binaries:
+
+* link:install_from_available_binary_packages.html[Installing from available binary packages]
+* link:install_from_available_archives.html[Installing from available archives]
+
+=== Manual build
+
+* link:install_manual_build.html[Manual build]
+
+=== 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 below 100Mb. For Honeycomb distribution with VPP related plugins, minimal footprint was observed below 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. \ No newline at end of file