summaryrefslogtreecommitdiffstats
path: root/infra/minimal-distribution/Readme.adoc
diff options
context:
space:
mode:
authorMaros Marsalek <mmarsale@cisco.com>2016-08-11 13:04:56 +0200
committerMaros Marsalek <mmarsale@cisco.com>2016-08-19 12:49:56 +0200
commit83efb0ff929801a5a2ab89f6b66c07ed940a309d (patch)
tree8d8ce5dec617fe8227c3089600a256f72842e6fb /infra/minimal-distribution/Readme.adoc
parent0f5925e907ab8f37eefc29a1843f4beb6ba9f4a8 (diff)
HONEYCOMB-19 Minimal distro ans wiring for hc infra
Change-Id: I8f0e577ac91106e6025f7f2f27811f850e1c5253 Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'infra/minimal-distribution/Readme.adoc')
-rw-r--r--infra/minimal-distribution/Readme.adoc16
1 files changed, 16 insertions, 0 deletions
diff --git a/infra/minimal-distribution/Readme.adoc b/infra/minimal-distribution/Readme.adoc
new file mode 100644
index 000000000..5606b2d2f
--- /dev/null
+++ b/infra/minimal-distribution/Readme.adoc
@@ -0,0 +1,16 @@
+= Honeycomb minimal distribution
+This is a minimal, statically wired distribution of Honeycomb. It wires all the dependencies from Opendaylight with
+Honeycomb infrastructure code in order to provide a lightweight runnable distribution utilizing Google's guice for DI.
+
+It is lightweight because:
+
+1. Not using ODL's config subsystem
+2. Not using ODL's global (clustered) MD-SAL
+3. Wiring only minimal necessary subset of ODL components together
+
+== How to build&use
+Regular maven build (install) creates an ${project.artifactId}-${project.version}-infra.zip (or tar.gz) that can be
+unpacked and HC can be started using honeycomb.sh script
+
+== How to run from IntelliJ
+Just mark the src/config folder as resources root and you should be able to run Main from Intellij \ No newline at end of file