Fix issue with brooklyn version display
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/c348bf08 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/c348bf08 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/c348bf08 Branch: refs/heads/master Commit: c348bf08f14dc38a3cfa7ad78396b27e05d5c6b7 Parents: 9fc94e0 Author: Thomas Bouron <[email protected]> Authored: Tue Oct 10 14:28:31 2017 +0100 Committer: Thomas Bouron <[email protected]> Committed: Mon Oct 16 14:56:02 2017 +0100 ---------------------------------------------------------------------- book.json | 8 ++++ guide/blueprints/java/archetype.md | 2 +- guide/dev/env/maven-build.md | 20 +++++----- guide/dev/tips/debugging-remote-brooklyn.md | 26 ++++++------- guide/dev/tips/index.md | 28 +++++++------- guide/dev/tips/logging.md | 2 +- guide/misc/download.md | 28 +++++++------- guide/misc/release-notes.md | 4 +- guide/ops/cli/index.md | 10 ++--- guide/ops/production-installation.md | 4 +- guide/start/running.md | 48 ++++++++++++------------ 11 files changed, 94 insertions(+), 86 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/c348bf08/book.json ---------------------------------------------------------------------- diff --git a/book.json b/book.json index ae08c30..0aca217 100644 --- a/book.json +++ b/book.json @@ -39,6 +39,14 @@ } }, "variables": { + "brooklyn_version": "1.0.0-SNAPSHOT", + + + + + + + "encoding": "utf-8", "markdown": "kramdown", http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/c348bf08/guide/blueprints/java/archetype.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/archetype.md b/guide/blueprints/java/archetype.md index 8c112ad..f053e57 100644 --- a/guide/blueprints/java/archetype.md +++ b/guide/blueprints/java/archetype.md @@ -26,7 +26,7 @@ Alternatively, all options can be supplied at the command line. For example, if creating a project named "autobrick" for "com.acme": ```bash -$ BROOKLYN_VERSION={{ book.brooklyn-version }} +$ BROOKLYN_VERSION={{ book.brooklyn_version }} $ mvn archetype:generate \ -DarchetypeGroupId=org.apache.brooklyn \ -DarchetypeArtifactId=brooklyn-archetype-quickstart \ http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/c348bf08/guide/dev/env/maven-build.md ---------------------------------------------------------------------- diff --git a/guide/dev/env/maven-build.md b/guide/dev/env/maven-build.md index 2b1bc65..daf52cf 100644 --- a/guide/dev/env/maven-build.md +++ b/guide/dev/env/maven-build.md @@ -16,32 +16,32 @@ The full build requires the following software to be installed: With these in place, you should be able to build everything with a: ```bash -% mvn clean install +mvn clean install ``` Alternatively you can build most things with just Java and Maven installed using: ```bash -mvn clean install -Dno-go-client -Dno-rpm` +mvn clean install -Dno-go-client -Dno-rpm ``` Other tips: -* Add ``-DskipTests`` to skip tests (builds much faster, but not as safe) +* Add `-DskipTests` to skip tests (builds much faster, but not as safe) * You may need more JVM memory, e.g. at the command-line (or in `.profile`): - ``export MAVEN_OPTS="-Xmx1024m -Xms512m"`` + `export MAVEN_OPTS="-Xmx1024m -Xms512m"` -* Run ``-PIntegration`` to run integration tests, or ``-PLive`` to run live tests - ([tests described here](../code/tests.html)) +* Run `-PIntegration` to run integration tests, or `-PLive` to run live tests + ([tests described here](../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. +* 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/). +* For tips on building within various IDEs, look [here](ide/index.md). ## When the RAT Bites @@ -78,10 +78,10 @@ If there is a good reason that a file, pattern, or directory should be permanent * The **mvnf** script ([get the gist here](https://gist.github.com/2241800)) - simplifies building selected projects, so if you just change something in ``software-webapp`` + simplifies building selected projects, so if you just change something in `software-webapp` and then want to re-run the examples you can do: - ``examples/simple-web-cluster% mvnf ../../{software/webapp,usage/all}`` + `examples/simple-web-cluster% mvnf ../../{software/webapp,usage/all}` ## Appendix: Sample Output http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/c348bf08/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 b33b486..979f8f3 100644 --- a/guide/dev/tips/debugging-remote-brooklyn.md +++ b/guide/dev/tips/debugging-remote-brooklyn.md @@ -4,18 +4,18 @@ title: Brooklyn Remote Debugging toc: /guide/toc.json --- -Usually during development, you will be running Brooklyn from your IDE (see [IDE Setup](../env/ide/)), in which case +Usually during development, you will be running Brooklyn from your IDE (see [IDE Setup](../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. Thankfully, the tools are available to do this, and setting it up is quite straightforward. The steps are as follows: -* [Getting the right source code version](#sourceCodeVersion) -* [Starting Brooklyn with a debug listener](#startingBrooklyn) -* [Creating an SSH tunnel](#sshTunnel) -* [Connecting your IDE](#connectingIDE) +* [Getting the right source code version](#getting-the-right-source-code-version) +* [Starting Brooklyn with a debug listener](#starting-brooklyn-with-a-debug-listener) +* [Creating an SSH tunnel](#creating-an-ssh-tunnel) +* [Connecting your IDE](#connecting-your-ide) -## <a name="sourceCodeVersion"></a>Getting the right source code version +## Getting the right source code version The first step is to ensure that your local copy of the source code is at the version used to build the remote Brooklyn instance. The git commit that was used to build Brooklyn is available via the REST API: @@ -25,7 +25,7 @@ This should return details of the build as a JSON string similar to the followin ```json { - "version": "1.0.0-SNAPSHOT", {% comment %}BROOKLYN_VERSION{% endcomment %} + "version": "1.0.0-SNAPSHOT", // BROOKLYN_VERSION "buildSha1": "c0fdc15291702281acdebf1b11d431a6385f5224", "buildBranch": "UNKNOWN" } @@ -41,7 +41,7 @@ checkout and build the Brooklyn code at this commit by running the following in Whilst building the code isn't strictly necessary, it can help prevent some IDE issues. -## <a name="startingBrooklyn"></a>Starting Brooklyn with a debug listener +## Starting Brooklyn with a debug listener By default, Brooklyn does not listen for a debugger to be attached, however this behaviour can be set by setting JAVA_OPTS, which will require a restart of the Brooklyn node. To do this, SSH to the remote Brooklyn node and run the following in the root of the Brooklyn installation: @@ -62,7 +62,7 @@ You should see the following in the console output: This will indicate the Brooklyn is listening on port 8888 for a debugger to be attached. -## <a name="sshTunnel"></a>Creating an SSH tunnel +## Creating an SSH tunnel If port 8888 is accessible on the remote Brooklyn server, then you can skip this step and simply use the address of the server in place of 127.0.0.1 in the [Connecting your IDE](#connectingIDE) section below. It will normally be possible to @@ -97,14 +97,14 @@ The SSH tunnel should now be redirecting traffic from port 8888 on the local 127 tunnel to port 8888 on the remote 127.0.0.1 interface. It should now be possible to connect the debugger and start debugging. -## <a name="connectingIDE"></a> Connecting your IDE +## Connecting your IDE Setting up your IDE will differ depending upon which IDE you are using. Instructions are given here for Eclipse and 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/)). +To debug using Eclipse, first open the Brooklyn project in Eclipse (see [IDE Setup](../env/ide/index.md)). Now create a debug configuration by clicking `Run` | `Debug Configurations...`. You will then be presented with the Debug Configuration dialog. @@ -116,7 +116,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/)). +To debug using IntelliJ, first open the Brooklyn project in IntelliJ (see [IDE Setup](../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. @@ -124,7 +124,7 @@ Run/Debug Configurations dialog. Click on the `+` button and select 'Remote' to create a new remote configuration. Set the name to something suitable such as 'Remote debug on 8888'. The first three sections simply give the command line arguments for starting the java process using different versions of java, however we have already done this in -[Starting Brooklyn with a debug listener](#startingBrooklyn). The Transport option should be set to 'Socket', the Debugger Mode should be set to 'Attach', the +[Starting Brooklyn with a debug listener](#starting-brooklyn-with-a-debug-listener). The Transport option should be set to 'Socket', the Debugger Mode should be set to 'Attach', the Host should be set to localhost or 127.0.0.1 (or the address of the remote machine if you are not using an SSH tunnel), and the Port should be set to 8888. The 'Search sources' section should be set to `<whole project>`. Click OK to save the configuration, then select the configuration from the configurations drop-down and click the debug button to start http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/c348bf08/guide/dev/tips/index.md ---------------------------------------------------------------------- diff --git a/guide/dev/tips/index.md b/guide/dev/tips/index.md index bfacfcf..4253965 100644 --- a/guide/dev/tips/index.md +++ b/guide/dev/tips/index.md @@ -6,23 +6,23 @@ title: Miscellaneous Tips and Tricks ## General Good Ways of Working * If working on something which could be contributed to Brooklyn, - do it in a project under the ``sandbox`` directory. + do it in a project under the `sandbox` directory. 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.html) is set to DEBUG and accessible. +* When debugging an entity, make sure the [brooklyn.SSH logger](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]({{book.path.guide}}/dev/env/ide/)), +* Use tests heavily! These are pretty good to run in the IDE (once you've completed [IDE setup](../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.) * If you hit inexplicable problems at runtime, try clearing your Maven caches, - or the brooklyn-relevant parts, under ``~/.m2/repository``. + or the brooklyn-relevant parts, under `~/.m2/repository`. Also note your IDE might be recompiling at the same time as a Maven command-line build, so consider turning off auto-build. -* When a class or method becomes deprecated, always include ``@deprecated`` in the Javadoc - e.g. "``@deprecated since 0.7.0; instead use {@link ...}``" +* When a class or method becomes deprecated, always include `@deprecated` in the Javadoc + e.g. "`@deprecated since 0.7.0; instead use {@link ...}`" * Include when it was deprecated * Suggest what to use instead -- e.g. link to alternative method, and/or code snippet, etc. * Consider logging a warning message when a deprecated method or config option is used, @@ -38,13 +38,13 @@ title: Miscellaneous Tips and Tricks * Look at related entities and understand what they've done, in particular which sensors and config keys can be re-used. (Many are inherited from interfaces, where they are declared as constants, - e.g. ``Attributes`` and ``UsesJmx``.) + e.g. `Attributes` and `UsesJmx`.) -* Understand the location hierarchy: software process entities typically get an ``SshMachineLocation``, - and use a ``*SshDriver`` to do what they need. This will usually have a ``MachineProvisioningLocation`` parent, e.g. a - ``JcloudsLocation`` (e.g. AWS eu-west-1 with credentials) or possibly a ``LocalhostMachineProvisioningLocation``. - Clusters will take such a ``MachineProvisioningLocation`` (or a singleton list); fabircs take a list of locations. - Some PaaS systems have their own location model, such as ``OpenShiftLocation``. +* Understand the location hierarchy: software process entities typically get an `SshMachineLocation`, + and use a `*SshDriver` to do what they need. This will usually have a `MachineProvisioningLocation` parent, e.g. a + `JcloudsLocation` (e.g. AWS eu-west-1 with credentials) or possibly a `LocalhostMachineProvisioningLocation`. + Clusters will take such a `MachineProvisioningLocation` (or a singleton list); fabircs take a list of locations. + Some PaaS systems have their own location model, such as `OpenShiftLocation`. * Finally, don't be shy about [talking with others]({{book.path.website}}/community/), that's far better than spinning your wheels (or worse, having a bad experience), @@ -64,7 +64,7 @@ title: Miscellaneous Tips and Tricks ## Project Maintenance -* Adding a new project may need updates to ``/pom.xml`` ``modules`` section and ``usage/all`` dependencies +* Adding a new project may need updates to `/pom.xml` `modules` section and `usage/all` dependencies -* Adding a new example project may need updates to ``/pom.xml`` and ``/examples/pom.xml`` (and the documentation too!) +* Adding a new example project may need updates to `/pom.xml` and `/examples/pom.xml` (and the documentation too!) http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/c348bf08/guide/dev/tips/logging.md ---------------------------------------------------------------------- diff --git a/guide/dev/tips/logging.md b/guide/dev/tips/logging.md index d6d9347..19b8a4b 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.html#karaf-console)) +(Details regarding using [Apache Brooklyn Karaf console](../../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/c348bf08/guide/misc/download.md ---------------------------------------------------------------------- diff --git a/guide/misc/download.md b/guide/misc/download.md index fabfefa..65ce67e 100644 --- a/guide/misc/download.md +++ b/guide/misc/download.md @@ -10,7 +10,7 @@ The latest stable release can be accessed on the [main download page]({{ book.pa {% endif %} -## Download Version {{ book.brooklyn-version }} +## Download Version {{ book.brooklyn_version }} <table class="table"> <tr> @@ -20,77 +20,77 @@ The latest stable release can be accessed on the [main download page]({{ book.pa </tr> <tr> <td style='text-align:left;vertical-align:top' rowspan='2'>Binary distribution<br />Server & client</td> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-bin.tar.gz' title='Download TGZ archive'>apache-brooklyn-{{ book.brooklyn-version }}-bin.tar.gz</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-bin.tar.gz' title='Download TGZ archive'>apache-brooklyn-{{ book.brooklyn_version }}-bin.tar.gz</a></td> <td ><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-bin.tar.gz.asc'>PGP</a>, {% endif %} <a href='{{ book.hash_brooklyn.download_prefix }}-bin.tar.gz.sha1'>SHA1</a></small></td> </tr> <tr> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-bin.zip' title='Download ZIP archive'>apache-brooklyn-{{ book.brooklyn-version }}-bin.zip</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-bin.zip' title='Download ZIP archive'>apache-brooklyn-{{ book.brooklyn_version }}-bin.zip</a></td> <td><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-bin.zip.asc'>PGP</a>, {% endif %} <a href='{{ book.brooklyn.hash_download_prefix }}-bin.zip.sha1'>SHA1</a></small></td> </tr> <tr> <td style='text-align:left;vertical-align:top'>RPM package<br />CentOS7, RHEL7, etc.</td> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-1.noarch.rpm' title='Download RPM package'>apache-brooklyn-{{ book.brooklyn-version }}-1.noarch.rpm</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-1.noarch.rpm' title='Download RPM package'>apache-brooklyn-{{ book.brooklyn_version }}-1.noarch.rpm</a></td> <td><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-1.noarch.rpm.asc'>PGP</a>, {% endif %} <a href='{{ book.brooklyn.hash_download_prefix }}-1.noarch.rpm.sha1'>SHA1</a></small></td> </tr> <tr> <td style='text-align:left;vertical-align:top'>DEB package<br />Ubuntu, Debian, etc.</td> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}.deb' title='Download DEB package'>apache-brooklyn-{{ book.brooklyn-version }}.deb</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}.deb' title='Download DEB package'>apache-brooklyn-{{ book.brooklyn_version }}.deb</a></td> <td><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}.deb.asc'>PGP</a>, {% endif %} <a href='{{ book.brooklyn.hash_download_prefix }}.deb.sha1'>SHA1</a></small></td> </tr> <tr> <td style='text-align:left;vertical-align:top' rowspan='6'>Client CLI only</td> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-linux.tar.gz' title='Download client CLI linux TGZ archive'>apache-brooklyn-{{ book.brooklyn-version }}-client-cli-linux.tar.gz</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-linux.tar.gz' title='Download client CLI linux TGZ archive'>apache-brooklyn-{{ book.brooklyn_version }}-client-cli-linux.tar.gz</a></td> <td ><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-client-cli-linux.tar.gz.asc'>PGP</a>, {% endif %} <a href='{{ book.hash_brooklyn.download_prefix }}-client-cli-linux.tar.gz.sha1'>SHA1</a></small></td> </tr> <tr> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-linux.zip' title='Download client CLI linux ZIP archive'>apache-brooklyn-{{ book.brooklyn-version }}-client-cli-linux.zip</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-linux.zip' title='Download client CLI linux ZIP archive'>apache-brooklyn-{{ book.brooklyn_version }}-client-cli-linux.zip</a></td> <td><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-client-cli-linux.zip.asc'>PGP</a>, {% endif %} <a href='{{ book.brooklyn.hash_download_prefix }}-client-cli-linux.zip.sha1'>SHA1</a></small></td> </tr> <tr> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-macosx.tar.gz' title='Download client CLI macosx TGZ archive'>apache-brooklyn-{{ book.brooklyn-version }}-client-cli-macosx.tar.gz</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-macosx.tar.gz' title='Download client CLI macosx TGZ archive'>apache-brooklyn-{{ book.brooklyn_version }}-client-cli-macosx.tar.gz</a></td> <td ><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-client-cli-macosx.tar.gz.asc'>PGP</a>, {% endif %} <a href='{{ book.hash_brooklyn.download_prefix }}-client-cli-macosx.tar.gz.sha1'>SHA1</a></small></td> </tr> <tr> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-macosx.zip' title='Download client CLI macosx ZIP archive'>apache-brooklyn-{{ book.brooklyn-version }}-client-cli-macosx.zip</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-macosx.zip' title='Download client CLI macosx ZIP archive'>apache-brooklyn-{{ book.brooklyn_version }}-client-cli-macosx.zip</a></td> <td><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-client-cli-macosx.zip.asc'>PGP</a>, {% endif %} <a href='{{ book.brooklyn.hash_download_prefix }}-client-cli-macosx.zip.sha1'>SHA1</a></small></td> </tr> <tr> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-windows.tar.gz' title='Download client CLI windows TGZ archive'>apache-brooklyn-{{ book.brooklyn-version }}-client-cli-windows.tar.gz</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-windows.tar.gz' title='Download client CLI windows TGZ archive'>apache-brooklyn-{{ book.brooklyn_version }}-client-cli-windows.tar.gz</a></td> <td ><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-client-cli-windows.tar.gz.asc'>PGP</a>, {% endif %} <a href='{{ book.hash_brooklyn.download_prefix }}-client-cli-windows.tar.gz.sha1'>SHA1</a></small></td> </tr> <tr> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-windows.zip' title='Download client CLI windows ZIP archive'>apache-brooklyn-{{ book.brooklyn-version }}-client-cli-windows.zip</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-client-cli-windows.zip' title='Download client CLI windows ZIP archive'>apache-brooklyn-{{ book.brooklyn_version }}-client-cli-windows.zip</a></td> <td><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-client-cli-windows.zip.asc'>PGP</a>, {% endif %} <a href='{{ book.brooklyn.hash_download_prefix }}-client-cli-windows.zip.sha1'>SHA1</a></small></td> </tr> <tr> <td style='text-align:left;vertical-align:top' rowspan='2'>Source code</td> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-src.tar.gz' title='Download source TGZ archive'>apache-brooklyn-{{ book.brooklyn-version }}-src.tar.gz</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-src.tar.gz' title='Download source TGZ archive'>apache-brooklyn-{{ book.brooklyn_version }}-src.tar.gz</a></td> <td ><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-src.tar.gz.asc'>PGP</a>, {% endif %} <a href='{{ book.hash_brooklyn.download_prefix }}-src.tar.gz.sha1'>SHA1</a></small></td> </tr> <tr> - <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-src.zip' title='Download source ZIP archive'>apache-brooklyn-{{ book.brooklyn-version }}-src.zip</a></td> + <td style='text-align:left'><a href='{{ book.brooklyn.download_prefix }}-src.zip' title='Download source ZIP archive'>apache-brooklyn-{{ book.brooklyn_version }}-src.zip</a></td> <td><small> {% if book.brooklyn.is_release %}<a href='{{ book.brooklyn.hash_download_prefix }}-src.zip.asc'>PGP</a>, {% endif %} <a href='{{ book.brooklyn.hash_download_prefix }}-src.zip.sha1'>SHA1</a></small></td> @@ -117,7 +117,7 @@ If you use Maven, you can add Brooklyn with the following in your pom: <dependency> <groupId>org.apache.brooklyn</groupId> <artifactId>brooklyn-all</artifactId> - <version>{{ book.brooklyn-version }}</version> + <version>{{ book.brooklyn_version }}</version> </dependency> </dependencies> ``` http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/c348bf08/guide/misc/release-notes.md ---------------------------------------------------------------------- diff --git a/guide/misc/release-notes.md b/guide/misc/release-notes.md index b36fcab..672c5c9 100644 --- a/guide/misc/release-notes.md +++ b/guide/misc/release-notes.md @@ -3,9 +3,9 @@ layout: website-normal title: Release Notes --- -## Version {{ book.brooklyn-version }} +## Version {{ book.brooklyn_version }} -{% if SNAPSHOT %} +{% if 'SNAPSHOT' in book.brooklyn_version %} **You are viewing a SNAPSHOT release (master branch), so this list is in progress!** {% endif %} http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/c348bf08/guide/ops/cli/index.md ---------------------------------------------------------------------- diff --git a/guide/ops/cli/index.md b/guide/ops/cli/index.md index d618100..6b67ed2 100644 --- a/guide/ops/cli/index.md +++ b/guide/ops/cli/index.md @@ -12,13 +12,13 @@ information on starting on a Brooklyn Server, refer to [Server CLI Reference](.. ## Obtaining the CLI tool -A selection of distributions of the CLI tool, `br`, are available to download from the download site {% if book.brooklyn-version %} -[here](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=brooklyn-client-cli&v={{book.brooklyn-version}}&c=bin&e=zip). +A selection of distributions of the CLI tool, `br`, are available to download from the download site {% if 'SNAPSHOT' in book.brooklyn_version %} +[here](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=brooklyn-client-cli&v={{book.brooklyn_version}}&c=bin&e=zip). {% else %} here: -* [Windows](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}-client-cli-windows.zip) -* [Linux](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}-client-cli-linux.tar.gz) -* [OSX](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}-client-cli-macosx.tar.gz) +* [Windows](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn_version}}-client-cli-windows.zip) +* [Linux](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn_version}}-client-cli-linux.tar.gz) +* [OSX](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn_version}}-client-cli-macosx.tar.gz) {% endif %} Alternatively the CLI tool is available as an executable binary for many more platforms in the Apache Brooklyn http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/c348bf08/guide/ops/production-installation.md ---------------------------------------------------------------------- diff --git a/guide/ops/production-installation.md b/guide/ops/production-installation.md index e6fe90a..f36ee8b 100644 --- a/guide/ops/production-installation.md +++ b/guide/ops/production-installation.md @@ -40,13 +40,13 @@ Then configure the server as follows: Download Brooklyn and obtain a binary build as described on [the download page]({{book.path.website}}/download/). -{% if book.brooklyn-version %} +{% if 'SNAPSHOT' in book.brooklyn_version %} Expand the `tar.gz` archive (note: as this is a -SNAPSHOT version, your filename will be slightly different): {% else %} Expand the `tar.gz` archive: {% endif %} -{% if book.brooklyn-version %} +{% if 'SNAPSHOT' in book.brooklyn_version %} ```bash % tar -zxf apache-brooklyn-dist-{{ book.brooklyn-stable-version }}-timestamp-dist.tar.gz ``` http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/c348bf08/guide/start/running.md ---------------------------------------------------------------------- diff --git a/guide/start/running.md b/guide/start/running.md index 7dee1b4..c68b0d6 100644 --- a/guide/start/running.md +++ b/guide/start/running.md @@ -26,37 +26,37 @@ Firstly, download and install: * [Oracle VirtualBox](https://www.virtualbox.org/wiki/Downloads){:target="_blank"} Then download the provided Apache Brooklyn vagrant configuration from -{% if book.brooklyn-version %} - [here](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=brooklyn-vagrant&v={{book.brooklyn-version}}&c=dist&e=zip). +{% if 'SNAPSHOT' in book.brooklyn_version %} + [here](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=brooklyn-vagrant&v={{book.brooklyn_version}}&c=dist&e=zip). {% else %} - [here](https://www.apache.org/dyn/closer.lua?action=download&filename=brooklyn/apache-brooklyn-{{book.brooklyn-version}}/apache-brooklyn-{{book.brooklyn-version}}-vagrant.tar.gz). + [here](https://www.apache.org/dyn/closer.lua?action=download&filename=brooklyn/apache-brooklyn-{{book.brooklyn_version}}/apache-brooklyn-{{book.brooklyn_version}}-vagrant.tar.gz). {% endif %} This archive contains everything you need to create an environment for use with this guide, providing an Apache Brooklyn instance and some blank VMs. -Extract the `tar.gz` archive and navigate into the expanded `apache-brooklyn-{{book.brooklyn-version}}-vagrant` folder {% if book.brooklyn-version %}(note: as this is a -SNAPSHOT version, your filename will be slightly different){% endif %} +Extract the `tar.gz` archive and navigate into the expanded `apache-brooklyn-{{book.brooklyn_version}}-vagrant` folder {% if 'SNAPSHOT' in book.brooklyn_version %}(note: as this is a -SNAPSHOT version, your filename will be slightly different){% endif %} ```bash -$ tar xvf apache-brooklyn-{{book.brooklyn-version}}-vagrant.tar.gz -$ cd apache-brooklyn-{{book.brooklyn-version}}-vagrant +$ tar xvf apache-brooklyn-{{book.brooklyn_version}}-vagrant.tar.gz +$ cd apache-brooklyn-{{book.brooklyn_version}}-vagrant ``` {% sample lang="centos" -%} -{% if book.brooklyn-version %}<strong>Please note, an RPM is not available for snapshot builds</strong>{% endif %} +{% if 'SNAPSHOT' in book.brooklyn_version %}<strong>Please note, an RPM is not available for snapshot builds</strong>{% endif %} For Centos 7 and RHEL 7 users, the recommended way to install Apache Brooklyn on RPM-based Linux distributions is by using the RPM package. RPM is the de facto standard for packaging software on these Linux distributions and provides a mechanism for installing, upgrading and removing packages such as Apache Brooklyn. The RPM package contains all the necessary files associated with the Apache Brooklyn application. -{% if book.brooklyn-version %} +{% if 'SNAPSHOT' in book.brooklyn_version %} This is a snapshot build and no RPM is available, please download [a different version]({{book.path.website}}/download/). {% else %} -Download the Apache Brooklyn [RPM distribution](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}/apache-brooklyn-{{book.brooklyn-version}}-1.noarch.rpm){:target="_blank"}. +Download the Apache Brooklyn [RPM distribution](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn_version}}/apache-brooklyn-{{book.brooklyn_version}}-1.noarch.rpm){:target="_blank"}. {% endif %} Once downloaded, run the following shell command as root: ```bash -$ yum install apache-brooklyn-{{book.brooklyn-version}}-1.rpm +$ yum install apache-brooklyn-{{book.brooklyn_version}}-1.rpm ``` {% sample lang="ubuntu" -%} @@ -64,36 +64,36 @@ For Ubuntu and Debian users, the recommended way to install Apache Brooklyn is t The deb file is the de facto standard for packaging software on these Linux distributions and provides a mechanism for installing, upgrading and removing packages such as Apache Brooklyn. The deb package contains all the necessary files associated with the Apache Brooklyn application. -{% if book.brooklyn-version %} -Download the Apache Brooklyn [deb distribution](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=deb-packaging&v={{book.brooklyn-version}}&e=deb){:target="_blank"}. +{% if 'SNAPSHOT' in book.brooklyn_version %} +Download the Apache Brooklyn [deb distribution](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=deb-packaging&v={{book.brooklyn_version}}&e=deb){:target="_blank"}. {% else %} -Download the Apache Brooklyn [deb distribution](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn_{{book.brooklyn-version}}_noarch.deb){:target="_blank"}. +Download the Apache Brooklyn [deb distribution](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn_{{book.brooklyn_version}}_noarch.deb){:target="_blank"}. {% endif %} Once downloaded, run the following shell command: ```bash -$ sudo dpkg -i apache-brooklyn_{{book.brooklyn-version}}_noarch.deb +$ sudo dpkg -i apache-brooklyn_{{book.brooklyn_version}}_noarch.deb ``` {% sample lang="osx" -%} For Linux or OSX please download the Apache Brooklyn `tar.gz` archive from the [download]({{book.path.website}}/download/){:target="_blank"} section. -{% if book.brooklyn-version %} +{% if 'SNAPSHOT' in book.brooklyn_version %} Extract the `tar.gz` archive (note: as this is a -SNAPSHOT version, your filename will be slightly different): {% else %} -Extract the `tar.gz` archive and navigate into the expanded `apache-brooklyn-{{ book.brooklyn-version }}` folder. +Extract the `tar.gz` archive and navigate into the expanded `apache-brooklyn-{{ book.brooklyn_version }}` folder. {% endif %} -{% if book.brooklyn-version %} +{% if 'SNAPSHOT' in book.brooklyn_version %} ```bash -$ tar -zxf apache-brooklyn-dist-{{ book.brooklyn-version }}-timestamp-dist.tar.gz +$ tar -zxf apache-brooklyn-dist-{{ book.brooklyn_version }}-timestamp-dist.tar.gz $ cd apache-brooklyn-{{ book.brooklyn.version }} ``` {% else %} ```bash -$ tar -zxf apache-brooklyn-{{ book.brooklyn-version }}-dist.tar.gz +$ tar -zxf apache-brooklyn-{{ book.brooklyn_version }}-dist.tar.gz $ cd apache-brooklyn-{{ book.brooklyn.version }} ``` {% endif %} @@ -187,14 +187,14 @@ INFO Started Brooklyn console at http://127.0.0.1:8081/, running classpath://br By default it can be accessed by opening [127.0.0.1:8081](http://127.0.0.1:8081){:target="_blank"} in your web browser. The rest of this getting started guide uses the Apache Brooklyn command line interface (CLI) tool, `br`. -This tool is both distributed with Apache Brooklyn or can be downloaded {% if book.brooklyn-version %} -from [here](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=brooklyn-client-cli&v={{book.brooklyn-version}}&c=bin&e=zip). +This tool is both distributed with Apache Brooklyn or can be downloaded {% if 'SNAPSHOT' in book.brooklyn_version %} +from [here](https://repository.apache.org/service/local/artifact/maven/redirect?r=snapshots&g=org.apache.brooklyn&a=brooklyn-client-cli&v={{book.brooklyn_version}}&c=bin&e=zip). {% else %} using the most appropriate link for your OS: -* [Windows](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}/apache-brooklyn-{{book.brooklyn-version}}-client-cli-windows.zip) -* [Linux](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}/apache-brooklyn-{{book.brooklyn-version}}-client-cli-linux.tar.gz) -* [OSX](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn-version}}/apache-brooklyn-{{book.brooklyn-version}}-client-cli-macosx.tar.gz) +* [Windows](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn_version}}/apache-brooklyn-{{book.brooklyn_version}}-client-cli-windows.zip) +* [Linux](https://www.apache.org/dyn/closer.lua/brooklyn/apache-brooklyn-{{book.brooklyn_version}}/apache-brooklyn-{{book.brooklyn_version}}-client-cli-linux.tar.gz) +* [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]({{ book.path.guide }}/ops/cli/) page.
