Skip to content
Permalink
Browse files
Address review comments
  • Loading branch information
rdowner committed Jun 21, 2016
1 parent 07101c4 commit f6e1f4a4403251a272999036cee22b8eede7ee54
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 20 deletions.
@@ -23,22 +23,24 @@ any binaries for custom blueprints/integrations.

There are three main consumers of disk space:

* **Static files**: these are the Apache Brooklyn files themselves, plus
binaries for custom blueprints and integrations added to the `lib` directory.
* **Static files**: these are the Apache Brooklyn distribution with its own
dependencies, plus binaries for custom blueprints and integrations added to
the `lib` directory. Note that Brooklyn requires that Java is installed which
you may have to consider when calculating disk space requirements.
* **Persisted state**: when using [Persistence](persistence/index.html) -- which
is a prerequisite for [High Availability](high-availability.html) -- Brooklyn
will save data to a store location. Items in the persisted state include
metadata about the Brooklyn servers, catalog items, and metadata about all
running applications and entities.
* **Log files**: Brooklyn writes detailed log files by default to its own
installation directory. This can be reconfigured to change the destination
files, and increase or decrease the detail of the logs. See the
[Logging](logging.html) page for more details.

* **Log files**: Brooklyn writes info and debug log files. By default, these are
written to the local filesystem. This can be reconfigured to set the
destination and to increase or decrease the detail in the logs. See the
[Logging](logging.html) section for more details.

The Apache Brooklyn distribution itself, when unpacked, consumes approximately
75MB of disk space. The space consumed by additional binaries for custom
blueprints and integrations is application-specific.
75MB of disk space. This includes everything needed to run Brooklyn except for a
Java VM. The space consumed by additional binaries for custom blueprints and
integrations is application-specific.

Persisted state, excluding catalog data, is relatively small, starting at
approximately 300KB for a clean, idle Brooklyn server. Deploying blueprints will
@@ -50,17 +52,21 @@ Log data can be a large consumer of disk space. By default Brooklyn generates
two logfiles, one which logs notable information only, and another which logs at
a debug level. Each logfile rotates when it hits a size of 100MB; a maximum of
10 log files are retained for each type. The two logging streams combined,
therefore, can consume up to 2GB of disk space. In the default configuration
therefore, can consume up to 2GB of disk space.

In the default configuration of Brooklyn's `.tar.gz` and `.zip` distributions,
logs are saved to the Brooklyn installation directory. You will most likely want
to [reconfigure Brooklyn's logging](logging.html) to save logs to a location
elsewhere, and to rotate logs according to your organisation's policy.
elsewhere. In the `.rpm` and `.deb` packaging, logging files will be located
under `/var/log`. You can further reconfiguring the logging detail level and log
rotation according to your organisation's policy.


## Supported Operating Systems

The recommended operating system is CentOS 6.x or RedHat 6.x.

Brooklyn has also been tested on Ubuntu 12.04 and OS X.
Brooklyn has also been tested on Ubuntu 14.04 and OS X.


## Software Requirements
@@ -7,8 +7,21 @@ layout: website-normal
Server. For information on using the Brooklyn Client CLI to access an already
running Brooklyn Server, refer to [Client CLI Reference](cli/index.html).

## Packages for RHEL/CentOS and Ubuntu

## Starting
If you are using the `.rpm` or `.deb` package of Apache Brooklyn, then Brooklyn
will integrate with your OS service management. Commands such as
`service brooklyn start` will work as expected, and Brooklyn's PID file will be
stored in the normal location for your OS, such as `/var/run/brooklyn.pid`.


## Platform-independent distributions

The platform-independent distributions are packaged in `.tar.gz` and `.zip`
files.


### Starting

To launch Brooklyn, from the directory where Brooklyn is unpacked, run:

@@ -28,7 +41,7 @@ the Brooklyn directory, which contains the PID of the last Brooklyn process to
be started.


## Stopping
### Stopping

To stop Brooklyn, simply send a `TERM` signal to the Brooklyn process. The PID
of the most recently run Brooklyn process can be found in the `pid_java` file at
@@ -43,20 +56,24 @@ For example:

## Monitoring

As already mentioned, the Brooklyn startup script will create a file name
`pid_java` at the root of the Brooklyn directory, which contains the PID of the
last Brooklyn process to be started. You can examine this file to discover the
PID, and then test that the process is still running.
For `.tar.gz` and `.zip` distributions of Brooklyn, the Brooklyn startup script
will create a file name `pid_java` at the root of the Brooklyn directory, which
contains the PID of the last Brooklyn process to be started. You can examine
this file to discover the PID, and then test that the process is still running.
`.rpm` and `.deb` distributions of Brooklyn will use the normal mechanism that
your OS uses, such as writing to `/var/run/brooklyn.pid`.

This should lead to a fairly straightforward integration with many monitoring
tools - the monitoring tool can discover the expected PID, and can execute the
start or stop commands shown above as necessary.

For example, here is a fragment of a `monitrc` file as used by [Monit](http://https://mmonit.com/monit/):
For example, here is a fragment of a `monitrc` file as used by
[Monit](http://https://mmonit.com/monit/), for a Brooklyn `.tar.gz` distribution
unpacked and installed at `/opt/apache-brooklyn`:

{% highlight text %}
check process apachebrooklyn with pidfile /opt/apache-brooklyn/pid_java
start program = "/bin/bash -c '/opt/apache-brooklyn/bin/brooklyn launch & disown'" with timeout 10 seconds
start program = "/bin/bash -c '/opt/apache-brooklyn/bin/brooklyn launch --persist auto & disown'" with timeout 10 seconds
stop program = "/bin/bash -c 'kill $( cat /opt/apache-brooklyn/pid_java )'"
{% endhighlight %}

0 comments on commit f6e1f4a

Please sign in to comment.