http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e73b66e0/guide/ops/security-guidelines.md ---------------------------------------------------------------------- diff --git a/guide/ops/security-guidelines.md b/guide/ops/security-guidelines.md index 3b86a23..453612c 100644 --- a/guide/ops/security-guidelines.md +++ b/guide/ops/security-guidelines.md @@ -37,7 +37,7 @@ relevant mount points, disks and directories. For credential storage, users are strongly encouraged to consider using the "externalised configuration" feature. This allows credentials to be retrieved from a store managed by you, -rather than being stored within YAML blueprints or brooklyn.properties. +rather than being stored within YAML blueprints or brooklyn.cfg. A secure credential store is strongly recommended, such as use of [HashiCorp's Vault](https://www.vaultproject.io) - see
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e73b66e0/guide/ops/server-cli-reference.md ---------------------------------------------------------------------- diff --git a/guide/ops/server-cli-reference.md b/guide/ops/server-cli-reference.md index eddf2d9..f30fa06 100644 --- a/guide/ops/server-cli-reference.md +++ b/guide/ops/server-cli-reference.md @@ -17,7 +17,7 @@ To launch Brooklyn, from the directory where Brooklyn is unpacked, run: With no configuration, this will launch the Brooklyn web console and REST API on [`http://localhost:8081/`](http://localhost:8081/), listening on all network interfaces. No credentials are required by default. For a production system, or if Apache Brooklyn is publicly reachable, it is strongly recommended to -[configure security](brooklyn_properties.html). +[configure security](brooklyn_cfg.html). By default, Brooklyn will write log messages at the INFO level or above to `brooklyn.info.log` and messgages at the DEBUG level or above to `brooklyn.debug.log`. Redirecting the output to `/dev/null` prevents the default console output @@ -101,12 +101,12 @@ from earlier ones, if exactly the same property is specified multiple times). generic metadata such as jurisdiction and geographic information about Cloud providers. 1. The file `~/.brooklyn/location-metadata.properties` (unless `--noGlobalBrooklynProperties` is specified). This is intended to contain custom metadata about additional locations. -1. The file `~/.brooklyn/brooklyn.properties` (unless `--noGlobalBrooklynProperties` is specified). +1. The file `brooklyn.cfg` (unless `--noGlobalBrooklynProperties` is specified). 1. Another properties file, if the `--localBrooklynProperties <local brooklyn.properties file>` is specified. 1. Shell environment variables 1. System properties, supplied with ``-D`` on the brooklyn (Java) command-line. -These properties are described in more detail [here](brooklyn_properties.html). +These properties are described in more detail [here](brooklyn_cfg.html). ### Extending the Classpath http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e73b66e0/guide/ops/starting-stopping-monitoring.md ---------------------------------------------------------------------- diff --git a/guide/ops/starting-stopping-monitoring.md b/guide/ops/starting-stopping-monitoring.md index e6196ea..906c11b 100644 --- a/guide/ops/starting-stopping-monitoring.md +++ b/guide/ops/starting-stopping-monitoring.md @@ -26,31 +26,25 @@ files. To launch Brooklyn, from the directory where Brooklyn is unpacked, run: {% highlight bash %} -% bin/brooklyn launch > /dev/null 2>&1 & disown +% bin/start {% endhighlight %} With no configuration, this will launch the Brooklyn web console and REST API on [`http://localhost:8081/`](http://localhost:8081/), listening on all network interfaces. No credentials are required by default. It is strongly -recommended to [configure security](brooklyn_properties.html). +recommended to [configure security](configuration/). See the [Server CLI Reference](server-cli-reference.html) for more information about the Brooklyn server process. -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. - ### 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 -the root of the Brooklyn directory. +To stop Brooklyn, from the directory where Brooklyn is unpacked, run: For example: {% highlight bash %} -% kill $( cat pid_java ) +% bin/stop {% endhighlight bash %} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e73b66e0/guide/start/blueprints.md ---------------------------------------------------------------------- diff --git a/guide/start/blueprints.md b/guide/start/blueprints.md index c7989f5..959b5be 100644 --- a/guide/start/blueprints.md +++ b/guide/start/blueprints.md @@ -107,7 +107,7 @@ First, log in to brooklyn with the command line interface (CLI) tool by typing: $ br login http://localhost:8081/ {% endhighlight %} -To secure the Apache Brooklyn instance, you can add a username and password to Brooklyn's properties file, as described in the User Guide [here]({{ site.path.guide }}/ops/brooklyn_properties.html){:target="_blank"}. +To secure the Apache Brooklyn instance, you can add a username and password to Brooklyn's properties file, as described in the User Guide [here]({{ site.path.guide }}/ops/configuration/brooklyn_cfg.html){:target="_blank"}. If this is configured, the login command will require an additional parameter for the userid and will then prompt for a password. Now you can create the application with the command below: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e73b66e0/guide/start/brooklyn.properties ---------------------------------------------------------------------- diff --git a/guide/start/brooklyn.properties b/guide/start/brooklyn.properties index cecd292..fc23bc9 100644 --- a/guide/start/brooklyn.properties +++ b/guide/start/brooklyn.properties @@ -17,7 +17,7 @@ # under the License. # # This is Brooklyn's dot-properties file. -# It should be located at "~/.brooklyn/brooklyn.properties" for automatic loading, +# It should be located at "brooklyn.cfg" for automatic loading, # or can be specified as a CLI option with --localProperties /path/to/these.properties. ################################## Welcome! ############################################ @@ -32,7 +32,7 @@ ## GUI Security ## NOTE: in production it is highly recommended to set up security. -## See http://brooklyn.apache.org/v/latest/ops/brooklyn_properties.html#authentication +## See http://brooklyn.apache.org/v/latest/ops/configuration/brooklyn_cfg.html#authentication ## Edit the name(s) and passwords as appropriate to your system, or even better generate ## a salt and sha256 of your password. @@ -107,7 +107,7 @@ ################################## Geoscaling ########################################### -## Entities can retrieve their configuration from brooklyn.properties. However, it is +## Entities can retrieve their configuration from brooklyn.cfg. However, it is ## more common to set this configuration in the blueprint's YAML. ## The Geoscaling Service - used for the Global Web Fabric demo - can read the following @@ -120,10 +120,10 @@ ############################# Locations Credentials ##################################### ## Best practice is to add locations to the catalog, rather than configuring locations -## in brooklyn.properties. We also recommend using a proper credentials store, such as +## in brooklyn.cfg. We also recommend using a proper credentials store, such as ## Vault. ## -## However, brooklyn.properties is supported. Example configurations are shown below. +## However, brooklyn.cfg is supported. Example configurations are shown below. ## Amazon EC2 Credentials ## These should be an "Access Key ID" and "Secret Access Key" for your account. @@ -145,7 +145,7 @@ ################################ Named Locations ######################################## ## Best practice is to add locations to the catalog, rather than using named locations in -## brooklyn.properties. However, the latter approach is supported. Example configurations +## brooklyn.cfg. However, the latter approach is supported. Example configurations ## are shown below. ## Named locations appear in the web console. If using the command line or YAML it may be http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/e73b66e0/guide/start/running.md ---------------------------------------------------------------------- diff --git a/guide/start/running.md b/guide/start/running.md index ef0c2a9..a8d5032 100644 --- a/guide/start/running.md +++ b/guide/start/running.md @@ -138,7 +138,7 @@ By default, no authentication is required and the web-console will listen on all For a production system, or if Apache Brooklyn is publicly reachable, it is strongly recommended to configure security. Documentation of configuration options include: -* [Security]({{ site.path.guide }}/ops/brooklyn_properties.html) +* [Security]({{ site.path.guide }}/ops/configuration/brooklyn_cfg.html) * [Persistence]({{ site.path.guide }}/ops/persistence/) * [Cloud credentials]({{ site.path.guide }}/locations/) @@ -182,7 +182,7 @@ Apache Brooklyn should now have been installed and be running as a system servic $ systemctl start|stop|restart|status brooklyn {% endhighlight %} -The application should then output its logs to `/var/log/brooklyn/apache-brooklyn.debug.log` and `/var/log/brooklyn/apache-brooklyn.info.log`. +The application should then output its logs to `/var/log/brooklyn/brooklyn.debug.log` and `/var/log/brooklyn/brooklyn.info.log`. </div> <div id="impl-3" class="tab-pane fade"> @@ -195,7 +195,7 @@ Apache Brooklyn should now have been installed and be running as a system servic $ sudo service brooklyn start|stop|restart|status {% endhighlight %} -The application should then output its logs to `/var/log/brooklyn/apache-brooklyn.debug.log` and `/var/log/brooklyn/apache-brooklyn.info.log`. +The application should then output its logs to `/var/log/brooklyn/brooklyn.debug.log` and `/var/log/brooklyn/brooklyn.info.log`. </div> <div id="impl-4" class="tab-pane fade"> @@ -205,19 +205,19 @@ The application should then output its logs to `/var/log/brooklyn/apache-brookly Now start Apache Brooklyn with the following command: {% highlight bash %} -$ bin/brooklyn launch +$ bin/start {% endhighlight %} -The application should then output its log into the console and also `apache-brooklyn.debug.log` and `apache-brooklyn.info.log` +The application should then output its log to `./data/log/brooklyn.debug.log` and `./data/log/brooklyn.info.log` </div> <div id="impl-5" class="tab-pane fade"> <strong class="hidden started-pdf-include">e) Windows</strong> -You can now start Apache Brooklyn by running `c:\Program Files\brooklyn\bin\brooklyn.bat` +You can now start Apache Brooklyn by running `c:\Program Files\brooklyn\bin\start.bat` -The application should then output its log into the console and also `c:\Program Files\brooklyn\apache-brooklyn.debug.log` and `c:\Program Files\brooklyn\apache-brooklyn.info.log` +The application should then output its log into the console and also `c:\Program Files\brooklyn\data\log\brooklyn.debug.log` and `c:\Program Files\brooklyn\data\log\brooklyn.info.log` </div> _Notice! Before launching Apache Brooklyn, please check the `date` on the local machine.
