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:27 UTC
[02/29] incubator-brooklyn git commit: Updated blueprints + fixes
Updated blueprints + fixes
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/5644e28e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/5644e28e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/5644e28e
Branch: refs/heads/master
Commit: 5644e28e86979c68659168c2733a3ba03cdec479
Parents: 5aca6ca
Author: Duncan Godwin <du...@cloudsoftcorp.com>
Authored: Thu Jan 14 17:39:55 2016 +0000
Committer: Duncan Godwin <du...@cloudsoftcorp.com>
Committed: Fri Jan 15 12:04:29 2016 +0000
----------------------------------------------------------------------
brooklyn-docs/guide/ops/security-guidelines.md | 2 +-
brooklyn-docs/guide/start/blueprints.md | 91 +++++++++++++++------
brooklyn-docs/guide/start/running.md | 4 +-
brooklyn-docs/guide/yaml/test/test-entities.md | 2 -
4 files changed, 72 insertions(+), 27 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5644e28e/brooklyn-docs/guide/ops/security-guidelines.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/guide/ops/security-guidelines.md b/brooklyn-docs/guide/ops/security-guidelines.md
index d8c919d..b6e4460 100644
--- a/brooklyn-docs/guide/ops/security-guidelines.md
+++ b/brooklyn-docs/guide/ops/security-guidelines.md
@@ -40,7 +40,7 @@ configuration" feature. This allows credentials to be retrieved from a store man
rather than being stored within YAML blueprints or brooklyn.properties.
A secure credential store is strongly recommended, such as use of
-[HashiCorp's Vault](www.vaultproject.io) - see
+[HashiCorp's Vault](https://www.vaultproject.io) - see
`org.apache.brooklyn.core.config.external.vault.VaultExternalConfigSupplier`.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5644e28e/brooklyn-docs/guide/start/blueprints.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/guide/start/blueprints.md b/brooklyn-docs/guide/start/blueprints.md
index 492ac73..90d1d48 100644
--- a/brooklyn-docs/guide/start/blueprints.md
+++ b/brooklyn-docs/guide/start/blueprints.md
@@ -6,44 +6,82 @@ children:
- { section: Launching from a Blueprint, title: Blueprint }
---
-<div style="width: 100%; display: block; background-color: #CC9966; margin-bottom: 2px; padding: 50px 30px 50px 80px;" >
- <h3>NOTE</h3>
- <div>
- The structure of Brooklyn's repositories is changing at present (Jan 2016). Until this is complete
- please obtain the "br" command line tool from <a href="https://github.com/brooklyncentral/brooklyn-cli">Brooklyn Central</a>
- </div>
-</div>
+Blueprints are the descriptors or patterns which describe how Apache Brooklyn should deploy applications.
## Launching from a Blueprint
We'll start by deploying an application with a simple YAML blueprint containing a Tomcat server.
-Copy the blueprint below into a text file, "myapp.yaml", in your workspace, but *before* you create an application with
-it, modify the YAML to specify the location where the application will be deployed. (Note, to copy the file you can
+Copy the blueprint below into a text file, "myapp.yaml", in your workspace (Note, to copy the file you can
hover your mouse over the right side of the text box below to get a Javascript "copy" button.)
{% highlight yaml %}
name: Tomcat
location:
- jclouds:aws-ec2:
- identity: ABCDEFGHIJKLMNOPQRST
- credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l
services:
- serviceType: brooklyn.entity.webapp.tomcat.TomcatServer
{% endhighlight %}
-Replace the ```location:``` element with values for your chosen target environment, for example to use SoftLayer rather
-than AWS (updating with your own credentials):
+
+## Locations
+
+Before you create an application with the configuration you need to modify the YAML to specify a location. Locations in Apache Brooklyn are server resources Brooklyn can use to deploy applications. These locations may be servers or cloud providers which provide access to servers.
+
+In order to configure the location Apache Brooklyn launches an application, replace the ```location:``` element with values for your chosen target environment, here are some examples for the variouss location types.
+
+{::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="#">Clouds</a></li>
+ <li class="impl-3-tab"><a data-target="#impl-3, .impl-3-tab" data-toggle="tab" href="#">BYON</a></li>
+ <li class="impl-4-tab"><a data-target="#impl-4, .impl-4-tab" data-toggle="tab" href="#">Localhost</a></li>
+</ul>
+
+<div class="tab-content">
+<div id="impl-1" class="tab-pane fade in active">
+
+The Vagrant configuration described in [Running Apache Brooklyn](./running.html), on the previous page is the **recommended** way of running this tutorial. This configuration comes with four blank vagrant configurations called byon1 to byon4
+
+These can be launched by entering the following line into the terminal in the vagrant configuration directory.
+
+{% highlight bash %}
+ $ vagrant up byon1 byon2 byon3 byon4
+{% endhighlight %}
+
+The location in "myapp.yaml" can then be replaced by the following YAML to launch to these
+
+{% highlight yaml %}
+location:
+ byon:
+ user: vagrant
+ password: vagrant
+ hosts:
+ - 10.10.10.101
+ - 10.10.10.102
+ - 10.10.10.103
+ - 10.10.10.104
+{% endhighlight %}
+
+</div>
+<div id="impl-2" class="tab-pane fade">
+
+Apache Brooklyn uses [Apcahe jclouds](http://jclouds.apache.org/) to support a range of cloud locations. More information on the range of providers and configurations is available [here](../ops/locations/#clouds).
+
+As an example here is a configuration for [Amazon Web Services (AWS)](http://www.aws.amazon.com). Swap the identity and credential with your AWS account details then replace the location in your "myapp.yaml" with this.
{% highlight yaml %}
location:
- jclouds:softlayer:
+ jclouds:aws-ec2:
identity: ABCDEFGHIJKLMNOPQRST
credential: s3cr3tsq1rr3ls3cr3tsq1rr3ls3cr3tsq1rr3l
{% endhighlight %}
-Or, if you already have machines provisioned, you can use the "bring your own nodes" (byon) approach.
-Of course, replace the identity and address values below with your own values.
+</div>
+<div id="impl-3" class="tab-pane fade">
+
+The Bring Your Own Nodes (BYON) configuration allows Apache Brooklyn to make use of already available servers. These can be specified by a list of IP addresses with a user and password as shown below. More information including the full range of configuration options is available [here](../ops/locations/#byon).
+
{% highlight yaml %}
location:
byon:
@@ -56,17 +94,24 @@ location:
- 192.168.0.19
{% endhighlight %}
-**Note**: See __[Locations](../ops/locations)__ 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.
-(For the application above, if you are using a "Bring your own Nodes" location, you will need at least three nodes.)
+</div>
+<div id="impl-4" class="tab-pane fade">
+
+</div>
+</div>
+
+---
+
+**Note**: For instructions on setting up a variety of locations or storing credentials/locations in a file on disk rather than in the blueprint see __[Locations](../ops/locations)__ in the Operations section of the User Guide.
+
+## Deploying the Application
-First you will have to log in to brooklyn:
+First, log in to brooklyn with the command line tool (CLI) by typing:
{% highlight bash %}
$ br login http://localhost:8081/
{% endhighlight %}
-To secure the server you can add a username and password in Brooklyn's properties file, as described in the User Guide.
+To secure the Apache Brooklyn instance you can add a username and password to Brooklyn's properties file, as described in the User Guide [here](../ops/brooklyn_properties.html).
Then the login command will require the additional parameters of the userid and password.
Now you can create the application with the command below:
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5644e28e/brooklyn-docs/guide/start/running.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/guide/start/running.md b/brooklyn-docs/guide/start/running.md
index 1cb64c5..3fefeb5 100644
--- a/brooklyn-docs/guide/start/running.md
+++ b/brooklyn-docs/guide/start/running.md
@@ -126,7 +126,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. To use this, download and install the tool as described on [the download page]({{site.path.website}}/download/){: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/brooklyncentral/brooklyn-cli){: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/)
## Next
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5644e28e/brooklyn-docs/guide/yaml/test/test-entities.md
----------------------------------------------------------------------
diff --git a/brooklyn-docs/guide/yaml/test/test-entities.md b/brooklyn-docs/guide/yaml/test/test-entities.md
index a81a3d6..2b9fdfe 100644
--- a/brooklyn-docs/guide/yaml/test/test-entities.md
+++ b/brooklyn-docs/guide/yaml/test/test-entities.md
@@ -37,7 +37,6 @@ Timeouts on child entities should be set relative to the start of the `ParallelT
The `LoopOverGroupMembersTestCase` entity is configured with a target group and a test specification. For each member of the targeted group, the test case will create a TargetableTestComponent entity from the supplied test specification and set the components target to be the group member.
{% highlight yaml %}
-{% readj example_yaml/entities/loopovergroupmembers-entity.yaml %}
{% endhighlight %}
#### Parameters
@@ -50,7 +49,6 @@ The `LoopOverGroupMembersTestCase` entity is configured with a target group and
The `InfrastructureDeploymentTestCase` will first create and deploy an infrastructure from the `infrastructure.deployment.spec` config. It will then retrieve a deployment location by getting the value of the infrastructures `infrastructure.deployment.location.sensor` sensor. It will then create and deploy all entities from the `infrastructure.deployment.spec` config to the deployment location.
{% highlight yaml %}
-{% readj example_yaml/entities/infrastructuredeploymenttestcase-entity.yaml %}
{% endhighlight %}
#### Parameters