http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/starting-stopping-monitoring.md ---------------------------------------------------------------------- diff --git a/guide/ops/starting-stopping-monitoring.md b/guide/ops/starting-stopping-monitoring.md index 3f95749..5e50acb 100644 --- a/guide/ops/starting-stopping-monitoring.md +++ b/guide/ops/starting-stopping-monitoring.md @@ -5,7 +5,7 @@ title: Starting, Stopping and Monitoring **NOTE:** This document is for information on starting an Apache Brooklyn Server. For information on using the Brooklyn Client CLI to access an already -running Brooklyn Server, refer to [Client CLI Reference](cli/index.md). +running Brooklyn Server, refer to [Client CLI Reference]({{book.path.docs}}/ops/cli/index.md). ## Packages for RHEL/CentOS and Ubuntu @@ -31,9 +31,9 @@ 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. It is strongly -recommended to [configure security](configuration/index.md). +recommended to [configure security]({{book.path.docs}}/ops/configuration/index.md). -See the [Server CLI Reference](server-cli-reference.md) for more information +See the [Server CLI Reference]({{book.path.docs}}/ops/server-cli-reference.md) for more information about the Brooklyn server process. @@ -73,5 +73,5 @@ check process apachebrooklyn with pidfile /opt/apache-brooklyn/pid_java In addition to monitoring the Brooklyn process itself, you will almost certainly want to monitor resource usage of Brooklyn. In particular, please see the -[Requirements](requirements.md#disk-space) section for a discussion on Brooklyn's disk +[Requirements]({{book.path.docs}}/ops/requirements.md#disk-space) section for a discussion on Brooklyn's disk space requirements.
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/troubleshooting/deployment.md ---------------------------------------------------------------------- diff --git a/guide/ops/troubleshooting/deployment.md b/guide/ops/troubleshooting/deployment.md index ec2a136..78cb523 100644 --- a/guide/ops/troubleshooting/deployment.md +++ b/guide/ops/troubleshooting/deployment.md @@ -152,7 +152,7 @@ This just means that the entity did not get to service-up in the pre-defined tim two minutes, and can be configured using the `start.timeout` config key; the timer begins after the start tasks are completed). -See the [overview](overview.md) for where to find additional information, especially the section on +See the [overview]({{book.path.docs}}/ops/troubleshooting/overview.md) for where to find additional information, especially the section on "Entity's Error Status". ## Invalid packet error http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/troubleshooting/detailed-support-report.md ---------------------------------------------------------------------- diff --git a/guide/ops/troubleshooting/detailed-support-report.md b/guide/ops/troubleshooting/detailed-support-report.md index ccb70bb..9484612 100644 --- a/guide/ops/troubleshooting/detailed-support-report.md +++ b/guide/ops/troubleshooting/detailed-support-report.md @@ -6,7 +6,7 @@ title: Detailed Support Report If you wish to send a detailed report, then depending on the nature of the problem, consider collecting the following information. -See [Brooklyn Slow or Unresponse](slow-unresponsive.md) docs for details of these commands. +See [Brooklyn Slow or Unresponse]({{book.path.docs}}/ops/troubleshooting/slow-unresponsive.md) docs for details of these commands. ```bash BROOKLYN_HOME=/home/users/brooklyn/apache-brooklyn-0.9.0-bin @@ -37,6 +37,6 @@ tar czf brooklyn-report.tgz ${REPORT_DIR} Also consider providing your log files and persisted state, though extreme care should be taken if these might contain cloud or machine credentials (especially if -[Externalised Configuration](../externalized-configuration.md) +[Externalised Configuration]({{book.path.docs}}/ops/externalized-configuration.md) is not being used for credential storage). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/troubleshooting/going-deep-in-java-and-logs.md ---------------------------------------------------------------------- diff --git a/guide/ops/troubleshooting/going-deep-in-java-and-logs.md b/guide/ops/troubleshooting/going-deep-in-java-and-logs.md index 205e8d6..f2581e4 100644 --- a/guide/ops/troubleshooting/going-deep-in-java-and-logs.md +++ b/guide/ops/troubleshooting/going-deep-in-java-and-logs.md @@ -422,7 +422,7 @@ the "Show/hide empty records" icon (highlighted in yellow above): We know from previous steps that the installation and launch scripts completed, and we know the procecess is running, but we can see here that the server is not responding to JMX requests. A good thing to check here would be that the JMX port is not being blocked by iptables, firewalls or security groups -(see the [troubleshooting connectivity guide](connectivity.md)). +(see the [troubleshooting connectivity guide]({{book.path.docs}}/ops/troubleshooting/connectivity.md)). Let's assume that we've checked that and they're all open. There is still one more thing that Brooklyn can tell us. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/troubleshooting/overview.md ---------------------------------------------------------------------- diff --git a/guide/ops/troubleshooting/overview.md b/guide/ops/troubleshooting/overview.md index 4e8235c..1bfbb34 100644 --- a/guide/ops/troubleshooting/overview.md +++ b/guide/ops/troubleshooting/overview.md @@ -81,7 +81,7 @@ For example, it can show the exception stack trace in the thread that was execut ## Log Files Brooklyn's logging is configurable, for the files created, the logging levels, etc. -See [Logging docs](../logging.md). +See [Logging docs]({{book.path.docs}}/ops/logging.md). With out-of-the-box logging, `brooklyn.info.log` and `brooklyn.debug.log` files are created. These are by default rolling log files: when the log reaches a given size, it is compressed and a new log file is started. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/troubleshooting/slow-unresponsive.md ---------------------------------------------------------------------- diff --git a/guide/ops/troubleshooting/slow-unresponsive.md b/guide/ops/troubleshooting/slow-unresponsive.md index 2c2e057..f0b7eee 100644 --- a/guide/ops/troubleshooting/slow-unresponsive.md +++ b/guide/ops/troubleshooting/slow-unresponsive.md @@ -13,7 +13,7 @@ Possible reasons include: * SSH'ing is very slow due (e.g. due to lack of entropy) * Out of disk space -See [Brooklyn Requirements](../requirements.md) for details of server +See [Brooklyn Requirements]({{book.path.docs}}/ops/requirements.md) for details of server requirements. @@ -57,7 +57,7 @@ ulimit -a -u adalovelace Of particular interest is the limit for "open files". -See [Increase System Resource Limits](increase-system-resource-limits.md) +See [Increase System Resource Limits]({{book.path.docs}}/ops/troubleshooting/increase-system-resource-limits.md) for more information. @@ -104,7 +104,7 @@ netstat -an | grep ESTABLISHED | wc -l A lack of entropy can cause random number generation to be extremely slow. This can cause tasks like ssh to also be extremely slow. See -[linux kernel entropy](increase-entropy.md) +[linux kernel entropy]({{book.path.docs}}/ops/troubleshooting/increase-entropy.md) for details of how to work around this. @@ -156,14 +156,14 @@ appropriate for a production server. If the Brooklyn Server was originally run to allow a remote debugger to connect (strongly discouraged in production!), then this provides a convenient way to investigate why Brooklyn is being slow or unresponsive. See the Debugging Tips in the -tip [Debugging Remote Brooklyn](../../dev/tips/debugging-remote-brooklyn.md) -and the [IDE docs](../../dev/env/ide/index.md) for more information. +tip [Debugging Remote Brooklyn]({{book.path.docs}}/dev/tips/debugging-remote-brooklyn.md) +and the [IDE docs]({{book.path.docs}}/dev/env/ide/index.md) for more information. ## Log Files Apache Brooklyn will by default create brooklyn.info.log and brooklyn.debug.log files. See the -[Logging](../logging.md) docs for more information. +[Logging]({{book.path.docs}}/ops/logging.md) docs for more information. The following are useful log messages to search for (e.g. using `grep`). Note the wording of these messages (or their very presence) may change in future version of Brooklyn. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/troubleshooting/softwareprocess.md ---------------------------------------------------------------------- diff --git a/guide/ops/troubleshooting/softwareprocess.md b/guide/ops/troubleshooting/softwareprocess.md index 744060e..095c33e 100644 --- a/guide/ops/troubleshooting/softwareprocess.md +++ b/guide/ops/troubleshooting/softwareprocess.md @@ -3,7 +3,7 @@ title: Troubleshooting SoftwareProcess Entities --- # {{ page.title }} -The [troubleshooting overview](overview.md) in Brooklyn gives +The [troubleshooting overview]({{book.path.docs}}/ops/troubleshooting/overview.md) in Brooklyn gives information for how to find more information about errors. If that doesn't give enough information to diagnose, fix or workaround the problem, then it can be required http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/upgrade.md ---------------------------------------------------------------------- diff --git a/guide/ops/upgrade.md b/guide/ops/upgrade.md index 6c1cea6..87cc445 100644 --- a/guide/ops/upgrade.md +++ b/guide/ops/upgrade.md @@ -42,7 +42,7 @@ Instead, code must be built and installed as [OSGi bundles](https://en.wikipedia 2. Upgrade Apache Brooklyn: - 1. [Download](../misc/download.md) the new RPM/DEB package + 1. [Download]({{book.path.docs}}/misc/download.md) the new RPM/DEB package 2. Upgrade Apache Brooklyn: @@ -92,7 +92,7 @@ Instead, code must be built and installed as [OSGi bundles](https://en.wikipedia 3. Install new version of Apache Brooklyn: - 1. [Download](../misc/download.md) the new tarball zip package. + 1. [Download]({{book.path.docs}}/misc/download.md) the new tarball zip package. 2. Install Brooklyn: @@ -190,7 +190,7 @@ Instead, code must be built and installed as [OSGi bundles](https://en.wikipedia 5. Install new version of Apache Brooklyn: - 1. [Download](../misc/download.md) the new RPM/DEB package. + 1. [Download]({{book.path.docs}}/misc/download.md) the new RPM/DEB package. 2. Install Apache Brooklyn: @@ -286,7 +286,7 @@ yum downgrade apache-brooklyn.noarch dpkg -i apache-brooklyn-xxxx.deb ``` -*Note that to downgrade a DEB package is essentially installing a previous version therefore you need to [download](../misc/download.md) +*Note that to downgrade a DEB package is essentially installing a previous version therefore you need to [download]({{book.path.docs}}/misc/download.md) the version you want to downgrade to before hand.* ## How to stop your service @@ -303,11 +303,11 @@ stop brooklyn ## Web login credentials -* User credentials should now be recorded in [`brooklyn.cfg`](paths.md). +* User credentials should now be recorded in [`brooklyn.cfg`]({{book.path.docs}}/ops/paths.md). -* Brooklyn will still read them from both [`brooklyn.cfg`](paths.md) and `~/.brooklyn/brooklyn.properties`. +* Brooklyn will still read them from both [`brooklyn.cfg`]({{book.path.docs}}/ops/paths.md) and `~/.brooklyn/brooklyn.properties`. -* Configure a username/password by modifying [`brooklyn.cfg`](paths.md). An example entry is: +* Configure a username/password by modifying [`brooklyn.cfg`]({{book.path.docs}}/ops/paths.md). An example entry is: ```bash brooklyn.webconsole.security.users=admin @@ -318,10 +318,10 @@ brooklyn.webconsole.security.user.admin.password=password2 If you have persisted state you wish to rebind to, persistence is now configured in the following files: -* [`brooklyn.cfg`](paths.md) -* [`org.apache.brooklyn.osgilauncher.cfg`](paths.md) +* [`brooklyn.cfg`]({{book.path.docs}}/ops/paths.md) +* [`org.apache.brooklyn.osgilauncher.cfg`]({{book.path.docs}}/ops/paths.md) -For example, to use S3 for the persisted state, add the following to [`brooklyn.cfg`](paths.md): +For example, to use S3 for the persisted state, add the following to [`brooklyn.cfg`]({{book.path.docs}}/ops/paths.md): ```bash brooklyn.location.named.aws-s3-eu-west-1:aws-s3:eu-west-1 @@ -329,7 +329,7 @@ brooklyn.location.named.aws-s3-eu-west-1.identity=<ADD CREDS> brooklyn.location.named.aws-s3-eu-west-1.credential=<ADD CREDS> ``` -To continue the S3 example, for the persisted state, add the following to [`org.apache.brooklyn.osgilauncher.cfg`](paths.md): +To continue the S3 example, for the persisted state, add the following to [`org.apache.brooklyn.osgilauncher.cfg`]({{book.path.docs}}/ops/paths.md): ```bash persistenceLocation=aws-s3-eu-west-1 @@ -342,7 +342,7 @@ Apache Brooklyn should be stopped before this file is modified, and then restart in the persisted state. Apache Brooklyn needs to know it in order to read the persisted state at startup time.*** If binding to existing persisted state, an additional command is required to update the existing catalog with the Brooklyn -0.12.0 versions. Assuming Brooklyn has been installed to [`/opt/brooklyn`](paths.md) (as is done by the RPM and DEB): +0.12.0 versions. Assuming Brooklyn has been installed to [`/opt/brooklyn`]({{book.path.docs}}/ops/paths.md) (as is done by the RPM and DEB): ```bash br catalog add /opt/brooklyn/catalog/catalog.bom http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/start/blueprints.md ---------------------------------------------------------------------- diff --git a/guide/start/blueprints.md b/guide/start/blueprints.md index 97c6b17..45968d5 100644 --- a/guide/start/blueprints.md +++ b/guide/start/blueprints.md @@ -37,7 +37,7 @@ In order to configure the location in which Apache Brooklyn launches an applicat {% sample lang="vagrant" -%} ### Vagrant location -The Vagrant configuration described in [Running Apache Brooklyn](running.md), on the previous page is the recommended way of running this tutorial. This configuration comes with four blank vagrant configurations called byon1 to byon4. +The Vagrant configuration described in [Running Apache Brooklyn]({{book.path.docs}}/start/running.md), on the previous page is the recommended way of running this tutorial. This configuration comes with four blank vagrant configurations called byon1 to byon4. These can be launched by entering the following command into the terminal in the vagrant configuration directory. @@ -62,7 +62,7 @@ location: {% sample lang="clouds" -%} ### A cloud location -Apache Brooklyn uses [Apcahe jclouds](http://jclouds.apache.org/) to support a range of cloud locations. More information on the range of providers and configurations is available [here](../locations/index.md#clouds). +Apache Brooklyn uses [Apcahe jclouds](http://jclouds.apache.org/) to support a range of cloud locations. More information on the range of providers and configurations is available [here]({{book.path.docs}}/locations/index.md#clouds). As an example, here is a configuration for [Amazon Web Services (AWS)](http://www.aws.amazon.com). Swap the identity and credential with your AWS account details, then replace the location in your "myapp.yaml" with this. @@ -76,7 +76,7 @@ location: {% sample lang="byon" -%} ### "Bring your own nodes" location -The Bring Your Own Nodes (BYON) configuration allows Apache Brooklyn to make use of already available servers. These can be specified by a list of IP addresses with a user and password as shown below. More information including the full range of configuration options is available [here](../locations/index.md#byon). +The Bring Your Own Nodes (BYON) configuration allows Apache Brooklyn to make use of already available servers. These can be specified by a list of IP addresses with a user and password as shown below. More information including the full range of configuration options is available [here]({{book.path.docs}}/locations/index.md#byon). Replace the hosts, user and password in the example below with your own server details, then replace the location in your "myapp.yaml" with this. @@ -94,7 +94,7 @@ location: {% endmethod %} -**Note**: For instructions on setting up a variety of locations or storing credentials/locations in a file on disk rather than in the blueprint, see __[Locations](../locations/index.md)__ in the Operations section of the User Guide. +**Note**: For instructions on setting up a variety of locations or storing credentials/locations in a file on disk rather than in the blueprint, see __[Locations]({{book.path.docs}}/locations/index.md)__ in the Operations section of the User Guide. ## Deploying the Application @@ -103,7 +103,7 @@ First, log in to brooklyn with the command line interface (CLI) tool by typing: $ br login http://localhost:8081/ ``` -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](../ops/configuration/brooklyn_cfg.md). +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]({{book.path.docs}}/ops/configuration/brooklyn_cfg.md). 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: @@ -120,5 +120,5 @@ you can monitor the progress of the application deployment and verify if it was {% if output.name == 'website' %} ## Next -Having deployed an application, the next step is **[monitoring and managing](managing.md)** it. +Having deployed an application, the next step is **[monitoring and managing]({{book.path.docs}}/start/managing.md)** it. {% endif %} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/start/concept-quickstart.md ---------------------------------------------------------------------- diff --git a/guide/start/concept-quickstart.md b/guide/start/concept-quickstart.md index 1fa7cbd..9e16f50 100644 --- a/guide/start/concept-quickstart.md +++ b/guide/start/concept-quickstart.md @@ -3,7 +3,7 @@ title: Brooklyn Concepts Quickstart --- # {{ page.title }} -The following section provides a quick summary of the main Brooklyn concepts you will encounter in Getting Started. For further discussion of these concepts see [The Theory Behind Brooklyn]({{book.url.brooklyn_website}}/learnmore/theory.html), and the detailed descriptions in [Brooklyn Concepts](../concepts/index.md). +The following section provides a quick summary of the main Brooklyn concepts you will encounter in Getting Started. For further discussion of these concepts see [The Theory Behind Brooklyn]({{book.url.brooklyn_website}}/learnmore/theory.html), and the detailed descriptions in [Brooklyn Concepts]({{book.path.docs}}/concepts/index.md). ***Deployment and Management*** Brooklyn is built for agile deployment of applications across cloud and other targets, and real-time autonomic management. "Autonomic computing" is the concept of components looking after themselves where possible (self-healing, self-optimizing, etc). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/start/managing.md ---------------------------------------------------------------------- diff --git a/guide/start/managing.md b/guide/start/managing.md index c0fed8c..192501b 100644 --- a/guide/start/managing.md +++ b/guide/start/managing.md @@ -22,7 +22,7 @@ $ br app hTPAF19s Tomcat RUNNING ajVVAhER ``` -A full list of abbreviations such as this can be found in the [CLI reference guide](../ops/cli/cli-ref-guide.md#abbreviations). +A full list of abbreviations such as this can be found in the [CLI reference guide]({{book.path.docs}}/ops/cli/cli-ref-guide.md#abbreviations). In the above example the Id `hTPAF19s` and the Name `Tomcat` are shown. You can use either of these handles to monitor and control the application. The Id shown for your application will be different to this but the name should be the same, note that if you are running multiple applications the Name may not be unique. @@ -93,7 +93,7 @@ Id Name Type Wx7r1C4e tomcatServer org.apache.brooklyn.entity.webapp.tomcat.TomcatServer ``` -This shows one entity is available: `tomcatServer`. Note that this is the name we gave the entity in the YAML in [Launching from a Blueprint](blueprints.md#launching-from-a-blueprint) on the previous page. +This shows one entity is available: `tomcatServer`. Note that this is the name we gave the entity in the YAML in [Launching from a Blueprint]({{book.path.docs}}/start/blueprints.md#launching-from-a-blueprint) on the previous page. You can get summary information for this entity by providing its name (or ID). @@ -367,5 +367,5 @@ runs the ```config``` command with application scope of ```Tomcat``` and entity ## Next We will look next at a slightly more complex example, which will illustrate the capabilities of Brooklyn's -**[policies](policies.md)** mechanism, and how to configure dependencies between application entities. +**[policies]({{book.path.docs}}/start/policies.md)** mechanism, and how to configure dependencies between application entities. {% endif %} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/start/running.md ---------------------------------------------------------------------- diff --git a/guide/start/running.md b/guide/start/running.md index fa707bb..f58b4bc 100644 --- a/guide/start/running.md +++ b/guide/start/running.md @@ -116,9 +116,9 @@ 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](../ops/configuration/brooklyn_cfg.md) -* [Persistence](../ops/persistence/index.md) -* [Cloud credentials](../locations/index.md) +* [Security]({{book.path.docs}}/ops/configuration/brooklyn_cfg.md) +* [Persistence]({{book.path.docs}}/ops/persistence/index.md) +* [Cloud credentials]({{book.path.docs}}/locations/index.md) ## Launch Apache Brooklyn @@ -154,7 +154,7 @@ Apache Brooklyn should now have been installed and be running as a system servic $ systemctl start|stop|restart|status brooklyn ``` -The application should then output its logs to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths](../ops/paths.md) page for the locations of these. +The application should then output its logs to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths]({{book.path.docs}}/ops/paths.md) page for the locations of these. {% sample lang="ubuntu" -%} ### Launching on Ubuntu & Debian @@ -165,7 +165,7 @@ Apache Brooklyn should now have been installed and be running as a system servic $ sudo service brooklyn start|stop|restart|status ``` -The application should then output its logs to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths](../ops/paths.md) page for the locations of these. +The application should then output its logs to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths]({{book.path.docs}}/ops/paths.md) page for the locations of these. {% sample lang="osx" -%} ### Launching on other Linux distributions, OSX and other UNIX-like platforms @@ -176,7 +176,7 @@ Now start Apache Brooklyn with the following command: $ bin/start ``` -The application should then output its log to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths](../ops/paths.md) page for the locations of these. +The application should then output its log to `brooklyn.debug.log` and `brooklyn.info.log`, please refer to the [paths]({{book.path.docs}}/ops/paths.md) page for the locations of these. {% sample lang="windows" -%} ### Launching on Windows @@ -209,9 +209,9 @@ using the most appropriate link for your OS: * [OSX](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn_version}}/apache-brooklyn-{{book.brooklyn_version}}-client-cli-macosx.tar.gz) {% endif %} -For details on the CLI, see the [Client CLI Reference](../ops/cli/index.md) page. +For details on the CLI, see the [Client CLI Reference]({{book.path.docs}}/ops/cli/index.md) page. {% if output.name == 'website' %} ## Next -The first thing we want to do with Brooklyn is **[deploy a blueprint](blueprints.md)**. +The first thing we want to do with Brooklyn is **[deploy a blueprint]({{book.path.docs}}/start/blueprints.md)**. {% endif %}
