You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by sv...@apache.org on 2016/09/27 08:46:58 UTC
[3/5] brooklyn-docs git commit: Updates from review.
Updates from review.
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/cd7d51a6
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/cd7d51a6
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/cd7d51a6
Branch: refs/heads/master
Commit: cd7d51a687680d835796de79c4939124c4c4f928
Parents: 073edb1
Author: Geoff Macartney <ge...@cloudsoftcorp.com>
Authored: Thu Sep 22 10:23:01 2016 +0100
Committer: Geoff Macartney <ge...@cloudsoftcorp.com>
Committed: Thu Sep 22 11:24:45 2016 +0100
----------------------------------------------------------------------
guide/ops/brooklyn_properties.md | 2 +-
guide/ops/https.md | 17 ++++++++---------
guide/ops/osgi-configuration.md | 7 ++++---
guide/ops/osgi.md | 8 ++++----
4 files changed, 17 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cd7d51a6/guide/ops/brooklyn_properties.md
----------------------------------------------------------------------
diff --git a/guide/ops/brooklyn_properties.md b/guide/ops/brooklyn_properties.md
index aa08875..6d3b5e5 100644
--- a/guide/ops/brooklyn_properties.md
+++ b/guide/ops/brooklyn_properties.md
@@ -212,7 +212,7 @@ or
-## Configuring HTTPS in Brooklyn
+## HTTPS Configuration
See [HTTPS Configuration](https.html) for general information on configuring HTTPS.
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cd7d51a6/guide/ops/https.md
----------------------------------------------------------------------
diff --git a/guide/ops/https.md b/guide/ops/https.md
index 7bdeacb..7ed910c 100644
--- a/guide/ops/https.md
+++ b/guide/ops/https.md
@@ -3,11 +3,13 @@ title: HTTPS Configuration
layout: website-normal
---
-## HTTPS Configuration
-
-### Getting the Certificate
+## 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:
+for testing and non-production use, you can use the tool `keytool` from your Java distribution. (A self-signed
+certificate will cause a warning to be displayed by a browser when viewing the page. The various browsers each have
+ways to import the certificate as a trusted one, for test purposes.)
+
+The following command creates a self-signed certificate and adds it to a keystore, `keystore.jks`:
{% highlight bash %}
% keytool -genkey -keyalg RSA -alias brooklyn \
@@ -15,7 +17,7 @@ and add it to a keystore, `keystore.jks`, you can use the following command:
-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.
+The passwords above should be changed to your own values. 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
@@ -23,9 +25,6 @@ used in your brooklyn.properties (below). You will also need to replace `<path-t
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
-when viewing the page. (The various browsers each have ways to import the certificate as a trusted one, for test purposes.)
-
For production servers, a valid signed certificate from a trusted certifying authority should be used instead.
Typically keys from a certifying authority are not provided in Java keystore format. To create a Java keystore from
existing certificates (CA certificate, and public and private keys), you must first create a PKCS12 keystore from them,
@@ -45,7 +44,7 @@ and then convert it into a keystore `keystore.jks` as follows:
{% endhighlight %}
-### Configuring Brooklyn for HTTPS
+## Configuring Brooklyn for HTTPS
How to do this depends on whether you are using the traditional or the Karaf distribution. See either of
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cd7d51a6/guide/ops/osgi-configuration.md
----------------------------------------------------------------------
diff --git a/guide/ops/osgi-configuration.md b/guide/ops/osgi-configuration.md
index db2a6cd..2dfa681 100644
--- a/guide/ops/osgi-configuration.md
+++ b/guide/ops/osgi-configuration.md
@@ -3,10 +3,10 @@ title: OSGi Configuration
layout: website-normal
---
-Configuration of Brooklyn when running under Karaf is largely done through standard Karaf mechanisms.
+Configuration of Apache 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.
+and manipulated by the `config:` commands, see the [Karaf documentation](https://karaf.apache.org/manual/latest/) for full details.
## Configuring Brooklyn Properties
@@ -25,7 +25,8 @@ Web console related configuration is done through the corresponding Karaf mechan
* 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
- the password. To configure a custom JAAS realm see the `jetty.xml` file in `brooklyn-server/karaf/jetty-config/src/main/resources`
+ the password. To configure a custom JAAS realm see the `jetty.xml` file in
+ `brooklyn-server/karaf/jetty-config/src/main/resources`
and override it by creating a custom one in `etc` folder. Point the "webconsole" login service
to the JAAS realm you would like to use.
* For other Jetty related configuration consult the Karaf and pax-web docs.
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/cd7d51a6/guide/ops/osgi.md
----------------------------------------------------------------------
diff --git a/guide/ops/osgi.md b/guide/ops/osgi.md
index 4cb07f2..8f765f0 100644
--- a/guide/ops/osgi.md
+++ b/guide/ops/osgi.md
@@ -8,8 +8,8 @@ children:
# 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.
+It's still in a testing stage so some features might not work as expected. Please contact us on the
+[mailing list](mailto:dev@brooklyn.apache.org) if you find any problems.
## Building
@@ -39,7 +39,7 @@ To start in debug mode use
bin/karaf debug
{% endhighlight %}
-and connect to port 5005 using your debugger.
+and connect to port 5005 using your normal Java debugger.
To pause startup until the debugger is connected you can use
@@ -47,7 +47,7 @@ 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.
+The Karaf container will keep state such as installed bundles and configuration between restarts.
To reset any changes add **clean** to the cli arguments.
## Configuring