summaryrefslogtreecommitdiffstats
path: root/common/common-scripts/src/main/resources/scripts/README
diff options
context:
space:
mode:
Diffstat (limited to 'common/common-scripts/src/main/resources/scripts/README')
-rw-r--r--common/common-scripts/src/main/resources/scripts/README26
1 files changed, 26 insertions, 0 deletions
diff --git a/common/common-scripts/src/main/resources/scripts/README b/common/common-scripts/src/main/resources/scripts/README
new file mode 100644
index 0000000..80b1519
--- /dev/null
+++ b/common/common-scripts/src/main/resources/scripts/README
@@ -0,0 +1,26 @@
+= This is a Honeycomb distribution
+
+Built from: ${groupId}/${artifactId}
+Version: ${version}
+
+https://wiki.fd.io/view/Honeycomb
+
+== Structure
+
+Structure of the distribution:
+
+=== Config
+Folder config contains any configuration that's exposed by Honeycomb and its plugins
+
+=== Cert
+Keystore/Truststore for Restconf's HTTPS endpoint
+
+=== Modules
+Folder modules contains text files with list of modules to be installed into Honeycomb.
+Those modules bring up Honeycomb's infrastructure as well as modules.
+
+=== Shell scripts
+${startScript} - Start Honeycomb
+${debugScript} - Start Honeycomb with JVM remote debug capabilities
+${forkScript} - Start Honeycomb in background
+${killScript} - Kill all running Honeycomb instances