[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/brooklyn-docs/pull/108


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[geomacy]

Github user geomacy commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r80010683
  
--- Diff: guide/ops/osgi-configuration.md ---
@@ -1,79 +1,62 @@
 ---
-title: OSGi Distribution
+title: OSGi Configuration
 layout: website-normal
 ---
 
-# Running Apache Brooklyn inside Karaf container
+Configuration of Brooklyn when running under Karaf is largely done through 
standard Karaf mechanisms. 
+The Karaf "Configuration Admin" subsystem is used to manage configuration 
values loaded at first boot from the
+`.cfg` files in the `etc` directory of the distribution. In the Karaf 
command line these can then be viewed
+and manipulated by the `config:` commands, see the Karaf documentation for 
full details.
 
-The Apache Brooklyn Karaf based distribution lives in 
brooklyn-server/karaf/apache-brooklyn folder.
-It's still in a testing stage so some features might not work as expected. 
Do reach out if you
-find any problems.
+## Configuring Brooklyn Properties
 
-## Building
-
-{% highlight bash %}
-cd brooklyn-server
-mvn clean install
-cd karaf/apache-brooklyn/target
-tar -zxvf apache-brooklyn-{{ site.brooklyn-version }}.tar.gz
-cd apache-brooklyn-{{ site.brooklyn-version }}
-{% endhighlight %}
-
-## Running
-
-Start the instance using the following command
-
-{% highlight bash %}
-bin/karaf
-{% endhighlight %}
-
-This will launch the [Karaf 
console](https://karaf.apache.org/manual/latest/users-guide/console.html)
-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 %}
-bin/karaf debug
-{% endhighlight %}
-
-and connect to port 5005 using your debugger.
-
-To pause startup until the debugger is connected you can use
-
-{% highlight bash %}
-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 **brooklyn.properties**
+To configure the Brooklyn runtime create an `etc/brooklyn.cfg` file, 
following the standard `brooklyn.properties`
--- End diff --

the ** just makes it bold, think the backticks is more consistent


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[geomacy]

Github user geomacy commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r80010278
  
--- Diff: guide/ops/https.md ---
@@ -0,0 +1,53 @@
+---
+title: HTTPS Configuration
+layout: website-normal
+---
+
+## HTTPS Configuration
+
+### Getting the Certificate
+To enable HTTPS web access, you will need a server certificate in a java 
keystore. To create a self-signed certificate,
+and add it to a keystore, `keystore.jks`, you can use the following 
command:
+
+{% highlight bash %}
+% keytool -genkey -keyalg RSA -alias brooklyn \
+  -keystore /keystore.jks -storepass 
"mypassword" \
+  -validity 365 -keysize 2048 -keypass "password"
+{% endhighlight %}
+
+Of course, the passwords above should be changed.  Omit those arguments 
above for the tool to prompt you for the values.
--- End diff --

done


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[geomacy]

Github user geomacy commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r80010955
  
--- Diff: guide/ops/osgi.md ---
@@ -0,0 +1,56 @@
+---
+title: OSGi Distribution
+layout: website-normal
+children:
+- osgi-configuration.md
+---
+
+# Running Apache Brooklyn inside Karaf container
+
+The Apache Brooklyn Karaf based distribution lives in 
brooklyn-server/karaf/apache-brooklyn folder.
+It's still in a testing stage so some features might not work as expected. 
Do reach out if you
--- End diff --

fixed and added link to dev@brooklyn.apache.org


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[geomacy]

Github user geomacy commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r80012939
  
--- Diff: guide/ops/osgi.md ---
@@ -0,0 +1,56 @@
+---
+title: OSGi Distribution
+layout: website-normal
+children:
+- osgi-configuration.md
+---
+
+# Running Apache Brooklyn inside Karaf container
+
+The Apache Brooklyn Karaf based distribution lives in 
brooklyn-server/karaf/apache-brooklyn folder.
+It's still in a testing stage so some features might not work as expected. 
Do reach out if you
+find any problems.
+
+## Building
+
+{% highlight bash %}
+cd brooklyn-server
+mvn clean install
+cd karaf/apache-brooklyn/target
+tar -zxvf apache-brooklyn-{{ site.brooklyn-version }}.tar.gz
+cd apache-brooklyn-{{ site.brooklyn-version }}
+{% endhighlight %}
+
+## Running
+
+Start the instance using the following command
+
+{% highlight bash %}
+bin/karaf
+{% endhighlight %}
+
+This will launch the [Karaf 
console](https://karaf.apache.org/manual/latest/users-guide/console.html)
+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 %}
+bin/karaf debug
+{% endhighlight %}
+
+and connect to port 5005 using your debugger.
+
+To pause startup until the debugger is connected you can use
+
+{% highlight bash %}
+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.
--- End diff --

done


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[geomacy]

Github user geomacy commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r80010255
  
--- Diff: guide/ops/https.md ---
@@ -0,0 +1,53 @@
+---
+title: HTTPS Configuration
+layout: website-normal
+---
+
+## HTTPS Configuration
+
+### Getting the Certificate
+To enable HTTPS web access, you will need a server certificate in a java 
keystore. To create a self-signed certificate,
--- End diff --

done, although I don't think we need to link out to docs for the tool.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[geomacy]

Github user geomacy commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r80012902
  
--- Diff: guide/ops/osgi.md ---
@@ -0,0 +1,56 @@
+---
+title: OSGi Distribution
+layout: website-normal
+children:
+- osgi-configuration.md
+---
+
+# Running Apache Brooklyn inside Karaf container
+
+The Apache Brooklyn Karaf based distribution lives in 
brooklyn-server/karaf/apache-brooklyn folder.
+It's still in a testing stage so some features might not work as expected. 
Do reach out if you
+find any problems.
+
+## Building
+
+{% highlight bash %}
+cd brooklyn-server
+mvn clean install
+cd karaf/apache-brooklyn/target
+tar -zxvf apache-brooklyn-{{ site.brooklyn-version }}.tar.gz
+cd apache-brooklyn-{{ site.brooklyn-version }}
+{% endhighlight %}
+
+## Running
+
+Start the instance using the following command
+
+{% highlight bash %}
+bin/karaf
+{% endhighlight %}
+
+This will launch the [Karaf 
console](https://karaf.apache.org/manual/latest/users-guide/console.html)
+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 %}
+bin/karaf debug
+{% endhighlight %}
+
+and connect to port 5005 using your debugger.
--- End diff --

tweaked for a bit of extra clarity


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[geomacy]

Github user geomacy commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r80010633
  
--- Diff: guide/ops/osgi-configuration.md ---
@@ -1,79 +1,62 @@
 ---
-title: OSGi Distribution
+title: OSGi Configuration
 layout: website-normal
 ---
 
-# Running Apache Brooklyn inside Karaf container
+Configuration of Brooklyn when running under Karaf is largely done through 
standard Karaf mechanisms. 
+The Karaf "Configuration Admin" subsystem is used to manage configuration 
values loaded at first boot from the
+`.cfg` files in the `etc` directory of the distribution. In the Karaf 
command line these can then be viewed
+and manipulated by the `config:` commands, see the Karaf documentation for 
full details.
--- End diff --

done


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[geomacy]

Github user geomacy commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r80010298
  
--- Diff: guide/ops/brooklyn_properties.md ---
@@ -211,23 +211,10 @@ or
 {% include java_link.html class_name="EntitlementManager" 
package_path="org/apache/brooklyn/api/mgmt/entitlement" project_subpath="api" 
%}.
 
 
-## HTTPS Configuration
 
-To enable https, you will need a server certificate in a java keystore. To 
create a self-signed certificate, you can use the
-following command:
+## Configuring HTTPS in Brooklyn
--- End diff --

sorted


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[drigodwin]

Github user drigodwin commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r79150804
  
--- Diff: guide/ops/osgi-configuration.md ---
@@ -1,79 +1,62 @@
 ---
-title: OSGi Distribution
+title: OSGi Configuration
 layout: website-normal
 ---
 
-# Running Apache Brooklyn inside Karaf container
+Configuration of Brooklyn when running under Karaf is largely done through 
standard Karaf mechanisms. 
+The Karaf "Configuration Admin" subsystem is used to manage configuration 
values loaded at first boot from the
+`.cfg` files in the `etc` directory of the distribution. In the Karaf 
command line these can then be viewed
+and manipulated by the `config:` commands, see the Karaf documentation for 
full details.
--- End diff --

Link out to the Karaf documentation


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[drigodwin]

Github user drigodwin commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r79151739
  
--- Diff: guide/ops/osgi.md ---
@@ -0,0 +1,56 @@
+---
+title: OSGi Distribution
+layout: website-normal
+children:
+- osgi-configuration.md
+---
+
+# Running Apache Brooklyn inside Karaf container
+
+The Apache Brooklyn Karaf based distribution lives in 
brooklyn-server/karaf/apache-brooklyn folder.
+It's still in a testing stage so some features might not work as expected. 
Do reach out if you
+find any problems.
+
+## Building
+
+{% highlight bash %}
+cd brooklyn-server
+mvn clean install
+cd karaf/apache-brooklyn/target
+tar -zxvf apache-brooklyn-{{ site.brooklyn-version }}.tar.gz
+cd apache-brooklyn-{{ site.brooklyn-version }}
+{% endhighlight %}
+
+## Running
+
+Start the instance using the following command
+
+{% highlight bash %}
+bin/karaf
+{% endhighlight %}
+
+This will launch the [Karaf 
console](https://karaf.apache.org/manual/latest/users-guide/console.html)
+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 %}
+bin/karaf debug
+{% endhighlight %}
+
+and connect to port 5005 using your debugger.
+
+To pause startup until the debugger is connected you can use
+
+{% highlight bash %}
+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.
--- End diff --

keep state such as installed


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[drigodwin]

Github user drigodwin commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r79149990
  
--- Diff: guide/ops/https.md ---
@@ -0,0 +1,53 @@
+---
+title: HTTPS Configuration
+layout: website-normal
+---
+
+## HTTPS Configuration
+
+### Getting the Certificate
+To enable HTTPS web access, you will need a server certificate in a java 
keystore. To create a self-signed certificate,
+and add it to a keystore, `keystore.jks`, you can use the following 
command:
+
+{% highlight bash %}
+% keytool -genkey -keyalg RSA -alias brooklyn \
+  -keystore /keystore.jks -storepass 
"mypassword" \
+  -validity 365 -keysize 2048 -keypass "password"
+{% endhighlight %}
+
+Of course, the passwords above should be changed.  Omit those arguments 
above for the tool to prompt you for the values.
--- End diff --

Perhaps change "Of course, the passwords above should be changed" to "The 
passwords above should be changed to something [more 
secure](https://en.wikipedia.org/wiki/Password_strength)"


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[drigodwin]

Github user drigodwin commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r79150163
  
--- Diff: guide/ops/https.md ---
@@ -0,0 +1,53 @@
+---
+title: HTTPS Configuration
+layout: website-normal
+---
+
+## HTTPS Configuration
+
+### Getting the Certificate
+To enable HTTPS web access, you will need a server certificate in a java 
keystore. To create a self-signed certificate,
+and add it to a keystore, `keystore.jks`, you can use the following 
command:
+
+{% highlight bash %}
+% keytool -genkey -keyalg RSA -alias brooklyn \
+  -keystore /keystore.jks -storepass 
"mypassword" \
+  -validity 365 -keysize 2048 -keypass "password"
+{% endhighlight %}
+
+Of course, the passwords above should be changed.  Omit those arguments 
above for the tool to prompt you for the values.
+
+You will then be prompted to enter your name and organization details. 
This will use (or create, if it does not exist)
+a keystore with the password `mypassword` - you should use your own secure 
password, which will be the same password
+used in your brooklyn.properties (below). You will also need to replace 
`` with the full 
+path of the folder where you wish to store your keystore. The keystore 
will contain the newly generated key, 
+with alias `brooklyn` and password `password`.
+
+The certificate generated will be a self-signed certificate, which will 
cause a warning to be displayed by a browser 
--- End diff --

Move this paragraph to the top of this section?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[drigodwin]

Github user drigodwin commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r79151661
  
--- Diff: guide/ops/osgi.md ---
@@ -0,0 +1,56 @@
+---
+title: OSGi Distribution
+layout: website-normal
+children:
+- osgi-configuration.md
+---
+
+# Running Apache Brooklyn inside Karaf container
+
+The Apache Brooklyn Karaf based distribution lives in 
brooklyn-server/karaf/apache-brooklyn folder.
+It's still in a testing stage so some features might not work as expected. 
Do reach out if you
+find any problems.
+
+## Building
+
+{% highlight bash %}
+cd brooklyn-server
+mvn clean install
+cd karaf/apache-brooklyn/target
+tar -zxvf apache-brooklyn-{{ site.brooklyn-version }}.tar.gz
+cd apache-brooklyn-{{ site.brooklyn-version }}
+{% endhighlight %}
+
+## Running
+
+Start the instance using the following command
+
+{% highlight bash %}
+bin/karaf
+{% endhighlight %}
+
+This will launch the [Karaf 
console](https://karaf.apache.org/manual/latest/users-guide/console.html)
+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 %}
+bin/karaf debug
+{% endhighlight %}
+
+and connect to port 5005 using your debugger.
--- End diff --

Whats the debugger? - perhaps link out or describe this further


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[drigodwin]

Github user drigodwin commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r79151464
  
--- Diff: guide/ops/osgi.md ---
@@ -0,0 +1,56 @@
+---
+title: OSGi Distribution
+layout: website-normal
+children:
+- osgi-configuration.md
+---
+
+# Running Apache Brooklyn inside Karaf container
+
+The Apache Brooklyn Karaf based distribution lives in 
brooklyn-server/karaf/apache-brooklyn folder.
+It's still in a testing stage so some features might not work as expected. 
Do reach out if you
--- End diff --

I don't think I would use a colloquialism like 'reach out' here


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[drigodwin]

Github user drigodwin commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r79149015
  
--- Diff: guide/ops/brooklyn_properties.md ---
@@ -211,23 +211,10 @@ or
 {% include java_link.html class_name="EntitlementManager" 
package_path="org/apache/brooklyn/api/mgmt/entitlement" project_subpath="api" 
%}.
 
 
-## HTTPS Configuration
 
-To enable https, you will need a server certificate in a java keystore. To 
create a self-signed certificate, you can use the
-following command:
+## Configuring HTTPS in Brooklyn
--- End diff --

I think you need to change `section: HTTPS Configuration` at the top too if 
you're going to change the titles.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[drigodwin]

Github user drigodwin commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r79149490
  
--- Diff: guide/ops/https.md ---
@@ -0,0 +1,53 @@
+---
+title: HTTPS Configuration
+layout: website-normal
+---
+
+## HTTPS Configuration
+
+### Getting the Certificate
+To enable HTTPS web access, you will need a server certificate in a java 
keystore. To create a self-signed certificate,
--- End diff --

Perhaps link out [java keystore](https://en.wikipedia.org/wiki/Keystore) 
and say something like - To create a self-signed certificate (for testing and 
non-production use)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[drigodwin]

Github user drigodwin commented on a diff in the pull request:

https://github.com/apache/brooklyn-docs/pull/108#discussion_r79150922
  
--- Diff: guide/ops/osgi-configuration.md ---
@@ -1,79 +1,62 @@
 ---
-title: OSGi Distribution
+title: OSGi Configuration
 layout: website-normal
 ---
 
-# Running Apache Brooklyn inside Karaf container
+Configuration of Brooklyn when running under Karaf is largely done through 
standard Karaf mechanisms. 
+The Karaf "Configuration Admin" subsystem is used to manage configuration 
values loaded at first boot from the
+`.cfg` files in the `etc` directory of the distribution. In the Karaf 
command line these can then be viewed
+and manipulated by the `config:` commands, see the Karaf documentation for 
full details.
 
-The Apache Brooklyn Karaf based distribution lives in 
brooklyn-server/karaf/apache-brooklyn folder.
-It's still in a testing stage so some features might not work as expected. 
Do reach out if you
-find any problems.
+## Configuring Brooklyn Properties
 
-## Building
-
-{% highlight bash %}
-cd brooklyn-server
-mvn clean install
-cd karaf/apache-brooklyn/target
-tar -zxvf apache-brooklyn-{{ site.brooklyn-version }}.tar.gz
-cd apache-brooklyn-{{ site.brooklyn-version }}
-{% endhighlight %}
-
-## Running
-
-Start the instance using the following command
-
-{% highlight bash %}
-bin/karaf
-{% endhighlight %}
-
-This will launch the [Karaf 
console](https://karaf.apache.org/manual/latest/users-guide/console.html)
-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 %}
-bin/karaf debug
-{% endhighlight %}
-
-and connect to port 5005 using your debugger.
-
-To pause startup until the debugger is connected you can use
-
-{% highlight bash %}
-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 **brooklyn.properties**
+To configure the Brooklyn runtime create an `etc/brooklyn.cfg` file, 
following the standard `brooklyn.properties`
--- End diff --

I think the ** links out to the file? This should link out to the 
brooklyn.properties page I think


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-docs pull request #108: Add config instructions for HTTPS on Karaf.

[geomacy]

GitHub user geomacy opened a pull request:

https://github.com/apache/brooklyn-docs/pull/108

Add config instructions for HTTPS on Karaf.

Plus a few more details on key generation.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/geomacy/brooklyn-docs karaf-https-config

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/brooklyn-docs/pull/108.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #108


commit 5687acd8f430555a7dec430c628b96862e3366d2
Author: Geoff Macartney 
Date:   2016-09-15T16:13:45Z

Add config instructions for HTTPS on Karaf.

Plus a few more details on key generation.




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---