Use relative links from docs root for all internal links
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/260fb279 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/260fb279 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/260fb279 Branch: refs/heads/master Commit: 260fb279629f8b493728d81bd373681f5f08cd9a Parents: 584c34c Author: Thomas Bouron <[email protected]> Authored: Wed Oct 25 11:34:08 2017 +0100 Committer: Thomas Bouron <[email protected]> Committed: Wed Oct 25 11:34:08 2017 +0100 ---------------------------------------------------------------------- book.json | 3 +++ guide/blueprints/blueprinting-tips.md | 8 +++---- guide/blueprints/catalog/bundle.md | 2 +- guide/blueprints/catalog/schema.md | 2 +- guide/blueprints/clusters-and-policies.md | 2 +- guide/blueprints/config-files.md | 2 +- guide/blueprints/configuring-vms.md | 4 ++-- guide/blueprints/creating-yaml.md | 12 +++++----- guide/blueprints/custom-entities.md | 2 +- guide/blueprints/effectors.md | 2 +- guide/blueprints/entity-configuration.md | 2 +- guide/blueprints/java/archetype.md | 2 +- guide/blueprints/java/bundle-dependencies.md | 4 ++-- guide/blueprints/java/defining-and-deploying.md | 14 ++++++------ guide/blueprints/java/entitlements.md | 2 +- guide/blueprints/java/entity.md | 12 +++++----- guide/blueprints/java/topology-dependencies.md | 2 +- guide/blueprints/multiple-services.md | 2 +- guide/blueprints/policies.md | 4 ++-- guide/blueprints/setting-locations.md | 8 +++---- guide/blueprints/test/usage-examples.md | 4 ++-- guide/blueprints/winrm/client.md | 2 +- guide/blueprints/winrm/index.md | 8 +++---- guide/blueprints/yaml-reference.md | 4 ++-- guide/dev/env/maven-build.md | 4 ++-- guide/dev/tips/debugging-remote-brooklyn.md | 6 ++--- guide/dev/tips/index.md | 4 ++-- guide/dev/tips/logging.md | 2 +- guide/locations/_AWS.md | 2 +- guide/locations/_GCE.md | 2 +- guide/locations/_byon.md | 2 +- guide/locations/_clouds.md | 4 ++-- guide/locations/_cloudstack.md | 2 +- guide/locations/_ibm-softlayer.md | 2 +- guide/locations/_localhost.md | 2 +- .../_location-customizer-security-groups.md | 2 +- guide/locations/_location-customizers.md | 2 +- guide/locations/_openstack.md | 2 +- guide/locations/_ssh-keys.md | 2 +- guide/locations/cloud-credentials.md | 2 +- guide/locations/index.md | 12 +++++----- guide/misc/download.md | 4 ++-- guide/ops/cli/cli-usage-guide.md | 2 +- guide/ops/cli/index.md | 2 +- guide/ops/configuration/brooklyn_cfg.md | 8 +++---- guide/ops/configuration/cors.md | 4 ++-- guide/ops/configuration/https.md | 2 +- guide/ops/configuration/index.md | 10 ++++---- guide/ops/gui/blueprints.md | 6 ++--- guide/ops/gui/managing.md | 2 +- guide/ops/gui/policies.md | 2 +- guide/ops/gui/running.md | 10 ++++---- .../high-availability-supplemental.md | 12 +++++----- guide/ops/high-availability/index.md | 2 +- guide/ops/logging.md | 4 ++-- guide/ops/persistence/index.md | 8 +++---- guide/ops/production-installation.md | 20 ++++++++-------- guide/ops/requirements.md | 12 +++++----- guide/ops/server-cli-reference.md | 10 ++++---- guide/ops/starting-stopping-monitoring.md | 8 +++---- guide/ops/troubleshooting/deployment.md | 2 +- .../troubleshooting/detailed-support-report.md | 4 ++-- .../going-deep-in-java-and-logs.md | 2 +- guide/ops/troubleshooting/overview.md | 2 +- guide/ops/troubleshooting/slow-unresponsive.md | 12 +++++----- guide/ops/troubleshooting/softwareprocess.md | 2 +- guide/ops/upgrade.md | 24 ++++++++++---------- guide/start/blueprints.md | 12 +++++----- guide/start/concept-quickstart.md | 2 +- guide/start/managing.md | 6 ++--- guide/start/running.md | 16 ++++++------- 71 files changed, 189 insertions(+), 186 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/book.json ---------------------------------------------------------------------- diff --git a/book.json b/book.json index 997a992..d44f9e5 100644 --- a/book.json +++ b/book.json @@ -102,6 +102,9 @@ "brooklyn_website": "https://brooklyn.apache.org";, "brooklyn_javadoc": "https://brooklyn.apache.org/v/latest/misc/javadoc"; }, + "path": { + "docs": "" + }, "url_root": "http://0.0.0.0:4000"; } } http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/blueprinting-tips.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/blueprinting-tips.md b/guide/blueprints/blueprinting-tips.md index 9d07349..260e091 100644 --- a/guide/blueprints/blueprinting-tips.md +++ b/guide/blueprints/blueprinting-tips.md @@ -37,11 +37,11 @@ Options for speeding up provisioning include those below. #### Deploying to Bring Your Own Nodes (BYON) -A [BYON location](../locations/index.md#byon) can be defined, which avoids the time +A [BYON location]({{book.path.docs}}/locations/index.md#byon) can be defined, which avoids the time required to provision VMs. This is fast, but has the downside that artifacts installed during a previous run can interfere with subsequent runs. -A variant of this is to [use Vagrant](../start/running.md) (e.g. with VirtualBox) +A variant of this is to [use Vagrant]({{book.path.docs}}/start/running.md) (e.g. with VirtualBox) to create VMs on your local machine, and to use these as the target for a BYON location. These VMs should mirror the target environment as much as possible. @@ -113,7 +113,7 @@ real thing. ## Writing Entity Tests -Use the [test framework](test/index.md) to write test cases. This will make +Use the [test framework]({{book.path.docs}}/blueprints/test/index.md) to write test cases. This will make automated (regression) testing easier, and will allow others to easily confirm that the entity works in their environment. @@ -180,4 +180,4 @@ below may also be of help: ALWAYS keep logs when there is an error. -See the [Troubleshooting](../ops/troubleshooting/index.md) guide for more information. +See the [Troubleshooting]({{book.path.docs}}/ops/troubleshooting/index.md) guide for more information. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/catalog/bundle.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/catalog/bundle.md b/guide/blueprints/catalog/bundle.md index 30a821e..af9e4e3 100644 --- a/guide/blueprints/catalog/bundle.md +++ b/guide/blueprints/catalog/bundle.md @@ -14,7 +14,7 @@ uploaded bundles so that they are available after a restart or on HA failover. The bundle must be a ZIP file including a `catalog.bom` in the root. (The `br` CLI will create a ZIP from a local folder, for convenience.) The `catalog.bom` must declare a `bundle` identifier and a `version`, -following Brooklyn's [versioning](versioning.md) rules. +following Brooklyn's [versioning]({{book.path.docs}}/blueprints/catalog/versioning.md) rules. Brooklyn will keep track of that bundle, allowing items to be added and removed as a group, and associated resources to be versioned and included alongside them. With SNAPSHOT-version bundles, it allows replacement of multiple related items at the same time, http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/catalog/schema.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/catalog/schema.md b/guide/blueprints/catalog/schema.md index 82c2496..c005ccb 100644 --- a/guide/blueprints/catalog/schema.md +++ b/guide/blueprints/catalog/schema.md @@ -223,7 +223,7 @@ The items this will add to the catalog are: #### Locations in the Catalog -In addition to blueprints, locations can be added to the Apache Brooklyn catalog. The example below shows a location for the vagrant configuration used in the [getting started guide](../../start/blueprints.md), formatted as a catalog entry. +In addition to blueprints, locations can be added to the Apache Brooklyn catalog. The example below shows a location for the vagrant configuration used in the [getting started guide]({{book.path.docs}}/start/blueprints.md), formatted as a catalog entry. ~~~ yaml brooklyn.catalog: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/clusters-and-policies.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/clusters-and-policies.md b/guide/blueprints/clusters-and-policies.md index df9d880..029f2b7 100644 --- a/guide/blueprints/clusters-and-policies.md +++ b/guide/blueprints/clusters-and-policies.md @@ -15,7 +15,7 @@ deployment of our `hello-world-sql` application as follows: This sets up Nginx as the controller by default, but that can be configured using the `controllerSpec` key. -This uses the same [externalized config](../ops/externalized-configuration.md) +This uses the same [externalized config]({{book.path.docs}}/ops/externalized-configuration.md) as in other examples to hide the password. JBoss is actually the default appserver in the `ControlledDynamicWebAppCluster`, http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/config-files.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/config-files.md b/guide/blueprints/config-files.md index e17f64c..dfbd031 100644 --- a/guide/blueprints/config-files.md +++ b/guide/blueprints/config-files.md @@ -23,7 +23,7 @@ connection details of another entity). Available substitutions are: | `${attribute['key']}` | Equivalent to `entity.sensors().get(key)` | | `${mgmt['key']}` | Loads the value for `key` from the management context's properties | | `${entity.foo}` | FreeMarker calls `getFoo` on the entity | -| `${driver.foo}` | FreeMarker calls `getFoo` on the entity's [driver](java/entity.md#things-to-know) | +| `${driver.foo}` | FreeMarker calls `getFoo` on the entity's [driver]({{book.path.docs}}/blueprints/java/entity.md#things-to-know) | | `${location.foo}` | FreeMarker calls `getFoo` on the entity's location | | `${javaSysProps.foo.bar}` | Loads the system property named `foo.bar` | http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/configuring-vms.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/configuring-vms.md b/guide/blueprints/configuring-vms.md index 607f9d1..4c8c4f8 100644 --- a/guide/blueprints/configuring-vms.md +++ b/guide/blueprints/configuring-vms.md @@ -14,7 +14,7 @@ ignored if deploying to `localhost` or `byon` fixed-IP machines.* This will create a VM with the specified parameters in your choice of cloud. In the GUI (and in the REST API), the entity is called "VM", -and the hostname and IP address(es) are reported as [sensors](../concepts/entities.md). +and the hostname and IP address(es) are reported as [sensors]({{book.path.docs}}/concepts/entities.md). There are many more `provisioning.properties` supported here, including: @@ -24,4 +24,4 @@ including: * `machineCreateAttempts` (for dodgy clouds, and they nearly all fail occasionally!) * and things like `imageId` and `userMetadata` and disk and networking options (e.g. `autoAssignFloatingIp` for private clouds) -For more information, see [Operations: Locations](../locations/index.md). +For more information, see [Operations: Locations]({{book.path.docs}}/locations/index.md). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/creating-yaml.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/creating-yaml.md b/guide/blueprints/creating-yaml.md index f95ea13..9b97f06 100644 --- a/guide/blueprints/creating-yaml.md +++ b/guide/blueprints/creating-yaml.md @@ -8,7 +8,7 @@ title: The Basic Structure The easiest way to write a blueprint is as a YAML file. This follows the <a href="https://www.oasis-open.org/committees/camp/";>OASIS CAMP</a> plan specification, with some extensions described below. -(A [YAML reference](yaml-reference.md) has more information, +(A [YAML reference]({{book.path.docs}}/blueprints/yaml-reference.md) has more information, and if the YAML doesn't yet do what you want, it's easy to add new extensions using your favorite JVM language.) @@ -21,19 +21,19 @@ Here's a very simple YAML blueprint plan, to explain the structure: * The `name` is just for the benefit of us humans. * The `location` specifies where this should be deployed. - If you've [set up passwordless localhost SSH access](../locations/index.md#localhost) + If you've [set up passwordless localhost SSH access]({{book.path.docs}}/locations/index.md#localhost) you can use `localhost` as above, but if not, just wait ten seconds for the next example. * The `services` block takes a list of the typed services we want to deploy. This is the meat of the blueprint plan, as you'll see below. Finally, the clipboard in the top-right corner of the example plan box above (hover your cursor over the box) lets you easily copy-and-paste into the web-console: -simply [download and launch](../start/running.md) Brooklyn, +simply [download and launch]({{book.path.docs}}/start/running.md) Brooklyn, then in the "Create Application" dialog at the web console (usually [http://127.0.0.1:8081/](http://127.0.0.1:8081/), paste the copied YAML into the "Yaml" tab of the dialog and press "Finish". There are several other ways to deploy, including `curl` and via the command-line, and you can configure users, https, persistence, and more, -as described [in the ops guide](../ops/index.md). +as described [in the ops guide]({{book.path.docs}}/ops/index.md). [](web-console-yaml.png) @@ -60,8 +60,8 @@ Brooklyn lived as a Java framework for many years before we felt confident to make a declarative front-end, so you can do pretty much anything you want to by dropping to the JVM. For more information on Java: -* start with a [Maven archetype](java/archetype.md) -* see all [Brooklyn Java guide](java/index.md) topics +* start with a [Maven archetype]({{book.path.docs}}/blueprints/java/archetype.md) +* see all [Brooklyn Java guide]({{book.path.docs}}/blueprints/java/index.md) topics * look at test cases in the [codebase](https://github.com/apache/brooklyn) You can also come talk to us, on IRC (#brooklyncentral on Freenode) or http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/custom-entities.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/custom-entities.md b/guide/blueprints/custom-entities.md index 8edc295..8966418 100644 --- a/guide/blueprints/custom-entities.md +++ b/guide/blueprints/custom-entities.md @@ -262,7 +262,7 @@ command over ssh every 5 seconds. This can be very CPU intensive when there are is to disable the ssh-polling (by setting `sshMonitoring.enabled: false`) and to configure a different health-check. -See documentation on the [Entity's error status](../ops/troubleshooting/overview.md#entitys-error-status) +See documentation on the [Entity's error status]({{book.path.docs}}/ops/troubleshooting/overview.md#entitys-error-status) for how Brooklyn models an entity's health. In the snippet below, we'll define a new health-check sensor (via http polling), and will automatically add this http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/effectors.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/effectors.md b/guide/blueprints/effectors.md index af83a34..c2a26ba 100644 --- a/guide/blueprints/effectors.md +++ b/guide/blueprints/effectors.md @@ -4,7 +4,7 @@ title: Effectors # {{ page.title }} Effectors perform an operation of some kind, carried out by a Brooklyn Entity. -They can be manually invoked or triggered by a [Policy](policies.md). +They can be manually invoked or triggered by a [Policy]({{book.path.docs}}/blueprints/policies.md). Common uses of an effector include the following: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/entity-configuration.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/entity-configuration.md b/guide/blueprints/entity-configuration.md index 62b9b3d..b33ed0a 100644 --- a/guide/blueprints/entity-configuration.md +++ b/guide/blueprints/entity-configuration.md @@ -74,7 +74,7 @@ services: - type: entity-config-example ``` -For details of how to write and add catalog items, see [Catalog](catalog/index.md). +For details of how to write and add catalog items, see [Catalog]({{book.path.docs}}/blueprints/catalog/index.md). #### Config Key Constraints http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/java/archetype.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/archetype.md b/guide/blueprints/java/archetype.md index 4e30c3a..076daba 100644 --- a/guide/blueprints/java/archetype.md +++ b/guide/blueprints/java/archetype.md @@ -57,7 +57,7 @@ $ mvn clean install #### Adding to the Catalog The build will produce an OSGi bundle in `target/autobrick-0.1.0-SNAPSHOT.jar`, suitable for -use in the [Brooklyn catalog](../catalog/index.md) (using `brooklyn.libraries`). +use in the [Brooklyn catalog]({{book.path.docs}}/blueprints/catalog/index.md) (using `brooklyn.libraries`). To use this in your Brooklyn catalog you will first have to copy the target jar to a suitable location. For developing/testing purposes storing on the local filesystem is fine. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/java/bundle-dependencies.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/bundle-dependencies.md b/guide/blueprints/java/bundle-dependencies.md index 869ac8c..4aa0008 100644 --- a/guide/blueprints/java/bundle-dependencies.md +++ b/guide/blueprints/java/bundle-dependencies.md @@ -28,7 +28,7 @@ is a convenient way of building OSGi bundles. #### OSGi Bundles Declared in Catalog Items -Within a [catalog item](../catalog/index.md), a list of URLs can be supplied under +Within a [catalog item]({{book.path.docs}}/blueprints/catalog/index.md), a list of URLs can be supplied under `brooklyn.libraries`. Each URL should point to an OSGi bundle. This list should include the OSGi bundle that has the Java code for your blueprint, and also the OSGi bundles that it depends on (including all transitive dependencies). @@ -37,7 +37,7 @@ It is vital that these jars are built correctly as OSGi bundles, and that all tr dependencies are included. The bundles will be added to Karaf in the order given, so a bundle's dependencies should be listed before the bundle(s) that depend on them. -In the [GistGenerator example](defining-and-deploying.md), the +In the [GistGenerator example]({{book.path.docs}}/blueprints/java/defining-and-deploying.md), the [catalog.bom file](gist_generator/gist_generator.bom) included the URL of the dependency `org.eclipse.egit.github.core`. It also (before that line) included its transitive dependency, which is a specific version of `gson`. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/java/defining-and-deploying.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/defining-and-deploying.md b/guide/blueprints/java/defining-and-deploying.md index 45f7038..0c989c0 100644 --- a/guide/blueprints/java/defining-and-deploying.md +++ b/guide/blueprints/java/defining-and-deploying.md @@ -13,8 +13,8 @@ with an effector to create new gists. ## Project Setup -Follow the instructions to create a new Java project using the [archetype](archetype.md), and -import it into your [favorite IDE](../../dev/env/ide/index.md). This example assumes you +Follow the instructions to create a new Java project using the [archetype]({{book.path.docs}}/blueprints/java/archetype.md), and +import it into your [favorite IDE]({{book.path.docs}}/dev/env/ide/index.md). This example assumes you used the groupId `com.acme` and artifact id `autobrick`. First ensure you can build this project at the command line, using `mvn clean install`. @@ -57,7 +57,7 @@ To describe each part of this: web-console. Note there is an alternative way of defining effectors - adding them to the entity dynamically, -discussed in the section [Dynamically Added Effectors](common-usage.md#dynamically-added-effectors). +discussed in the section [Dynamically Added Effectors]({{book.path.docs}}/blueprints/java/common-usage.md#dynamically-added-effectors). Next lets add the implementation. Create a new Java class named `GistGeneratorImpl`. @@ -113,7 +113,7 @@ inside `src/test/java`. Again you will need to substitute the github access token you generated in the previous section for the placeholder text `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`. See the section on -[externalised configuration](../../ops/externalized-configuration.md) +[externalised configuration]({{book.path.docs}}/ops/externalized-configuration.md) for how to store these credentials more securely. !CODEFILE "gist_generator/GistGeneratorYamlTest.java" @@ -138,7 +138,7 @@ artifact (which will be in the `target` sub-directory after running `mvn clean i !CODEFILE "gist_generator/gist_generator.bom" -See [Handling Bundle Dependencies](bundle-dependencies.md) +See [Handling Bundle Dependencies]({{book.path.docs}}/blueprints/java/bundle-dependencies.md) for a description of the `brooklyn.libraries` used above, and for other alternative approaches. The command below will use the `br` CLI to add this to the catalog of a running Brooklyn instance. @@ -162,5 +162,5 @@ The YAML blueprint below shows an example usage of this blueprint: Note the type name matches the id defined in the `.bom` file. -You can now call the effector by any of the standard means - [web console](../../ops/gui/index.md), -[REST api](../../ops/rest.md), or [Client CLI](../../ops/cli/index.md). +You can now call the effector by any of the standard means - [web console]({{book.path.docs}}/ops/gui/index.md), +[REST api]({{book.path.docs}}/ops/rest.md), or [Client CLI]({{book.path.docs}}/ops/cli/index.md). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/java/entitlements.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/entitlements.md b/guide/blueprints/java/entitlements.md index 858b5d7..50ee35e 100644 --- a/guide/blueprints/java/entitlements.md +++ b/guide/blueprints/java/entitlements.md @@ -35,7 +35,7 @@ which you can see [here]({{ book.brooklyn.url.git }}/core/src/test/java/org/apac and include in your project by adding the core tests JAR to your `dropins` folder. There are some entitlements schemes which exist out of the box, so for a simpler setup, -see [Operations: Entitlements](../../ops/configuration/brooklyn_cfg.md#entitlements). +see [Operations: Entitlements]({{book.path.docs}}/ops/configuration/brooklyn_cfg.md#entitlements). There are also more complex schemes which some users have developed, including LDAP extensions which re-use the LDAP authorization support in Brooklyn, http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/java/entity.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/entity.md b/guide/blueprints/java/entity.md index 15525e3..071e4f1 100644 --- a/guide/blueprints/java/entity.md +++ b/guide/blueprints/java/entity.md @@ -13,11 +13,11 @@ There are several ways to write a new entity: scripts. * For composite entities, use YAML to compose exiting types of entities (potentially overwriting parts of their configuration), and wire them together. -* Use **[Chef recipes](../chef/index.md)**. -* Use **[Salt formulas](../salt/index.md)**. -* Use **[Ansible playbooks](../ansible/index.md)**. +* Use **[Chef recipes]({{book.path.docs}}/blueprints/chef/index.md)**. +* Use **[Salt formulas]({{book.path.docs}}/blueprints/salt/index.md)**. +* Use **[Ansible playbooks]({{book.path.docs}}/blueprints/ansible/index.md)**. * Write pure-java, extending existing base-classes. For example, the `GistGenerator` - [example](defining-and-deploying.md). These can use utilities such as `HttpTool` and + [example]({{book.path.docs}}/blueprints/java/defining-and-deploying.md). These can use utilities such as `HttpTool` and `BashCommands`. * Write pure-Java blueprints that extend `SoftwareProcess`. However, the YAML approach is strongly recommended over this approach. @@ -99,6 +99,6 @@ hierarchy; it is suggested to avoid these, looking at the ones below instead): You might also find the following helpful: -* **[Entity Design Tips](../../dev/tips/index.md#EntityDesign)** -* The **[User Guide](../../)** +* **[Entity Design Tips]({{book.path.docs}}/dev/tips/index.md#EntityDesign)** +* The **[User Guide]({{book.path.docs}})** * The **[Mailing List](https://mail-archives.apache.org/mod_mbox/brooklyn-dev/)** http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/java/topology-dependencies.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/topology-dependencies.md b/guide/blueprints/java/topology-dependencies.md index 303c35b..841ba81 100644 --- a/guide/blueprints/java/topology-dependencies.md +++ b/guide/blueprints/java/topology-dependencies.md @@ -10,7 +10,7 @@ recommended. The example below creates a three tier web service, composed of an Nginx load-balancer, a cluster of Tomcat app-servers, and a MySQL database. It is similar to the [YAML policies -example](../../start/policies.md), but also includes the MySQL database +example]({{book.path.docs}}/start/policies.md), but also includes the MySQL database to demonstrate the use of dependent configuration. !CODEFILE "java_app/ExampleWebApp.java" http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/multiple-services.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/multiple-services.md b/guide/blueprints/multiple-services.md index 1eaf709..f52b48d 100644 --- a/guide/blueprints/multiple-services.md +++ b/guide/blueprints/multiple-services.md @@ -39,7 +39,7 @@ Here there are a few things going on: * We've injected the URL of the second service into the appserver as a Java system property (so our app knows where to find the database) * We've used externalized config to keep secret information out of the blueprint; - this is loaded at runtime from an [externalized config provider](../ops/externalized-configuration.md), + this is loaded at runtime from an [externalized config provider]({{book.path.docs}}/ops/externalized-configuration.md), such as a remote credentials store **Caution: Be careful if you write your YAML in an editor which attempts to put "smart-quotes" in. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/policies.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/policies.md b/guide/blueprints/policies.md index fd841fc..2c6e3c0 100644 --- a/guide/blueprints/policies.md +++ b/guide/blueprints/policies.md @@ -70,7 +70,7 @@ brooklyn.policies: ``` Typically this is used in conjunction with the FailureDetector enricher to emit the trigger sensor. -The [introduction to policies](../start/policies.md) shows a worked +The [introduction to policies]({{book.path.docs}}/start/policies.md) shows a worked example of these working together. @@ -80,7 +80,7 @@ example of these working together. The ServiceReplacer attaches to a DynamicCluster and replaces a failed member in response to `ha.entityFailed` (or other configurable sensor). -The [introduction to policies](../start/policies.md) shows a worked +The [introduction to policies]({{book.path.docs}}/start/policies.md) shows a worked example of this policy in use. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/setting-locations.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/setting-locations.md b/guide/blueprints/setting-locations.md index 9439ee7..0f985d3 100644 --- a/guide/blueprints/setting-locations.md +++ b/guide/blueprints/setting-locations.md @@ -5,7 +5,7 @@ title: Setting Locations Brooklyn supports a very wide range of target locations. With deep integration to [Apache jclouds](https://jclouds.apache.org), most well-known clouds -and cloud platforms are supported. See the [Locations guide](../locations/index.md) +and cloud platforms are supported. See the [Locations guide]({{book.path.docs}}/locations/index.md) for details and more examples. ### Cloud Example @@ -100,14 +100,14 @@ The examples above have given all the location details within the application bl It is also possible (and indeed preferred) to add the location definitions to the catalog so that they can be referenced by name in any blueprint. -For more information see the [Operations: Catalog](catalog/index.md) section of +For more information see the [Operations: Catalog]({{book.path.docs}}/blueprints/catalog/index.md) section of the User Guide. ### Externalized Configuration For simplicity, the examples above have included the cloud credentials. For a production system, -it is strongly recommended to use [Externalized Configuration](../ops/externalized-configuration.md) +it is strongly recommended to use [Externalized Configuration]({{book.path.docs}}/ops/externalized-configuration.md) to retrieve the credentials from a secure credentials store, such as [Vault](https://www.vaultproject.io). @@ -115,5 +115,5 @@ to retrieve the credentials from a secure credentials store, such as [Vault](htt An entity that represents a "software process" can use the configuration option `provisioning.properties` to augment the location's configuration. For more information, see -[Entity Configuration](../blueprints/entity-configuration.md#entity-provisioningproperties-overriding-and-merging) +[Entity Configuration]({{book.path.docs}}/blueprints/entity-configuration.md#entity-provisioningproperties-overriding-and-merging) details. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/test/usage-examples.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/test/usage-examples.md b/guide/blueprints/test/usage-examples.md index 90132aa..6e06c33 100644 --- a/guide/blueprints/test/usage-examples.md +++ b/guide/blueprints/test/usage-examples.md @@ -4,7 +4,7 @@ title: Example Blueprint Tests # {{ page.title }} ## Introduction -This section describes some simple tests based on the [Getting Started](../../start/blueprints.md#launching-from-a-blueprint) example blueprint: +This section describes some simple tests based on the [Getting Started]({{book.path.docs}}/start/blueprints.md#launching-from-a-blueprint) example blueprint: !CODEFILE "../../start/_my-web-cluster.yaml" @@ -42,6 +42,6 @@ This `TestEffector` example demonstrates the use of the `TestCase` and `TestSens ### Full Example A sample blueprint containing all the tests described above is available [here](./example_yaml/testcases/getting-started-test-example.yaml). -This blueprint will deploy the [Getting Started](../../start/blueprints.md#launching-from-a-blueprint) application and run all of the test entities, which if successful should appear in the web console as follows. +This blueprint will deploy the [Getting Started]({{book.path.docs}}/start/blueprints.md#launching-from-a-blueprint) application and run all of the test entities, which if successful should appear in the web console as follows. [](images/getting-started-blueprint-test-large.png) http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/winrm/client.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/winrm/client.md b/guide/blueprints/winrm/client.md index 11b2376..cd3bf81 100644 --- a/guide/blueprints/winrm/client.md +++ b/guide/blueprints/winrm/client.md @@ -49,7 +49,7 @@ where Apache Brooklyn complains about failing to connect to the IP you should ch If the quick list above doesn't help then follow the steps bellow. To speed up diagnosing the problem we advice to trigger a deployment with the JcloudsLocation flag `destroyOnFailure: false` so you can check status of the provisioned machine -or try later different WinRM parameters with a Apache Brooklyn [BYON Location](../../locations/index.md#byon). +or try later different WinRM parameters with a Apache Brooklyn [BYON Location]({{book.path.docs}}/locations/index.md#byon). After you determined what is the username and the password you can proceed with next steps. *(Notice that for cloud providers which use Auto Generated password will not be logged. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/winrm/index.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/winrm/index.md b/guide/blueprints/winrm/index.md index d6d98f3..cc612d3 100644 --- a/guide/blueprints/winrm/index.md +++ b/guide/blueprints/winrm/index.md @@ -70,7 +70,7 @@ A Sample Blueprint Creating a Windows VM is done using the `org.apache.brooklyn.entity.software.base.VanillaWindowsProcess` entity type. This is very similar to `VanillaSoftwareProcess`, but adapted to work for Windows and WinRM instead of Linux. We suggest you read the -[documentation for VanillaSoftwareProcess](../custom-entities.md#vanilla-software-using-bash) to find out what you +[documentation for VanillaSoftwareProcess]({{book.path.docs}}/blueprints/custom-entities.md#vanilla-software-using-bash) to find out what you can do with this entity. Entity authors are strongly encouraged to write Windows Powershell or Batch scripts as separate @@ -127,7 +127,7 @@ Brooklyn source code]({{ book.brooklyn.url.git }}/software/database/src/main/res Tips and Tricks --------------- -The best practices for other entities (e.g. using [VanillaSoftwareProcess](../custom-entities.md#vanilla-software-using-bash)) +The best practices for other entities (e.g. using [VanillaSoftwareProcess]({{book.path.docs}}/blueprints/custom-entities.md#vanilla-software-using-bash)) apply for WinRM as well. ### Execution Phases @@ -277,7 +277,7 @@ Re-authentication also requires that the password credentials are passed in plai script. Please be aware that it is normal for script files - and therefore the plaintext password - to be saved to the VM's disk. The scripts are also accessible via the Brooklyn web-console's activity view. Access to the latter can be controlled via -[Entitlements](../java/entitlements.md). +[Entitlements]({{book.path.docs}}/blueprints/java/entitlements.md). As an example (taken from MSSQL install), the command below works when run locally, but fails over WinRM: @@ -361,7 +361,7 @@ on the Microsoft TechNet site. Troubleshooting --------------- -Much of the [operations troubleshooting guide](../../ops/troubleshooting/index.md) is applicable for Windows blueprints. +Much of the [operations troubleshooting guide]({{book.path.docs}}/ops/troubleshooting/index.md) is applicable for Windows blueprints. ### User metadata service requirement http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/blueprints/yaml-reference.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/yaml-reference.md b/guide/blueprints/yaml-reference.md index 815989e..0fad386 100644 --- a/guide/blueprints/yaml-reference.md +++ b/guide/blueprints/yaml-reference.md @@ -20,7 +20,7 @@ defining types: * `com.acme.brooklyn.package.JavaEntityClass` * `java:com.acme.brooklyn.package.JavaEntityClass` -* `java-entity-class` (where this has been added to the [catalog](catalog/index.md)) +* `java-entity-class` (where this has been added to the [catalog]({{book.path.docs}}/blueprints/catalog/index.md)) A reference of some of the common service `type` instances used is included in a section below. @@ -79,7 +79,7 @@ the entity being defined, with these being the most common: * `default`: a default value; this will be coerced to the declared `type` * `pinned`: mark the parameter as pinned (always displayed) for the UI. The default is `true` * `constraints`: a list of constraints the parameter should meet; - for details, see [Entity Configuration](entity-configuration.md#config-key-constraints). + for details, see [Entity Configuration]({{book.path.docs}}/blueprints/entity-configuration.md#config-key-constraints). A shorthand notation is also supported where just the name of the parameter is supplied as an item in the list, with the other values being unset or the default. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/dev/env/maven-build.md ---------------------------------------------------------------------- diff --git a/guide/dev/env/maven-build.md b/guide/dev/env/maven-build.md index 9321738..f1b9339 100644 --- a/guide/dev/env/maven-build.md +++ b/guide/dev/env/maven-build.md @@ -33,14 +33,14 @@ Other tips: `export MAVEN_OPTS="-Xmx1024m -Xms512m"` * Run `-PIntegration` to run integration tests, or `-PLive` to run live tests - ([tests described here](../code/tests.md)) + ([tests described here]({{book.path.docs}}/dev/code/tests.md)) * You may need to install `rpm` package to build RPM packages: `brew install rpm` for Mac OS, `apt-get install rpm` for Ubuntu, `yum install rpm` for Centos/RHEL. On Mac OS you may also need to set `%_tmppath /tmp` in `~/.rpmmacros`. * If you're looking at the maven internals, note that many of the settings are inherited from parent projects (see for instance `brooklyn-server/parent/pom.xml`) -* For tips on building within various IDEs, look [here](ide/index.md). +* For tips on building within various IDEs, look [here]({{book.path.docs}}/dev/env/ide/index.md). ## When the RAT Bites http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/dev/tips/debugging-remote-brooklyn.md ---------------------------------------------------------------------- diff --git a/guide/dev/tips/debugging-remote-brooklyn.md b/guide/dev/tips/debugging-remote-brooklyn.md index 557042e..a5a256b 100644 --- a/guide/dev/tips/debugging-remote-brooklyn.md +++ b/guide/dev/tips/debugging-remote-brooklyn.md @@ -3,7 +3,7 @@ title: Brooklyn Remote Debugging --- # {{ page.title }} -Usually during development, you will be running Brooklyn from your IDE (see [IDE Setup](../env/ide/index.md)), in which case +Usually during development, you will be running Brooklyn from your IDE (see [IDE Setup]({{book.path.docs}}/dev/env/ide/index.md)), in which case debugging is as simple as setting a breakpoint. There may however be times when you need to debug an existing remote Brooklyn instance (often referred to as Resident Brooklyn, or rBrooklyn) on another machine, usually in the cloud. @@ -103,7 +103,7 @@ IntelliJ, and have been tested with Eclipse Luna and IntelliJ Ultimate 14. ### Eclipse Setup -To debug using Eclipse, first open the Brooklyn project in Eclipse (see [IDE Setup](../env/ide/index.md)). +To debug using Eclipse, first open the Brooklyn project in Eclipse (see [IDE Setup]({{book.path.docs}}/dev/env/ide/index.md)). Now create a debug configuration by clicking `Run` | `Debug Configurations...`. You will then be presented with the Debug Configuration dialog. @@ -115,7 +115,7 @@ and the Port should be set to 8888. Click 'Debug' to start debugging. ### IntelliJ Setup -To debug using IntelliJ, first open the Brooklyn project in IntelliJ (see [IDE Setup](../env/ide/index.md)). +To debug using IntelliJ, first open the Brooklyn project in IntelliJ (see [IDE Setup]({{book.path.docs}}/dev/env/ide/index.md)). Now create a debug configuration by clicking `Run` | `Edit Configurations`. You will then be presented with the Run/Debug Configurations dialog. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/dev/tips/index.md ---------------------------------------------------------------------- diff --git a/guide/dev/tips/index.md b/guide/dev/tips/index.md index e1e28e2..2e94140 100644 --- a/guide/dev/tips/index.md +++ b/guide/dev/tips/index.md @@ -10,9 +10,9 @@ title: Miscellaneous Tips and Tricks This means we can accept pulls more easily (as sandbox items aren't built as part of the main build) and speed up collaboration. -* When debugging an entity, make sure the [brooklyn.SSH logger](logging.md) is set to DEBUG and accessible. +* When debugging an entity, make sure the [brooklyn.SSH logger]({{book.path.docs}}/dev/tips/logging.md) is set to DEBUG and accessible. -* Use tests heavily! These are pretty good to run in the IDE (once you've completed [IDE setup](../env/ide/index.md)), +* Use tests heavily! These are pretty good to run in the IDE (once you've completed [IDE setup]({{book.path.docs}}/dev/env/ide/index.md)), and far quicker to spot problems than runtime, plus we get early-warning of problems introduced in the future. (In particular, Groovy's laxity with compilation means it is easy to introduce silly errors which good test coverage will find much faster.) http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/dev/tips/logging.md ---------------------------------------------------------------------- diff --git a/guide/dev/tips/logging.md b/guide/dev/tips/logging.md index 612b89b..61b2ad6 100644 --- a/guide/dev/tips/logging.md +++ b/guide/dev/tips/logging.md @@ -16,7 +16,7 @@ if you prefer one of those. While developing it may be useful to change logging level of some of the Apache Brooklyn modules. The easiest way to do that is via the karaf console which can be started by `bin/client`. -(Details regarding using [Apache Brooklyn Karaf console](../../blueprints/java/bundle-dependencies.md#karaf-console)) +(Details regarding using [Apache Brooklyn Karaf console]({{book.path.docs}}/blueprints/java/bundle-dependencies.md#karaf-console)) For example if you would like to inspect jclouds API calls, enable jclouds.wire logging just enable it from karaf client. log:set DEBUG jclouds.wire http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_AWS.md ---------------------------------------------------------------------- diff --git a/guide/locations/_AWS.md b/guide/locations/_AWS.md index ab01718..16cb88d 100644 --- a/guide/locations/_AWS.md +++ b/guide/locations/_AWS.md @@ -19,7 +19,7 @@ An example of the expected format is shown below: credential: abcdefghijklmnopqrstu+vwxyzabcdefghijklm Users are strongly recommended to use -[externalized configuration](../ops/externalized-configuration.md) for better +[externalized configuration]({{book.path.docs}}/ops/externalized-configuration.md) for better credential management, for example using [Vault](https://www.vaultproject.io/). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_GCE.md ---------------------------------------------------------------------- diff --git a/guide/locations/_GCE.md b/guide/locations/_GCE.md index 1f51877..af801ee 100644 --- a/guide/locations/_GCE.md +++ b/guide/locations/_GCE.md @@ -49,7 +49,7 @@ However, this can make it harder to setup and manage multiple Brooklyn servers ( when using high availability mode). Users are strongly recommended to use -[externalized configuration](../ops/externalized-configuration.md) for better +[externalized configuration]({{book.path.docs}}/ops/externalized-configuration.md) for better credential management, for example using [Vault](https://www.vaultproject.io/). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_byon.md ---------------------------------------------------------------------- diff --git a/guide/locations/_byon.md b/guide/locations/_byon.md index fa051a7..43820d6 100644 --- a/guide/locations/_byon.md +++ b/guide/locations/_byon.md @@ -42,7 +42,7 @@ brooklyn.location.named.On-Prem\ Iron\ Example.privateKeyPassphrase=s3cr3tpassph ``` Alternatively, you can create a specific BYON location through the location wizard tool available within the web console. -This location will be saved as a [catalog entry](../blueprints/catalog/index.md#locations-in-catalog) for easy reusability. +This location will be saved as a [catalog entry]({{book.path.docs}}/blueprints/catalog/index.md#locations-in-catalog) for easy reusability. For more complex host configuration, one can define custom config values per machine. In the example below, there will be two machines. The first will be a machine reachable on http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_clouds.md ---------------------------------------------------------------------- diff --git a/guide/locations/_clouds.md b/guide/locations/_clouds.md index 42ffd3c..bdc62ce 100644 --- a/guide/locations/_clouds.md +++ b/guide/locations/_clouds.md @@ -21,7 +21,7 @@ location: ``` The above YAML can be embedded directly in blueprints, either at the root or on individual services. -If you prefer to keep the credentials separate, you can instead store them as a [catalog entry](../blueprints/catalog/index.md#locations-in-catalog) or set them in `brooklyn.properties` +If you prefer to keep the credentials separate, you can instead store them as a [catalog entry]({{book.path.docs}}/blueprints/catalog/index.md#locations-in-catalog) or set them in `brooklyn.properties` in the `jclouds.<provider>` namespace: ```bash @@ -33,7 +33,7 @@ And in this case you can reference the location in YAML with `location: jclouds: Alternatively, you can use the location wizard tool available within the web console to create any cloud location supported by <a href="http://jclouds.org";>Apache jclouds</a>. -This location will be saved as a [catalog entry](../blueprints/catalog/index.md#locations-in-catalog) for easy reusability. +This location will be saved as a [catalog entry]({{book.path.docs}}/blueprints/catalog/index.md#locations-in-catalog) for easy reusability. Brooklyn irons out many of the differences between clouds so that blueprints run similarly in a wide range of locations, including setting up access and configuring images and machine specs. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_cloudstack.md ---------------------------------------------------------------------- diff --git a/guide/locations/_cloudstack.md b/guide/locations/_cloudstack.md index c88a113..1a2e8f9 100644 --- a/guide/locations/_cloudstack.md +++ b/guide/locations/_cloudstack.md @@ -14,7 +14,7 @@ the CloudStack gui: under accounts, select "view users", then "generate key". credential: mycred-abcdefghijklmnopqrstuvwxyz01234567890-abcdefghijklmnopqrstuvwxyz01234567890-abc Users are strongly recommended to use -[externalized configuration](../ops/externalized-configuration.md) for better +[externalized configuration]({{book.path.docs}}/ops/externalized-configuration.md) for better credential management, for example using [Vault](https://www.vaultproject.io/). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_ibm-softlayer.md ---------------------------------------------------------------------- diff --git a/guide/locations/_ibm-softlayer.md b/guide/locations/_ibm-softlayer.md index 4edccd1..e0a84c3 100644 --- a/guide/locations/_ibm-softlayer.md +++ b/guide/locations/_ibm-softlayer.md @@ -13,7 +13,7 @@ For example: credential: 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef Users are strongly recommended to use -[externalized configuration](../ops/externalized-configuration.md) for better +[externalized configuration]({{book.path.docs}}/ops/externalized-configuration.md) for better credential management, for example using [Vault](https://www.vaultproject.io/). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_localhost.md ---------------------------------------------------------------------- diff --git a/guide/locations/_localhost.md b/guide/locations/_localhost.md index 4b90467..bafab8c 100644 --- a/guide/locations/_localhost.md +++ b/guide/locations/_localhost.md @@ -13,7 +13,7 @@ If you use a passphrase or prefer a different key, these can be configured as fo Alternatively, you can create a specific localhost location through the location wizard tool available within the web console. -This location will be saved as a [catalog entry](../blueprints/catalog/index.md#locations-in-the-catalog) +This location will be saved as a [catalog entry]({{book.path.docs}}/blueprints/catalog/index.md#locations-in-the-catalog) for easy reusability. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_location-customizer-security-groups.md ---------------------------------------------------------------------- diff --git a/guide/locations/_location-customizer-security-groups.md b/guide/locations/_location-customizer-security-groups.md index caf0de3..bfca929 100644 --- a/guide/locations/_location-customizer-security-groups.md +++ b/guide/locations/_location-customizer-security-groups.md @@ -1,6 +1,6 @@ ## Customizing Cloud Security Groups -Before using SharedLocationSecurityGroupCustomizer, please first refer to [Port Inferencing](../blueprints/custom-entities.md#port-inferencing). +Before using SharedLocationSecurityGroupCustomizer, please first refer to [Port Inferencing]({{book.path.docs}}/blueprints/custom-entities.md#port-inferencing). A security group is a named collection of network access rules that are use to limit the types of traffic that have access to instances.<br> Security group is the standard way to set firewall restrictions on the AWS-EC2 environment. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_location-customizers.md ---------------------------------------------------------------------- diff --git a/guide/locations/_location-customizers.md b/guide/locations/_location-customizers.md index cfa03d3..4de5dc0 100644 --- a/guide/locations/_location-customizers.md +++ b/guide/locations/_location-customizers.md @@ -3,7 +3,7 @@ Apache Brooklyn supports a number of ways to configure and customize locations. These include the `JcloudsLocationCustomizer`, which is for advanced customization of VM provisioning through jclouds. There is also a `MachineLocationCustomizer`, which allows customization of machines being obtained -from any kind of location (including [Bring Your Own Nodes](index.md#byon)). +from any kind of location (including [Bring Your Own Nodes]({{book.path.docs}}/locations/index.md#byon)). ### Usage Guidelines http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_openstack.md ---------------------------------------------------------------------- diff --git a/guide/locations/_openstack.md b/guide/locations/_openstack.md index 84c9f3d..fa5947b 100644 --- a/guide/locations/_openstack.md +++ b/guide/locations/_openstack.md @@ -24,7 +24,7 @@ as an openrc.sh file. It is usually available from API Access tab in "Access & S This file will normally contain the identity and credential. Users are strongly recommended to use -[externalized configuration](../ops/externalized-configuration.md) for better +[externalized configuration]({{book.path.docs}}/ops/externalized-configuration.md) for better credential management, for example using [Vault](https://www.vaultproject.io/). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/_ssh-keys.md ---------------------------------------------------------------------- diff --git a/guide/locations/_ssh-keys.md b/guide/locations/_ssh-keys.md index f4cacea..ef4091a 100644 --- a/guide/locations/_ssh-keys.md +++ b/guide/locations/_ssh-keys.md @@ -79,4 +79,4 @@ If this isn't the case, see below. if command-line `ssh` and `scp` work, but Brooklyn/java does not, check the versions enabled in Java and on both servers. * Missing entropy: creating and using ssh keys requires randomness available on the servers, - usually in `/dev/random`; see [here](../ops/troubleshooting/increase-entropy.md) for more information + usually in `/dev/random`; see [here]({{book.path.docs}}/ops/troubleshooting/increase-entropy.md) for more information http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/cloud-credentials.md ---------------------------------------------------------------------- diff --git a/guide/locations/cloud-credentials.md b/guide/locations/cloud-credentials.md index e037ef8..13fe543 100644 --- a/guide/locations/cloud-credentials.md +++ b/guide/locations/cloud-credentials.md @@ -2,4 +2,4 @@ title: More Clouds --- -This page has moved. See [More Clouds](index.md#more-details-on-specific-clouds) instead. +This page has moved. See [More Clouds]({{book.path.docs}}/locations/index.md#more-details-on-specific-clouds) instead. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/locations/index.md ---------------------------------------------------------------------- diff --git a/guide/locations/index.md b/guide/locations/index.md index 2c966c7..41a15ca 100644 --- a/guide/locations/index.md +++ b/guide/locations/index.md @@ -9,11 +9,11 @@ to a pre-provisioned network or to localhost (primarily useful for testing bluep See also: -* The [Locations yaml guide](../blueprints/setting-locations.md) +* The [Locations yaml guide]({{book.path.docs}}/blueprints/setting-locations.md) * Use within an entity of the configuration option - [provisioning.properties](../blueprints/entity-configuration.md#entity-provisioningproperties-overriding-and-merging) -* How to add location definitions to the [Catalog](../blueprints/catalog/index.md); and -* How to use [Externalized Configuration](../ops/externalized-configuration.md). + [provisioning.properties]({{book.path.docs}}/blueprints/entity-configuration.md#entity-provisioningproperties-overriding-and-merging) +* How to add location definitions to the [Catalog]({{book.path.docs}}/blueprints/catalog/index.md); and +* How to use [Externalized Configuration]({{book.path.docs}}/ops/externalized-configuration.md). The requirements for how a provisioned machine should behave will depend on the entites subsequently deployed there. @@ -23,7 +23,7 @@ could cause subsequent errors if they do not hold. These relate to the machine's configuration, rather than additional networking or security that a given Cloud might offer. -Also see the [Troubleshooting](../ops/troubleshooting/index.md) docs. +Also see the [Troubleshooting]({{book.path.docs}}/ops/troubleshooting/index.md) docs. ## Remote Access @@ -152,7 +152,7 @@ The result should be more than 1M. If not, consider setting `installDevUrandom: true` for jclouds-based locations. -See instructions to [Increase Entropy](../ops/troubleshooting/increase-entropy.md). +See instructions to [Increase Entropy]({{book.path.docs}}/ops/troubleshooting/increase-entropy.md). ## File System http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/misc/download.md ---------------------------------------------------------------------- diff --git a/guide/misc/download.md b/guide/misc/download.md index 93fe98b..3d1c82d 100644 --- a/guide/misc/download.md +++ b/guide/misc/download.md @@ -100,7 +100,7 @@ The latest stable release can be accessed on the [main download page]({{ book.ur ## Release Notes -Release notes can be found [here](release-notes.md). +Release notes can be found [here]({{book.path.docs}}/misc/release-notes.md). <a name="maven"></a> @@ -152,4 +152,4 @@ with this version in branch [{{ book.brooklyn.git_branch }}]({{ book.brooklyn.ur These locations have a `README.md` in the root which explains how to get the code including submodules. -Useful information on working with the source is [here](../dev/code). +Useful information on working with the source is [here]({{book.path.docs}}/dev/code/structure.md). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/cli/cli-usage-guide.md ---------------------------------------------------------------------- diff --git a/guide/ops/cli/cli-usage-guide.md b/guide/ops/cli/cli-usage-guide.md index 443c910..6031c15 100644 --- a/guide/ops/cli/cli-usage-guide.md +++ b/guide/ops/cli/cli-usage-guide.md @@ -429,7 +429,7 @@ tvZoNUTN ssh: launching NginxControllerImpl{id... Sun Dec 20 19:18:08 GMT 20 ``` ## YAML Blueprint -This is the YAML blueprint used for this document, based on the [web cluster](../../blueprints/clusters-and-policies.md) examples. +This is the YAML blueprint used for this document, based on the [web cluster]({{book.path.docs}}/blueprints/clusters-and-policies.md) examples. ```text name: WebCluster http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/cli/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/cli/index.md b/guide/ops/cli/index.md index 23a05db..0affab6 100644 --- a/guide/ops/cli/index.md +++ b/guide/ops/cli/index.md @@ -5,7 +5,7 @@ partial-summary-depth: 1 **NOTE:** These documents are for using the Brooklyn Client CLI tool to access a running Brooklyn Server. For -information on starting on a Brooklyn Server, refer to [Server CLI Reference](../server-cli-reference.md). +information on starting on a Brooklyn Server, refer to [Server CLI Reference]({{book.path.docs}}/ops/server-cli-reference.md). ## Obtaining the CLI tool http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/configuration/brooklyn_cfg.md ---------------------------------------------------------------------- diff --git a/guide/ops/configuration/brooklyn_cfg.md b/guide/ops/configuration/brooklyn_cfg.md index 442e4bd..d3efc1a 100644 --- a/guide/ops/configuration/brooklyn_cfg.md +++ b/guide/ops/configuration/brooklyn_cfg.md @@ -3,7 +3,7 @@ title: brooklyn.cfg --- # {{ page.title }} -The file `brooklyn.cfg` is read when Apache Brooklyn starts in order to load any server configuration values. It can be found in the Brooklyn configuration folder. You can check [here](../paths.md) for the location of your Brooklyn configuration folder +The file `brooklyn.cfg` is read when Apache Brooklyn starts in order to load any server configuration values. It can be found in the Brooklyn configuration folder. You can check [here]({{book.path.docs}}/ops/paths.md) for the location of your Brooklyn configuration folder ## Quick Setup @@ -37,7 +37,7 @@ More information, including setting up a certificate, is described [further belo Values in `brooklyn.cfg` can use the Camp YAML syntax. Any value starting `$brooklyn:` is parsed as a Camp YAML expression. -This allows [externalized configuration](../externalized-configuration.md) to be used from +This allows [externalized configuration]({{book.path.docs}}/ops/externalized-configuration.md) to be used from `brooklyn.cfg`. For example: ```properties @@ -181,7 +181,7 @@ brooklyn.entitlements.perUser.metrics=minimal ``` For more information, see -[Java: Entitlements](../../blueprints/java/entitlements.md). +[Java: Entitlements]({{book.path.docs}}/blueprints/java/entitlements.md). or [EntitlementManager]({{book.url.brooklyn_javadoc}}/org/apache/brooklyn/api/mgmt/entitlement/EntitlementManager.html). @@ -189,6 +189,6 @@ or ## HTTPS Configuration -See [HTTPS Configuration](https.md) for general information on configuring HTTPS. +See [HTTPS Configuration]({{book.path.docs}}/ops/configuration/https.md) for general information on configuring HTTPS. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/configuration/cors.md ---------------------------------------------------------------------- diff --git a/guide/ops/configuration/cors.md b/guide/ops/configuration/cors.md index 8946ae6..0b7a9e0 100644 --- a/guide/ops/configuration/cors.md +++ b/guide/ops/configuration/cors.md @@ -4,7 +4,7 @@ title: CORS Configuration # {{ page.title }} To enable / configure [cross-origin resource sharing (CORS)](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing). -The following file must be added to [`org.apache.brooklyn.rest.filter.cors.cfg`](../paths.md) +The following file must be added to [`org.apache.brooklyn.rest.filter.cors.cfg`]({{book.path.docs}}/ops/paths.md) ```properties # Enables experimental support for Cross Origin Resource Sharing (CORS) filtering in Apache Brooklyn REST API. @@ -40,6 +40,6 @@ cors.preflight.error.status=200 #cors.block.if.unauthorized=false ``` -*NOTE*: You must [restart Brooklyn](../starting-stopping-monitoring.md) for these changes to be applied +*NOTE*: You must [restart Brooklyn]({{book.path.docs}}/ops/starting-stopping-monitoring.md) for these changes to be applied Further information on client side [usage](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/configuration/https.md ---------------------------------------------------------------------- diff --git a/guide/ops/configuration/https.md b/guide/ops/configuration/https.md index 879eec5..d8f6b9b 100644 --- a/guide/ops/configuration/https.md +++ b/guide/ops/configuration/https.md @@ -46,7 +46,7 @@ and then convert it into a keystore `keystore.jks` as follows: ## HTTPS Configuration -In [`org.ops4j.pax.web.cfg`](../paths.md) in the Brooklyn distribution root, un-comment the settings: +In [`org.ops4j.pax.web.cfg`]({{book.path.docs}}/ops/paths.md) in the Brooklyn distribution root, un-comment the settings: ```properties org.osgi.service.http.port.secure=8443 http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/configuration/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/configuration/index.md b/guide/ops/configuration/index.md index e718fb2..36c73ac 100644 --- a/guide/ops/configuration/index.md +++ b/guide/ops/configuration/index.md @@ -6,9 +6,9 @@ partial-summary-depth: 1 Apache Brooklyn contains a number of configuration options managed across several files. Historically Brooklyn has been configured through a brooklyn.properties file, this changed -to a [brooklyn.cfg](brooklyn_cfg.md) file when the Karaf release became the default in Brooklyn 0.12.0. +to a [brooklyn.cfg]({{book.path.docs}}/ops/configuration/brooklyn_cfg.md) file when the Karaf release became the default in Brooklyn 0.12.0. -The configurations for [persistence](../persistence/index.md) and [high availability](../high-availability/index.md) are described +The configurations for [persistence]({{book.path.docs}}/ops/persistence/index.md) and [high availability]({{book.path.docs}}/ops/high-availability/index.md) are described elsewhere in this manual. Configuration of Apache Brooklyn when running under Karaf is largely done through standard Karaf mechanisms. @@ -63,15 +63,15 @@ groups which can be configured as detailed [here](https://karaf.apache.org/manua * Apache Brooklyn authentication -Users and passwords for Brooklyn can be configured in the brooklyn.cfg as detailed [here](brooklyn_cfg.md#authentication). +Users and passwords for Brooklyn can be configured in the brooklyn.cfg as detailed [here]({{book.path.docs}}/ops/configuration/brooklyn_cfg.md#authentication). ### HTTPS Configuration -See [HTTPS Configuration](https.md) for general information on configuring HTTPS. +See [HTTPS Configuration]({{book.path.docs}}/ops/configuration/https.md) for general information on configuring HTTPS. ## Catalog in Karaf With the traditional launcher, Brooklyn loads the initial contents of the catalog from a `default.catalog.bom` file -as described in the section on [installation](../production-installation.md). Brooklyn finds Java +as described in the section on [installation]({{book.path.docs}}/ops/production-installation.md). Brooklyn finds Java implementations to provide for certain things in blueprints (entities, enrichers etc.) by scanning the classpath. In the OSGI world this approach is not used, as each bundle only has visibility of its own and its imported Java packages. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/gui/blueprints.md ---------------------------------------------------------------------- diff --git a/guide/ops/gui/blueprints.md b/guide/ops/gui/blueprints.md index e99dca6..7d60286 100644 --- a/guide/ops/gui/blueprints.md +++ b/guide/ops/gui/blueprints.md @@ -32,7 +32,7 @@ location: credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l ``` -**NOTE**: See __[Locations](../../locations/index.md)__ in the Operations section of the User Guide for instructions on setting up alternate cloud providers, bring-your-own-nodes, or localhost targets, and storing credentials/locations in a file on disk rather than in the blueprint. +**NOTE**: See __[Locations]({{book.path.docs}}/locations/index.md)__ in the Operations section of the User Guide for instructions on setting up alternate cloud providers, bring-your-own-nodes, or localhost targets, and storing credentials/locations in a file on disk rather than in the blueprint. With the modified YAML in the dialog, click "Finish". The dialog will close and Brooklyn will begin deploying your application. Your application will be shown as "Starting" on the web console's front page. @@ -51,10 +51,10 @@ Instead of pasting the YAML blueprint each time, it can be added to the Brooklyn rather than extensively document default.catalog.bom. also need to include instructions on stopping (currently in help, including stopping apps) --> -See __[Catalog](../catalog/)__ in the Operations section of the User Guide for instructions on creating a new Catalog entry from your Blueprint YAML. +See __[Catalog]({{book.path.docs}}/blueprints/catalog/index.md)__ in the Operations section of the User Guide for instructions on creating a new Catalog entry from your Blueprint YAML. ## Next So far we have touched on Brooklyn's ability to *deploy* an application blueprint to a cloud provider. -The next section will show how to **[Monitor and Manage Applications](managing.md)**. +The next section will show how to **[Monitor and Manage Applications]({{book.path.docs}}/ops/gui/managing.md)**. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/gui/managing.md ---------------------------------------------------------------------- diff --git a/guide/ops/gui/managing.md b/guide/ops/gui/managing.md index 2a01dc6..f2f7e8c 100644 --- a/guide/ops/gui/managing.md +++ b/guide/ops/gui/managing.md @@ -65,4 +65,4 @@ To stop an application, select the application in the tree view (the top/root en ## Next -Brooklyn's real power is in using **[Policies](policies.md)** to automatically *manage* applications. +Brooklyn's real power is in using **[Policies]({{book.path.docs}}/ops/gui/policies.md)** to automatically *manage* applications. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/gui/policies.md ---------------------------------------------------------------------- diff --git a/guide/ops/gui/policies.md b/guide/ops/gui/policies.md index 2a3c262..8c6f5f3 100644 --- a/guide/ops/gui/policies.md +++ b/guide/ops/gui/policies.md @@ -42,5 +42,5 @@ targets changes. This guide has given a quick overview of using the Apache Brooklyn GUI to deploy, monitor and manage applications. The GUI also allows you to perform various Advanced management tasks and to explore and use the REST API (from the Script tab). Please take some time now to become more familiar with the GUI. -Then continue to read through the [Operations Guide](../rest.md). +Then continue to read through the [Operations Guide]({{book.path.docs}}/ops/rest.md). http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/gui/running.md ---------------------------------------------------------------------- diff --git a/guide/ops/gui/running.md b/guide/ops/gui/running.md index b63f847..f5281dc 100644 --- a/guide/ops/gui/running.md +++ b/guide/ops/gui/running.md @@ -5,7 +5,7 @@ title: Launching This guide will walk you through connecting to the Brooklyn Server Graphical User Interface and performing various tasks. -For an explanation of common Brooklyn Concepts see the [Brooklyn Concepts Quickstart](../../start/concept-quickstart.md) or see the full guide in the [Brooklyn Concepts](../../concepts/index.md) chapter of the [User Guide](../../). +For an explanation of common Brooklyn Concepts see the [Brooklyn Concepts Quickstart]({{book.path.docs}}/start/concept-quickstart.md) or see the full guide in the [Brooklyn Concepts](../../concepts/index.md) chapter of the [User Guide](../../). This guide assumes that you are using Linux or Mac OS X and that Brooklyn Server will be running on your local system. @@ -15,15 +15,15 @@ If you haven't already done so, you will need to start Brooklyn Server using the It is not necessary at this time, but depending on what you are going to do, you may wish to set up some other configuration options first, -* [Security](../configuration/brooklyn_cfg.md) -* [Persistence](../persistence/index.md) +* [Security]({{book.path.docs}}/ops/configuration/brooklyn_cfg.md) +* [Persistence]({{book.path.docs}}/ops/persistence/index.md) Now start Brooklyn with the following command: <pre><code class="lang-sh">$ cd apache-brooklyn-{{ book.brooklyn_version }} $ bin/brooklyn launch</code></pre> -Please refer to the [Server CLI Reference](../server-cli-reference.md) for details of other possible command line options. +Please refer to the [Server CLI Reference]({{book.path.docs}}/ops/server-cli-reference.md) for details of other possible command line options. Brooklyn will output the address of the management interface: @@ -47,5 +47,5 @@ No applications have been deployed yet, so the "Create Application" dialog opens {% if output.name == 'website' %} ## Next -The next section will show how to **[deploy a blueprint](blueprints.md)**. +The next section will show how to **[deploy a blueprint]({{book.path.docs}}/ops/gui/blueprints.md)**. {% endif %} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/high-availability/high-availability-supplemental.md ---------------------------------------------------------------------- diff --git a/guide/ops/high-availability/high-availability-supplemental.md b/guide/ops/high-availability/high-availability-supplemental.md index df0ba5b..5d01b58 100644 --- a/guide/ops/high-availability/high-availability-supplemental.md +++ b/guide/ops/high-availability/high-availability-supplemental.md @@ -3,7 +3,7 @@ title: Configuring HA - an example --- # {{ page.title }} -This supplements the [High Availability](index.md) documentation +This supplements the [High Availability]({{book.path.docs}}/ops/high-availability/index.md) documentation and provides an example of how to configure a pair of Apache Brooklyn servers to run in master-standby mode with a shared NFS datastore ### Prerequisites @@ -12,14 +12,14 @@ and provides an example of how to configure a pair of Apache Brooklyn servers to - An NFS folder has been mounted on both VMs at `/mnt/brooklyn-persistence` and both machines can write to the folder \* Brooklyn can be configured to use either an object store such as S3, or a shared NFS mount. The recommended option is to use an object -store as described in the [Object Store Persistence](../persistence/#object-store-persistence) documentation. For simplicity, a shared NFS folder +store as described in the [Object Store Persistence]({{book.path.docs}}/ops/persistence/#object-store-persistence) documentation. For simplicity, a shared NFS folder is assumed in this example ### Launching To start, download and install the latest Apache Brooklyn release on both VMs following the instructions in -[Running Apache Brooklyn](../../start/running.md) +[Running Apache Brooklyn]({{book.path.docs}}/start/running.md) -On the first VM, which will be the master node, set the following configuration options in [`org.apache.brooklyn.osgilauncher.cfg`](../paths.md): +On the first VM, which will be the master node, set the following configuration options in [`org.apache.brooklyn.osgilauncher.cfg`]({{book.path.docs}}/ops/paths.md): - highAvailabilityMode: MASTER - persistMode: AUTO @@ -31,10 +31,10 @@ Then launch Brooklyn with: $ bin/start ``` -If you are using RPMs/deb to install, please see the [Running Apache Brooklyn](../../start/running.md) +If you are using RPMs/deb to install, please see the [Running Apache Brooklyn]({{book.path.docs}}/start/running.md) documentation for the appropriate launch commands -Once Brooklyn has launched, on the second VM, set the following configuration options in [`org.apache.brooklyn.osgilauncher.cfg`](../paths.md): +Once Brooklyn has launched, on the second VM, set the following configuration options in [`org.apache.brooklyn.osgilauncher.cfg`]({{book.path.docs}}/ops/paths.md): - highAvailabilityMode: AUTO - persistMode: AUTO http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/high-availability/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/high-availability/index.md b/guide/ops/high-availability/index.md index dbf4ffb..c6b342d 100644 --- a/guide/ops/high-availability/index.md +++ b/guide/ops/high-availability/index.md @@ -26,7 +26,7 @@ Once one node is running as `MASTER`, other nodes start in either `STANDBY` or ` so it can safely be used to test compatibility across different versions. To explicitly specify what HA mode a node should be in, the following options are available -for the config option `highAvailabilityMode` in [`org.apache.brooklyn.osgilauncher.cfg`](../paths.md): +for the config option `highAvailabilityMode` in [`org.apache.brooklyn.osgilauncher.cfg`]({{book.path.docs}}/ops/paths.md): * `DISABLED`: management node works in isolation; it will not cooperate with any other standby/master nodes in management plane * `AUTO`: will look for other management nodes, and will allocate itself as standby or master based on other nodes' states http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/logging.md ---------------------------------------------------------------------- diff --git a/guide/ops/logging.md b/guide/ops/logging.md index c7c11de..b8072c2 100644 --- a/guide/ops/logging.md +++ b/guide/ops/logging.md @@ -21,7 +21,7 @@ Loggers follow the ``package.ClassName`` naming standard. In the OSGi based Apache Brooklyn logging is configured from ops4j pax logging. -See: [Logging - OSGi based Apache Brooklyn](../dev/tips/logging.md#osgi-based-apache-brooklyn) <br/> +See: [Logging - OSGi based Apache Brooklyn]({{book.path.docs}}/dev/tips/logging.md#osgi-based-apache-brooklyn) <br/> [https://ops4j1.jira.com/wiki/display/paxlogging/Configuration](https://ops4j1.jira.com/wiki/display/paxlogging/Configuration) @@ -76,5 +76,5 @@ which can then [feed its logs to Logstash](http://www.logstash.net/docs/1.4.2/in The following resources may be useful when configuring logging: * The [logback-includes]({{ book.brooklyn.url.git }}/usage/logback-includes) project -* [Brooklyn Developer Guide](../dev/tips/logging.md) logging tips +* [Brooklyn Developer Guide]({{book.path.docs}}/dev/tips/logging.md) logging tips * The [Logback Project](http://logback.qos.ch/) home page http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/persistence/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/persistence/index.md b/guide/ops/persistence/index.md index 5b6133f..7a05e34 100644 --- a/guide/ops/persistence/index.md +++ b/guide/ops/persistence/index.md @@ -23,7 +23,7 @@ directory of your Brooklyn instance. The following options are available: * `CLEAN` - will start up fresh (removing any existing state) `persistenceDir` - This is the directory to which Apache Brooklyn reads and writes its persistence data. The default location depends -on your installation method. Checkout [this page](../paths.md) for more information. +on your installation method. Checkout [this page]({{book.path.docs}}/ops/paths.md) for more information. `persistenceLocation` - This is the location for an object store to read and write persisted state. @@ -33,7 +33,7 @@ is carried out, for example `1s`. # File-based Persistence -Apache Brooklyn starts with file-based persistence by default, saving data in the [persisted state folder](../paths.md). +Apache Brooklyn starts with file-based persistence by default, saving data in the [persisted state folder]({{book.path.docs}}/ops/paths.md). For the rest of this document we will refer to this location as `%persistence-home%`. If there is already data at `%persistence-home%/data`, then a backup of the directory will @@ -99,7 +99,7 @@ any registered policies. ## Handling Rebind Failures If rebind fails fail for any reason, details of the underlying failures will be reported -in the [`brooklyn.debug.log`](../paths.md). This will include the entities, locations or policies which caused an issue, and in what +in the [`brooklyn.debug.log`]({{book.path.docs}}/ops/paths.md). This will include the entities, locations or policies which caused an issue, and in what way it failed. There are several approaches to resolving problems. 1) Determine Underlying Cause @@ -182,7 +182,7 @@ Behaviour on rebind: * By extending `SoftwareProcess`, entities get a lot of the rebind logic for free. For example, the default `rebind()` method will call `connectSensors()`. - See [`SoftwareProcess` Lifecycle](../../blueprints/java/entities.md) + See [`SoftwareProcess` Lifecycle]({{book.path.docs}}/blueprints/java/entities.md) for more details. * If necessary, implement rebind. The `entity.rebind()` is called automatically by the Brooklyn framework on rebind, after configuring the entity's config/attributes but before http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/production-installation.md ---------------------------------------------------------------------- diff --git a/guide/ops/production-installation.md b/guide/ops/production-installation.md index 53c7389..4bb02c0 100644 --- a/guide/ops/production-installation.md +++ b/guide/ops/production-installation.md @@ -14,24 +14,24 @@ To install Apache Brooklyn on a production server: This guide covers the basics. You may also wish to configure: -* [Logging](logging.md) -* [Persistence](persistence/index.md) -* [High availability](high-availability/index.md) +* [Logging]({{book.path.docs}}/ops/logging.md) +* [Persistence]({{book.path.docs}}/ops/persistence/index.md) +* [High availability]({{book.path.docs}}/ops/high-availability/index.md) ### Set up the Prerequisites -Check that the server meets the [requirements](requirements.md). +Check that the server meets the [requirements]({{book.path.docs}}/ops/requirements.md). Then configure the server as follows: * install Java JRE or JDK (version 8 or later) * enable "Java Cryptography Extension" (already enabled out of the box of OpenJDK installs) -* install an [SSH key](../locations/index.md#ssh-keys), if not available -* if the "localhost" location will be used, enable [passwordless ssh login](../locations/index.md#ssh-keys) +* install an [SSH key]({{book.path.docs}}/locations/index.md#ssh-keys), if not available +* if the "localhost" location will be used, enable [passwordless ssh login]({{book.path.docs}}/locations/index.md#ssh-keys) * create a `~/.brooklyn` directory on the host with `$ mkdir ~/.brooklyn` * check your `iptables` or other firewall service, making sure that incoming connections on port 8443 is not blocked -* check that the [linux kernel entropy](troubleshooting/increase-entropy.md) is sufficient -* check that the [ulimit values](troubleshooting/increase-system-resource-limits.md) are sufficiently high +* check that the [linux kernel entropy]({{book.path.docs}}/ops/troubleshooting/increase-entropy.md) is sufficient +* check that the [ulimit values]({{book.path.docs}}/ops/troubleshooting/increase-system-resource-limits.md) are sufficiently high * ensure external libraries are up-to-date, including `nss` for SSL. * ensure the time is continually accurate, ideally by running a service like the [ntp daemon](http://www.ntp.org/). @@ -63,7 +63,7 @@ Let's setup some paths for easy commands. ### Configuring brooklyn.cfg -Set up `brooklyn.cfg` as described [here](configuration/brooklyn_cfg.md): +Set up `brooklyn.cfg` as described [here]({{book.path.docs}}/ops/configuration/brooklyn_cfg.md): * Configure the users who should have access * Turn on HTTPS @@ -83,7 +83,7 @@ By default Brooklyn loads the catalog of available application components and se `default.catalog.bom` on the classpath. The initial catalog is in `conf/brooklyn/` in the dist. If you have a preferred catalog, simply replace that file. -[More information on the catalog is available here.](../blueprints/catalog/index.md) +[More information on the catalog is available here.]({{book.path.docs}}/blueprints/catalog/index.md) ### Confirm Installation http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/requirements.md ---------------------------------------------------------------------- diff --git a/guide/ops/requirements.md b/guide/ops/requirements.md index 336a1ad..aa0cadf 100644 --- a/guide/ops/requirements.md +++ b/guide/ops/requirements.md @@ -28,15 +28,15 @@ There are three main consumers of disk space: plus `data/` directory which is generated on first launch. 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.md) -- which - is a prerequisite for [High Availability](high-availability/index.md) -- Brooklyn +* **Persisted state**: when using [Persistence]({{book.path.docs}}/ops/persistence/index.md) -- which + is a prerequisite for [High Availability]({{book.path.docs}}/ops/high-availability/index.md) -- 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 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.md) section for more details. + [Logging]({{book.path.docs}}/ops/logging.md) section for more details. The Apache Brooklyn distribution itself, when unpacked, consumes approximately 75MB of disk space. This includes everything needed to run Brooklyn except for a @@ -57,7 +57,7 @@ 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.md) to save logs to a location +to [reconfigure Brooklyn's logging]({{book.path.docs}}/ops/logging.md) to save logs to a location 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. @@ -109,9 +109,9 @@ It is normally recommended that Brooklyn run as a non-root user with keys instal ### Linux Kernel Entropy -Check that the [linux kernel entropy](troubleshooting/increase-entropy.md) is sufficient. +Check that the [linux kernel entropy]({{book.path.docs}}/ops/troubleshooting/increase-entropy.md) is sufficient. ### System Resource Limits -Check that the [ulimit values](troubleshooting/increase-system-resource-limits.md) are sufficiently high. +Check that the [ulimit values]({{book.path.docs}}/ops/troubleshooting/increase-system-resource-limits.md) are sufficiently high. http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/260fb279/guide/ops/server-cli-reference.md ---------------------------------------------------------------------- diff --git a/guide/ops/server-cli-reference.md b/guide/ops/server-cli-reference.md index b1fc26b..bfc904f 100644 --- a/guide/ops/server-cli-reference.md +++ b/guide/ops/server-cli-reference.md @@ -4,7 +4,7 @@ title: Server CLI Reference # {{ page.title }} **NOTE:** This document is for information on starting a 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). +already running Brooklyn Server, refer to [Client CLI Reference]({{book.path.docs}}/ops/cli/index.md). ## Launch command @@ -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](configuration/brooklyn_cfg.md). +[configure security]({{book.path.docs}}/ops/configuration/brooklyn_cfg.md). 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 @@ -46,7 +46,7 @@ it keeps running after the shell terminates. ### Other Server CLI Arguments -The Server CLI arguments for [persistence and HA](persistence/index.md) and the [catalog](../blueprints/catalog/index.md) are described separately. +The Server CLI arguments for [persistence and HA]({{book.path.docs}}/ops/persistence/index.md) and the [catalog]({{book.path.docs}}/blueprints/catalog/index.md) are described separately. ### Path Setup @@ -78,7 +78,7 @@ This means that, once the task history is large, Brooklyn will continually use t memory. It will only expunge tasks from memory when this space is required for other objects within the Brooklyn process. -See [Memory Usage](troubleshooting/memory-usage.md) for more information on memory usage and +See [Memory Usage]({{book.path.docs}}/ops/troubleshooting/memory-usage.md) for more information on memory usage and other suggested `JAVA_OPTS`. @@ -106,7 +106,7 @@ from earlier ones, if exactly the same property is specified multiple times). 1. Shell environment variables 1. System properties, supplied with ``-D`` on the brooklyn (Java) command-line. -These properties are described in more detail [here](configuration/brooklyn_cfg.md). +These properties are described in more detail [here]({{book.path.docs}}/ops/configuration/brooklyn_cfg.md). ### Extending the Classpath
