From ffbdfa586ae0c3c0c3739e1ea3c9b3e7782486c8 Mon Sep 17 00:00:00 2001 From: Geoff Macartney Date: Tue, 23 Feb 2016 15:22:49 +0000 Subject: [PATCH 1/4] Link update for CLI. --- guide/start/running.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guide/start/running.md b/guide/start/running.md index ca1936c5..b851079f 100644 --- a/guide/start/running.md +++ b/guide/start/running.md @@ -133,7 +133,7 @@ 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). To use this, download and install the tool as described on the [CLI GitHub page](https://github.com/brooklyncentral/brooklyn-cli){:target="_blank"}. +The rest of this getting started guide uses the Apache Brooklyn command line interface (CLI). To use this, download and install the tool as described on the [CLI GitHub page](https://github.com/apache/brooklyn-client){:target="_blank"}. The CLI provides the command `br`, it's full usage is described in the user manual which can be found [here](../ops/cli/){:target="_blank"} From d015cda061bee0aab3a66dba36702cd136e7b3c8 Mon Sep 17 00:00:00 2001 From: Geoff Macartney Date: Fri, 26 Feb 2016 16:05:45 +0000 Subject: [PATCH 2/4] Documentation updates to instruct how to find the br client. --- guide/ops/cli/cli-ref-guide.md | 6 ++++-- guide/ops/cli/cli-usage-guide.md | 2 +- guide/ops/cli/index.md | 22 ++++++++++++++++++++-- guide/start/running.md | 9 +++++---- 4 files changed, 30 insertions(+), 9 deletions(-) diff --git a/guide/ops/cli/cli-ref-guide.md b/guide/ops/cli/cli-ref-guide.md index 9a7ebfd0..772aa5eb 100644 --- a/guide/ops/cli/cli-ref-guide.md +++ b/guide/ops/cli/cli-ref-guide.md @@ -110,7 +110,8 @@ policy pol ### Login - `br login [username [password]]` - Login to Brooklyn. The CLI will prompt for a password if it is not provided. If the Brooklyn server is running on localhost with no security enabled, the username and password may be omitted. + Login to Brooklyn. The CLI will prompt for a password if it is not provided. If the Brooklyn server is running on + localhost with no security enabled, the username and password may be omitted. On successful login, the version of the connected Brooklyn server is shown. - `br version` @@ -150,7 +151,8 @@ policy pol - `br delete` Delete an application from Brooklyn. - **NOTE:** Use this command with care. Even if the application / entities are still running, Brooklyn will drop all knowledge of them and they will be left running in an 'orphaned' state. + **NOTE:** Use this command with care. Even if the application / entities are still running, Brooklyn will drop all + knowledge of them and they will be left running in an 'orphaned' state. ### Entities diff --git a/guide/ops/cli/cli-usage-guide.md b/guide/ops/cli/cli-usage-guide.md index 593bb6bf..16590cf7 100644 --- a/guide/ops/cli/cli-usage-guide.md +++ b/guide/ops/cli/cli-usage-guide.md @@ -212,7 +212,7 @@ parameter to the `sensor` command: {% highlight text %} $ br app WebCluster entity CZ8QUVgX sensor service.state.expected -"running @ 1449314377781 / Sat Dec 05 11:19:37 GMT 2015" +running @ 1449314377781 / Sat Dec 05 11:19:37 GMT 2015 {% endhighlight %} ## Effectors diff --git a/guide/ops/cli/index.md b/guide/ops/cli/index.md index d01cc479..d6e3eda4 100644 --- a/guide/ops/cli/index.md +++ b/guide/ops/cli/index.md @@ -6,7 +6,25 @@ children: - cli-usage-guide.md --- -{% include list-children.html %} -**NOTE:** These documents are for using the Brooklyn Client CLI to access a running Brooklyn Server. For +**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.html). + +## Obtaining the CLI tool + +The CLI tool, `br`, is included in the Apache Brooklyn distribution, in bin/brooklyn-client-cli-0.9.0-SNAPSHOT. +The tool is an executable binary (written in Go), and is distributed in a number of builds for a variety of platforms +and architectures, each build in its own subdirectory: + + darwin.386 freebsd.386 linux.386 netbsd.386 openbsd.386 windows.386 + darwin.amd64 freebsd.amd64 linux.amd64 netbsd.amd64 openbsd.amd64 windows.amd64 + +You can add the appropriate directory to your path, alias the command, or copy it somewhere on your path, whatever is +convenient. For example: + + PATH=$PATH:$HOME/apache-brooklyn/bin/brooklyn-client-cli-0.9.0-SNAPSHOT/linux/amd64 + +## Documentation + + +{% include list-children.html %} \ No newline at end of file diff --git a/guide/start/running.md b/guide/start/running.md index b851079f..3b807204 100644 --- a/guide/start/running.md +++ b/guide/start/running.md @@ -116,7 +116,7 @@ Now start Apache Brooklyn with the following command: $ bin/brooklyn launch {% endhighlight %} -The application should then output it's log into the console +The application should then output its log into the console @@ -125,7 +125,8 @@ The application should then output it's log into the console ## Control Apache Brooklyn -Apache Brooklyn has a web console which can be used to control the application. The Brooklyn log will contain the address of the management interface: +Apache Brooklyn has a web console which can be used to control the application. The Brooklyn log will contain the +address of the management interface: 
 INFO  Started Brooklyn console at http://127.0.0.1:8081/, running classpath://brooklyn.war
@@ -133,9 +134,9 @@ 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). To use this, download and install the tool as described on the [CLI GitHub page](https://github.com/apache/brooklyn-client){:target="_blank"}.
+The rest of this getting started guide uses the Apache Brooklyn command line interface (CLI) tool, `br`. 
+This tool is distributed along with Apache Brooklyn. See details on the [Client CLI Reference](../../ops/cli/) page. 
 
-The CLI provides the command `br`, it's full usage is described in the user manual which can be found [here](../ops/cli/){:target="_blank"}
 
 ## Next
 

From 7ec32e4d26dd4f54ca5f62f2206f7ce830126d98 Mon Sep 17 00:00:00 2001
From: Alex Heneveld 
Date: Thu, 10 Mar 2016 10:11:39 +0000
Subject: [PATCH 3/4] write cli binaries to a directory without the version
 name, and list fewer platforms

---
 guide/ops/cli/index.md | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/guide/ops/cli/index.md b/guide/ops/cli/index.md
index d6e3eda4..15ea9057 100644
--- a/guide/ops/cli/index.md
+++ b/guide/ops/cli/index.md
@@ -12,19 +12,21 @@ information on starting on a Brooklyn Server, refer to [Server CLI Reference](..
 
 ## Obtaining the CLI tool
 
-The CLI tool, `br`,  is included in the Apache Brooklyn distribution, in bin/brooklyn-client-cli-0.9.0-SNAPSHOT.
-The tool is an executable binary (written in Go), and is distributed in a number of builds for a variety of platforms
-and architectures, each build in its own subdirectory:
+The CLI tool, `br`,  is included in the Apache Brooklyn distribution, under `bin/brooklyn-client-cli/`.
+The tool is an executable binary available for many platforms, with each build in its own subdirectory:
 
-    darwin.386    freebsd.386    linux.386    netbsd.386     openbsd.386    windows.386
-    darwin.amd64  freebsd.amd64  linux.amd64  netbsd.amd64   openbsd.amd64  windows.amd64
+* Mac: `darwin.amd64/`
+* Windows 32-bit: `windows.386/`
+* Windows 64-bit: `windows.amd64/`
+* Linux 32-bit: `linux.386/`
+* Linux 64-bit: `linux.amd64/`
 
-You can add the appropriate directory to your path, alias the command, or copy it somewhere on your path, whatever is
-convenient. For example:
+The binary is completely self-contained so you can either copy it to your `bin/` directory
+or add the appropriate directory above to your path:
 
-    PATH=$PATH:$HOME/apache-brooklyn/bin/brooklyn-client-cli-0.9.0-SNAPSHOT/linux/amd64
+    PATH=$PATH:$HOME/apache-brooklyn/bin/brooklyn-client-cli/linux.amd64/
 
-## Documentation
 
+## Documentation
 
-{% include list-children.html %}
\ No newline at end of file
+{% include list-children.html %}

From ad9dc2b48eac029f7dad2e0b94c1842b7a8f98f9 Mon Sep 17 00:00:00 2001
From: Alex Heneveld 
Date: Thu, 10 Mar 2016 12:00:44 +0000
Subject: [PATCH 4/4] update for Go dependency and skipping Go

---
 guide/dev/env/ide/index.md   | 4 ++--
 guide/dev/env/maven-build.md | 6 ++++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/guide/dev/env/ide/index.md b/guide/dev/env/ide/index.md
index 60ad11d2..94bbfbad 100644
--- a/guide/dev/env/ide/index.md
+++ b/guide/dev/env/ide/index.md
@@ -12,7 +12,7 @@ But with a bit of a dance the IDE can still be your friend,
 making it much easier to run tests and debug.
 
 As a general tip, don't always trust the IDE to build correctly; if you hit a snag,
-do a command-line ``mvn clean install`` (optionally with ``-DskipTests``)
+do a command-line ``mvn clean install`` (optionally with ``-DskipTests`` and/or ``-Dno-go-client``)
 then refresh the project.
 
 See instructions below for specific IDEs.
@@ -41,7 +41,7 @@ If you encounter issues, the following hints may be helpful:
   You can manually mark as permanently ignored certain errors;
   this updates the pom.xml (and should be current).
 
-* A quick command-line build (`mvn clean install -DskipTests`) followed by a workspace refresh
+* A quick command-line build (`mvn clean install -DskipTests -Dno-go-client`) followed by a workspace refresh
   can be useful to re-populate files which need to be copied to `target/`
 
 * m2e likes to put `excluding="**"` on `resources` directories; if you're seeing funny missing files
diff --git a/guide/dev/env/maven-build.md b/guide/dev/env/maven-build.md
index 84896585..2f01899c 100644
--- a/guide/dev/env/maven-build.md
+++ b/guide/dev/env/maven-build.md
@@ -6,7 +6,7 @@ toc: /guide/toc.json
 
 ## The Basics
 
-To build the code, you need Maven (v3) installed and Java (v1.7+).
+To build the code, you need Maven (v3.1+) and Java (v1.7+, 1.8 recommended) and Go (v1.6+).
 With that in place, you should be able to build everything with a:
 
 {% highlight bash %}
@@ -23,10 +23,12 @@ Key things to note if you're new to Maven:
 
 * Add ``-DskipTests`` to skip tests. 
 
+* Add ``-Dno-go-client`` to skip building the ``brooklyn-client`` project (useful if you don't have Go installed).
+
 * Run ``-PIntegration`` to run integration tests, or ``-PLive`` to run live tests
   ([tests described here](../code/tests.html))
 
-* Nearly all the gory details are in the root ``pom.xml``, which is referenced by child project poms.
+* Note that many of the gory details are in ``brooklyn-server/parent/pom.xml``, which is referenced by most other poms.
 
 * You can also open and use the code in your favourite IDE,
   although you may hit a few **[snags](ide/)**