You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2016/01/30 04:38:29 UTC
[04/29] incubator-brooklyn git commit: Getting Started with Vagrant
updates - for review
Getting Started with Vagrant updates - for review
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/b5873c94
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/b5873c94
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/b5873c94
Branch: refs/heads/master
Commit: b5873c946fd1a6cb79adf731a418be9519959ec0
Parents: 289eb5b
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Thu Jan 14 11:27:28 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Fri Jan 15 12:04:29 2016 +0000
----------------------------------------------------------------------
brooklyn-docs/guide/start/running.md | 100 +++++++++++++++++++++++++-----
1 file changed, 84 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/b5873c94/brooklyn-docs/guide/start/running.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/guide/start/running.md b/brooklyn-docs/guide/start/running.md
index 54315ec..43066e4 100644
--- a/brooklyn-docs/guide/start/running.md
+++ b/brooklyn-docs/guide/start/running.md
@@ -9,31 +9,62 @@ This guide will walk you through deploying an example 3-tier web application to
An overview of core [Brooklyn concepts](./concept-quickstart.html) is available for reference.
-This tutorial assumes that you are using Linux or Mac OS X.
+Two methods of deployment are detailed in this tutorial, using virtualisation with Vagrant and a local install. Both assume that you are using Linux or Mac OS X.
## Install Apache Brooklyn
-Download the Apache Brooklyn binary distribution as described on [the download page]({{site.path.website}}/download/).
+{::options parse_block_html="true" /}
+
+<ul class="nav nav-tabs">
+ <li class="active impl-1-tab"><a data-target="#impl-1, .impl-1-tab" data-toggle="tab" href="#">Vagrant</a></li>
+ <li class="impl-2-tab"><a data-target="#impl-2, .impl-2-tab" data-toggle="tab" href="#">Local Install</a></li>
+</ul>
+
+<div class="tab-content">
+<div id="impl-1" class="tab-pane fade in active">
+
+[Vagrant](https://www.vagrantup.com/){:target="_blank"} is a software package which automates the process of setting up virtual environments such as [Oracle VirtualBox](https://www.virtualbox.org){:target="_blank"}. We recommend it as
+the easiest way of getting started with Apache Brooklyn.
+
+Firstly, download and install:
+
+ * [Vagrant](http://www.vagrantup.com/downloads){:target="_blank"}
+ * [Oracle VirtualBox](https://www.virtualbox.org/wiki/Downloads){:target="_blank"}
+
+Then download the default Apache Brooklyn vagrant configuration from [here](http://someurl){:target="_blank"}. This configuration contains everything you need to get started using Apache Brooklyn.
+
+Extract the `tar.gz` archive and navigate into the expanded `apache-brooklyn-vagrant-{{ site.brooklyn-version }}` folder
+
+{% highlight bash %}
+$ tar xvf apache-brooklyn-vagrant-{{ site.brooklyn-version }}.tar.gz
+$ cd xvf apache-brooklyn-vagrant-{{ site.brooklyn-version }}
+{% endhighlight %}
+
+
+</div>
+<div id="impl-2" class="tab-pane fade">
+
+Download the Apache Brooklyn binary distribution as described on [the download page]({{site.path.website}}/download/){:target="_blank"}.
{% if brooklyn_version contains 'SNAPSHOT' %}
-Expand the `tar.gz` archive (note: as this is a -SNAPSHOT version, your filename will be slightly different):
+Extract the `tar.gz` archive (note: as this is a -SNAPSHOT version, your filename will be slightly different):
{% else %}
-Expand the `tar.gz` archive:
+Extract the `tar.gz` archive and navigate into the expanded `apache-brooklyn-{{ site.brooklyn-version }}` folder.
{% endif %}
{% if brooklyn_version contains 'SNAPSHOT' %}
{% highlight bash %}
$ tar -zxf apache-brooklyn-dist-{{ site.brooklyn-version }}-timestamp-dist.tar.gz
+$ cd apache-brooklyn-{{ site.brooklyn.version }}
{% endhighlight %}
{% else %}
{% highlight bash %}
$ tar -zxf apache-brooklyn-{{ site.brooklyn-version }}-dist.tar.gz
+$ cd apache-brooklyn-{{ site.brooklyn.version }}
{% endhighlight %}
{% endif %}
-This will create a `apache-brooklyn-{{ site.brooklyn-version }}` folder.
-
-**Note**: You'll need a Java JRE or SDK installed (version 7 or later), as Brooklyn is Java under the covers.
+**Note**: You'll need a [Java Runtime Environment (JRE)](https://www.java.com){:target="_blank"} installed (version 7 or later), as Brooklyn is Java under the covers.
It is not necessary at this time, but depending on what you are going to do,
you may wish to set up other configuration options first:
@@ -42,24 +73,61 @@ you may wish to set up other configuration options first:
* [Persistence](../ops/persistence/)
* [Cloud credentials](../ops/locations/)
+</div>
+</div>
+
+---
+
## Launch Apache Brooklyn
-Now start Brooklyn with the following command:
+<ul class="nav nav-tabs">
+ <li class="active impl-1-tab"><a data-target="#impl-1, .impl-1-tab" data-toggle="tab" href="#">Vagrant</a></li>
+ <li class="impl-2-tab"><a data-target="#impl-2, .impl-2-tab" data-toggle="tab" href="#">Local Install</a></li>
+</ul>
+
+<div class="tab-content">
+<div id="impl-1" class="tab-pane fade in active">
+
+Now start Apache Brooklyn with the following command:
+
+{% highlight bash %}
+$ vagrant up brooklyn
+{% endhighlight %}
+
+You can see if Apache Brooklyn launched OK by viewing the log files with the command
+
+{% highlight bash %}
+$ ssh brooklyn --command 'sudo journalctl -n15 -f -u brooklyn'
+{% endhighlight %}
+
+</div>
+<div id="impl-2" class="tab-pane fade">
+
+Now start Apache Brooklyn with the following command:
{% highlight bash %}
-$ cd apache-brooklyn-{{ site.brooklyn.version }}
$ bin/brooklyn launch
{% endhighlight %}
-Brooklyn will output the address of the management interface:
+The application should then output it's log into the console
+
+</div>
+</div>
+
+---
+
+## 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:
<pre>
-INFO Starting brooklyn web-console on loopback interface because no security config is set
-INFO Started Brooklyn console at http://127.0.0.1:8081/, running classpath://brooklyn.war and []
+INFO Started Brooklyn console at http://127.0.0.1:8081/, running classpath://brooklyn.war
</pre>
-### Next
+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. To use this, download and install the tool as described on [the download page]({{site.path.website}}/download/){:target="_blank"}.
+
+## Next
-Next, open the web console on [127.0.0.1:8081](http://127.0.0.1:8081).
-No applications have been deployed yet, so the "Create Application" dialog opens automatically:
-let's remedy this by **[deploying a blueprint](blueprints.html)**.
\ No newline at end of file
+The first thing we want to do with Brooklyn is **[deploy a blueprint](blueprints.html)**.