brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [2/4] brooklyn-docs git commit: Address review comments
Date Thu, 21 Apr 2016 13:19:22 GMT
Address review comments


Branch: refs/heads/master
Commit: 9e1f1c14611e61acd3504b904ea18009a1f840d0
Parents: 1533b0d
Author: Svetoslav Neykov <>
Authored: Wed Apr 13 09:34:05 2016 +0300
Committer: Svetoslav Neykov <>
Committed: Wed Apr 13 09:51:20 2016 +0300

 guide/misc/ | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)
diff --git a/guide/misc/ b/guide/misc/
index 4c4f6c7..5482481 100644
--- a/guide/misc/
+++ b/guide/misc/
@@ -1,11 +1,13 @@
-title: FAQ
+title: OSGi Distribution
 layout: website-normal
-# Running Apache Brooklin inside Karaf container
+# Running Apache Brooklyn inside Karaf container
 The Apache Brooklyn Karaf based distribution lives in brooklyn-server/karaf/apache-brooklyn
+It's still in a testing stage so some features might not work as expected. Do reach out if
+find any problems.
 ## Building
@@ -25,6 +27,10 @@ Start the instance using the following command
 {% endhighlight %}
+This will launch the [Karaf console](
+where you can interact with the running instance. Note that Brooklyn has already started
at this point
+and is reachable at the usual web console url.
 To start in debug mode use
 {% highlight bash %}
@@ -39,13 +45,23 @@ To pause startup until the debugger is connected you can use
 JAVA_DEBUG_OPTS='-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005'
bin/karaf debug
 {% endhighlight %}
+The Karaf container will keep state like installed bundles and configuration between restarts.
+To reset any changes add **clean** to the cli arguments.
 ## Configuring
+To configure the Brooklyn runtime create an **etc/brooklyn.cfg** file, following the standard
+file format. Values can be viewed and managed dynamically via the OSGI configuration admin
commands in Karaf,
+e.g. config:property-set. The global **~/.brooklyn/** is still supported
and has higher
+priority for duplicate keys, but it's values can't be manipulated with the Karaf commands,
so its use is
 You can use the standard ~/.brooklyn/ file to configure Brooklyn. Alternatively
 create etc/brooklyn.cfg inside the distribution folder (same file format). The keys in the
former override
 those in the latter.
 Web console related configuration is done through the corresponding Karaf mechanisms:
   * The port is set in etc/org.ops4j.pax.web.cfg, key org.osgi.service.http.port.
   * For authentication the JAAS realm "webconsole" is used; by default it will use any
     SecurityProvider implementations configured in Brooklyn falling back to auto generating
@@ -57,7 +73,7 @@ Web console related configuration is done through the corresponding Karaf
 ## Caveats
-In the OSGi world specifying class names by string in Brooklyn's configuraiton will work
+In the OSGi world specifying class names by string in Brooklyn's configuration will work
 for classes living in Brooklyn's core modules. Raise an issue or ping us on IRC if you find
 a case where this doesn't work for you. For custom SecurityProvider implementations refer
to the
 documentation of BrooklynLoginModule.

View raw message